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

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

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

GET /watch-lists/

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

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

Полный список доступных параметров находится по ссылке: http://<findface-ip:port>/api-docs.

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

CURL пример

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

В случае успешного ответа (OK: 200) возвращается JSON-объект со следующими параметрами:

Название	Тип	Описание
`next_page`	string┃null	Следующая страница.
`prev_page`	string┃null	Предыдущая страница.
`results`	[{…}]	Массив, содержащий следующие параметры. Пример.

Примечание

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

Название	Тип	Описание
`id*`	integer 🆁	ID списка наблюдения.
`created_date*`	date-time 🆁	Дата и время создания списка наблюдения.
`modified_date*`	date-time 🆁	Дата и время последнего изменения списка наблюдения.
`active`	boolean	`true`, если список наблюдения активен.
`name*`	string	Название списка наблюдения. Ограничения: минимальное количество символов — 1, максимальное количество символов — 256.
`comment`	string	Комментарий. Ограничения: минимальное количество символов — 0, максимальное количество символов — 2048.
`color`	string	Цвет метки списка наблюдения в шестнадцатеричном формате. Ограничения: минимальное количество символов — 0, максимальное количество символов — 6.
`notify`	boolean	`true`, если для списка наблюдения включены звуковые оповещения.
`acknowledge`	boolean	`true`, если события, соответствующие этому списку наблюдения, должны быть подтверждены оператором.
`camera_groups`	array of integers	Массив из ID групп камер, связанных со списком наблюдения.
`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`, если события, соответствующие этому списку наблюдения, должны отправляться на внешнюю виртуальную машину.
`origin`	string	Название прикладного модуля, в котором был создан список наблюдения. Ограничения: минимальное количество символов — 0, максимальное количество символов — 256.
`collect_location`	boolean	`true`, если карточки из этого списка наблюдения включены в задачу ежедневного поиска. Используется только в FindFace CIBR, когда экземпляр FindFace CIBR настроен в качестве сервера-кукловода.

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

{
 "next_page": null,
 "prev_page": null,
 "results": [
   {
     "id": 3,
     "created_date": "2025-05-13T12:10:28.303303Z",
     "modified_date": "2025-05-13T12:10:28.303325Z",
     "active": true,
     "name": "Parking watch list",
     "comment": "",
     "color": "cccccc",
     "notify": false,
     "acknowledge": false,
     "camera_groups": [],
     "face_threshold": null,
     "body_threshold": null,
     "car_threshold": null,
     "ignore_events": false,
     "send_events_to_external_vms": false,
     "origin": "ffsecurity",
     "collect_location": false
   },
   {
     "id": 2,
     "created_date": "2025-05-13T11:37:43.593898Z",
     "modified_date": "2025-07-01T15:42:33.537511Z",
     "active": true,
     "name": "Shopping mall watch list",
     "comment": "",
     "color": "cccccc",
     "notify": false,
     "acknowledge": true,
     "camera_groups": [
       2,
       3
     ],
     "face_threshold": 0.702,
     "body_threshold": 0.65,
     "car_threshold": 0.65,
     "ignore_events": true,
     "send_events_to_external_vms": false,
     "origin": "ffsecurity",
     "collect_location": false
   }
 ]
}

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

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

POST /watch-lists/

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

Название	Тип	Описание
`active`	boolean	Если `true`, список наблюдения будет активен.
`name*`	string	Название списка наблюдения. Ограничения: минимальное количество символов — 1, максимальное количество символов — 256.
`comment`	string	Комментарий. Ограничения: минимальное количество символов — 0, максимальное количество символов — 2048.
`color`	string	Цвет метки списка наблюдения в шестнадцатеричном формате. Ограничения: минимальное количество символов — 0, максимальное количество символов — 6.
`notify`	boolean	Если `true`, для списка наблюдения будут включены звуковые оповещения.
`acknowledge`	boolean	Если `true`, события, соответствующие этому списку наблюдения, должны быть подтверждены оператором.
`camera_groups`	array of integers	Массив из ID групп камер, связанных со списком наблюдения.
`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`, события, соответствующие этому списку наблюдения, будут отправлены на внешнюю виртуальную машину.
`origin`	string	Название прикладного модуля, в котором будет создан список наблюдения. Ограничения: минимальное количество символов — 0, максимальное количество символов — 256.
`collect_location`	boolean	Если `true`, карточки из этого списка наблюдения могут быть включены в задачу ежедневного поиска. Используется только в FindFace CIBR, когда экземпляр FindFace CIBR настроен в качестве сервера-кукловода.

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

Совет

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

{
 "active": false,
 "name": "A",
 "comment": "AAAAAA",
 "color": "A",
 "notify": false,
 "acknowledge": false,
 "camera_groups": [
   0
 ],
 "face_threshold": 0,
 "body_threshold": 0,
 "car_threshold": 0,
 "ignore_events": false,
 "send_events_to_external_vms": false,
 "origin": "A"
}

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

{
 "active": true,
 "name": "new watch list",
 "comment": "sample",
 "color": "35a2ee"
}

CURL пример

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

В случае успешного ответа (Created: 201) возвращается JSON-объект со следующими параметрами. Пример.

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

{
 "id": 9,
 "created_date": "2025-07-22T09:36:00.253232Z",
 "modified_date": "2025-07-22T09:36:00.253273Z",
 "active": true,
 "name": "new watch list",
 "comment": "sample",
 "color": "35a2ee",
 "notify": false,
 "acknowledge": false,
 "camera_groups": [],
 "face_threshold": null,
 "body_threshold": null,
 "car_threshold": null,
 "ignore_events": false,
 "send_events_to_external_vms": false,
 "origin": "ffsecurity",
 "collect_location": false
}

Используйте 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/