post https://example.com/device/v1/devices//commands/start
Start a new command
Request Body Parameters:
Parameter | Type | Mandatory | Description | Example |
---|---|---|---|---|
<customAttribute1> | <customAttribute1Type> | false | Regular custom attribute 1 value | |
<customAttributeN> | <customAttributeNType> | false | Regular custom attribute N value | |
_configuration | object | false | An object that holds the entity configuration attributes | |
_configuration.<customAttribute1> | <customAttribute1Type> | false | Configuration custom attribute 1 value | |
_configuration.<customAttributeN> | <customAttributeNType> | false | Configuration custom attribute N value | |
_name | string | false | The name of the command | |
_status.<customAttribute1> | <customAttribute1Type> | false | Status custom attribute 1 value | |
_status.<customAttributeN> | <customAttributeNType> | false | Status custom attribute N value | |
_summary.<customAttribute1> | <customAttribute1Type> | false | Summary custom attribute 1 value | |
_summary.<customAttributeN> | <customAttributeNType> | false | Summary custom attribute N value | |
_templateId | string | true | The id of a template that is configured in the settings service. | 3fa85f64-5717-4562-b3fc-2c963f66afa6 |
Path Parameters:
Parameter | Type | Mandatory | Description | Example |
---|---|---|---|---|
deviceId | string | true | null |
This API requires PROTECTED_API permission(s).