Reports

Разработчикам / REST API для BOOCO Meteor (v 1.x) / Общее API

Endpoints

Endpoint
Метод
Описание
Queries
Body (JSON)
Значение поля data
Права (ресурс)
Версия
GET

Возвращает список категорий, которые указаны у всех отчетов. Если категория встречается дважды или более, то возвращается только одно значение.

string[]

read:any (report)

1.36.2

GET

Возвращает список отчетов, для данной категории :category

ReportItem[]

read:any (report)

1.36.2

GET

Запускает на обсчет отчет :reportId

localeCode...query

ReportResultItem[]

1.36.2

GET

Возвращает список отчетов из коллекции reports.

ReportResultItem[]

read:any (report)

1.36.2

POST

Создать новую запись в коллекции reports.

ReportItem

GET

Возвращает отчет из коллекции reports по :reportId (key=_id - обязательный параметр в данном запросе).

key

ReportItem

read:any (report)

1.36.2

PUT

Изменить запись из коллекции reports по ключу :reportId (key=_id - обязательный параметр в данном запросе). Требуется заново загрузить права после выполнения этой операции.

key

ReportItem

update:any (report)

1.36.2

DELETE

Удалить запись из коллекции reports по ключу :reportId (key=_id - обязательный параметр в данном запросе). Требуется заново загрузить права после выполнения этой операции.

key

delete:any (report)

1.36.2

Параметры запроса (Queries)

Queries
Описание
Тип значения
Обязательный
Значение по умолчанию

Обозначает язык для вывода дат (ru, en и т.д. из списка поддерживаемых locale)

Locale
нет

Набор параметров для фильтра в зависимости от отчета. Примеры: category=meeting-room, start=2023-01-01T00:00:00Z

нет

Параметры URL

Name
Описание
Тип значения

id отчета из коллекции reports

string