Component Webservice

Get or create device physical port config

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.

post/api/component/getOrCreateDevicePhysicalPortConfig

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/component/getOrCreateDevicePhysicalPortConfig
  • Auth: API key in header x-auth-apikey

Headers

x-auth-scheme'api-token' | 'api' | 'partner-api-token' | 'partner-api' required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Request body

ownerDeviceUuidstring RUUID nullable

base 64 (url-safe) uuid string

Example request

{
  "ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}

Response

OK

supportedAperioLockModelsAperioLockModelEnum[] nullable
supportedSchlageApmFamiliesSchlageApmFamilyEnum[] nullable

Example response

{
  "detectedInvalidPortConfigs": [
    {
      "componentUuids": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ]
    }
  ],
  "deviceComponents": [
    {
      "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "hardwareUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ],
  "devicePhysicalPortConfig": {
    "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
  },
  "supportedAperioLockModels": [
    "IN100_V3_MC"
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.