Модель
Модель данных Report
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| id | string |
Required | Идентификатор отчета в формате uuid |
| created_at | string |
Required | Дата и время создания отчета в формате date-time |
| updated_at | string |
Required | Дата и время изменения отчета в формате date-time |
| name | string |
Required | Название отчета |
| config | object |
Optional | Настройки отображения виджетов в отчете. Структура объекта валидируется только на этапе генерации отчета. |
| config{pages} | Array<Array<object>> |
Optional | Настройки виджетов для каждой страницы |
| settings | object<ReportSettings> |
Optional | Общие настройки отчета |
| is_system | boolean |
Required | Является ли отчет системным |
| category | object<ReportCategory> |
Optional | Категория отчета |
| dashboard | object<Dashboard> |
Optional | Связанный рабочий стол |
| owner | object<PublicUser> |
Required | Пользователь создавший отчет |
| users | Array<PublicUser> |
Optional | Список пользователей с доступом к данному отчету |
| groups | Array<KeycloakGroup> |
Optional | Группы пользователей с доступом к данному отчету |
| task | object<ReportTask> |
Optional | Периодическая задача генерации отчета |
Пример настройки виджетов для каждой страницы
Настройка выполняется двумерным массивом элементов, следующего формата:
{
"id": "00000000-0000-0000-0000-000000000000", // id виджета
"x": 0.0, // Расположение верхнего левого угла виджета на странице по оси X
"y": 4.2, // Расположение верхнего левого угла виджета на странице по оси Y
"h": 31.5, // Высота виджета
"w": 47.7, // Ширина виджета
}
Модель данных ReportSettings
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| general | object<ReportSettingsGeneral> |
Optional | Базовые настройки |
| header | object<ReportSettingsHeader> |
Optional | Настройки верхнего колонтитула |
| footer | object<ReportSettingsFooter> |
Optional | Настройки нижнего колонтитула |
| style | object<ReportSettingsStyle> |
Optional | Настройки стиля |
Модель данных ReportSettingsGeneral
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| period | Array<string> |
Optional | Период выборки данных. Выборка данных с period[0] до period[1]. Если в массиве один элемент, на место второго подставлятеся текущий момент вермени. Первый элемент может иметь значение start — время установки системы. |
| name_mask | string |
Optional | Шаблон имени файла. Поддерживаемые плейсхолдеры: - ##ID## — ID отчета, - ##NAME## — название отчета, - ##YEAR##, ##MONTH##, ##DAY##, ##HOUR##, ##MINUTE## — год, месяц, день, час и минута создания отчета. |
Модель данных ReportSettingsHeader
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| show | boolean |
Optional | Показать/скрыть верхний колонтитул |
| text | string |
Optional | Текст верхнего колонтитула |
| show_on_all_pages | boolean |
Optional | Показывать колонтитул на всех страницах (false — только на первой) |
| color | string |
Optional | Цвет текста в hex-формате |
| text_align | string |
Optional | Выравнивание текста. Допустимые значения: - right - center - left Значение по умолчанию: left Если задано недопустимое значение, используется вариант по умолчанию. |
| image | string |
Optional | Изображение в формате base64. Поддерживаются jpeg и png |
| fit | string |
Optional | Настройки встраивания изображения - fit: изображение подстраивается под высоту колонтитула, - cover: изображение растягивается на ширину страницы. При недопустимом значении используется вариант по умолчанию fit. |
| image_align | string |
Optional | Выравнивание изображения. Допустимые значения: - right - center - left Значение по умолчанию: left Если задано недопустимое значение, используется вариант по умолчанию. |
Модель данных ReportSettingsFooter
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| show | boolean |
Optional | Показать/скрыть нижний колонтитул |
| show_on_first_page | boolean |
Optional | Показывать нижний колонтитул на первой странице |
| text | string |
Optional | Текст нижнего колонтитула |
| color | string |
Optional | Цвет текста в hex-формате |
| show_date | boolean |
Optional | Показывать дату и время |
| show_page_number | boolean |
Optional | Показывать номер страницы |
| text_align | string |
Optional | Выравнивание текста. Допустимые значения: - right - center - left Значение по умолчанию: left Если задано недопустимое значение, используется вариант по умолчанию. |
| date_align | string |
Optional | Выравнивание даты. Допустимые значения: - right - center - left Значение по умолчанию: left Если задано недопустимое значение, используется вариант по умолчанию. |
| page_number_align | string |
Optional | Выравнивание номеров страниц. Допустимые значения: - right - center - left Значение по умолчанию: left Если задано недопустимое значение, используется вариант по умолчанию. |
| image | string |
Optional | Изображение в формате base64. Поддерживаются jpeg и png. |
| fit | string |
Optional | Настройки встраивания изображения - fit: изображение подстраивается под высоту колонтитула, - cover: изображение растягивается на ширину страницы. При недопустимом значении используется вариант по умолчанию fit. |
| image_align | string |
Optional | Выравнивание изображения. Допустимые значения: - right - center - left Значение по умолчанию: left Если задано недопустимое значение, используется вариант по умолчанию. |
Модель данных ReportSettingsStyle
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| font | string |
Optional | Стиль шрифта |
PublicUser
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| id | string |
Required | Идентификатор пользователя |
string |
Required | Почта пользователя | |
| first_name | string |
Required | Имя пользователя |
| last_name | string |
Required | Фамилия пользователя |
| username | string |
Required | Логин пользователя |
KeycloakGroup
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| id | string |
Required | Идентификатор группы |
| name | string |
Required | Название группы |
| parent_group | string |
Required | Название родительской группы |
| realm_id | string |
Required | Идентификатор инстанса |
string |
Required | Почта | |
| phone_number | string |
Required | Номер телефона |
| leader_id | string |
Required | Идентификатор лидера группы |
| accept_risk | boolean |
Required | Признак принимать ли риск, назначенного инцидента |
| visible_scan_schedules | boolean |
Required | Признак видимости периодических задач сканирования |
| stop_scans | boolean |
Required | Признак остановки сканирования |
| edited_by | string |
Required | Кем изменена информация о группе |
| user_ids | Array<string> |
Required | Список идентификаторов пользователей в группе |
Модель данных ReportCreate
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| name | string |
Required | Название отчета |
| config | object |
Optional | Настройки отображения виджетов в отчете. Структура объекта валидируется только на этапе генерации отчета. |
| config{pages} | Array<Array<object>> |
Optional | Настройки виджетов для каждой страницы |
| settings | object<ReportSettings> |
Optional | Общие настройки отчета |
| is_system | boolean |
Required | Является ли отчет системным |
| category_id | string |
Optional | Категория отчета |
| dashboard_id | string |
Optional | Связанный рабочий стол |
Модель данных ReportUpdate
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| id | string |
Required | Идентификатор отчета, в который вносятся изменения |
| name | string |
Optional | Название отчета |
| config | object |
Optional | Настройки отображения виджетов в отчете. Структура объекта валидируется только на этапе генерации отчета. |
| config{pages} | Array<Array<object>> |
Optional | Настройки виджетов для каждой страницы |
| settings | object<ReportSettings> |
Optional | Общие настройки отчета |
| is_system | boolean |
Optional | Является ли отчет системным |