Списки наблюдения

Отобразить списки наблюдений

Для того чтобы отобразить списки наблюдений, используйте следующий метод:

GET /watch-lists/

Запрос содержит следующие параметры QUERY-STRING PARAMETERS:

Название	Схема JSON	Описание
`limit`	integer	Количество возвращаемых результатов.
`ordering`	string	Допустимые значения: id, created_date, modified_date.

Для того чтобы найти ID списка наблюдения, укажите произвольное значение для limit и ordering.

CURL пример

curl -X GET "http://<findface-ip:port>/watch-lists/?limit=2&ordering=id" \
 -H "Accept: application/json" \
 -H "Content-Language: ru" \
 -H "Accept-Language: ru" \
 -H "Authorization: Token <token>" \

В случае успешного ответа (OK: 200) возвращается объект, содержащий массив results со следующими параметрами. Пример.

Совет

* – означает, что параметр является обязательным. 🆁 – только для чтения.

Название	Схема JSON	Описание
`id*`	integer 🆁	ID списка наблюдения.
`created_date*`	date-time 🆁	Дата создания объекта.
`modified_date*`	date-time 🆁	Дата изменения объекта.
`active`	boolean	`true`, если список наблюдения активен.
`name*`	string	Название списка наблюдения, до 256 знаков.
`comment`	string	Комментарий, до 2048 знаков.
`color`	string	Цвет метки объекта в шестнадцатеричном формате. Ограничения: Максимум 6 символов.
`notify`	boolean	`true` , если включены звуковые оповещения.
`acknowledge`	boolean	Требуется подтверждение событий, которые соответствуют списку наблюдения.
`permissions`	{<any-key>: string}	Разрешения.
`camera_groups`	[integer]	Группы камер, используемые в списке наблюдения.
`face_threshold`	number┃null	Порог схожести для распознавания лиц для текущего списка наблюдения (от 0 до 1).
`body_threshold`	number┃null	Порог схожести для распознавания силуэтов для текущего списка наблюдения (от 0 до 1).
`car_threshold`	number┃null	Порог схожести для распознавания автомобилей для текущего списка наблюдения (от 0 до 1).
`ignore_events`	boolean	События не будут создаваться, если установлено значение `True`.
`send_events_to_external_vms`	boolean	`true`, если события, соответствующие этому списку наблюдения, должны быть отправлены на внешнюю виртуальную машину.
`active_after`	date-time┃null	Информация о дате и времени.
`active_before`	date-time┃null	Информация о дате и времени.
`disable_schedule`	{…}	Сериализатор mixin, который вызывает ошибку проверки `ValidationError`, если представлены избыточные поля. Может использоваться во вложенных сериализаторах.
`recount_schedule_on*` 🆁	date-time	Информация о дате и времени.
`origin`	string	Максимум 256 символов.

Пример ответа

{
 "results": [
   {
     "id": -1,
     "created_date": "2023-01-16T13:44:36.407610Z",
     "modified_date": "2023-01-16T13:44:36.407750Z",
     "active": true,
     "name": "Unmatched",
     "comment": "Default list for unmatched events",
     "color": "ffffff",
     "notify": false,
     "acknowledge": false,
     "permissions": {
       "1": "edit",
       "2": "view",
       "3": "view"
     },
     "camera_groups": [],
     "face_threshold": null,
     "body_threshold": null,
     "car_threshold": null,
     "ignore_events": false,
     "send_events_to_external_vms": false,
     "active_after": null,
     "active_before": null,
     "disable_schedule": {},
     "recount_schedule_on": null,
     "origin": "ffsecurity"
   },
   {
     "id": 1,
     "created_date": "2023-01-16T13:44:36.394542Z",
     "modified_date": "2023-01-16T13:44:36.394577Z",
     "active": true,
     "name": "Default Watch List",
     "comment": "",
     "color": "123456",
     "notify": false,
     "acknowledge": false,
     "permissions": {
       "1": "edit",
       "2": "view",
       "3": "view"
     },
     "camera_groups": [],
     "face_threshold": null,
     "body_threshold": null,
     "car_threshold": null,
     "ignore_events": false,
     "send_events_to_external_vms": false,
     "active_after": null,
     "active_before": null,
     "disable_schedule": {},
     "recount_schedule_on": null,
     "origin": "ffsecurity"
   }
 ]
}

Создать новый список наблюдений

Чтобы добавить новый список наблюдений, используйте следующий метод:

POST /watch-lists/

Тело запроса является обязательным и содержит объект application/json со следующими параметрами списка наблюдения.

Название	Схема JSON	Описание
`active`	boolean	`true`, если список наблюдения активен.
`name*`	string	Название списка наблюдения, до 256 знаков.
`comment`	string	Комментарий, до 2048 знаков.
`color`	string	Цвет метки объекта в шестнадцатеричном формате. Ограничения: от 1 до 6 символов.
`notify`	boolean	`true` , если включены звуковые оповещения.
`acknowledge`	boolean	Требуется подтверждение событий, которые соответствуют списку наблюдения.
`permissions`	<any-key>: string	Ограничения: Минимум 1 символ.
`camera_groups`	[integer]	Группы камер, используемые в списке наблюдения.
`face_threshold`	number┃null	Порог схожести для распознавания лиц для текущего списка наблюдения (от 0 до 1).
`body_threshold`	number┃null	Порог схожести для распознавания силуэтов для текущего списка наблюдения (от 0 до 1).
`car_threshold`	number┃null	Порог схожести для распознавания автомобилей для текущего списка наблюдения (от 0 до 1).
`ignore_events`	boolean	События не будут создаваться, если установлено значение `True`.
`send_events_to_external_vms`	boolean	`true`, если события, соответствующие этому списку наблюдения, должны быть отправлены на внешнюю виртуальную машину.
`active_after`	date-time┃null	Информация о дате и времени.
`active_before`	date-time┃null	Информация о дате и времени.
`disable_schedule`	{…}	Сериализатор mixin, который вызывает ошибку проверки `ValidationError`, если представлены избыточные поля. Может использоваться во вложенных сериализаторах.
`origin`	string	Ограничения: от 1 до 256 символов.

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

Совет

Этот пример приведен только для ознакомления, подставьте свои значения в соответствующие поля. Вы можете заполнить только обязательные поля, а остальные будут по умолчанию.

{
 "active": false,
 "name": "A",
 "comment": "AAAAAA",
 "color": "A",
 "notify": false,
 "acknowledge": false,
 "permissions": {},
 "camera_groups": [
   0
 ],
 "face_threshold": 0,
 "body_threshold": 0,
 "car_threshold": 0,
 "ignore_events": false,
 "send_events_to_external_vms": false,
 "active_after": "1970-01-01T00:00:00.000Z",
 "active_before": "1970-01-01T00:00:00.000Z",
 "disable_schedule": {
   "monday": [
     [
       "A"
     ]
   ],
   "tuesday": [
     [
       "A"
     ]
   ],
   "wednesday": [
     [
       "A"
     ]
   ],
   "thursday": [
     [
       "A"
     ]
   ],
   "friday": [
     [
       "A"
     ]
   ],
   "saturday": [
     [
       "A"
     ]
   ],
   "sunday": [
     [
       "A"
     ]
   ]
 },
 "origin": "A"
}

Вы можете отправить в запросе следующие параметры:

{
 "active": true,
 "name": "Test_list",
 "comment": "AAAAAA",
 "color": "35a2ee"
}

CURL пример

curl -X POST "http://<findface-ip:port>/watch-lists/" \
 -H "Accept: application/json" \
 -H "Content-Language: ru" \
 -H "Accept-Language: ru" \
 -H "Authorization: Token <token>" \
 -H "Content-Type: application/json" \
 -d '{"active":true,"name":"Test_list","comment":"AAAAAA","color":"35a2ee"}' \

Если ответ успешен (Created: 201), то возвращается объект, который содержит следующие параметры. Пример.

Пример ответа

{
 "id": 2,
 "created_date": "2023-01-16T14:07:52.424520Z",
 "modified_date": "2023-01-16T14:07:52.424549Z",
 "active": true,
 "name": "Test_list",
 "comment": "AAAAAA",
 "color": "35a2ee",
 "notify": false,
 "acknowledge": false,
 "permissions": {
   "1": "edit"
 },
 "camera_groups": [],
 "face_threshold": 0,
 "body_threshold": 0,
 "car_threshold": 0,
 "ignore_events": false,
 "send_events_to_external_vms": false,
 "active_after": null,
 "active_before": null,
 "disable_schedule": {},
 "recount_schedule_on": null,
 "origin": "ffsecurity"
}

Используйте id списка наблюдения, чтобы отправить POST запрос для создания новой карточки.

Полезные API запросы

GET /watch-lists/
POST /watch-lists/
GET /watch-lists/{id}/
DELETE /watch-lists/{id}/
PATCH /watch-lists/{id}/
POST /watch-lists/{id}/purge/
GET /watch-lists/count/
POST /watch-lists/purge_all/