multi_export
Метод exchange/multi_export позволяет экспортировать объекты и группы объектов в ZIP-архив, при необходимости вместе с их сообщениями. Чтобы создать объекты из такого архива, используйте метод exchange/multi_import.
Для использования метода в учетной записи должна быть включена услуга Импорт/Экспорт. Каждый ID, указанный в параметре ids, засчитывается как одно использование услуги.
В Wialon Local этот метод доступен начиная с версии 2304.
Конечная точка
svc=exchange/multi_export¶ms={
"ids": [<long>],
"props": <uint>,
"time_from": <uint>,
"time_to": <uint>
}
Метод относится к ресурсоемким запросам, поэтому на него распространяется ограничение на количество одновременно обрабатываемых ресурсоемких запросов в одной сессии. При превышении ограничения возвращается ошибка 1003 с причиной
LIMIT api_concurrent. Список ресурсоемких запросов см. в разделе Ограничения.
Параметры
Обязательные параметры отмечены звездочкой (*).
| Параметр | Описание |
|---|---|
ids* |
Массив ID объектов и групп объектов. Для группы объектов экспортируются все входящие в нее объекты. Каждый объект экспортируется один раз, даже если он указан несколько раз или входит в несколько групп. |
props |
Свойства объектов, которые нужно экспортировать. Значение представляет собой сумму флагов свойств. Значение по умолчанию: 0xFFFF (все свойства). |
time_from |
Начало интервала, за который экспортируются сообщения объектов (время UNIX). |
time_to |
Конец интервала, за который экспортируются сообщения объектов (время UNIX). |
Сообщения экспортируются, только если указаны оба параметра time_from и time_to. Если один из них не указан, экспортируются только свойства объектов.
Флаги свойств
В таблице ниже перечислены доступные флаги и права доступа к объекту, необходимые для экспорта соответствующих свойств.
| Флаг | Свойства | Необходимое право доступа |
|---|---|---|
0x1 |
Основные свойства. | Просмотр элемента и его основных свойств |
0x2 |
Датчики. | Просмотр элемента и его основных свойств |
0x4 |
Произвольные поля. | Просмотр произвольных полей |
0x8 |
Административные поля. | Просмотр административных полей |
0x10 |
Команды. | Просмотр команд |
0x20 |
Интервалы техобслуживания. | Просмотр интервалов техобслуживания |
0x40 |
Характеристики. | Просмотр произвольных полей |
0x80 |
Счетчики. | Просмотр элемента и его основных свойств |
0x100 |
Конфигурация устройства. | Редактирование настроек подключения |
0x200 |
Настройки отчетов. | Просмотр подробных свойств |
0x400 |
Дополнительные свойства. | Просмотр подробных свойств |
0x800 |
Настройки детектора поездок. | Просмотр подробных свойств |
0x1000 |
Настройки качества вождения. | Просмотр подробных свойств |
0x2000 |
Иконка объекта. Экспортируется только вместе с флагом 0x1, 0x2 или 0x80. |
Просмотр элемента и его основных свойств |
Настройки расхода топлива экспортируются всегда.
Если у вас нет права доступа, необходимого для флага, соответствующие свойства не экспортируются, а ошибка не возвращается. Если у вас нет прав доступа ни к одному из запрошенных свойств, объект не экспортируется. Для экспорта сообщений объекта необходимо право Экспорт сообщений.
Ответ
Если запрос выполнен успешно, возвращается архив multi_export.zip. Для каждого объекта архив содержит следующие файлы:
| Файл | Содержимое |
|---|---|
<имя объекта>_<ID объекта>.wlp |
Свойства объекта. |
<имя объекта>_<ID объекта>.wlb |
Сообщения объекта. Файл добавляется, только если указан интервал и у объекта есть сообщения за этот интервал. |
Символы / в имени объекта заменяются в именах файлов на _.
При неудачном выполнении возвращается код ошибки.
Коды ошибок
| Код ошибки | Описание |
|---|---|
| 4 | Неверные входные параметры. |
| 6 | Ни один объект не экспортирован. Например, указанные ID не принадлежат объектам или группам объектов, у пользователя нет прав доступа к объектам или услуга Импорт/Экспорт недоступна для учетной записи. |
| 1003 | Достигнуто ограничение на количество одновременно обрабатываемых ресурсоемких запросов (причина LIMIT api_concurrent). |