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

get_report_tables

Для получения списка таблиц, которые можно включить в отчеты, используйте метод report/get_report_tables.

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

Copied!
svc=report/get_report_tables&params={}

Параметры

Запрос не требует параметров.

Возвращаемый результат

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

Copied!
[
	{
		"id":<uint>,		/* ID таблицы */
		"n":"<text>",			/* системное название таблицы */
		"l":"<text>",			/* название таблицы по умолчанию */
		"t":"<text>",			/* тип таблицы */
		"ct":"<text>",		/* тип шаблона, в котором может использоваться эта таблица */
		"pt":"<text>",		/* текстовые параметры */
		"gt":"<text>",		/* дополнительные настройки группировки */
		"col":[				/* массив столбцов */
			{
				"n":"<text>",		/* системное название столбца */
				"l":"<text>",		/* название столбца по умолчанию */
				"sl":"<text>",	/* список названий столбцов (если это таблица статистики) */
				"t":"<text>",		/* тип столбца */
				"f":<uint>		/* флаги столбца (см. ниже) */
				"calc_type":<uint>		/* значение группировки (если задано) */
				"available_calc_types":<uint>		/* значения группировки, доступные для столбца (если применимо) */
			}
		]
	}
]

Типы шаблонов отчетов описаны в разделе Типы шаблонов. Флаги таблиц описаны на странице exec_report.

Названия и типы таблиц

Каждая таблица регистрируется отдельно для каждого типа шаблона, поэтому ее значение n уникально. Одна и та же таблица в разных типах шаблонов имеет разные названия. Например, таблица Поездки — это unit_trips в шаблоне типа avl_unit и unit_group_trips в шаблоне типа avl_unit_group. Значение n используется для указания таблиц в запросе report/update_report.

Таблицы с одинаковым значением t рассчитываются одинаково. Чтобы найти аналог таблицы в другом типе шаблона, найдите таблицу с таким же значением t и нужным значением ct.

Не все таблицы доступны для каждого типа шаблона. Например, таблицы График (обычный), Движение топлива, Изображения, Трассировка сообщений и Видео доступны для шаблонов типа avl_unit, но не имеют аналогов для avl_unit_group.

Содержимое таблицы unit_location (Последние данные) зависит от типа шаблона. Таблица существует как для avl_unit, так и для avl_unit_group, но в шаблоне типа avl_unit все ее столбцы являются столбцами статистики с флагом 0x02. В этом случае таблица не содержит строк, а только добавляет блок в статистику отчета. В качестве обычной таблицы Последние данные доступна только для шаблонов типа avl_unit_group.

Возвращаемый список также зависит от учетной записи. Таблицы фильтруются по услугам, доступным текущему пользователю, поэтому разные пользователи могут получать разные списки таблиц.

Флаги столбцов

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

Флаг (HEX) Флаг (DEC) Описание
0x01 1 Показывать как столбец таблицы.
0x02 2 Показывать как столбец статистики.
0x04 4 Показывать как глобальный переключатель.
0x08 8 Показывать как столбец с позиционными данными.
0x10 16 Показывать как ось графика.
0x20 32 Скрывать столбец в таблице отчета. Используется вместе с 0x10 для столбцов датчиков на графиках.
0x40 64 Показывать как произвольный график.
0x100 256 Показывать как маркер на графике.
0x200 512 Показывать как фоновую область на графике.

Значение f представляет собой битовую маску, поэтому у столбца может быть несколько флагов одновременно. Например, 0x01 + 0x02 = 0x03 означает, что столбец показывается и как столбец таблицы, и как столбец статистики.

Столбцы с флагами 0x100 и 0x200 относятся к таблицам, которые предоставляют данные для графика (например, unit_events или unit_stays), а не к самой таблице графика. Они определяют, что отображается на графике. Подробнее см. в разделах Маркеры и Фон.

Значения параметра «pt»

В параметре pt перечисляются текстовые параметры и опции, доступные для таблицы. Он может иметь следующие значения:

Значение Описание
geozones Геозоны/Объекты.
unfinished_ival Незавершенный интервал.
duration Длительность.
mileage Пробег.
base_eh_sensor Датчик моточасов.
engine_hours Моточасы.
speed Скорость.
trips Поездки.
stops Остановки.
parkings Стоянки.
sensors Датчики.
sensor_name Маска датчиков.
driver Водитель.
trailer Прицеп.
fillings Заправки.
thefts Сливы.
duration_format Формат длительности.
geozones_ex Расширенные геозоны/объекты.
username Маска пользователя.
route_points Точки маршрута.
event_mask Маска событий.
rides Рейсы. Применяется для таблиц Объект и Рейсы.
fields_config Тип поля. Применяется для таблиц Произвольные поля.
units Объекты. Применяется для таблицы Маневры.
interval Интервал трассировки в минутах. Применяется для таблицы ОбъектТрассировка датчика.
group_zones_pass Доступна опция Рассматривать группу как целое. Применяется для таблицы Группа объектовПропущенные геозоны.
routes Применяется для таблиц типа Маршруты.
last_location Доступна опция Учитывать интервал отчета. Применяется для таблицы Последние данные.
hide_total Флажок Итого скрыт для этой таблицы.
groupitem Доступна опция Сама группа. Применяется для таблиц Группа объектовЖурнал и Произвольные поля.
noschedule Опция Ограничение по времени недоступна. Применяется для таблиц Сводка и Последние данные.
hide_driver_split Флажок Извлечь интервалы скрыт в фильтре водителей.
account_tree Иерархия учетной записи.
custom_fields_mask Маска произвольных полей.
drv_activity Активность водителя.
movement_chronology Хронология движения.
sensor_val Значение датчика.
timeout_sensor Таймаут датчика.
custom_sensor_name Имя произвольного датчика.
filter_notifications Сохранять только сообщения с текстом уведомления.

Коды ошибок

Код ошибки Описание
6 Неопределенная ошибка.

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