Отчеты
1. Получение информации об отчете (GET /users/reports/{report_id}
)
Тела запроса нет. В query-параметрах передается id
отчета, информацию о котором необходимо получить.
200 OK
-
Получена информация об отчете.
404 NOT_FOUND
-
Отчет не найден.
2. Получение списка отчетов (GET /users/reports
)
200 OK
-
Получен список отчетов.
3. Создание отчета (POST /users/reports
)
{
"name": "my_report_name", (1)
"owner": "Nobody", (1)
"min": 0,
"hour": 0,
"dom": 1,
"mon": 1,
"dow": 1,
"perpetually": true,
"start_period": "2025-02-04T14:11:19.667438",
"end_period": "2026-02-04T14:11:19.667453",
"status": "wait",
"notify": "Nobody",
"notify_cc": "email@http://domain.ru[domain.ru]",
"description": ""
}
1 | Обязательное поле |
201 CREATED
-
Отчет создан.
4. Изменение отчета (PATCH /users/reports/{report_id}
)
Также в query-параметрах передается id
отчета, информацию о котором необходимо изменить.
{
"min": 0,
"hour": 0,
"dom": 1,
"mon": 1,
"dow": 1,
"perpetually": true,
"start_period": "2025-02-04T14:11:19.667438",
"end_period": "2026-02-04T14:11:19.667453",
"status": "wait",
"notify": "Nobody",
"notify_cc": "email@http://domain.ru[domain.ru]",
"description": ""
}
200 OK
-
Параметры отчета изменены.
400 BAD_REQUEST
-
Некорректное тело запроса.
404 NOT_FOUND
-
Отчет не найден.
5. Изменение статуса отчета (PATCH /users/reports
)
{
"reports": [
{
"id": 1, (1)
"status": "wait" (1)
}
]
}
1 | Обязательное поле |
200 OK
-
Статус отчета изменен.
400 BAD_REQUEST
-
Некорректное тело запроса.
404 NOT_FOUND
-
Отчет не найден.
6. Удаление списка отчетов (DELETE /users/reports
)
{
"ids": [ (1)
1
]
}
1 | Обязательное поле |
204 NO_CONTENT
-
Список отчетов удален.
404 NOT_FOUND
-
Отчет не найден.