О событиях системы

Метод и параметры

Метод инициирует процесс генерации отчета о событиях системы. По завершении приходит пуш-уведомление типа generate_report с указанием ссылки на готовый отчет.

POST /api/admin/v1/reports?type=events

Параметры:

array cameras – Фильтрация по камерам. Массив id камер используется для фильтрации событий, которые относятся к группе system_camera_events.

array event_groups – Группы системных событий. Список возможных групп можно найти в VMS Admin/Настройки/Основные конфигурации администратора(../settings/static.md) в ключе report.settings.events.event_groups.

array event_types – Типы событий из группы. Список возможных событий для группы берется из запроса VMS Admin/События/Типы событий в группе (../events/event_types_by_group.md).

date from – дата начала.

date to – дата окончания.

string timezone – часовой пояс для отображения даты создания в отчете. Пример: Europe/Paris.

cURL

BASH

curl -k --request POST \
	--url 'https://your-domain/api/admin/v1/reports?type=events' \
	--header 'Content-Type: application/json' \
	--header 'Accept: application/json' \
	--data '{
    "cameras": [],
    "event_groups": [],
    "event_types": [],
    "from": "date",
    "to": "date",
    "timezone": "string"
}'

PHP

$data = array (
  'cameras' => 
  array (
  ),
  'event_groups' => 
  array (
  ),
  'event_types' => 
  array (
  ),
  'from' => 'date',
  'to' => 'date',
  'timezone' => 'string',
);
$context = stream_context_create([
	'ssl'=>['verify_peer' => false],
	'http' => [
		'method' => 'POST',
		'header' => "Content-Type: application/json\r
Accept: application/json",
		'content'=>json_encode($data)
	]
]);
$result = file_get_contents('https://your-domain/api/admin/v1/reports?type=events', false, $context);

Ответы на запрос

Детальный перечень кодов возможных ответов смотрите в разделе «Общее описание API».

Успешный ответ:

201 Created

JSON

{
    "id": 6438,
    "name": "report_1",
    "type": "intercoms",
    "from": "2023-05-24",
    "to": "2023-05-24",
    "url": "https://vms.local:8080/storage/",
    "created_at": "2023-03-09T13:15:35.000000Z"
}

Ответ с ошибкой:

401 Unauthorized

Токен авторизации не передан или невалидный.