List all queued commands

POST 
/v1/commands/list

This API allows devices to fetch the list of commands if out of order execution or parallel execution of multiple commands is required. Please note that changing status of a command received from list API may change the output of next API List API returns the command list in the ascending order of creation.

note

The list API returns commands with following status only: pending, received, processing. Commands with any other status is considered as concluded

MQTT Topic

$anedya/device/{deviceid}/commands/list/json

Request

application/json

Body

reqId string
limit integer
offset integer

Responses

2XX

Success

application/json

Schema

Schema

reqId string
success string
error string
errorcode string
commands object[]
Array [
commandId string
command string
status string
Possible values: [pending, received, processing]
issuedAt integer
updated integer
]
count integer
next integer

Example (from schema)

{
  "reqId": "string",
  "success": "string",
  "error": "string",
  "errorcode": "string",
  "commands": [
    {
      "commandId": "string",
      "command": "string",
      "status": "pending",
      "issuedAt": 0,
      "updated": 0
    }
  ],
  "count": 0,
  "next": 0
}

Loading...