Skip to content

Query command execution status

GET
/devices/{deviceId}/commands/{commandId}

Return the execution status of a command.

Authorizations

AccessToken
Type
HTTP (bearer)

Parameters

Path Parameters

deviceId*

Device ID

Type
string
Required
commandId*

Command ID

Type
string
Required

Responses

Command status returned successfully

application/json
object

Command status details

Command ID

Device ID

object

Active power control

object

Reactive power control

Execution start time

Format"date-time"

Execution end time

Format"date-time"

Execution status: received=Received, executing=Executing, completed=Completed, cancelled=Cancelled

Valid values"received""executing""completed""cancelled"

Time when command was received

Format"date-time"

Time when command was cancelled

Format"date-time"

Cancellation reason: Manually cancelled, Time window overlap, Start time expired, Device fault, Not supported

Valid values"manuallyCancel""timeWindowOverlap""startTimeExpire""deviceFault""notSupported"

Time when execution started

Format"date-time"

Time when execution completed

Format"date-time"

Playground

Authorization
Variables
Key
Value