Skip to main content
Skip table of contents

Обновление события и реакции

Обновление события и реакции.

PUT/api/v1/scripts/{script}

Headers

Authorization

Bearer token

Accept

application/json

X-Client

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

X-UUID

unique device id

Body

json

JSON
{
    "reaction_id": 1,
    "event_id": 1,
    "title": "script",
    "status": "active",
    "cameras": null,
    "users": [
        1
    ],
    "timetable": {
        "days": [
            {
                "type": "same_every_day",
                "from": "00:00:00+01:00",
                "to": "23:59:00+01:00",
                "breaks": [
                    {
                        "from": "16:00:00+01:00",
                        "to": "17:00:00+01:00"
                    }
                ]
            }
        ]
    },
    "extra": {
        "chat_id": "chat_id",
        "bot_token": "bot_token"
    }
}

scriptoptional

int

Уникальный идентификатор события и реакции

titlerequired

string

Название события и реакции

reaction_idrequired

int

Id реакции. Значение берется из статистики, см. Основные конфигурации

event_idrequired

int

Id события. Значение берется из статистики, см. Основные конфигурации

usersrequired

array

Массив id пользователей, которым будет приходить реакция на событие. Суб-пользователем будут приходить реакции: show-camera-sidebar, sound, show-camera

statusrequired

array

Статус события и реакции. Если он выключен (false), то события не будут обрабатываться

timetablerequired

array

Время работы события и реакции

timetable.daysrequired

array

Расписание работы события и реакции

timetable.days.*.typerequired

string

Расписание работы события и реакции в рамках одного дня

timetable.days.*.fromrequired

string

Начало работы события и реакции

timetable.days.*.torequired

string

Окончание работы события и реакции

timetable.days.*.breaksrequired

array

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

timetable.days.*.breaks.*.fromrequired

string

Начало паузы события и реакции

timetable.days.*.breaks.*.torequired

string

Окончание паузы события и реакции

timetable.intervalsrequired

array

Расписание работы по временным интервалам события и реакции

timetable.intervals.*.fromrequired

string

Дата и время начала работы события и реакции

timetable.intervals.*.torequired

string

Дата и время окончания работы события и реакции

extrarequired

array

Экстра дата для создания события и реакции с типом реакции 'telegram-message'

extra.bot_tokenrequired

str

Токен telegram бота

extra.chat_idrequired

str

Id telegram чата

Response

200

Возвращает объект события и реакции

JSON
{
    "id": 1,
    "title": "script",
    "schedule": [],
    "timetable": {
        "days": [
            {
                "to": "23:59:00+05:00",
                "from": "00:00:00+05:00",
                "type": "same_every_day",
                "breaks": [
                    {
                        "to": "17:00:00+05:00",
                        "from": "16:00:00+05:00"
                    }
                ]
            }
        ],
        "intervals": []
    },
    "status": "active",
    "created_at": "2022-04-08 10:30:11",
    "updated_at": "2022-04-08 10:30:11",
    "users": [
        {
            "id": 1,
            "login": "user@mail.com",
            "name": "Имя пользователя",
            "parent_id": 3,
            "permissions": [
                {
                    "id": 240,
                    "name": "inner_key_name",
                    "display_name": "Название пермишена для пользователя"
                }
            ],
            "created_at": "2021-05-27 15:47:57",
            "updated_at": "2022-02-10 12:34:50",
            "online_request_interval": 100,
            "access_token_id": "3zsdfqc32323fbc38cc98e7b",
            "can_update_password": true
        }
    ],
    "event": {
        "id": 1,
        "name": "inner_key_name",
        "description": "Название ивента",
        "color": "#07D4F0",
        "analytic_type": "analytic_type"
    },
    "reaction": {
        "id": 1,
        "name": "inner_key_name",
        "description": "Название ивента",
        "is_default": false
    },
    "extra": {
        "chat_id": "chat_id",
        "bot_token": "bot_token"
    }
}
401

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

422

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

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

Пример

JSON
curl -k --location --request PUT 'https://vms.local/api/v1/scripts/{script}' \
--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 '{
    "reaction_id": 1,
    "event_id": 1,
    "title": "script",
    "status": "active",
    "cameras": null,
    "users": [
        1
    ],
    "timetable": {
        "days": [
            {
                "type": "same_every_day",
                "from": "00:00:00+01:00",
                "to": "23:59:00+01:00",
                "breaks": [
                    {
                        "from": "16:00:00+01:00",
                        "to": "17:00:00+01:00"
                    }
                ]
            }
        ]
    },
    "extra": {
        "chat_id": "chat_id",
        "bot_token": "bot_token"
    }
}'
JavaScript errors detected

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

If this problem persists, please contact our support.