get_command_definition_data
Для получения данных о командах используйте метод unit/get_command_definition_data.
Конечная точка
svc=unit/get_command_definition_data¶ms={
"itemId": <long>,
"col": [<long>]
}
Параметры
Обязательные параметры отмечены звездочкой (*).
| Параметр | Описание |
|---|---|
itemId* |
ID объекта. |
col |
Массив ID команд. Если этот параметр указан, в ответе возвращаются только команды с этими ID в том же порядке. ID несуществующих команд пропускаются. |
Ответ
Если запрос выполнен успешно, возвращается ответ в следующем формате:
[
{
"id": <long>, /* ID команды */
"n": "<text>", /* Имя команды */
"c": "<text>", /* Тип команды */
"l": "<text>", /* Тип связи. Пустая строка, если тип связи выбирается автоматически */
"p": "<text>", /* Параметры */
"a": <long>, /* Права доступа, которые необходимы пользователю для выполнения команды */
"f": <uint>, /* Флаги */
"jp": "<text>" /* JSON-параметры в виде текста. Пустая строка, если они не заданы */
}
]
Значение a — это комбинация флагов доступа. Чтобы выполнить команду, пользователь должен иметь все эти права доступа на объект, а также право Отправка команд. Например, значение 1 соответствует праву доступа Просмотр элемента и его основных свойств.
Типы команд и связи, а также параметры p и jp описаны на странице unit/update_command_definition.
В ответе возвращаются не только те команды, которые устройство может выполнить в данный момент. Чтобы получить только такие команды, используйте флаг Доступные команды формата данных объекта.
Если запрос не выполнен, возвращается код ошибки.
Коды ошибок
| Код ошибки | Описание |
|---|---|
| 4 | Параметр itemId отсутствует или не является числом. |
| 7 | Объект не существует, или у пользователя нет права доступа Просмотр команд на него. |