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

export_result

Метод report/export_result позволяет экспортировать результаты отчета в файл.

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

Copied!
svc=report/export_result&params={
  "format": <uint>,
  "pageOrientation": "<text>",
  "hideGoogleLinks": <uint>,
  "pageSize": "<text>",
  "pageWidth": <uint>,
  "coding": "<text>",
  "delimiter": "<text>",
  "headings": <uint>,
  "compress": <uint>,
  "attachMap": <uint>,
  "extendBounds": <uint>,
  "hideMapBasis": <uint>,
  "outputFileName": "<text>",
  "splitChart": "<text>",
  "appendTreeAnchorRows": <uint>
}

Метод относится к ресурсоемким запросам, поэтому на него распространяется ограничение на количество одновременно обрабатываемых ресурсоемких запросов в одной сессии. При превышении ограничения возвращается ошибка 1003 с причиной LIMIT api_concurrent. Список ресурсоемких запросов см. в разделе Ограничения.

Параметры

Параметр Описание
format Битовая маска формата файла (см. список ниже). Чтобы экспортировать несколько форматов одновременно, сложите их значения (например, 2 + 4 = 6 для PDF + XLS). В этом случае результат автоматически упаковывается в ZIP-архив.

Необязательные параметры:

Параметр Описание Значение по умолчанию
compress Сжатие файла отчета:
  • 0: нет;
  • 1: да. Автоматически устанавливается в 1, если при экспорте создается более одного файла.
 1
pageOrientation Ориентация страницы (PDF): portrait, landscap. portrait
pageSize Формат страницы (PDF): a4, a3, letter, legal. a4
pageWidth Ширина страницы (PDF):
  • 0: фиксированная;
  • 1: компактная;
  • 2: без переносов.
 0
coding Кодировка (CSV): utf8, cp1251. utf8
delimiter Разделитель (CSV). Возможные значения: semicolon (применяется ;), colon (применяется ,). Чтобы использовать запятую в качестве разделителя, укажите значение colon или оставьте поле пустым ("delimiter":""). colon
headings Отображение заголовков:
  • 0: нет;
  • 1: да.
 0
attachMap Прикрепить карту (только PDF и HTML):
  • 0: нет;
  • 1: да.
 0
extendBounds Расширить карту, чтобы включить геозоны:
  • 0: нет;
  • 1: да.
 0
hideMapBasis Скрыть слой карты:
  • 0: нет;
  • 1: да.
 0
outputFileName Имя файла. Online_report
hideGoogleLinks Скрыть ссылки Google в ячейках координат (PDF и XLSX):
  • 0: нет;
  • 1: да.
 0
splitChart Разбивать по дням (day) или неделям (week). <empty>
appendTreeAnchorRows Добавить опорные строки дерева с пустой строкой:
  • 0: нет;
  • 1: да.
 0

Согласно логике параметра extendBounds, по умолчанию масштаб карты подстраивается так, чтобы вместить треки, маркеры и иконки. Когда опция включена, карта также масштабируется под геозоны. Если нет графических элементов (ни треков, маркеров и иконок для ситуации по умолчанию, ни геозон для включенной опции extendBounds), карта не отображается.

Значения формата файла (битовая маска):

  • 1: HTML;
  • 2: PDF;
  • 4: XLS;
  • 8: XLSX;
  • 16: XML;
  • 32: CSV.

Ответ

Возвращает файл запрошенного формата.

Если запрос не выполнен, ответ содержит текст «Report has not been saved», за которым следует код ошибки, например:

Copied!
Report has not been saved{"error":5}

Коды ошибок

Код ошибки Описание
4 Неверные входные параметры: не указан параметр format или файл не создан (например, format не содержит ни одного из поддерживаемых значений или результат отчета не содержит данных).
5 В сессии нет результата отчета (запрос report/exec_report не выполнялся или его результат очищен) или произошла ошибка чтения/записи файла отчета.
6 Не удалось получить пользователя.

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