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

Обзор

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

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

Описание: Ресурс reports отвечает за управление отчетами. Данный ресурс выполняет взаимодействие со следующими ресурсами:

  • report_category – категории для хранения отчетов;
  • report_tasks – периодические задачи генерации отчетов;
  • reports_archive – архив отчетов.

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

Тип Метод Описание
POST /reports/create Создание отчета
PUT /reports/update Обновление информации об отчете
POST /reports/search Поиск отчетов
GET /reports/{id} Получение отчета по ID
DELETE /reports/{id} Удаление отчета
POST /reports/group Группировка отчетов
POST /reports/mass_delete Массовое удаление отчетов
DELETE /reports/all Удаление всех отчетов
POST /reports/{id}/allow_access_for_groups Предоставление доступа к отчету для групп пользователей
POST /reports/{id}/allow_access_for_users Предоставление доступа к отчету для пользователей
POST /reports/{id}/restrict_access_for_groups Ограничение доступа к отчету для групп пользователей
POST /reports/{id}/restrict_access_for_users Ограничение доступа к отчету для пользователей
POST /reports/{id}/generate Генерация отчета
GET /reports/{id}/archive/{file_id}/download Скачать отчёт из архива

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

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

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

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