Конечная точка Reports

Конечная точка для построения отчетов Сервиса Аудита

Описание

Конечная точка Reports позволяет формировать отчеты о деятельности ПАК КриптоПро DSS на основании информации, расположенной в БД Аудита.

Конечная точка /reports предоставляет следующие методы:

Создание отчета

Предназначен для создания выбранного отчета.

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

Параметр Значение
HTTP-метод POST
Путь https://dss.cryptopro.ru/AnalyticsService/api/reports/create
Параметры CreateReportInput - запрос на создание отчета
Возвращаемое значение string - Base64-представление двоичных данных файла с отчетом
Примечание

Данный метод может быть вызыван только для пользователей с ролями Admins, Readonly или Audit.

Пример запроса:
POST /AnalyticsService/api/reports/create HTTP/1.1
Content-Type: application/json

{
    "Parameters":
            {
                "StartDate":"01.01.2000",
                "EndDate":"10.10.2020"
            },
    "ReportFormat":"Xml",
    "ReportType":"gdr"
}
Пример ответа:

Ответ содержит base64

"77u/...ydD4="
Типовые ошибки
HTTP код Код ошибки Описание
400 plugin_not_registered Запрошенный плагин формирования отчета не зарегистрирован
400 required_param_not_set Не задан обязательный параметр отчета
500 - Внутренняя ошибка сервера

Получение информации о доступных отчетах

Данный метод предназначен для получения информации о плагинах формирования отчетов, доступных на сервисе.

Информация включает в себя Тип отчета, а также список параметров, с указанием того, какие из параметров являются обязательными.

Параметр Значение
HTTP-метод GET
Путь https://dss.cryptopro.ru/AnalyticsService/api/reports/policy
Возвращаемое значение ReportPolicy - список описаний зарегистрированных плагинов формирования отчета
Пример запроса:
GET /AnalyticsService/api/reports/policy HTTP/1.1
Пример ответа:

Ответ содержит закодированное в Base-64 двоичное содержимое файла с отчетом.

[
    {
        "ReportType": "gdr",
        "ReportName": "Обобщенный отчет по СЭП DSS",
        "Parameters": [
            {
                "Type": 0,
                "Name": "StartDate",
                "Description": "Начальная дата",
                "Required": true
            },
            {
                "Type": 0,
                "Name": "EndDate",
                "Description": "Конечная дата",
                "Required": true
            }
        ]
    }
]
Типовые ошибки
HTTP код Код ошибки Описание
500 - Внутренняя ошибка сервера