Polls new device commands.

This method returns all device commands that were created after specified timestamp.

In the case when no commands were found, the method blocks until new command is received. If no commands are received within the waitTimeout period, the server returns an empty response. In this case, to continue polling, the client should repeat the call with the same timestamp value.

Request

HTTP Request

GET /device/command/poll?deviceId={deviceId}&networkIds={networkIds}&deviceTypeIds={deviceTypeIds}&timestamp={timestamp}&names={names}&waitTimeout={waitTimeout}

Parameters

Parameter NameRequiredType
deviceIdNostringDevice unique identifier.
networkIdsNostringComma-separated list of network unique identifiers.
deviceTypeIdsNostringComma-separated list of device type unique identifiers.
timestampNodatetimeUTC datetime (yyyy-MM-dd'T'HH:mm:ss.SSS ISO 8601) of the last received command. If not specified, the server's timestamp is taken instead.
namesNostringComma-separated list of commands names.
waitTimeoutNointegerWaiting timeout in seconds (default: 30 seconds, maximum: 60 seconds). Specify 0 to disable waiting.
limitNointegerLimits number of commands.

Authorization

Access JSON Web Token (GetDeviceCommand)

Request Body

Do not supply a request body with this method.

Response

If successful, this method returns array of the following resources in the response body.

Property NameTypeDescription
idintegerCommand identifier.
commandstringCommand name
timestampdatetimeCommand UTC datetime (yyyy-MM-dd'T'HH:mm:ss.SSS ISO 8601).
userIdintegerAssociated user identifier.
deviceIdstringDevice unique identifier.
networkIdintegerNetwork unique identifier.
deviceTypeIdintegerDevice type unique identifier.
parametersobjectCommand parameters, a JSON object with an arbitrary structure.
lifetimeintegerCommand lifetime, a number of seconds until this command expires.
statusstringCommand status, as reported by device or related infrastructure.
resultobjectCommand execution result, an optional value that could be provided by device
lastUpdateddatetimeLast command update UTC datetime (yyyy-MM-dd'T'HH:mm:ss.SSS ISO 8601).