Commands V2.0 provides advanced device commands capabilities like queuing, support for offline devices, dynamic device set for commands and command history. Commands 2.0 is in active development and we will add support for all the commands soon
API to get and filter command requests
on successful request
Authorization information is missing or invalid.
Not Found.
Internal server error
{- "count": 0,
- "next": "string",
- "previous": "string",
- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "enterprise": "796caaf9-a7de-4817-9ffa-39d04bf83de9",
- "command_type": "DEVICE",
- "devices": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "groups": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "device_type": "active",
- "command": "ADD_TO_WHITELIST",
- "command_args": {
- "device_alias_name": "string",
- "custom_settings_config": { },
- "app_version": "string",
- "package_name": "string",
- "policy_url": "string",
- "wifi_access_points": { },
- "state": "string",
- "message": "string",
- "title": "string",
- "url": "string",
- "app_state": "string",
- "bluetooth_state": true,
- "brightness_value": 0,
- "gps_state": 0,
- "rotate_state": 0,
- "screen_off_timeout": 0,
- "stream": 0,
- "volume_level": 0,
- "timezone_string": 0,
- "wifi_state": true,
- "wifi_revert_timeout": 0,
- "locale": "string",
- "ethernet_auth_mode": "NONE",
- "ethernet_ca_cert_alias": "string",
- "ethernet_client_cert_alias": "string",
- "ethernet_eap_identity": "string",
- "interface": "string",
- "dhcp_enabled": "string",
- "static_ip": "string",
- "primary_dns": "string",
- "subnet_mask": "string",
- "secondary_dns": "string",
- "gateway": "string",
- "duration": "string",
- "tag": "string",
- "video_quality": "string",
- "enable_debug_mode": false,
- "converge_with_provision_option": false,
- "auto_update_mode": "autoUpdateDefault"
}, - "schedule": "IMMEDIATE",
- "schedule_args": {
- "name": "string",
- "start_datetime": "2019-08-24T14:15:22Z",
- "end_datetime": "2019-08-24T14:15:22Z",
- "time_type": "console",
- "window_start_time": "string",
- "window_end_time": "string",
- "days": [
- "string"
]
}, - "issued_by": "string",
- "created_on": "2019-08-24T14:15:22Z",
- "status": [
- {
- "state": "0e231ca7-8c83-44ad-9df9-f0699a512c67",
- "total": 0
}
]
}
]
}
API to create a command request for the device.
The request body to create a command for set of devices or groups
command request successfully created
Bad request
Authorization information is missing or invalid.
Forbidden, no permission to perform this action.
Internal server error
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "enterprise": "796caaf9-a7de-4817-9ffa-39d04bf83de9",
- "command_type": "DEVICE",
- "devices": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "groups": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "device_type": "active",
- "command": "ADD_TO_WHITELIST",
- "command_args": {
- "device_alias_name": "string",
- "custom_settings_config": { },
- "app_version": "string",
- "package_name": "string",
- "policy_url": "string",
- "wifi_access_points": { },
- "state": "string",
- "message": "string",
- "title": "string",
- "url": "string",
- "app_state": "string",
- "bluetooth_state": true,
- "brightness_value": 0,
- "gps_state": 0,
- "rotate_state": 0,
- "screen_off_timeout": 0,
- "stream": 0,
- "volume_level": 0,
- "timezone_string": 0,
- "wifi_state": true,
- "wifi_revert_timeout": 0,
- "locale": "string",
- "ethernet_auth_mode": "NONE",
- "ethernet_ca_cert_alias": "string",
- "ethernet_client_cert_alias": "string",
- "ethernet_eap_identity": "string",
- "interface": "string",
- "dhcp_enabled": "string",
- "static_ip": "string",
- "primary_dns": "string",
- "subnet_mask": "string",
- "secondary_dns": "string",
- "gateway": "string",
- "duration": "string",
- "tag": "string",
- "video_quality": "string",
- "enable_debug_mode": false,
- "converge_with_provision_option": false,
- "auto_update_mode": "autoUpdateDefault"
}, - "schedule": "IMMEDIATE",
- "schedule_args": {
- "name": "string",
- "start_datetime": "2019-08-24T14:15:22Z",
- "end_datetime": "2019-08-24T14:15:22Z",
- "time_type": "console",
- "window_start_time": "string",
- "window_end_time": "string",
- "days": [
- "string"
]
}, - "issued_by": "string",
- "created_on": "2019-08-24T14:15:22Z",
- "status": [
- {
- "state": "0e231ca7-8c83-44ad-9df9-f0699a512c67",
- "total": 0
}
]
}
API to get and filter command request status
on successful request
Authorization information is missing or invalid.
Not Found.
Internal server error
{- "count": 0,
- "next": "string",
- "previous": "string",
- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "request": "60448f3a-8291-43df-9526-c3d4a574e4d2",
- "device": "string",
- "state": "Command Queued",
- "reason": "string",
- "created_on": "2019-08-24T14:15:22Z",
- "updated_on": "2019-08-24T14:15:22Z",
- "meta": {
- "device": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "device_name": "string",
- "alias_name": "string",
- "timezone_string": "string"
}
}
}
]
}
API to get and filter deivce command history
on successful request
Authorization information is missing or invalid.
Not Found.
Internal server error
{- "count": 0,
- "next": "string",
- "previous": "string",
- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "request": "60448f3a-8291-43df-9526-c3d4a574e4d2",
- "command": "string",
- "command_args": { },
- "issued_by": {
- "id": 0,
- "username": "string"
}, - "device": "string",
- "state": "Command Queued",
- "reason": "string",
- "requeue_value": 0,
- "created_on": "2019-08-24T14:15:22Z",
- "updated_on": "2019-08-24T14:15:22Z"
}
]
}