🚧 The Rhombus Developer Documentation is currently in beta. For the official documentation, please visit docs.rhombus.com.
curl --request POST \
--url https://api2.rhombussystems.com/api/component/getOrCreateDevicePhysicalPortConfig \
--header 'Content-Type: application/json' \
--header 'x-auth-apikey: <api-key>' \
--header 'x-auth-scheme: <x-auth-scheme>' \
--data '
{
"ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
'{
"detectedInvalidPortConfigs": [
{
"boardNum": 123,
"componentUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"portNum": 123,
"reason": "NON_EXISTANT_COMPONENT_BOARD_NUM"
}
],
"deviceComponents": [
{
"baseType": "reader",
"createdAtMillis": 123,
"deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"disableCardReader": true,
"disableKeypad": true,
"disableWaveToUnlock": true,
"hardwareUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"name": "<string>",
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"osdpAddress": 123,
"otherReaderUnlockAudioFeedbackEnabled": true,
"ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"ownerHardwareType": "RASPBERRY_PI_3",
"port": {
"boardNum": 123,
"portNum": 123,
"portType": "RS485"
},
"portImmutable": true,
"readerType": "wiegand",
"remoteUnlockAudioFeedbackEnabled": true,
"serialNumber": "<string>",
"type": "RhombusOsdpDoorReader",
"updatedAtMillis": 123,
"uuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
],
"devicePhysicalPortConfig": {
"boardMap": {},
"createdAtMillis": 123,
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"updatedAtMillis": 123
}
}Gets a physical port layout for the specified device, components owned by that device and details about the port configuration validity. Map is instantiated if it doesn’t currently exist as part of the call.
curl --request POST \
--url https://api2.rhombussystems.com/api/component/getOrCreateDevicePhysicalPortConfig \
--header 'Content-Type: application/json' \
--header 'x-auth-apikey: <api-key>' \
--header 'x-auth-scheme: <x-auth-scheme>' \
--data '
{
"ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
'{
"detectedInvalidPortConfigs": [
{
"boardNum": 123,
"componentUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"portNum": 123,
"reason": "NON_EXISTANT_COMPONENT_BOARD_NUM"
}
],
"deviceComponents": [
{
"baseType": "reader",
"createdAtMillis": 123,
"deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"disableCardReader": true,
"disableKeypad": true,
"disableWaveToUnlock": true,
"hardwareUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"name": "<string>",
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"osdpAddress": 123,
"otherReaderUnlockAudioFeedbackEnabled": true,
"ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"ownerHardwareType": "RASPBERRY_PI_3",
"port": {
"boardNum": 123,
"portNum": 123,
"portType": "RS485"
},
"portImmutable": true,
"readerType": "wiegand",
"remoteUnlockAudioFeedbackEnabled": true,
"serialNumber": "<string>",
"type": "RhombusOsdpDoorReader",
"updatedAtMillis": 123,
"uuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
],
"devicePhysicalPortConfig": {
"boardMap": {},
"createdAtMillis": 123,
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"updatedAtMillis": 123
}
}Your API key for Rhombus.
Authentication scheme indicator ("api-token").
9base 64 (url-safe) uuid string
"AAAAAAAAAAAAAAAAAAAAAA"
OK
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?