/archive_events : Данные о событиях в архиве🔗

POST /archive_events : Получение событий из архива🔗

Для получения списка событий из архива используется POST-запрос к ресурсу /archive_events.

Доступно во всех типах лицензий.

Предупреждение

Доступно в Macroscop версии 4.0 и выше.

Предупреждение

При выполнении этого запроса требуется авторизация.

Параметры запроса🔗

Параметр	Описание
shortevent	Формат ответа. Доступные значения: true — ответ будет содержать сокращённый набор атрибутов. false — ответ будет содержать полный набор атрибутов. Если этот параметр не указан, будет использовано значение по умолчанию — false.

Параметр

Описание

shortevent

Формат ответа. Доступные значения: true — ответ будет содержать сокращённый набор атрибутов. false — ответ будет содержать полный набор атрибутов. Если этот параметр не указан, будет использовано значение по умолчанию — false.

В теле запроса передаётся JSON-объект со следующими параметрами:

Параметр	Тип	Описание	Значение по умолчанию
startTimeUtc	string	Дата/время начала интервала поиска, UTC, в формате dd.MM.yyyy HH:mm:ss.fff	Наиболее ранний доступный момент
endTimeUtc	string	Дата/время конца интервала поиска, UTC	Момент получения запроса
eventCategories	[number]	Список категорий события. Доступны следующие значения: 0 — Информация; 1 — Тревога; 2 — Ошибка.	Выбраны все категории: [0, 1, 2]
eventInitiatorTypes	[number]	Список типов инициаторов событий. Доступны следующие значения: 0 — Система; 1 — Пользователь; 2 — Сценарий; 3 — Пользовательский сценарий; 4 — Задача по расписанию; 8 — Внешний модуль.	Выбраны все типы инициаторов событий: [0, 1, 2, 3, 4, 8]
eventInitiators	[string]	Список идентификаторов пользователей, инициировавших событие	[Все пользователи системы]
eventIds	[string]	Список идентификаторов типов событий	[Идентификаторы всех типов событий]
channelIds	[string]	Список идентификаторов камер (для получения событий, не привязанных к камере, нужно указать пустой Guid: 00000000-0000-0000-0000-000000000000)	[Идентификаторы всех камер, пустой Guid]
isSearchFromBegin	boolean	Искать события событий в архиве с начала временного интервала	false
searchLimitCount	number	Ограничение количества возвращаемых записей	5000

Если какие-либо из параметров не указаны, будет использовано значение этого параметра по умолчанию. Если в теле запроса не будет указан объект JSON, то будут использованы значения всех параметров по умолчанию.

При отправке в теле запроса некорректных значений следующих параметров будет возвращён ответ с кодом ошибки 400 (BadRequest):

StartTimeUtc
EndTimeUtc
IsSearchFromBegin
SearchLimitCount

Предупреждение

Параметры IsSearchFromBegin и SearchLimitCount работают совместно. SearchLimitCount возвращает заданное количество записей (событий), а IsSearchFromBegin определяет, откуда именно начнётся выборка этого количества событий — с начала или с конца временного промежутка архива. Если общее число событий меньше значения SearchLimitCount, параметр IsSearchFromBegin не повлияет на структуру и состав ответа.

Пример запроса🔗

POST http://localhost:8080/archive_events?login=root&password=

Пример тела запроса:

{
    "startTimeUtc": "17.04.2023 09:54:31.775",
    "endTimeUtc": "17.04.2023 10:54:31.775",
    "cameraIds": ["00000000-0000-0000-0000-000000000000"],
    "eventCategories": [0,1,2],
    "eventInitiatorTypes":[0,2,8,4,1,3],
    "eventInitiators":["2aa0118f-8849-499c-b0df-6b071d95ee66"],
    "isSearchFromBegin":false,
    "searchLimitCount":200
}

В ответ сервер вернёт информацию о событиях в формате JSON. Этот ответ будет содержать следующие параметры событий:

Параметр	Тип	Описание
ChannelId	Guid	Идентификатор камеры
ChannelName	string	Название камеры
EventId	Guid	Идентификатор типа события
EventCategory	number	Категория события: 0 — Информация; 1 — Тревога; 2 — Ошибка.
EventComment	string	Комментарий события
EventDescription	string	Описание события
EventInitiatorType	number	Тип инициатора события: 1 — Пользователь; 2 — Сценарий; 3 — Пользовательский сценарий; 4 — Задача по расписанию; 8 — Внешний модуль.
Timestamp	string	Время события, UTC
Event	object	Вложенный объект с информацией о событии (для Unified-событий — null, для модулей видеоаналитики — см. ниже)
IsLongTermEvent	boolean	Индикатор хранения события в сервисе Длительное хранение событий (добавлено в версии 4.3)

Примеры событий в ответах🔗

Событие без дополнительной информации🔗

{
    "ChannelId": "00000000-0000-0000-0000-000000000000",
    "ChannelName": "",
    "Event": null,
    "EventCategory": 0,
    "EventComment": "Скорость записи на диск: 1,59 МБайт/с.Подсистема работы с архивом.",
    "EventDescription": null,
    "EventId": "00000000-0000-0000-0000-000000000010",
    "EventInitiatorType": 0,
    "EventInitiatorId": "00000000-0000-0000-0000-000000000000"
    "Timestamp": "2022-10-03T08:45:20.9497012Z",
    "IsLongTermEvent": false
}

Событие с дополнительной информацией🔗

{
    "ChannelId": "effbcd69-9f89-4301-87bf-2663bff0a44d",
    "ChannelName",: "Камера 9",
        "Event": {
        "AdditionalInfo": "Елена. Маркетинг",
        "Age": 24,
        "Emotion": 2,
        "EventName": "FaceDetectedNotifyEvent",
        "EventTime": "2022-10-03T08:23:40.8019552Z",
        "FaceId": "fe705eb2-4f76-47eb-92eb-178c0ccf7077",
        "FaceImageBase64": "base64 jpeg image",
        "FirstName": "Лена",
        "Gender": 1,
        "Groups": ["Доверенная", "Перехват"],
        "IsIdentified": true,
        "LastName": "Иванова",
        "Patronymic": "Сергеевна",
        "Height": 0.152734375,
        "Left": 0.56064453125,
        "Top": 0.3083984375,
        "Width": 0.11455078125,
        "Similarity": 0.9900000095367432,
    },
    "EventCategory": 1,
    "EventComment": "Иванова Лена Сергеевна",
    "EventDescription": "Обнаружено лицо (Модуль распознавания лиц)",
    "EventId": "427f1cc3-2c2f-4f50-8865-56ae99c3610d",
    "EventInitiatorType": 0,
    "EventInitiatorId": "00000000-0000-0000-0000-000000000000",
    "Timestamp": "2022-10-03T08:23:40.8019552Z",
    "IsLongTermEvent": false
}

Параметры события из ответа на запрос с параметром shortevent=true🔗

{
    "EventCategory": 1,
    "EventId": "427f1cc3-2c2f-4f50-8865-56ae99c3610d",
    "Timestamp": "2022-10-03T08:23:40.8019552Z"
}