Skip to main content
Skip table of contents

Обновление кейса аналитики. Детекция дыма и огня

Обновление кейса аналитики с типом «Детекция дыма и огня».

PUT/api/v1/analytic-case/{case}

Headers

Authorization

Bearer token

Accept

application/json

X-Client

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

X-UUID

unique device id

Body

json

JSON
{
    "title": "Детекция дыма и огня",
    "type": "smoke-fire",
    "cameras": [
        {
            "id": 10,
            "analytic_case_camera_user_status": null,
            "scripts": [
                {
                    "id": 24
                }
            ],
            "meta": {
                "figures": [
                    {
                        "name": "Figure 1",
                        "coords": [
                            {
                                "x": 0.153125,
                                "y": 0.31666666666666665
                            },
                            {
                                "x": 0.3421875,
                                "y": 0.7361111111111112
                            },
                            {
                                "x": 0.86875,
                                "y": 0.6472222222222223
                            },
                            {
                                "x": 0.78125,
                                "y": 0.125
                            }
                        ]
                    }
                ]
            }
        },
        {
            "id": 7,
            "analytic_case_camera_user_status": null,
            "scripts": [
                {
                    "id": 24
                }
            ],
            "meta": {
                "figures": [
                    {
                        "name": "Figure 1",
                        "coords": [
                            {
                                "x": 0.153125,
                                "y": 0.31666666666666665
                            },
                            {
                                "x": 0.3421875,
                                "y": 0.7361111111111112
                            },
                            {
                                "x": 0.86875,
                                "y": 0.6472222222222223
                            },
                            {
                                "x": 0.78125,
                                "y": 0.125
                            }
                        ]
                    }
                ]
            }
        }
    ]
}

caseoptional

int

Уникальный идентификатор кейса аналитики, который нужно обновить

titlerequired

string

Название кейса аналитики

camerasrequired

array

Массив объектов камер с указанием события и реакции

cameras.*.idrequired

array

Id камеры

cameras.*.scriptsrequired

array

Массив id событий и реакций

cameras.*.scripts.*.idrequired

int

Id события и реакции, см. Создание события и реакции

cameras.*.meta.figurerequired

array

Выделенная область камеры, которую будет обрабатывать аналитика. Передаётся как массив координат (точки изгиба линии) в относительных значениях от 0 до 1. Количество точек может быть от трёх до n. Передавать последнюю координату не надо, область будет замыкаться с первоначальной координатой. Пример:

JSON
[
    {
        "x":0.10390625,
        "y":0.18125
    },
    {
        "x":0.81953126,
        "y":0.8979167
    },
    {
        "x":0.87890625,
        "y":0.45833334
    },
    {
        "x":0.7445313,
        "y":0.19375
    }
]

cameras.*.meta.sensitiverequired

int

Чувствительность, с которой будет срабатывать аналитика

cameras.*.analytic_case_camera_user_statusrequired

str

Изменение статуса кейса. pause - поставить отдельную камеру кейса на паузу, unpause - снять с паузы отдельную камеру кейса

camerasrequired

array

Массив объектов камер, которые нужно удалить, с указанием типа удаления

cameras.*.idrequired

int

Id камеры

cameras.*.forcerequired

bool

Тип удаления. true - полное удаление кейса, false - кейс пометиться как удаленный и события по нему остануться, но не будут приходить новые события

Response

200

Возвращает кейс аналитики

JSON
{
    "id": 50,
    "title": "Детекция дыма и огня",
    "type": "smoke-fire",
    "type_pretty": "Детекция дыма и огня",
    "status": "active",
    "cameras": [
        {
            "id": 10,
            "group_id": 2,
            "status": "active",
            "type": "media_server_v2",
            "start_at": "",
            "created_at": "2022-12-16 10:25:55",
            "billing_id": null,
            "pretty_name": "Камера 1",
            "pretty_text": "Камеры",
            "short_address": "Камеры",
            "full_address": "Камеры",
            "lat": null,
            "lng": null,
            "azimuth": null,
            "streams": [
                {
                    "id": 19,
                    "type": "high",
                    "camera_id": 10,
                    "is_preview_from_server": true,
                    "is_archive_from_server": null,
                    "status": "active",
                    "has_sound": false,
                    "width": null,
                    "height": null
                },
                {
                    "id": 20,
                    "type": "low",
                    "camera_id": 10,
                    "is_preview_from_server": true,
                    "is_archive_from_server": null,
                    "status": "active",
                    "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": 24,
                    "title": "Установить метку",
                    "schedule": [],
                    "timetable": {
                        "days": [
                            {
                                "to": "23:59:00+05:00",
                                "from": "00:00:00+05:00",
                                "type": "same_every_day",
                                "breaks": []
                            }
                        ],
                        "intervals": []
                    },
                    "status": "active",
                    "created_at": "2022-12-21 12:48:58",
                    "updated_at": "2022-12-21 12:48:58",
                    "users": [
                        {
                            "id": 5,
                            "login": "user",
                            "name": "user",
                            "parent_id": null,
                            "created_at": "2022-12-06 20:20:58",
                            "updated_at": "2022-12-21 10:53:45",
                            "access_token_id": null,
                            "can_update_password": true
                        }
                    ],
                    "event": {
                        "id": 11,
                        "name": "smoke-fire",
                        "description": "Детекция дыма и огня",
                        "color": "#FF5A3F",
                        "analytic_type": "smoke-fire"
                    },
                    "extra": null
                }
            ],
            "meta": {
                "figures": [
                    {
                        "name": "Figure 1",
                        "coords": [
                            {
                                "x": 0.153125,
                                "y": 0.31666666666666665
                            },
                            {
                                "x": 0.3421875,
                                "y": 0.7361111111111112
                            },
                            {
                                "x": 0.86875,
                                "y": 0.6472222222222223
                            },
                            {
                                "x": 0.78125,
                                "y": 0.125
                            }
                        ]
                    }
                ]
            },
            "analytic_case_camera_status": "active",
            "analytic_case_camera_status_pretty": "Камера активна",
            "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"
        },
        {
            "id": 7,
            "group_id": 2,
            "status": "inactive",
            "type": "media_server_v2",
            "start_at": "",
            "created_at": "2022-12-16 10:25:54",
            "billing_id": null,
            "pretty_name": "Камера 2",
            "pretty_text": "Камеры",
            "short_address": "Камеры",
            "full_address": "Камеры",
            "lat": null,
            "lng": null,
            "azimuth": null,
            "streams": [
                {
                    "id": 13,
                    "type": "high",
                    "camera_id": 7,
                    "is_preview_from_server": true,
                    "is_archive_from_server": null,
                    "status": "active",
                    "has_sound": false,
                    "width": null,
                    "height": null
                },
                {
                    "id": 14,
                    "type": "low",
                    "camera_id": 7,
                    "is_preview_from_server": true,
                    "is_archive_from_server": null,
                    "status": "active",
                    "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": 24,
                    "title": "Установить метку",
                    "schedule": [],
                    "timetable": {
                        "days": [
                            {
                                "to": "23:59:00+05:00",
                                "from": "00:00:00+05:00",
                                "type": "same_every_day",
                                "breaks": []
                            }
                        ],
                        "intervals": []
                    },
                    "status": "active",
                    "created_at": "2022-12-21 12:48:58",
                    "updated_at": "2022-12-21 12:48:58",
                    "users": [
                        {
                            "id": 5,
                            "login": "user",
                            "name": "user",
                            "parent_id": null,
                            "created_at": "2022-12-06 20:20:58",
                            "updated_at": "2022-12-21 10:53:45",
                            "access_token_id": null,
                            "can_update_password": true
                        }
                    ],
                    "event": {
                        "id": 11,
                        "name": "smoke-fire",
                        "description": "Детекция дыма и огня",
                        "color": "#FF5A3F",
                        "analytic_type": "smoke-fire"
                    },
                    "extra": null
                }
            ],
            "meta": {
                "figures": [
                    {
                        "name": "Figure 1",
                        "coords": [
                            {
                                "x": 0.153125,
                                "y": 0.31666666666666665
                            },
                            {
                                "x": 0.3421875,
                                "y": 0.7361111111111112
                            },
                            {
                                "x": 0.86875,
                                "y": 0.6472222222222223
                            },
                            {
                                "x": 0.78125,
                                "y": 0.125
                            }
                        ]
                    }
                ]
            },
            "analytic_case_camera_status": "active",
            "analytic_case_camera_status_pretty": "Камера активна",
            "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": "Камера 2"
        }
    ],
    "created_at": "2022-12-21 12:49:16",
    "updated_at": "2022-12-21 12:49:16",
    "color": "#DE2000",
    "available_events": [],
    "is_fails_exists": false
}
401

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

402

Превышен лимит лицензий для выбранного кейса аналитики

422

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

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

Пример

JSON
curl -k --location --request PUT 'https://vms.local/api/v1/analytic-case/{case}' \
--header 'Authorization:Bearer token' \
--header 'Accept:application/json' \
--header 'X-Client:ios-cctv|android-cctv|thick-legal|web' \
--header 'X-UUID:unique device id' \
--header 'Content-Type: application/json \
--data-raw '{
    "title": "Детекция дыма и огня",
    "type": "smoke-fire",
    "cameras": [
        {
            "id": 10,
            "analytic_case_camera_user_status": null,
            "scripts": [
                {
                    "id": 24
                }
            ],
            "meta": {
                "figures": [
                    {
                        "x": 0.26875,
                        "y": 0.3277777777777778
                    },
                    {
                        "x": 0.4,
                        "y": 0.7694444444444445
                    },
                    {
                        "x": 0.79375,
                        "y": 0.5777777777777777
                    },
                    {
                        "x": 0.703125,
                        "y": 0.13333333333333333
                    }
                ]
            }
        },
        {
            "id": 7,
            "analytic_case_camera_user_status": null,
            "scripts": [
                {
                    "id": 24
                }
            ],
            "meta": {
                "figures": [
                    {
                        "x": 0.18125,
                        "y": 0.31666666666666665
                    },
                    {
                        "x": 0.3859375,
                        "y": 0.9
                    },
                    {
                        "x": 0.9203125,
                        "y": 0.7
                    },
                    {
                        "x": 0.784375,
                        "y": 0.175
                    }
                ]
            }
        }
    ]
}'
JavaScript errors detected

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

If this problem persists, please contact our support.