command/get

Gets information about the command.

Authorization

Access JSON Web Token (GetDeviceCommand)

Request Topic and Payload

Topic

dh/request

Payload Representation

{
    "action": {string},
    "requestId": {object},
    "deviceId": {string},
    "commandId": {long}
}

Payload Parameters

Property Name	Required	Type	Descripton
action	Yes	string	Action name: command/get
requestId	No	object	Request unique identifier, will be passed back in the response message.
deviceId	Yes	Yes	Device unique identifier.
commandId	Yes	Yes	Command unique identifier.

Response Topic and Payload

Topic

dh/response/command/get@{clientId}

Payload Representation

{
    "action": {string},
    "status": {string},
    "requestId": {object},
    "command": {
        "id": {long},
        "command": {string},
        "timestamp": {datetime},
        "lastUpdated": {datetime},
        "userId": {integer},
        "deviceId": {string},
        "networkId": {integer},
        "parameters": {object},
        "lifetime": {integer},
        "status": {string},
        "result": {object}
    }
}

Payload Parameters

Property Name	Type	Description
action	string	Action name: command/get
status	string	Operation execution status (success or error).
requestId	object	Request unique identifier as specified in the request message.
command	object	An inserted DeviceCommand resource.
command.id	long	Command identifier.
command.command	string	Command name.
command.timestamp	datetime	Command UTC datetime (yyyy-MM-dd'T'HH:mm:ss.SSS ISO 8601).
command.lastUpdated	datetime	Last command update UTC datetime (yyyy-MM-dd'T'HH:mm:ss.SSS ISO 8601).
command.userId	integer	Associated user identifier.
command.deviceId	string	Associated device identifier.
command.networkId	integer	Associated network identifier.
command.parameters	object	Command parameters, a JSON object with an arbitrary structure.
command.lifetime	integer	Command lifetime, a number of seconds until this command expires.
command.status	string	Command status, as reported by device or related infrastructure.
command.result	object	Command execution result, an optional value that could be provided by device.