v1

latestOpenAPI 3.0.12026-07-17265663.1 KB

Devices

Get all devices

All registered devices user is authorized to use are returned in form of a stream, chunk by chunk. Attach your reader and consume device by device. Various filters allows you to be more concrete in devices you would like to get. Error response might be returned immediately, but also anytime during the stream reading.

get/api/v1/devices

Query parameters

deviceIdstring uuid

Filter by the device id.

typestring[]

Filter by the type.

statusConnectionStatus[]

Filter by the device status.

Response

Stream of devices or errors.

Example response

{
  "result": {
    "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"
  }
}