v1

latestOpenAPI 3.0.12026-07-17265663.1 KB

Devices

Get device by ID

Get information about a single device. Alternative is to call 'Get all devices' with a deviceId filter query parameter.

get/api/v1/devices/{deviceId}

Path parameters

deviceIdstring uuid required

Id of the device.

Response

Information about a single device.

idstring

typesstring[]

namestring

modelNumberstring

interfacesstring[]

protocolIndependentIdstring

Example response

{
  "id": "4629b3cb-3a6e-477c-5d50-ccb28ad7c349",
  "types": [
    "oic.d.cloudDevice",
    "oic.wk.d"
  ],
  "name": "CloudServer",
  "metadata": {
    "connection": {
      "status": "ONLINE"
    },
    "twinEnabled": true
  },
  "manufacturerName": [
    {
      "language": "en-US",
      "value": "plugged"
    }
  ],
  "modelNumber": "12-d21d4-23jzi2",
  "interfaces": [
    "oic.if.r",
    "oic.if.baseline"
  ],
  "protocolIndependentId": "cd5f73ed-51e0-4ad7-59f9-bfb0f7b4b747"
}