Параметры JSON
Параметры запроса задаются в формате JSON и содержат следующие ключи:
Общие параметры
|
Ключ
|
Описание
|
Тип данных
|
Возможные значения
|
Обязательный
|
Особенности
|
|
tag
|
Тег сигнала на сервере.
|
string
|
|
Нет
|
Если указан в корне, применяется ко всем колонкам. Иначе задается в колонках.
|
|
mode
|
Режим запроса.
|
string
|
historical
operative
|
Да
|
Определяет тип данных: исторические или оперативные
|
|
show_metrics
|
Включение метрик выполнения.
|
bool
|
true
false
|
Нет
|
Если true, возвращаются метрики (число строк, время выполнения).
|
|
columns
|
Список колонок для вывода данных.
|
array
|
Массив объектов с описанием
|
Да
|
Определяет структуру выходных данных.
|
Параметры для режима historical
|
Ключ
|
Описание
|
Тип данных
|
Обязательный
|
Особенности
|
|
historical_range_start
|
Начало исторического интервала.
|
object
|
Да
|
Задает начальную временную границу.
|
|
historical_range_end
|
Окончание исторического интервала.
|
object
|
Да
|
Задает конечную временную границу.
|
Объект описания границы интервала (historical_range_start, historical_range_end)
|
Ключ
|
Описание
|
Тип данных
|
Возможные значения
|
Обязательный
|
Особенности
|
|
timestamp
|
Метка времени границы.
|
uint8
|
|
Да
|
|
|
include_bound
|
Включение границы.
|
bool
|
true
false
|
Нет
|
По умолчанию true.
|
Параметры для режима operative
|
Ключ
|
Описание
|
Тип данных
|
Возможные значения
|
Обязательный
|
Особенности
|
|
operative_
interval
|
Интервал обновления
(в секундах)
|
uint4
|
|
Да
|
Определяет частоту обновления данных.
|
|
preload_
historical_
data
|
Подгрузка исторических данных.
|
bool
|
true
false
|
Нет
|
По умолчанию false. Если true, подгружаются исторические данные.
|
Описание колонок (columns)
|
Ключ
|
Описание
|
Тип данных
|
Обязательный
|
Особенности
|
|
id
|
Идентификатор колонки.
|
string
|
Да
|
Уникальный ID в наборе данных.
|
|
type
|
Тип данных колонки.
|
string
|
Да
|
Поддерживается только attribute.
|
|
parameters
|
Параметры колонки.
|
object
|
Да
|
Зависят от типа колонки.
|
Параметры для типа attribute
|
Ключ
|
Описание
|
Тип данных
|
Обязательный
|
Особенности
|
|
id
|
Идентификатор атрибута.
|
string
|
Да
|
Определяет тип возвращаемых данных.
|
|
tag
|
Тег сигнала.
|
string
|
Нет
|
Если не указан, берется из корня JSON.
|
Возможные идентификаторы атрибутов
|
Ключ
|
Описание
|
Тип данных
|
|
value
|
Значение сигнала.
|
variant
|
|
quality
|
Качество сигнала.
|
uint4
|
|
timestamp
|
Метка времени клиента.
|
uint8
|
|
server_timestamp
|
Метка времени сервера.
|
uint8
|
|
source_kind
|
Код источника значения.
1: значение загружено из истории.
2: значение получено из оперативных данных.
|
uint4
|
|
custom_info
|
Пользовательское поле.
|
uint8
|
Метрики выполнения запроса
|
Ключ
|
Описание
|
Тип данных
|
|
metrics
|
Метрики выполнения запроса.
|
object
|
|
Содержимое метрик
| ||
|
row_count
|
Количество строк в результате.
|
uint8
|
|
exec_elapsed_ms
|
Время выполнения (в миллисекундах).
|
uint8
|