Группы объектов
В зависимости от указанных флагов формат ответа может различаться.
На этой странице описаны флаги, которые могут быть применены к группам объектов, и соответствующие им части результирующего JSON, которыми они управляют. Если указано несколько флагов, их соответствующие части объединяются в единый JSON.
Флаги указываются в формате DEC. Подробнее см. в разделе Формат данных.
Содержимое ответа также зависит от ваших прав доступа к элементу. Подробнее см. в разделе Флаги и права доступа.
Флаги групп объектов
К группам объектов могут быть применены следующие флаги:
| Значение в HEX | Значение в DEC | Описание |
|---|---|---|
| 0x00000001 | 1 | Основные свойства (базовый флаг) |
| 0x00000002 | 2 | Произвольные свойства |
| 0x00000004 | 4 | Информация о биллинге |
| 0x00000008 | 8 | Произвольные поля |
| 0x00000010 | 16 | Изображение |
| 0x00000040 | 64 | GUID |
| 0x00000080 | 128 | Административные поля |
| 0x3FFFFFFFFFFFFFFF | 4611686018427387903 | Установить все флаги группы объектов |
Основные свойства
Флаг — 0x00000001 (1).
{
"nm":"<text>", /* название */
"cls":<uint>, /* ID суперкласса avl_unit_group, обычно 5 (см. ключ classes в ответе token/login) */
"id":<uint>, /* ID группы */
"mu":<uint>, /* система измерения: 0 — СИ, 1 — американская, 2 — имперская, 3 — метрическая с галлонами */
"u":[<long>], /* массив идентификаторов объектов, входящих в группу */
"uacl":<long> /* уровень доступа к группе у текущего пользователя (64-битное значение) */
}
Произвольные свойства
Флаг — 0x00000002 (2).
В произвольных свойствах вы можете сохранять любые нужные вам данные о группе объектов.
{
"prp":{}, /* произвольные свойства */
"ftp": { /* настройки FTP (используются только для учетных записей) */
"hs": <text>, /* хост (только если задан) */
"lg": <text>, /* логин (только если задан) */
"pt": <text>, /* путь к директории (только если задан) */
"ch": <uint>, /* валидность настроек FTP: 1 — да, 0 — нет */
"tp": <uint>, /* использовать FTP Wialon Hosting: 1 — да, 0 — нет */
"fl": <uint> /* доступность FTP Wialon Hosting: 1 — да, 0 — нет */
},
"ct": <uint> /* время создания (Unix-время) */
}
Информация о биллинге
Флаг — 0x00000004 (4).
{
"crt":<uint>, /* ID создателя */
"bact":<uint> /* ID учетной записи */
}
Произвольные поля
Флаг — 0x00000008 (8).
{
"flds":{
"<text>":{ /* ID произвольного поля */
"id":<uint>, /* ID произвольного поля */
"n":"<text>", /* имя произвольного поля */
"v":"<text>", /* значение произвольного поля */
"ct":<uint>, /* время создания (Unix-время) */
"mt":<uint> /* время последнего изменения (Unix-время) */
},
...
},
"fldsmax":<long> /* максимальное количество произвольных полей, разрешенное тарифным планом учетной записи (-1 — не ограничено). Может быть равно 0, если услуги нет в тарифном плане; существующие произвольные поля при этом все равно возвращаются */
}
Изображение группы объектов
Флаг — 0x00000010 (16).
{
"uri":"<text>", /* путь к изображению группы объектов на сервере. Чтобы получить изображение, добавьте его к адресу сервера Wialon */
"ugi":<uint> /* счетчик изменений изображения */
}
GUID
Флаг — 0x00000040 (64).
{
"gd":"<text>" /* GUID группы */
}
Административные поля
Флаг — 0x00000080 (128).
{
"aflds":{ /* административные поля */
"<text>":{ /* ID административного поля */
"id":<uint>, /* ID */
"n":"<text>", /* название */
"v":"<text>", /* значение */
"ct":<uint>, /* время создания (Unix-время) */
"mt":<uint> /* время последнего изменения (Unix-время) */
},
...
},
"afldsmax": <long> /* максимальное количество административных полей, разрешенное тарифным планом учетной записи (-1 — не ограничено). Может быть равно 0, если услуги нет в тарифном плане; существующие административные поля при этом все равно возвращаются */
}