Queries device commands.

Request

HTTP Request

GET /device/{deviceId}/command

Parameters

Parameter NameRequiredTypeDescription
deviceIdYesstringDevice unique identifier.
startNodatetimeFilter by command start UTC datetime (yyyy-MM-dd'T'HH:mm:ss.SSS ISO 8601).
endNodatetimeFilter by command end UTC datetime (yyyy-MM-dd'T'HH:mm:ss.SSS ISO 8601).
commandNostringFilter by command name.
statusNostringFilter by command status.
sortFieldNostringResult list sort field. Available values are Timestamp (default), Command and Status.
sortOrderNostringResult list sort order. Available values are ASC and DESC.
takeNointegerNumber of records to take from the result list (default is 1000).
skipNointegerNumber of records to skip from the result list.

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 DeviceCommand resources in the response body.

Property NameTypeDescription
idintegerCommand identifier.
commandstringCommand name
timestampdatetimeCommand UTC datetime (yyyy-MM-dd'T'HH:mm:ss.SSS ISO 8601).
lastUpdateddatetimeLast command update UTC datetime (yyyy-MM-dd'T'HH:mm:ss.SSS ISO 8601).
userIdintegerAssociated user identifier.
deviceIdstringDevice unique identifier.
networkIdintegerNetwork 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.