Skip to main content
Skip table of contents

Список событий и реакций

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

GET/api/v1/scripts

Headers

Authorization

Bearer token

Accept

application/json

X-Client

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

X-UUID

unique device id

Body

pagerequired

int

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

per_pagerequired

int

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

searchrequired

int

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

excluderequired

array

Массив id событий и реакций для исключения. Исключенные id не будут отражены в выдаче.

reactionsrequired

array

Поиск по типу реакции

eventsrequired

array

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

case_typerequired

str

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

sort

string

Поле, по которому нужно отсортировать. Необязательное. Поля сортировки:

  • created_at - дата создания

  • event - название события

  • reaction - название реакции

  • status - статус реакции

dir

string

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

Response

200

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

JSON
{
    "data": [
        {
            "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"
            }
        }
    ],
    "links": {
        "first": "https://vms.local/api/v1/scripts?page=1",
        "last": "https://vms.local/api/v1/scripts?page=6",
        "prev": null,
        "next": "https://vms.local/api/v1/scripts?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "pagination.previous",
                "active": false
            }
        ],
        "path": "https://vms.local/api/v1/scripts",
        "per_page": 25,
        "to": 25,
        "total": 1
    }
}
401

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

422

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

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

Пример

JSON
curl -k --location --request GET 'https://vms.local/api/v1/scripts?page=int&per_page=int&search=int&exclude=array&reactions=array&events=array&case_type=str' \
--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.