Skip to main content
Skip table of contents

Список групп ресурсов

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

GET/api/v1/analytics/groups

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 штук

analytic_groupsrequired

array

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

analytic_typerequired

str

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

filesrequired

int

Поиск групп ресурсов, содержащих id ресурса

analytic_caserequired

int

Поиск групп ресурсов, относящихся к кейсу аналитики

sort

string

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

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

  • name - название

dir

string

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

Response

200

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

JSON
{
    "data": [
        {
            "id": 1,
            "name": "name",
            "type": "type",
            "type_pretty": "type_pretty",
            "uuid": "0906deb6-b1b1-11ec-8995-a3b0e5228375",
            "created_at": "2022-04-01 14:44:06",
            "updated_at": "2022-04-01 14:44:06",
            "files_count": 1
        }
    ],
    "links": {
        "first": "https://vms.local/api/v1/analytics/groups?page=1",
        "last": "https://vms.local/api/v1/analytics/groups?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "pagination.previous",
                "active": false
            },
            {
                "url": "https://vms.local/api/v1/analytics/groups?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "pagination.next",
                "active": false
            }
        ],
        "path": "https://vms.local/api/v1/analytics/groups",
        "per_page": 25,
        "to": 1,
        "total": 1
    }
}
401

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

422

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

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

Пример

JSON
curl -k --location --request GET 'https://vms.local/api/v1/analytics/groups?page=int&per_page=int&analytic_groups=array&analytic_type=str&files=int&analytic_case=int' \
--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.