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 поста.
  •  guid поста; 
  • <channel-no>
- номер
  •  номер канала поста
. Возможные
  • (возможны значения в интервале [0; 2147483647]);
  • <plate>
-
  •  — текстовое выражение для поиска номера (в кодировке UTF8)
. Может представлять собой (в порядке убывания приоритета):
  1. Строку для точного совпадения (не содержит спец. символов regex)

    1. Строку для сравнения по расстоянию Левенштейна (при distance > 0)

  2. Маску - строка, в которой из спец. символов встречается только * (1 или более)

  3. Регулярное выражение - строка, в которой встречаются спец. символы regex.

<distance> - макс. расстояние Левенштейна. Мин. значение 0. По умолчанию 0.

<from-ts> - Начальное
  • ;
  • <distance>  макс. расстояние Левенштейна (мин. значение 0, по умолчанию  0);
  • <from-ts>  начальное время (мкс от 01.01.1970 00:00 UTC) поиска, или null

. Значение
  • ; значение null интерпретируется как время первого события в архиве на момент обработки запроса

. Мин
  • ; мин. значение 0

. По умолчанию null.
  • ; по умолчанию null;

  • <limit> — опциональный параметр; задает ограничение на количество событий в теле ответа;

  • <to-ts>

- Конечное
  •   конечное время (мкс от 01.01.1970 00:00 UTC) поиска, или null

. Значение
  • ; значение null интерпретируется как время последнего события в архиве на момент обработки запроса

. Мин
  • ; мин. значение 0

. По
  • ; по умолчанию null

.

<limit> - Опциональный параметр. Задает ограничение на количество событий в теле ответа.

<order> - Опциональный параметр. Задает
  • ;

  • <order> — опциональный параметр; задает порядок сортировки событий в теле ответа

.
  1. asc (по умолчанию). В порядке возрастания параметра Bestts события Fact (подраздел 2.6).

  2. desc. В порядке убывания параметра Bestts события Fact  (подраздел 2.6)

  • ;

  • <alarm-type-1>..<alarm-type-N>

- Опциональный
  •   опциональный набор параметров

. Задает
  • ; задает ограничение на разрешенные типы тревог в теле ответа

. Возможные (подраздел 2.1)
  • .

Значение параметра <plate> может представлять собой (в порядке убывания приоритета):

  1. строку для точного совпадения (не содержит спец. символов regex);

    1. строку для сравнения по расстоянию Левенштейна (при distance > 0);

  2. маску — строка, в которой из спец. символов встречается только * (1 или более);

  3. регулярное выражение — строка, в которой встречаются спец. символы regex.

Возможные значения параметра <order>:

  1. asc (по умолчанию). В порядке возрастания параметра Bestts события Fact;

  2. desc. В порядке убывания параметра Bestts события Fact.


Если структура url-запроса get-fact-search соответствует требованиям, сервер, после успешной обработки, возвращает ответ с http-кодом 200. Тело ответа содержит application/json-документ с параметрами:
  1. "status" <uint16_t>. Содержит 200.

  2. "result" <struct[]>. Массив. Каждый элемент содержит параметры одного события Fact (подраздел 2.6).