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

select_result_rows

Метод report/select_result_rows позволяет получить строки многоуровневых отчетов.

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

Copied!
svc=report/select_result_rows&params={
  "tableIndex": <int>,
  "config": {
    "type": "<text>",
    "data": {}
  }
}

Параметры

Параметр Описание
tableIndex Индекс таблицы. Чтобы получить строки таблицы статистики, укажите -1.
config Конфигурация.
type Тип запроса:
  • range: упорядоченная последовательность строк;
  • row: строка.
data Данные для конфигурации.

Если параметр type равен range, параметр data имеет следующий формат:

Copied!
"data": {
  "from": <uint>,
  "to": <uint>,
  "level": <uint>,
  "flat": <uint>,
  "rawValues": <uint>,
  "unitInfo": <uint>
}
Опция Описание
from Индекс первой строки.
to Индекс последней строки.
level Уровень вложенности.
flat Показывать вложенный уровень на одном уровне с родительской строкой:
  • 0: нет;
  • 1: да.

Необязательный параметр. Значение по умолчанию: 0.
rawValues Показывать в ячейках параметры v и vt и объект pi:
  • 0: нет;
  • 1: да.

Необязательный параметр. Значение по умолчанию: 0.

Объект pi содержит тип и ID элементов системы, связанных со значением ячейки, например геозоны или водителя. Подробнее см. в разделе Элементы, связанные со значениями ячеек.
unitInfo Показывать параметр uid:
  • 0: нет;
  • 1: да.

Необязательный параметр. Значение по умолчанию: 0.

Если параметр type равен row, параметр data имеет следующий формат:

Copied!
"data": {
  "rows": [<int>],
  "level": <uint>,
  "flat": <int>,
  "rawValues": <uint>,
  "unitInfo": <uint>,
  "from": <int>,
  "to": <int>
}
Опция Описание
rows Индекс строки. Можно указать индекс вложенной строки до предпоследнего уровня вложенности.
level Уровень вложенности.
flat Показывать вложенный уровень на одном уровне с родительской строкой:
  • 0: нет;
  • 1: да.

Необязательный параметр. Значение по умолчанию: 0.
from Индекс первой вложенной строки (необязательный параметр).
to Индекс последней вложенной строки (необязательный параметр).
rawValues Показывать в ячейках параметры v и vt и объект pi:
  • 0: нет;
  • 1: да.

Необязательный параметр. Значение по умолчанию: 0.

Объект pi содержит тип и ID элементов системы, связанных со значением ячейки, например геозоны или водителя. Подробнее см. в разделе Элементы, связанные со значениями ячеек.
unitInfo Показывать параметр uid:
  • 0: нет;
  • 1: да.

Необязательный параметр. Значение по умолчанию: 0.

Ответ

Copied!
[
  {
    "n": <uint>,                   /* индекс строки (от 0) */
    "i1": <uint>,                  /* номер первого сообщения в указанном интервале */
    "i2": <uint>,                  /* номер последнего сообщения в указанном интервале */
    "t1": <uint>,                  /* время первого сообщения в указанном интервале */
    "t2": <uint>,                  /* время последнего сообщения в указанном интервале */
    "d": <int>,                    /* количество строк следующего уровня вложенности */
    "uid": <long>,                 /* ID объекта; только если unitInfo равен 1 */
    "mrk": <long>,                 /* отметка ложного события: 1, если строка содержит событие, отмеченное как ложное, иначе 0 */
    "c": [                         /* массив ячеек */
      {                            /* общий тип ячейки */
        "t": "<text>",             /* форматированное значение ячейки */
        "v": <double>,             /* исходное значение ячейки */
        "vt": <double>,            /* тип значения */
        "pi": {                    /* элементы, связанные со значением ячейки; только если rawValues равен 1 */
          "t": "<text>",           /* тип элемента */
          "ids": [<long>]          /* массив ID элементов */
        },
        "y": <double>,             /* широта */
        "x": <double>,             /* долгота */
        "u": <long>,               /* ID объекта, которому принадлежат координаты; только для ячеек с координатами */
        "c": "<text>"              /* цвет ячейки (только если у ячейки есть цвет) в формате "RRGGBB" */
      },
      {                            /* тип ячейки: видео или изображение */
        "t": "<text>",             /* текст значения ячейки */
        "j": <JSON>,               /* значение ячейки в формате JSON */
        "v": <double>,             /* значение ячейки */
        "vt": <int>                /* тип значения ячейки */
      }
    ],
    "r": [                         /* содержит подстроки, которые соответствуют запрошенному уровню вложенности */
      {                            /* набор полей строки такой же, как у родительской строки */
        "n": <uint>,
        "i1": <uint>,
        "i2": <uint>,
        ...
      }
    ]
  }
]

Описание типов значений см. в разделе Типы значений.

Параметр mrk равен 1 для строк с заправками или сливами топлива, отмеченными как ложные. Чтобы отметить заправку или слив топлива как ложное событие, используйте метод unit/update_events.

Объект pi возвращается для ячеек, значение которых связано с элементами системы, например с геозоной, водителем или прицепом. Параметр t этого объекта содержит тип элемента:

Значение Тип элемента
zone Геозона.
driver Водитель.
traler Прицеп.
sensor Датчик.
service_interval Интервал техобслуживания.

Если в шаблоне отчета активирована опция Геозоны в качестве адресов и адрес заменен именем геозоны, в ячейке адреса возвращается объект pi с типом zone и ID геозоны. Таким образом можно получить ID геозон без дополнительных запросов.

Коды ошибок

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

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