Модель

Модель данных Dashboard

Параметр	Тип	Обязательность	Описание
id	String	Required	ID рабочего стола
created_at	String Time	Required	Дата создания в формате: date-time
updated_at	String Time	Required	Дата изменения в формате: date-time
trace_id	String	Required	Идентификатор трассировки действия пользователя для аудита
name	String	Required	Название рабочего стола
config	Object <config>	Required	Свойства рабочего стола
owner	Object <public_user>	Required	Владелец рабочего стола
users	Array of <public_user>	Required	Пользователи, которым открыт доступ к рабочему столу
user_ids	Array of Strings	Optional	Список ID пользователей, которым открыт доступ к рабочему столу. Не отображается в ответе, если поле пустое
groups	Array of <keycloak_group>	Required	Группы, которым открыт доступ к рабочему столу
group_ids	Array of Strings	Optional	Список ID групп, которым открыт доступ к рабочему столу Не отображается в ответе, если поле пустое
widgets	Array of <widget>	Required	Список виджетов

Config

Параметр	Тип	Обязательность	Описание
grid	Array of <grid>	Required	Список параметров расположения виджетов на странице
period	Array of Strings	Required	Временной диапазон данных на рабочем столе

Public User

Параметр	Тип	Обязательность	Описание
id	String	Required	ID пользователя
email	String	Required	Почта пользователя
first_name	String	Required	Имя пользователя
last_name	String	Required	Фамилия пользователя
username	String	Required	Логин пользователя

Keycloak Group

Параметр	Тип	Обязательность	Описание
id	String	Required	ID группы
name	String	Required	Название группы пользователей
parent_group	String	Required	Название родительской группы пользователей
realm_id	String	Required
email	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 of Strings	Required	Список ID пользователей

Модель Widget

Параметр	Тип	Обязательность	Описание
id	String	Required	ID рабочего стола
created_at	String Time	Required	Дата создания в формате: 2023-12-20T00:00:01.652259Z
updated_at	String Time	Required	Дата изменения в формате: 2023-12-20T00:00:01.652259Z
trace_id	String	Required	Идентификатор трассировки действия пользователя для аудита
name	String	Required	Название виджета
config	Json <widget_config>	Required	Конфигурация виджета ("сырые" данные)
settings	Json <widget_settings>	Required	Свойства виджета
dashboard_id	String	Required	ID рабочего стола

Widget Config

Параметр	Тип	Обязательность	Описание
type	String	Required	Тип виджета ("metric", "histogram" и др.)
settings	Object <widget_type>	Required	Данные виджета. Состав параметров зависит от типа виджета.
series	Array of <series>	Required	Список серий (датасетов) в виджете

Widget Types

Table

Pie

Metric

Radar

Time Series

Text

Histogram

Image

Widget Type "Table"

Параметр	Тип	Обязательность	Описание
kind	String	Required	Тип виджета. Константа - "table"
base	Object <base>	Required	Базовые настройки
mappings	Object <mappings>	Required	Маппинг полей

Base table

Параметр	Тип	Обязательность	Описание
name	String	Required	Название виджета в UI. Константа - "Таблица"
showHeading	Boolean	Required	Флаг отображения заголовка
description	String	Required	Описание виджета

Mappings table

Параметр	Тип	Обязательность	Описание	Допустимые значения
fields	Array of <field>	Required	Список полей
groupField	Array of Strings	Optional	Список полей для группировки
normalizationStrategy	String	Optional	Стратегия нормализации	- fix - ignore

Field table

Параметр	Тип	Обязательность	Описание
label	String	Required	Лейбл поля
key	String	Required	Ключ
group	Boolean	Required	Флаг группировки

Widget Type "Pie"

Параметр	Тип	Обязательность	Описание
kind	String	Required	Тип виджета. Константа - "pie"
base	Object <base>	Required	Базовые настройки
legend	Object <legend>	Required	Легенда
settings	Object <settings>	Required	Настройки
mappings	Object <mappings>	Required	Маппинг полей

Base pie

Параметр	Тип	Обязательность	Описание
name	String	Required	Название виджета в UI. Константа - "Круговая диаграмма"
showHeading	Boolean	Required	Флаг отображения заголовка
description	String	Required	Описание виджета

Legend pie

Параметр	Тип	Обязательность	Описание
show	Boolean	Required	Флаг отображения легенды
placement	String	Required	Расположение легенды

Settings

Параметр	Тип	Обязательность	Описание
showPercentage	Boolean	Required	Флаг отображения процентов
showValues	Boolean	Required	Флаг отображения значений

Mappings pie

Параметр	Тип	Обязательность	Описание	Допустимые значения
xAxis	Object <xAxis>	Required	Настройки оси X
xAxis{field}	String	Optional	Поле для оси X
yAxis	Object <yAxis>	Required	Настройки оси Y
yAxis{field}	String	Optional	Поле для оси Y
normalizationStrategy	String	Required	Стратегия нормализации	- fix - ignore

Widget Type "Metric"

Параметр	Тип	Обязательность	Описание
kind	String	Required	Тип виджета. Константа - "metric"
base	Object <base>	Required	Базовые настройки
trend	Object <trend>	Required	Легенда
mappings	Object <mappings>	Required	Маппинг полей

Base "Metric"{#base_metric}

Параметр	Тип	Обязательность	Описание
name	String	Required	Название виджета в UI. Константа - "Метрика"
showHeading	Boolean	Required	Флаг отображения заголовка
description	String	Required	Описание виджета

Trend "Metric"

Параметр	Тип	Обязательность	Описание
enabled	Boolean	Required	Флаг отображения тренда
field	String	Optional	Название поля
invert	Boolean	Optional	Флаг "инвертировать тренд"
dataSeries	String	Optional	Серия c данными
trendSeries	String	Optional	Серия для прогнозирования

Mappings "Metric"

Параметр	Тип	Обязательность	Описание
field	String	Optional	Название поля
dataSeries	String	Optional	Серия c данными

Widget Type "Radar"

Параметр	Тип	Обязательность	Описание
kind	String	Required	Тип виджета. Константа - "radar"
base	Object <base>	Required	Базовые настройки

Base

Параметр	Тип	Обязательность	Описание
name	String	Required	Название виджета в UI. Константа - "Радиальная диаграмма"
showHeading	Boolean	Required	Флаг отображения заголовка
description	String	Required	Описание виджета

Widget Type "TimeSeries"

Параметр	Тип	Обязательность	Описание
kind	String	Required	Тип виджета. Константа - "timeseries"
base	Object <base>	Required	Базовые настройки
legend	Object <legend>	Required	Легенда
settings	Object <settings>	Required	Настройки
mappings	Object <mappings>	Required	Маппинг полей

Base "TimeSeries"

Параметр	Тип	Обязательность	Описание
name	String	Required	Название виджета в UI. Константа - "Временной ряд"
showHeading	Boolean	Required	Флаг отображения заголовка
description	String	Required	Описание виджета

Legend "TimeSeries"

Параметр	Тип	Обязательность	Описание
show	Boolean	Required	Флаг отображения легенды
placement	String	Required	Расположение легенды

Settings "TimeSeries"

Параметр	Тип	Обязательность	Описание	Допустимые значения
type	String	Required	Тип диаграммы	- bar - line
lineStyle	String	Optional	Стиль линии	- linear - rounded - start - end
showDots	Boolean	Optional	Флаг отображения точек на диаграмме
stack	Boolean	Optional	Флаг отображения стека

Mappings "TimeSeries"

Параметр	Тип	Обязательность	Описание	Допустимые значения
xAxis	Object <xAxis>	Required	Настройки оси X
xAxis{field}	String	Optional	Поле для оси X
yAxis	Object <yAxis>	Required	Настройки оси Y
yAxis{field}	String	Optional	Поле для оси Y
normalizationStrategy	String	Required	Стратегия нормализации	- fix - ignore

Widget Type "Text"

Параметр	Тип	Обязательность	Описание
kind	String	Required	Тип виджета. Константа - "text"
base	Object <base>	Required	Базовые настройки
settings	Object <settings>	Required	Настройки
settings{text}	String	Required	Текст

Base "Text"

Параметр	Тип	Обязательность	Описание
name	String	Required	Название виджета в UI. Константа - "Текст"
showHeading	Boolean	Required	Флаг отображения заголовка
description	String	Required	Описание виджета

Widget Type "Histogram"

Параметр	Тип	Обязательность	Описание
kind	String	Required	Тип виджета. Константа - "pie"
base	Object <base>	Required	Базовые настройки
legend	Object <legend>	Required	Легенда
settings	Object <settings>	Optional	Настройки
mappings	Object <mappings>	Optional	Маппинг полей

Base "Histogram"

Параметр	Тип	Обязательность	Описание
name	String	Required	Название виджета в UI. Константа - "Круговая диаграмма"
showHeading	Boolean	Required	Флаг отображения заголовка
description	String	Required	Описание виджета

Legend "Histogram"

Параметр	Тип	Обязательность	Описание
show	Boolean	Required	Флаг отображения легенды
placement	String	Required	Расположение легенды

Settings "Histogram"

Параметр	Тип	Обязательность	Описание	Допустимые значения
type	String	Required	Тип диаграммы	- bar - line
lineStyle	String	Required	Стиль линии	- linear - rounded - start - end
showDots	Boolean	Required	Флаг отображения точек на диаграмме
stack	Boolean	Required	Флаг отображения стека
theme	String	Optional	Цветовая схема

Mappings "Histogram"

Параметр	Тип	Обязательность	Описание	Допустимые значения
xAxis	Object <xAxis>	Required	Настройки по оси X
yAxis	Object <yAxis>	Required	Настройки по оси Y
normalizationStrategy	String	Required	Стратегия нормализации	- fix - ignore

xAxis "Histogram"

Параметр	Тип	Обязательность	Описание
field	String	Optional	Поле для оси X
customRange	Boolean	Optional	Кастомный диапазон
customRangeValues	Array of Strings	Optional	Диапазон
useUnknownValues	Boolean	Optional	Флаг "Использовать значения не входящие в диапазон"

yAxis "Histogram"

Параметр	Тип	Обязательность	Описание
field	String	Optional	Поле для оси Y
groupingField	String	Optional	Поле для группировки

Widget Type "Image"

Параметр	Тип	Обязательность	Описание
kind	String	Required	Тип виджета. Константа - "text"
base	Object <base>	Required	Базовые настройки
settings	Object <settings>	Required	Настройки

Base "Image"

Параметр	Тип	Обязательность	Описание
name	String	Required	Название виджета в UI. Константа - "Текст"
showHeading	Boolean	Required	Флаг отображения заголовка
description	String	Required	Описание виджета

Settings "Image"

Параметр	Тип	Обязательность	Описание	Допустимые значения
image	String	Required	Изображение в формате Base64
fit	String	Required	Способ размещения изображения	- cover (Растянуть) - contain (Вписать)

Модель Series

Параметр	Тип	Обязательность	Описание
name	String	Required	Название серии
mode	String	Required	Вид серии (query, code)
source	String	Required	Источник данных (разделы платформы)
period	Array of Strings	Required	Временной диапазон данных
sql	String	Required
query	Json <query>	Required	Данные выборки данных из датасета

Query Series

Параметр	Тип	Обязательность	Описание
dataset	String	Optional	Датасет
distinct	Boolean	Required	Уникальные данные
fields	Array of <field>	Required	Список полей выборки
filters	Array of <filter>	Required	Список фильтров по полям
group_by	Array of Strings	Required	Список полей группировки
limit	Integer	Required	Ограничение по выдачи результатов
offset	Integer	Required	Отступ выдачи результатов
order_by	Array of <sortby>	Required	Список полей сортировки
source	String	Required	Источник данных

SortBy Query Series

Параметр	Тип	Обязательность	Описание	Допустимые значения
direction	Integer	Required	Направление сортировки	- ASC - DESC - ""
field	String	Required	Поле для сортировки

Filter Query Series

Параметр	Тип	Обязательность	Описание	Допустимые значения
field	String	Required	Поле для фильтрации
negation	Boolean	Required	Флаг использования отрицания при применении фильтра
operator	String	Required	Оператор	"is","in", "between", "exists", "like", "lt", "lte", "gt", "gte"
value		Required	Значение для фильтрации	Принимает значения разных типов: string, string[], number, number[], null

Field Query Series

Параметр	Тип	Обязательность	Описание
field	String	Required	Поле для выборки
alias	String	Required	Алиас внутри набора полей
format	String	Required	Формат для форматируемых типов (пока только timestamp)
aggregation	Object <aggregation>	Required	Настройки агрегации полей

Aggregation Field

Параметр	Тип	Обязательность	Описание
func	String	Required	Вид агрегации
distinct	Boolean	Required	Уникальные данные
args	Array of Strings	Required	Параметр агрегации (временной интервал)

Параметр	Тип	Обязательность	Описание
settings	Object <general_widget_settings>	Required	Настройки виджета
period	Array of Strings	Required	Временной диапазон данных в виджете
series	Array of <series>	Required	Список серий (датасетов) в виджете

General Widget Settings

Параметр	Тип	Обязательность	Описание
kind	String	Required	Тип виджета ("metric", "histogram" и др.)
base	Object <base>	Required	Базовые данные
settings	Object <settings>	Required	Настройки
legend	Object <legend>	Required	Легенда отображения виджета в UI
slots	Object <slots>	Required	Настройка слотов
mappings	Object <mappings>	Required	Настройки осей

Base Widget Settings

Параметр	Тип	Обязательность	Описание
name	String	Required	Название типа виджета
showHeading	Boolean	Required	Флаг отображения заголовка
description	String	Required	Описание виджета

Settings Widget Settings

Параметр	Тип	Обязательность	Описание
type	String	Required	Тип диаграммы
showDots	Boolean	Required	Флаг отображения точек на диаграмме
text	String	Required	Текст
image	String	Required	Изображение в формате Base64
fit	String	Required	Способ размещения изображения

Legend Widget Settings

Параметр	Тип	Обязательность	Описание
show	Boolean	Required	Флаг отображения легенды
placement	String	Required	Расположение

Mappings Widget Settings

Параметр	Тип	Обязательность	Описание
xAxis	Object <xAxis>	Required	Настройки оси X
yAxis	Object <yAxis>	Required	Настройки оси Y
fields	Array of <field>	Required	Список полей
field	String	Required	Поле
dataSeries	String	Required	Серия c данными

xAxis Mappings Widget Settings

Параметр	Тип	Обязательность	Описание
field	String	Required	Поле по оси X
customRange	Boolean	Required	Кастомный диапазон
customRangeValues	Array of Strings	Required	Диапазон

yAxis Mappings Widget Settings

Параметр	Тип	Обязательность	Описание
field	String	Required	Поле по оси Y

Field Mappings Widget Settings

Параметр	Тип	Обязательность	Описание
label	String	Required	Название
key	String	Required	Ключ