get_vrt_command_queue
To get virtual commands, use the unit/get_vrt_command_queue method.
Endpoint
svc=unit/get_vrt_command_queue¶ms={
"itemId": <long>
}
Parameters
The request must contain the following parameter:
| Parameter | Description |
|---|---|
itemId |
Unit ID. |
Example
svc=unit/get_vrt_command_queue¶ms={
"itemId": 132343
}
Response
If the request is completed successfully, the response contains virtual commands. If the queue is empty, an empty object {} is returned.
[
{
"cmd_alias": "",
"cmd_hex": "4040FF001167165F9E0040313233343A7265626F6F74BE0C",
"cmd_name": "custom_msg",
"cmd_param": "@1234:reboot",
"cmd_tm_add": "1729519518",
"l_add_params": [
{
"pname": "cmd_seq_n",
"ptype": "int",
"pval": "0"
}
]
},
{
"cmd_alias": "",
"cmd_hex": "4040FF0011671678A70040313233343A7265626F6F749D52",
"cmd_name": "custom_msg",
"cmd_param": "@1234:reboot",
"cmd_tm_add": "1729525927",
"l_add_params": [
{
"pname": "cmd_seq_n",
"ptype": "int",
"pval": "0"
}
]
}
]
If the request fails, an error code is returned.
Error codes
| Error code | Description |
|---|---|
| 4 | Invalid input parameters. |
| 7 | The unit doesn’t exist, or the user doesn’t have the View detailed object properties access right to it. |