get_hw_cmds
Функция get_hw_cmds используется для получения списка команд, доступных для объекта или типа оборудования, или для получения шаблонов команд.
svc=core/get_hw_cmds¶ms={"deviceTypeId":<long>,
"unitId":<long>,
"template":<bool>
"lang":"<text>"}
Параметры
| Название | Описание |
|---|---|
deviceTypeId | ID типа оборудования. |
unitId | ID объекта. |
template | Флаг. Если указано 1 (on), возвращается JSON с данными шаблона команды. Необязательный параметр. |
lang | Флаг. Переводит значения параметров "title" и "label". Необязательный параметр. |
Можно указать один или сразу два параметра. Поиск начинается с ID типа оборудования, а в случае ошибки продолжается по ID объекта. Если необходимо пропустить параметр, укажите в нем 0.
Возвращаемый результат
В возвращаемом результате содержится список доступных команд если template:0 или параметра нет:
{
"<text>":[ /* тип связи: GSM, TCP, UDP, VRT */
"<text>", /* тип команды */
...
],
...
}
Если во флаге template указано 1, возвращается шаблон команды. Это может быть произвольный набор полей. Пример JSON:
{
"<cmd_template_name>": { /* имя */
"icon": "<text>", /* иконка */
"props": [ /* свойства */
{
"label":"<text>", /* название поля */
"type":"<text>", /* тип */
"validate":"<text>", /* правило для валидации */
"value": [ /* массив ключей-значений */
{
"n":"<text>", /* ключ */
"v":"<text>" /* значение */
},
...
],
"default":"<text>", /* значение по умолчанию (например, порт IP-адреса) */
"title":"<text>", /* заголовок */
"maxlength":<uint> /* максимальная длина */
},
...
]
},
...
}
Возможные коды ошибок:
| Код | Описание |
|---|---|
| 6 | Не удалось извлечь текущего пользователя. |
| 4 | Одна из следующих ошибок:
|