Waits for a command to be processed.

This method returns a command only if it has been processed by a device.

In the case when command is not processed, the method blocks until device acknowledges command execution. If the command is not processed within the waitTimeout period, the server returns an empty response. In this case, to continue polling, the client should repeat the call.

Request

HTTP Request

GET /device/{deviceId}/command/{commandId}/poll?waitTimeout={waitTimeout}

Parameters

deviceIdYesstringDevice unique identifier.
commandIdYesintegerCommand identifier.
waitTimeoutNointegerWaiting timeout in seconds (default: 30 seconds, maximum: 60 seconds). Specify 0 to disable waiting.

Authorization

Access JSON Web Token (GetDeviceCommand)

Request Body

Do not supply a request body with this method.

Response

If successful, this method returns a DeviceCommand resource 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).