API - Отчеты
Внимание
Для выполнения запроса к API необходима дополнительная авторизация.
Используйте в запросе заголовок Authorization: Bearer <персональный токен>
.
Шаблоны отчетов
Получение списка доступных пользователю шаблонов
GET /api/public/sm/v2/reports/templates
Параметры запроса
Название параметра | Тип параметра | Описание параметра |
---|---|---|
page | number | Номер страницы |
perPage | number | Количество записей на одну страницу. Если -1 - будут возвращены все шаблоны |
search | string/null | Строка поиска |
sortCol | string/null | Название поля, по которому выполняется сортировка |
sortDir | string/null | Направление сортировки (asc/desc) |
skip | number | Количество записей, которое требуется пропустить |
Пример выходной модели
[
{
"id": 744,
"name": "TestReportMulti",
"description": null,
"type": "availability-multi",
"workGroup": {
"id": 490,
"name": "DIAD"
},
"reportCount": 1,
"lastReport": {
"id": "5dd2c63e-60c0-49af-8fde-dfac8d7784b7",
"name": "12.03.2024 17:16 TestReportMulti",
"description": "11.03.2024 00:00 - 12.03.2024 00:00",
"error": null,
"status": "Ok",
"entityInfo": {
"createdAt": "2024-03-12T14:16:41.193456+00:00",
"createdBy": 90206,
"createdByName": "Getmanov Andrey",
"updatedAt": null,
"updatedBy": -1,
"updatedByName": null
}
}
},
{
"id": 40,
"name": "DIAD-1",
"description": null,
"type": "availability-single",
"workGroup": {
"id": 490,
"name": "DIAD"
},
"reportCount": 2,
"lastReport": {
"id": "b9cd13db-e51f-45f1-965d-c61208bfb881",
"name": "12.03.2024 17:16 DIAD-1",
"description": "12.03.2024 00:00 - 12.03.2024 17:16",
"error": null,
"status": "Ok",
"entityInfo": {
"createdAt": "2024-03-12T14:16:14.280912+00:00",
"createdBy": 90206,
"createdByName": "Getmanov Andrey",
"updatedAt": null,
"updatedBy": -1,
"updatedByName": null
}
}
}
]
Атрибуты выходной модели шаблона
Атрибут | Тип | Описание |
---|---|---|
id | long | Идентификатор шаблона |
name | string | Название шаблона |
description | string | Описание шаблона |
type | string | Тип шаблона |
workGroup | object | Модель рабочей группы, которой принадлежит шаблон |
reportCount | integer | Количество отчетов |
lastReport | object | Модель с информацией по последнему рассчитанному шаблону |
Коды ответа
Код | Описание |
---|---|
200 | Запрос успешно исполнен |
401 | Пользователь не авторизован |
500 | Непредвиденная ошибка при обработке запроса |
Получение статуса отчета по идентификатору
GET /api/public/sm/v2/reports/{reportId}
Параметры запроса
Параметр | Тип | Описание |
---|---|---|
reportId | string | Идентификатор отчета |
Пример выходной модели
{
"id": "71a45161-97af-4c0f-a59f-ae0146f3a46c",
"name": "13.03.2024 11:09 DIAD TestReportMulti",
"description": "12.03.2024 00:00 - 13.03.2024 00:00",
"error": null,
"status": "Ok",
"entityInfo": {
"createdAt": "2024-03-13T08:09:46.115926+00:00",
"createdBy": 90206,
"createdByName": "Getmanov Andrey",
"updatedAt": null,
"updatedBy": -1,
"updatedByName": null
}
}