v1

latestOpenAPI 3.0.12026-07-17265663.1 KB

Pending Commands

Get all pending commands

Resource shadow can be updated even if the device is offline. Each update request creates a pending command which is executed at the moment devices comes online. If the device is offline, this API allows you to retrieve all pending commands in form of a stream. Various filters allows you to be more concrete in pending commands you would like to get. Error response might be returned immediately, but also anytime during the stream reading.

get/api/v1/pending-commands

Query parameters

deviceIdstring uuid

Filter by the device id.

typestring[]

Filter by the type.

resourceIdstring[]

Filter by resource id specified in format {deviceId}{resourceHref}(?etag={etag}). ETag is optional and it is supported only for GET resources.

commandCommandType[]

Filter by the command type.

Response

Stream of resource links or errors.

Example response

{
  "result": {
    "resources": [
      {
        "href": "/switches/1",
        "deviceId": "4629b3cb-3a6e-477c-5d50-ccb28ad7c349",
        "resourceTypes": [
          "oic.r.switch.binary"
        ],
        "interfaces": [
          "oic.if.a",
          "oic.if.baseline"
        ],
        "anchor": "",
        "title": "",
        "supportedContentTypes": [],
        "validUntil": "0",
        "policy": {
          "bitFlags": 3
        },
        "endpointInformations": []
      }
    ],
    "deviceId": "4629b3cb-3a6e-477c-5d50-ccb28ad7c349",
    "auditContext": {
      "userId": "9772fcff-dcfb-4db8-a6c9-1b75f2165eb1",
      "correlationId": "ef007f88-6073-4af1-8951-971578bf6803"
    },
    "eventMetadata": {
      "connectionId": "194.1.25.111:61692",
      "sequence": "4",
      "version": "0",
      "timestamp": "1625432924483895839"
    }
  }
}