Skip to main content
POST
/
api
/
component
/
getOrCreateDevicePhysicalPortConfig
Get or create device physical port config
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
  }
}

Authorizations

x-auth-apikey
string
header
required

Your API key for Rhombus.

Headers

x-auth-scheme
string
default:api-token
required

Authentication scheme indicator ("api-token").

Required string length: 9

Body

application/json
ownerDeviceUuid
string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

Response

200 - application/json

OK

detectedInvalidPortConfigs
object[] | null
deviceComponents
object[] | null
devicePhysicalPortConfig
object