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

export_file

Чтобы экспортировать результаты поиска элементов в файл XLSX, используйте метод core/export_file.

Метод ищет элементы по критериям spec так же, как core/search_items. Если ранее в той же сессии был вызван core/search_items с теми же критериями, метод использует его результат, а не выполняет поиск заново, если только force не равен 1. В файл включаются все найденные элементы, а не только одна страница результатов.

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

Copied!
svc=core/export_file&params={
  "spec": {
    "itemsType": "<text>",
    "propName": "<text>",
    "propValueMask": "<text>",
    "sortType": "<text>"
  },
  "force": <uint>,
  "flags": <long>   /* Флаги столбцов. */
}

Параметры

Параметры spec и force описаны на странице core/search_items.

Параметр flags определяет, какие столбцы включить в файл. Доступные флаги зависят от значения itemsType.

Пользователи (user)

Значение Описание
0x0001 Имя.
0x0002 Создатель.
0x0004 Учетная запись.
0x0008 Тарифный план.
0x0010 Последний вход.
0x0020 Электронная почта.
0x0040 Маска хоста.
0x0080 Тип аутентификации.
0x0100 Телефонный номер для двухфакторной аутентификации.
0x0200 Статус: включена ли опция Включен в свойствах пользователя.
0x0400 Разрешение на изменение пароля.
0x0800 Разрешение на создание элементов.
0x1000 Разрешение на изменение настроек.
0x2000 Разрешение на отправку SMS.
0x4000 Часовой пояс.

Объекты (avl_unit)

Значение Описание
0x0001 Имя.
0x0002 Создатель.
0x0004 Учетная запись.
0x0008 Тип устройства.
0x0010 Уникальный ID.
0x0020 Телефон.
0x0040 Последнее сообщение.
0x0080 Создан.
0x0100 Произвольные поля.
0x0200 Группы.
0x0400 Деактивация.

Группы объектов (avl_unit_group)

Значение Описание
0x0001 Имя.
0x0002 Создатель.
0x0004 Учетная запись.
0x0008 Объекты.

Учетные записи (avl_resource)

Значение Описание
0x0001 Имя.
0x0002 Создатель.
0x0004 Родительская учетная запись.
0x0008 Тарифный план.
0x0010 Права дилера.
0x0020 Объекты.
0x0040 Баланс.
0x0080 Дни.
0x0100 Статус.
0x0200 Заблокирована.
0x0400 Активированные объекты.

Ретрансляторы (avl_retranslator)

Значение Описание
0x0001 Имя.
0x0002 Создатель.
0x0004 Учетная запись.
0x0008 Протокол.
0x0010 Сервер.
0x0020 Состояние.
0x0040 Объекты для ретрансляции.
0x0080 Уникальный ID объекта.

Ответ

В случае успешного выполнения запроса возвращается файл XLSX.

В случае неудачного выполнения запроса возвращается код ошибки.

Коды ошибок

Код ошибки Описание
4 Неверные входные параметры, не удалось получить текущего пользователя или поиск завершился ошибкой.
5 Не удалось создать файл.

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