Перейти к содержанию

Обзор

Основные характеристики

Характеристика Значение
Наименование report_category
Компоненты Cruddy
Появился в версии 4.2.0
Доступен в версиях 4.2.0 и выше
Авторизация по токену Security scheme type: http
Bearer format: JWT
Авторизация по APIkey Security scheme type: apiKey
Header parameter name: PgrApiKey
Версия API v2

Описание: Ресурс отвечает за работу с категориями хранения отчетов. Ресурс взаимодействует с ресурсом reports.

Список методов для работы с ресурсом

Тип Метод Описание
POST /report_category/create Создание категории для хранения отчетов
POST /report_category/search Поиск категорий
GET /report_category/{id} Получение категории по ID
DELETE /report_category/{id} Удаление категории по ID

Ответы методов

Статус код Описание
200 Успех
201 Успешное создание объекта
204 Успешный ответ. Пустое тело ответа
400 Неверный тип параметра запроса, либо отсутствует обязательный параметр
401 Ошибка авторизации
404 Ресурс не найден
500 Ошибка сервера

Модели объектов

Название Описание
ReportCategory Модель данных ресурса report_category