Analytics case update. Loud sound detection

Updating an analytics case with the type «Loud sound detection».

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": "Loud sound detection", "type": "loud-sound", "cameras": [ { "id": 10, "analytic_case_camera_user_status": null, "scripts": [ { "id": 21 } ], "meta": null }, { "id": 7, "analytic_case_camera_user_status": null, "scripts": [ { "id": 21 } ], "meta": null } ] }`
case^optional	int	Unique identifier of the analytics case to be updated
title^required	string	Name of the analytics case
cameras^required	array	Array of camera objects with event and reaction specifications
*cameras..id^required**	array	Camera ID
*cameras..scripts^required**	array	Array of event and reaction IDs
*cameras..scripts..id^required*	int	Event and reaction IDs, see Creating an event and reaction
*cameras..meta.sensitive^required**	int	Sensitivity level at which the analytics will trigger
*cameras..analytic_case_camera_user_status^required**	str	Changing the status of the case. «pause» to pause an individual camera of the case, «unpause» to unpause an individual camera of the case
cameras^required	array	Array of camera objects to be deleted, specifying the deletion type
*cameras..id^required**	int	Camera ID
*cameras..force^required**	bool	Deletion type. «true» for complete deletion of the case, «false» to mark the case as deleted while keeping the existing events, but new events will not be received

Response
200		Returns the updated analytics case
JSON { "id": 43, "title": "Loud sound detection", "type": "loud-sound", "type_pretty": "Loud sound detection", "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": "Camera 1", "pretty_text": "Cameras", "short_address": "Cameras", "full_address": "Cameras", "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": 21, "title": "Set a label", "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:44:02", "updated_at": "2022-12-21 12:44:02", "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": 10, "name": "loud-sound", "description": "Loud sound detection", "color": "#008CFF", "analytic_type": "loud-sound" }, "extra": null } ], "meta": null, "analytic_case_camera_status": "active", "analytic_case_camera_status_pretty": "Camera active", "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": "Camera 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": "Camera 2", "pretty_text": "Cameras", "short_address": "Cameras", "full_address": "Cameras", "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": 21, "title": "Set a label", "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:44:02", "updated_at": "2022-12-21 12:44:02", "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": 10, "name": "loud-sound", "description": "Loud sound detection", "color": "#008CFF", "analytic_type": "loud-sound" }, "extra": null } ], "meta": null, "analytic_case_camera_status": "inactive", "analytic_case_camera_status_pretty": "Camera inactive", "analytic_case_camera_user_status": "failed_to_create", "analytic_case_camera_user_status_pretty": "Creation error", "event": null, "is_bridge": false, "is_favorite": false, "user_status": "active", "name": "Camera 2" } ], "created_at": "2022-12-21 12:44:15", "updated_at": "2022-12-21 12:44:15", "color": "#1564A6", "available_events": [], "is_fails_exists": true, "errors": [ "Error creating camera Camera 1." ] }
401		Authorization token is missing or invalid, see Obtaining a token
402		The license limit for the selected analytics case has been exceeded
422		Returns a JSON object with an error, see Validation
JSON `{ "message": "There won't be any informative message here", "errors": { "any_key": [ "Here the error cause will be described" ] } }`

Example

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": "Loud sound detection",
    "type": "loud-sound",
    "cameras": [
        {
            "id": 10,
            "analytic_case_camera_user_status": null,
            "scripts": [
                {
                    "id": 21
                }
            ],
            "meta": null
        },
        {
            "id": 7,
            "analytic_case_camera_user_status": null,
            "scripts": [
                {
                    "id": 21
                }
            ],
            "meta": null
        }
    ]
}'