Skip to main content
Skip table of contents

Список всех кейсов аналитики

Пагинированный список всех кейсов аналитики, доступных пользователю

GET/api/v1/analytic-case

Headers

Authorization

Bearer token

Accept

application/json

X-Client

ios-cctv|android-cctv|thick-legal|web

X-UUID

unique device id

Body

per_pagerequired

int

Количество элементов в одной странице пагинации. По умолчанию 25 штук

pagerequired

int

Номер страницы пагинации

searchrequired

int

Поиск по имени, названию кейса аналитики

typesrequired

array

Поиск по типу кейса аналитики

scriptsrequired

array

Поиск по событиям

groupsrequired

array

Поиск по группе ресурсов аналитики

statusesrequired

array

Поиск по статусу кейса аналитики

sortrequired

array

Сортировка кейсов аналитики

dirrequired

string

В каком направлении нужно отсортировать

Response

200

Возвращает список кейсов аналитики на i странице пагинации

JSON
{
    "id": 2,
    "title": "asad",
    "type": "face-recognition",
    "type_pretty": "Распознавание лиц",
    "status": "active",
    "cameras": [
        {
            "id": 1,
            "group_id": 2,
            "status": "empty",
            "type": "without_server",
            "start_at": null,
            "created_at": "2023-01-24T10:36:08.000000Z",
            "billing_id": null,
            "pretty_name": "Камера 1",
            "pretty_text": "Камеры",
            "short_address": "Камеры",
            "full_address": "Камеры",
            "lat": null,
            "lng": null,
            "azimuth": null,
            "streams": [
                {
                    "id": 1,
                    "type": "high",
                    "camera_id": 1,
                    "is_preview_from_server": true,
                    "is_archive_from_server": null,
                    "status": null,
                    "has_sound": false,
                    "width": null,
                    "height": null
                },
                {
                    "id": 2,
                    "type": "low",
                    "camera_id": 1,
                    "is_preview_from_server": true,
                    "is_archive_from_server": null,
                    "status": null,
                    "has_sound": false,
                    "width": null,
                    "height": null
                }
            ],
            "has_sound": false,
            "archive_ranges": [],
            "archive_recording_timetable": null,
            "is_archive_recording": false,
            "archive_recording_type": "fulltime",
            "can_change_archive_timetable": false,
            "scripts": [
                {
                    "id": 1,
                    "title": null,
                    "schedule": 3,
                    "timetable": null,
                    "status": null,
                    "created_at": null,
                    "updated_at": null,
                    "users": [],
                    "event": {
                        "id": 5,
                        "name": "face-unrecognized",
                        "description": "Лицо не идентифицировано",
                        "color": "#91D4E2",
                        "analytic_type": "face-recognition"
                    },
            "analytic_groups": [
                {
                    "id": 1,
                    "name": "test",
                    "type": "cameras",
                    "type_pretty": "models.analytic_files.description.cameras",
                    "uuid": "de843c6a-cf88-4119-b117-e0e8971947f5",
                    "created_at": null,
                    "updated_at": null
                }
            ],
            "extra": null
        }
    ],
    "meta": null,
    "analytic_case_camera_status": null,
    "analytic_case_camera_status_pretty": null,
    "analytic_case_camera_user_status": null,
    "analytic_case_camera_user_status_pretty": null,
    "event": null,
    "is_bridge": false,
    "is_favorite": false,
    "user_status": "active",
    "name": "Камера 1"
    }
],
"created_at": "2023-02-03T10:51:53.000000Z",
"updated_at": "2023-01-26T07:56:47.000000Z",
"analytic_files": [],
"color": "#E5642E",
"available_events": [
        {
            "id": 5,
            "type": "camera",
            "type_pretty": "Лицо не идентифицировано",
            "data": null,
            "created_at": "2023-01-24T10:35:22.000000Z",
            "updated_at": "2023-01-24T10:35:22.000000Z"
        }
    ],
"is_fails_exists": false
}
401

Токен авторизации не передан или не валидный, см. Получение токена

422

Возвращает JSON объект с ошибкой, см. Валидация

JSON
{
    "message": "Тут не будет информативного сообщения",
    "errors": {
        "any_key": [
            "Тут будет описана причина ошибки"
        ]
    }
}

Пример

JSON
curl -k --location --request GET 'https://vms.local/api/v1/analytic-case?per_page=int&page=int&search=int&types=array' \
--header 'Authorization:Bearer token' \
--header 'Accept:application/json' \
--header 'X-Client:ios-cctv|android-cctv|thick-legal|web' \
--header 'X-UUID:unique device id'
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.