Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Структура url-запроса get-fact-search определяется форматом (2.10.1).:
Code Block |
---|
GET /api/v1/post/<post-guid>/channel/<channel-no>/\ |
factattrget/?plate=<plate>&distance=<distance>\ |
&fromts=<from-ts>&tots=<to-ts>\ |
&limit=<limit>&order=<order>\ |
&alarmtype=<alarm-type-1>&..&alarmtype=<alarm-type-N> |
(2.10.1)
где где
- <post-guid>
- — guid поста;
- <channel-no>
- — номер канала поста
- (возможны значения в интервале [0; 2147483647]);
- <plate>
- — текстовое выражение для поиска номера (в кодировке UTF8)
Строку для точного совпадения (не содержит спец. символов regex)
Строку для сравнения по расстоянию Левенштейна (при distance > 0)
Маску - строка, в которой из спец. символов встречается только * (1 или более)
Регулярное выражение - строка, в которой встречаются спец. символы regex.
<distance> - макс. расстояние Левенштейна. Мин. значение 0. По умолчанию 0.
<from-ts> - Начальное- ;
- <distance> — макс. расстояние Левенштейна (мин. значение 0, по умолчанию — 0);
<from-ts> — начальное время (мкс от 01.01.1970 00:00 UTC) поиска, или null
; значение null интерпретируется как время первого события в архиве на момент обработки запроса
; мин. значение 0
; по умолчанию null;
<limit> — опциональный параметр; задает ограничение на количество событий в теле ответа;
<to-ts>
— конечное время (мкс от 01.01.1970 00:00 UTC) поиска, или null
; значение null интерпретируется как время последнего события в архиве на момент обработки запроса
; мин. значение 0
; по умолчанию null
<limit> - Опциональный параметр. Задает ограничение на количество событий в теле ответа.
<order> - Опциональный параметр. Задает;
<order> — опциональный параметр; задает порядок сортировки событий в теле ответа
asc (по умолчанию). В порядке возрастания параметра Bestts события Fact (подраздел 2.6).
desc. В порядке убывания параметра Bestts события Fact (подраздел 2.6)
;
<alarm-type-1>..<alarm-type-N>
— опциональный набор параметров
; задает ограничение на разрешенные типы тревог в теле ответа
; возможные значения определяются запросом AlarmSet
.
Значение параметра <plate> может представлять собой (в порядке убывания приоритета):
строку для точного совпадения (не содержит спец. символов regex);
строку для сравнения по расстоянию Левенштейна (при distance > 0);
маску — строка, в которой из спец. символов встречается только * (1 или более);
регулярное выражение — строка, в которой встречаются спец. символы regex.
Возможные значения параметра <order>:
asc (по умолчанию). В порядке возрастания параметра Bestts события Fact;
desc. В порядке убывания параметра Bestts события Fact.
"status" <uint16_t>. Содержит 200.
"result" <struct[]>. Массив. Каждый элемент содержит параметры одного события Fact (подраздел 2.6).