Справочный центр Wialon
Wialon для разработчиков Руководство пользователя Документация API core update_data_flags

update_data_flags

Чтобы добавить элементы в сессию или удалить их из неё, используйте метод core/update_data_flags. Добавление элементов в сессию необходимо для того, чтобы получать события от них.

Конечная точка

Copied!
svc=core/update_data_flags&params={
  "spec": [
    {
      "type": "<text>",
      "data": <long|text|[long]>,
      "flags": <long>,
      "mode": <uint>,
      "max_items": <uint>
    }
  ]
}

Параметры

Запрос должен содержать следующие параметры:

Параметр Описание
spec Массив объектов. Каждый объект описывает, какие элементы и как изменить в сессии.
type Способ передачи элементов в сессию:
  • id: по ID. Укажите ID элемента в параметре data.
  • type: по типу. Укажите тип элементов в параметре data (см. core/search_items).
  • col: по списку ID. Укажите массив ID элементов в параметре data.
  • access: подписка на события о создании и удалении элементов, получении и лишении прав доступа к ним. В параметре data укажите 1, чтобы включить, или 0, чтобы выключить.
data Данные. Зависят от параметра type.
flags Флаги, определяющие, какая информация об элементах добавляется в сессию. Флаги элементов каждого типа описаны в разделе Формат данных.
mode Режим применения флагов:
  • 0: переопределить флаги для указанных элементов.
  • 1: добавить указанные флаги к уже имеющимся в сессии.
  • 2: удалить указанные флаги из сессии. При удалении базового флага элемент удаляется из сессии.
Флаги определяют, за изменениями каких свойств элемента следить. Укажите нужные флаги; чтобы получать все события, укажите все флаги. Получить события можно с помощью метода avl_evts.
max_items Максимальное количество подписанных элементов. Доступен, только если type равен type.

Ответ

Если запрос выполнен успешно, ответ возвращается в следующем формате:

Copied!
[             /* Массив элементов. */
  {
    "i": <long>,  /* ID. */
    "d": {        /* Другие поля. */
      ...
    },
    "f": <long>   /* Применённые флаги. */
  },
  ...
]

Формат поля d зависит от типа возвращаемого элемента. Поле d равно null, если запрос не добавляет новых флагов (например, в режиме 2); элементы, флаги которых не меняются, не включаются в результат. Форматы всех типов элементов описаны в разделе Формат данных.

Если в сессии установлено ограничение на количество параметров сообщений, запрос возвращает параметры объекта каждый раз, когда вы добавляете флаг параметров сообщений в режиме 1. Подробнее см. в разделе Ограниченный список параметров.

Если запрос не выполнен, возвращается код ошибки.

Коды ошибок

Код ошибки Описание
1 Невалидная сессия.
4 Неверные входные параметры или ошибка при обновлении флагов.

Если вы заметили ошибку в тексте, пожалуйста, выделите её и нажмите Ctrl+Enter.