Справочный центр Wialon

get_report_data

Для получения данных о шаблоне отчета используйте метод report/get_report_data.

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

Copied!
svc=report/get_report_data&params={
    "itemId": <long>,
    "col": [<long>],
    "flags": <uint>
}

Параметры

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

Название Описание
itemId ID ресурса.
col Массив ID шаблонов.
flags Флаги ответа.

Флаги ответа

Параметр flags определяет объем данных, возвращаемых в ответе:

Флаг (HEX) Флаг (DEC) Описание
0x0 0 Полный JSON (по умолчанию).
0x1 1 Основная информация и связанные объекты/группы.
0x2 2 Основная информация и краткая информация о таблицах.
0x4 4 Основная информация и полная информация о таблицах.

Ответ

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

Copied!
[
	{
		"id":<long>,		/* ID шаблона */
		"n":"<text>",			/* название */
		"ct":"<text>",		/* тип (см. ниже) */
		"c":"<text>",			/* data CRC16 */
		"p":"<text>",			/* параметры */
		"tbl":[				/* таблицы */
			{
				"n":"<text>",		/* системное название таблицы */
				"l":"<text>",		/* название таблицы, отображаемое в отчете */
				"c":"<text>",		/* список столбцов */
				"cl":"<text>",	/* список названий столбцов */
				"cp":"<text>", 	/* список параметров столбцов */
				"s":"<text>",		/* список столбцов (если это таблица статистики) */
				"sl":"<text>",	/* список названий столбцов (если это таблица статистики) */
				"filter_order":"<text>", 	/* порядок фильтров */
				"p":"<text>",		/* параметры таблицы */
				"sch":{			/* ограничение по времени */
					"f1":<uint>,	/* начало интервала 1 */
					"f2":<uint>,	/* начало интервала 2 */
					"t1":<uint>,	/* конец интервала 1 */
					"t2":<uint>,	/* конец интервала 2 */
					"m":<uint>,		/* маска дней месяца */
					"y":<uint>,		/* маска месяцев */
					"w":<uint>,		/* маска дней недели */
					"fl":<uint>		/* незавершенный интервал (0 — не обрезать, 1 — вывести и оборвать, 2 — не выводить в отчет, 3 — вывести и пометить как незавершенный) */

				},
				"f":<uint>			/* флаги таблицы */
			}
		]
	}
]

Флаги таблиц описаны на странице exec_report. Чтобы получить типы таблиц, которые можно включить в отчеты, используйте метод get_report_tables.

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

Типы шаблонов

Параметр ct может иметь следующие значения:

  • avl_unit
  • avl_unit_group
  • storage_user
  • avl_driver
  • avl_trailer
  • avl_resource
  • avl_retranslator
  • avl_route
  • avl_drivers_group
  • avl_trailers_group
  • avl_tag
  • avl_tags_group
  • avl_geozone
  • avl_geozones_group

Коды ошибок

Код ошибки Описание
7 Не удалось получить элемент отчета и ресурс отчета. Возможно, у пользователя нет права Просмотр шаблонов отчетов на этот ресурс.
4 Неверные входные параметры.

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