Описания интерфейса

Интерфейс для работы с объектами позволяет просматривать и редактировать информацию об объектах, работать с различными визуальными элементами, а также выполнять действия с объектами. Описание интерфейса системы является частью схемы домена и включается в поле views на уровне домена.

В описаниях интерфейса используются ссылки на действия, меню домена, меню панелей, а также иконки для виджетов представлений и элементов меню.

Структура `actions`

Поле actions представляет собой массив записей действий и является необязательным. Записи действий включают общие поля, а также специфические поля, которые наличествуют в зависимости от типа действия.

Общие поля для всех типов действий

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

Поле Обязательность и значение по умолчанию Описание Тип данных

Поле	Обязательность и значение по умолчанию	Описание	Тип данных
`id`	Да	Уникальный идентификатор действия.	View ID
`name`	Нет (по умолчанию: пустая строка)	Наименование действия. Используется, если не определен или не может быть определен `label` для элемента управления в представлении.	строка
`description`	Нет (по умолчанию: пустая строка)	Описание действия. Не выводится в представлениях, но отображается в схеме домена.	строка
`type`	Да	Тип действия. Ознакомьтесь со списком доступных действий.	перечисление

id

Да

Уникальный идентификатор действия.

View ID

name

Нет (по умолчанию: пустая строка)

Наименование действия. Используется, если не определен или не может быть определен label для элемента управления в представлении.

строка

description

Нет (по умолчанию: пустая строка)

Описание действия. Не выводится в представлениях, но отображается в схеме домена.

строка

type

Да

Тип действия. Ознакомьтесь со списком доступных действий.

перечисление

Допустимые значения для поля `type`

Поле type в записи действия может принимать следующие значения, каждое из которых определяет специфические поля действия:

open_panel — открыть панель деталей объекта (только для панели);
open_modal — открыть модальное окно для создания или редактирования объекта (только для модального окна);
open_list — открыть списочное представление объектов с заполненным контекстом на основании выбранного объекта в текущем списке;
open_page — открыть полноэкранную карточку объекта;
open_graph_view — открыть граф связей, позволяющий создавать, изменять и удалять экземпляры связей, а также просматривать связи объекта на разных уровнях;
remove — удалить объект;
bulk — массовое действие;
playbook — запуск выполнения указанного плейбука или скрипта;
generate_qr_code — открыть модальное окно со сгенерированным QR-кодом, содержащим ссылку на компактное представление сущности;
copy_entity_link — скопировать полный URL объекта, включая параметры текущего состояния формы.

Поля, применимые при `type: open_panel`

Эта таблица описывает поля, применимые для действий типа open_panel.

Поле Обязательность и значение по умолчанию Описание Тип данных

Поле	Обязательность и значение по умолчанию	Описание	Тип данных
`panel`	Да	Ссылка на панель, которая будет открываться при этом действии.	строка
`entity`	Да	Ссылка на сущность, над экземпляром которой производится действие.	Data ID Ref или FQID

panel

Да

Ссылка на панель, которая будет открываться при этом действии.

строка

entity

Да

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

Data ID Ref или FQID

Поля, применимые при `type: open_modal`

Эта таблица описывает поля, применимые для действий типа open_modal.

Поле Обязательность и значение по умолчанию Описание Тип данных

Поле	Обязательность и значение по умолчанию	Описание	Тип данных
`modal`	Да	Ссылка на модальное окно, которое будет открываться при этом действии.	строка
`entity`	Да	Ссылка на сущность, над экземпляром которой производится действие.	Data ID Ref или FQID
`operation`	Да	Тип операции над объектом. Доступные значения: `create` — добавление объекта; `edit` — изменение выбранного объекта.	перечисление

modal

Да

Ссылка на модальное окно, которое будет открываться при этом действии.

строка

entity

Да

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

Data ID Ref или FQID

operation

Да

Тип операции над объектом. Доступные значения:

create — добавление объекта;
edit — изменение выбранного объекта.

перечисление

Поля, применимые при `type: open_list`

Эта таблица описывает поля, применимые для действий типа open_list.

Поле Обязательность и значение по умолчанию Описание Тип данных

Поле	Обязательность и значение по умолчанию	Описание	Тип данных
`view`	Да	Ссылка на списочное представление объектов, зависимых от контекста.	View ID Ref
`contextPin`	Нет (по умолчанию: `false`)	Флаг, запрещающий удаление контекста из фильтра списка объектов.	булево
`page`	Нет	Окно, в котором будет отображен список. Возможные значения: `blank` — показать список в новом окне; `current` — показать список в текущем окне.	перечисление
`attribute`	Нет	Ссылка на атрибут-ссылку, для которого будет применен контекст. Список объектов можно отфильтровать по значению атрибута-ссылки. Нельзя указывать одновременно с `linkage`.	строка
`linkage`	Нет	Ссылка на связь, для которой будет применен контекст. Список объектов можно отфильтровать по одной из сторон связи. Нельзя указывать одновременно с `attribute`.	строка
`side`	Нет	Сторона ссылки или связи, в соответствии с которой отображаются объекты в списочном представлении с контекстом. Указывается только для симметричной направленной связи. Возможные значения: `1` — первая сторона связи; `2` — вторая сторона связи.	Data ID Ref или FQID

view

Да

Ссылка на списочное представление объектов, зависимых от контекста.

View ID Ref

contextPin

Нет (по умолчанию: false)

Флаг, запрещающий удаление контекста из фильтра списка объектов.

булево

page

Нет

Окно, в котором будет отображен список. Возможные значения:

blank — показать список в новом окне;
current — показать список в текущем окне.

перечисление

attribute

Нет

Ссылка на атрибут-ссылку, для которого будет применен контекст. Список объектов можно отфильтровать по значению атрибута-ссылки. Нельзя указывать одновременно с linkage.

строка

linkage

Нет

Ссылка на связь, для которой будет применен контекст. Список объектов можно отфильтровать по одной из сторон связи. Нельзя указывать одновременно с attribute.

строка

side

Нет

Сторона ссылки или связи, в соответствии с которой отображаются объекты в списочном представлении с контекстом. Указывается только для симметричной направленной связи. Возможные значения:

1 — первая сторона связи;
2 — вторая сторона связи.

Data ID Ref или FQID

Поля, применимые при `type: open_page`

Эта таблица описывает поля, применимые для действий типа open_page.

Поле Обязательность и значение по умолчанию Описание Тип данных

Поле	Обязательность и значение по умолчанию	Описание	Тип данных
`view`	Да	Ссылка на списочное представление объектов, зависимых от контекста.	View ID Ref
`entity`	Да	Ссылка на сущность, над экземпляром которой производится действие.	Data ID Ref или FQID
`operation`	Да	Тип операции над объектом. Доступные значения: `create` — добавление объекта; `edit` — изменение выбранного объекта; `view` — просмотр выбранного объекта.	перечисление

view

Да

Ссылка на списочное представление объектов, зависимых от контекста.

View ID Ref

entity

Да

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

Data ID Ref или FQID

operation

Да

Тип операции над объектом. Доступные значения:

create — добавление объекта;
edit — изменение выбранного объекта;
view — просмотр выбранного объекта.

перечисление

Поля, применимые при `type: open_graph_view`

Эта таблица описывает поля, применимые для действий типа open_graph_view.

Поле Обязательность и значение по умолчанию Описание Тип данных

Поле	Обязательность и значение по умолчанию	Описание	Тип данных
`entity`	Да	Ссылка на сущность, над экземпляром которой производится действие.	Data ID Ref или FQID

entity

Да

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

Data ID Ref или FQID

Поля, применимые при `type: remove`

Эта таблица описывает поля, применимые для действий типа remove.

Поле Обязательность и значение по умолчанию Описание Тип данных

Поле	Обязательность и значение по умолчанию	Описание	Тип данных
`entity`	Да	Ссылка на сущность, над экземпляром которой производится действие.	Data ID Ref или FQID

entity

Да

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

Data ID Ref или FQID

Поля, применимые при `type: bulk`

Эта таблица описывает поля, применимые для действий типа bulk (массовые операции).

Поле Обязательность и значение по умолчанию Описание Тип данных

Поле	Обязательность и значение по умолчанию	Описание	Тип данных
`entity`	Да	Ссылка на сущность, над экземпляром которой производится действие.	Data ID Ref или FQID
`operation`	Да	Тип операции над объектом. Доступные значения: `remove` — удаление выбранных объектов; `edit_attribute` — изменение атрибута с типом `workflow` в выбранных объектах; `edit` — редактирование выбранных объектов.	перечисление
`attribute`	Нет	Ссылка на атрибут-ссылку, для которого будет применен контекст.	строка
`attributes`	Да (для `operation: edit`)	Массив параметров атрибутов, доступных для массового редактирования. Подробнее о поле `attributes`.	массив

entity

Да

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

Data ID Ref или FQID

operation

Да

Тип операции над объектом. Доступные значения:

remove — удаление выбранных объектов;
edit_attribute — изменение атрибута с типом workflow в выбранных объектах;
edit — редактирование выбранных объектов.

перечисление

attribute

Нет

Ссылка на атрибут-ссылку, для которого будет применен контекст.

строка

attributes

Да (для operation: edit)

Массив параметров атрибутов, доступных для массового редактирования. Подробнее о поле attributes.

массив

Структура `attributes` (в описании действия)

В поле attributes задаются параметры атрибутов, доступных для массового редактирования. Оно включает следующие поля:

Поле Обязательность и значение по умолчанию Описание Тип данных

Поле	Обязательность и значение по умолчанию	Описание	Тип данных
`type`	Да	Тип атрибутов. Указывается значение `specific`.	перечисление
`use`	Да	Массив Data ID Ref атрибутов сущности, доступных для массового редактирования.	массив

type

Да

Тип атрибутов. Указывается значение specific.

перечисление

use

Да

Массив Data ID Ref атрибутов сущности, доступных для массового редактирования.

массив

Поля, применимые при `type: playbook`

Эта таблица описывает поля, применимые для действий типа playbook.

Поле Обязательность и значение по умолчанию Описание Тип данных

Поле	Обязательность и значение по умолчанию	Описание	Тип данных
`playbook`	Нет	Ссылка на плейбук или скрипт. Уникальное наименование плейбука или скрипта в рамках текущей экспертизы.	строка
`workerTag`	Нет	Тег воркера, используемый для выполнения запуска.	строка

playbook

Нет

Ссылка на плейбук или скрипт. Уникальное наименование плейбука или скрипта в рамках текущей экспертизы.

строка

workerTag

Нет

Тег воркера, используемый для выполнения запуска.

строка

Поля, применимые при `type: generate_qr_code`

Эта таблица описывает поля, применимые для действий типа generate_qr_code.

Поле Обязательность и значение по умолчанию Описание Тип данных

Поле	Обязательность и значение по умолчанию	Описание	Тип данных
`entity`	Да	Ссылка на сущность, для которой генерируется QR-код.	Data ID Ref или FQID

entity

Да

Ссылка на сущность, для которой генерируется QR-код.

Data ID Ref или FQID

Поля, применимые при `type: copy_entity_link`

Эта таблица описывает поля, применимые для действий типа copy_entity_link (копирование URL объекта).

Поле Обязательность и значение по умолчанию Описание Тип данных

Поле	Обязательность и значение по умолчанию	Описание	Тип данных
`entity`	Да	Ссылка на сущность, для которой копируется URL.	Data ID Ref или FQID

entity

Да

Ссылка на сущность, для которой копируется URL.

Data ID Ref или FQID

Структура `menus`

Поле menus представляет собой массив записей элементов меню.

Запись включает следующие поля:

Поле Обязательное поле Описание Комментарий

Поле	Обязательное поле	Описание	Комментарий
`id`	да	Идентификатор элемента меню.	View ID
`description`	нет	Описание меню. Не выводится в представлениях.	строка
`route`	да	Компонент адреса текущего пункта меню, отображаемый в строке веб-браузера. Фактически определяет путь в адресной строке, по которому можно перейти на целевую страницу. Пути должны быть уникальными как в рамках одной схемы домена, так и в разных схемах.	путь в URL
`label`	да	Отображаемое в меню системы название раздела домена.	строка
`icon`	нет	Ссылка на медиа-ресурс.	строка
`type`	да	Тип элемента меню: `root_group` — корневая группа элементов меню, включающая названия раздела домена и подразделов сущностей. Количество корневых групп не ограничено. `root_menu` — элемент меню, не включенный в корневую группу.	перечисление
`placement`	да	Настройки расположения меню в левой панели: `top` — в главном меню системы; `settings` — в разделе Настройки главного меню.	перечисление
`priority`	нет	Параметр, определяющий положение в главном меню, чем больше — тем выше в списке. Значение должно быть не меньше `1000`.	целое число
`view`	да	Ссылка на списочное представление или на представление списков с вкладками. Поле доступно только для типа `root_menu`.	View ID Ref
`items`	да	Дочерние элементы для корневой группы меню. Массив записей меню с подразделами типов сущностей. Используется для типа элементов меню `root_menu`. Ознакомьтесь с описанием поля `items`.	массив

id

да

Идентификатор элемента меню.

View ID

description

нет

Описание меню. Не выводится в представлениях.

строка

route

да

Компонент адреса текущего пункта меню, отображаемый в строке веб-браузера. Фактически определяет путь в адресной строке, по которому можно перейти на целевую страницу.

Пути должны быть уникальными как в рамках одной схемы домена, так и в разных схемах.

путь в URL

label

да

Отображаемое в меню системы название раздела домена.

строка

icon

нет

Ссылка на медиа-ресурс.

строка

type

да

Тип элемента меню:

root_group — корневая группа элементов меню, включающая названия раздела домена и подразделов сущностей.

Количество корневых групп не ограничено.
root_menu — элемент меню, не включенный в корневую группу.

перечисление

placement

да

Настройки расположения меню в левой панели:

top — в главном меню системы;
settings — в разделе Настройки главного меню.

перечисление

priority

нет

Параметр, определяющий положение в главном меню, чем больше — тем выше в списке. Значение должно быть не меньше 1000.

целое число

view

да

Ссылка на списочное представление или на представление списков с вкладками.

Поле доступно только для типа root_menu.

View ID Ref

items

да

Дочерние элементы для корневой группы меню. Массив записей меню с подразделами типов сущностей. Используется для типа элементов меню root_menu.

Ознакомьтесь с описанием поля items.

массив

Структура `items`

Поле items используется для создания массива записей пунктов меню в разделе домена.

Запись включает следующие поля:

Поле Обязательное поле Описание Тип данных

Поле	Обязательное поле	Описание	Тип данных
`id`	да	Идентификатор элемента меню.	View ID
`description`	нет	Описание меню. Не выводится в представлениях.	строка
`route`	да	Компонент адреса текущего пункта меню, отображаемый в строке веб-браузера. Фактически определяет путь в адресной строке, по которому можно перейти на целевую страницу.	путь в URL
`label`	да	Отображаемое в меню системы название пункта меню.	строка
`type`	да	Тип элемента меню. Устанавливается значение `menu` — дочерний элемент меню, который может быть задан только в рамках массива элементов корневой группы.	перечисление
`view`	да	Ссылка на представление. Ссылка на списочное представление или на представление списков с вкладками.	View ID Ref
`priority`	нет	Параметр, определяющий положение элемента в корневом меню, чем больше — тем выше в списке. Значение должно быть не меньше `1000`.	целое число

id

да

Идентификатор элемента меню.

View ID

description

нет

Описание меню. Не выводится в представлениях.

строка

route

да

путь в URL

label

да

Отображаемое в меню системы название пункта меню.

строка

type

да

Тип элемента меню.

Устанавливается значение menu — дочерний элемент меню, который может быть задан только в рамках массива элементов корневой группы.

перечисление

view

да

Ссылка на представление. Ссылка на списочное представление или на представление списков с вкладками.

View ID Ref

priority

нет

Параметр, определяющий положение элемента в корневом меню, чем больше — тем выше в списке. Значение должно быть не меньше 1000.

целое число

Структура `medias`

Поле medias представляет собой массив записей элементов иконок.

Запись включает следующие поля:

Поле Обязательное поле Значение по умолчанию Описание Тип данных Комментарий

Поле	Обязательное поле	Значение по умолчанию	Описание	Тип данных	Комментарий
`id`	да		Идентификатор иконки, которая будет использоваться в виджетах представлений и элементах меню.	View ID
`description`	нет	Пустая строка	Описание элемента домена.	строка	Не выводится в представлениях. Отображается в схеме домена
`type`	да		Тип иконки.	перечисление	Определяет тип медиа ресурса и его возможности. В текущей реализации поддерживается один тип иконки `icon_name` — именованная иконка из дизайн-системы.
`iconName`	да		Идентификатор медиаресурса в библиотеке	строка

id

да

Идентификатор иконки, которая будет использоваться в виджетах представлений и элементах меню.

View ID

description

нет

Пустая строка

Описание элемента домена.

строка

Не выводится в представлениях. Отображается в схеме домена

type

да

Тип иконки.

перечисление

Определяет тип медиа ресурса и его возможности.

В текущей реализации поддерживается один тип иконки icon_name — именованная иконка из дизайн-системы.

iconName

да

Идентификатор медиаресурса в библиотеке

строка

Структура `views`

Поле views представляет собой массив записей, описывающих различные интерфейсы системы (представления). Каждая запись включает общие поля, а также специфические поля, которые зависят от типа представления, указанного в поле type.

Общие поля для всех типов представлений

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

Поле Обязательность и значение по умолчанию Описание Тип данных

Поле	Обязательность и значение по умолчанию	Описание	Тип данных
`id`	Да	Уникальный идентификатор интерфейса.	View ID
`type`	Да	Тип интерфейса. Определяет, какие специфические поля будут применяться. Ознакомьтесь со списком доступных типов.	перечисление
`label`	Нет (по умолчанию: пустая строка)	Наименование, используемое в заголовках. Для полноэкранной карточки поддерживаются форматы: `"строка"` или `"{<attribute_id>}"`.	строка
`description`	Нет (по умолчанию: пустая строка)	Описание элемента. Не выводится в интерфейсе, но отображается на схеме домена.	строка

id

Да

Уникальный идентификатор интерфейса.

View ID

type

Да

Тип интерфейса. Определяет, какие специфические поля будут применяться. Ознакомьтесь со списком доступных типов.

перечисление

label

Нет (по умолчанию: пустая строка)

Наименование, используемое в заголовках. Для полноэкранной карточки поддерживаются форматы: "строка" или "{<attribute_id>}".

строка

description

Нет (по умолчанию: пустая строка)

Описание элемента. Не выводится в интерфейсе, но отображается на схеме домена.

строка

Допустимые типы представлений (`type`)

Поле type может принимать следующие значения:

entity — представление одного объекта (панели, модальные окна).
page — представление полноэкранной карточки объекта.
list — представление списка объектов (таблица с фильтрами и действиями).
tabs_list — группа вкладок, каждая из которых содержит список объектов.
dashboard — дашборд (группа виджетов-плиток с действиями).
tree — представление древовидных связей.

Поля, применимые при `type: entity`

Эта таблица описывает поля, применимые для представлений типа entity.

Поле Обязательность и значение по умолчанию Описание Тип данных

Поле	Обязательность и значение по умолчанию	Описание	Тип данных
`entity`	Да	Ссылка на идентификатор сущности.	Data ID Ref или FQID
`widgets`	Да	Массив записей виджетов, используемых в представлении.	массив
`groups`	Да	Массив записей групп (блоков, вкладок, форм).	массив
`views`	Да	Массив записей, описывающих конкретные панели и модальные окна.	массив

entity

Да

Ссылка на идентификатор сущности.

Data ID Ref или FQID

widgets

Да

Массив записей виджетов, используемых в представлении.

массив

groups

Да

Массив записей групп (блоков, вкладок, форм).

массив

views

Да

Массив записей, описывающих конкретные панели и модальные окна.

массив

Поля, применимые при `type: page`

Эта таблица описывает поля, применимые для представлений типа page (полноэкранная карточка).

Поле Обязательность и значение по умолчанию Описание Тип данных

Поле	Обязательность и значение по умолчанию	Описание	Тип данных
`entity`	Да	Ссылка на идентификатор сущности.	Data ID Ref или FQID
`widgets`	Да	Массив записей виджетов, используемых в представлении.	массив
`groups`	Да	Массив записей групп (блоков, вкладок, форм).	массив
`block`	Нет	Массив ссылок на группы или виджеты, отображаемые в карточке. Нельзя использовать одновременно с `tabs`.	массив ссылок
`tabs`	Нет	Массив ссылок на вкладки, отображаемые в карточке. Нельзя использовать одновременно с `block`.	массив ссылок
`pinnedView`	Нет	Блок, закрепленный в карточке для постоянного отображения.	объект

entity

Да

Ссылка на идентификатор сущности.

Data ID Ref или FQID

widgets

Да

Массив записей виджетов, используемых в представлении.

массив

groups

Да

Массив записей групп (блоков, вкладок, форм).

массив

block

Нет

Массив ссылок на группы или виджеты, отображаемые в карточке. Нельзя использовать одновременно с tabs.

массив ссылок

tabs

Нет

Массив ссылок на вкладки, отображаемые в карточке. Нельзя использовать одновременно с block.

массив ссылок

pinnedView

Нет

Блок, закрепленный в карточке для постоянного отображения.

объект

Структура `pinnedView`

Настройки в поле pinnedView определяют, какой блок будет закреплен для постоянного отображения в карточке. Поле имеет следующую структуру:

Поле Обязательность и значение по умолчанию Описание Тип данных

Поле	Обязательность и значение по умолчанию	Описание	Тип данных
`block`	Да	Ссылка на группу или виджет, закрепленные на странице.	Data ID Ref
`position`	Нет	Параметры закрепления блока. Допустимые значения: `top` — блок закрепляется вверху; `bottom` — блок закрепляется внизу.	перечисление
`minHeight`	Нет	Минимальная высота блока. Задается в процентах или пикселях (например, `25%` или `25px`).	строка
`maxHeight`	Нет	Максимальная высота блока. Задается в процентах или пикселях (например, `25%` или `25px`).	строка

block

Да

Ссылка на группу или виджет, закрепленные на странице.

Data ID Ref

position

Нет

Параметры закрепления блока. Допустимые значения:

top — блок закрепляется вверху;
bottom — блок закрепляется внизу.

перечисление

minHeight

Нет

Минимальная высота блока. Задается в процентах или пикселях (например, 25% или 25px).

строка

maxHeight

Нет

Максимальная высота блока. Задается в процентах или пикселях (например, 25% или 25px).

строка

Поля, применимые при `type: list`

Эта таблица описывает поля, применимые для представлений типа list.

Поле Обязательность и значение по умолчанию Описание Тип данных

Поле	Обязательность и значение по умолчанию	Описание	Тип данных
`source`	Да	Источник списка объектов.	объект
`actionPanel`	Нет (по умолчанию: пустой массив)	Массив ссылок на виджеты действий, отображаемые на панели действий над списком.	массив ссылок
`table`	Да	Таблица списка объектов. Доступно для интерфейса списка объектов. Ознакомьтесь с описанием поля `table`.	объект

source

Да

Источник списка объектов.

объект

actionPanel

Нет (по умолчанию: пустой массив)

Массив ссылок на виджеты действий, отображаемые на панели действий над списком.

массив ссылок

table

Да

Таблица списка объектов. Доступно для интерфейса списка объектов. Ознакомьтесь с описанием поля table.

объект

Структура `source`

Поле source представляет собой параметры источника объектов для списка. Запись включает следующие поля:

Поле Обязательность и значение по умолчанию Описание Тип данных

Поле	Обязательность и значение по умолчанию	Описание	Тип данных
`type`	Да (по умолчанию: `operational`)	Тип источника. Всегда устанавливается значение `operational` (база данных системы).	перечисление
`entity`	Да	Ссылка на сущность, данные объектов и связей которой отображаются в списке.	Data ID Ref или FQID
`joins`	Нет	Массив записей связей с сущностями, данные которых будут отображаться в списке. Подробнее.	массив

type

Да (по умолчанию: operational)

Тип источника. Всегда устанавливается значение operational (база данных системы).

перечисление

entity

Да

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

Data ID Ref или FQID

joins

Нет

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

массив

Структура `joins`

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

Поле Обязательность и значение по умолчанию Описание Тип данных

Поле	Обязательность и значение по умолчанию	Описание	Тип данных
`id`	Да	Идентификатор связи.	Data ID
`linkage`	Да	Ссылка на связь с сущностью.	Data ID Ref
`side`	Нет	Сторона связи. Доступные значения: `side 1` `side 2`	перечисление
`description`	Нет (по умолчанию: пустая строка)	Описание связи.	строка

id

Да

Идентификатор связи.

Data ID

linkage

Да

Ссылка на связь с сущностью.

Data ID Ref

side

Нет

Сторона связи. Доступные значения:

side 1
side 2

перечисление

description

Нет (по умолчанию: пустая строка)

Описание связи.

строка

Поля, применимые при `type: tabs_list`

Эта таблица описывает поля, применимые для представлений типа tabs_list.

Поле Обязательность и значение по умолчанию Описание Тип данных

Поле	Обязательность и значение по умолчанию	Описание	Тип данных
`defaultTab`	Нет (по умолчанию: первая вкладка)	View ID Ref вкладки, которая будет открыта по умолчанию.	View ID Ref
`tabs`	Да	Массив ссылок на идентификаторы описаний интерфейсов списков. Формат: `tabs: - view: <ссылка>`	массив ссылок

defaultTab

Нет (по умолчанию: первая вкладка)

View ID Ref вкладки, которая будет открыта по умолчанию.

View ID Ref

tabs

Да

Массив ссылок на идентификаторы описаний интерфейсов списков.
Формат: tabs: - view: <ссылка>

массив ссылок

Поля, применимые при `type: dashboard`

Эта таблица описывает поля, применимые для представлений типа dashboard.

Поле Обязательность и значение по умолчанию Описание Тип данных

Поле	Обязательность и значение по умолчанию	Описание	Тип данных
`widgets`	Да	Массив записей виджетов, используемых на дашборде.	массив
`layout`	Нет	Настройки взаимного расположения виджетов на дашборде.	объект

widgets

Да

Массив записей виджетов, используемых на дашборде.

массив

layout

Нет

Настройки взаимного расположения виджетов на дашборде.

объект

Структура `layout` (в интерфейсе дашбордов)

В поле layout задаются настройки взаимного расположения компонентов в интерфейсе. Оно включает следующие поля:

Поле Обязательность и значение по умолчанию Описание Тип данных

Поле	Обязательность и значение по умолчанию	Описание	Тип данных
`type`	Нет (по умолчанию: `grid`)	Тип взаимного расположения виджетов. Значение `grid` позволяет расположить виджеты в виде сетки.	перечисление
`columns`	Нет (по умолчанию: `3`)	Количество столбцов в сетке (при `type: grid`).	число

type

Нет (по умолчанию: grid)

Тип взаимного расположения виджетов. Значение grid позволяет расположить виджеты в виде сетки.

перечисление

columns

Нет (по умолчанию: 3)

Количество столбцов в сетке (при type: grid).

число

Поля, применимые при `type: tree`

Эта таблица описывает поля, применимые для представлений типа tree (древовидные связи).

Поле Обязательность и значение по умолчанию Описание Тип данных

Поле	Обязательность и значение по умолчанию	Описание	Тип данных
`tree`	Да	Ссылка на идентификатор дерева, описанного в блоке `trees` схемы домена.	Data ID Ref
`nodeChunkSize`	Да	В интерфейсе рядом со свернутым узлом связи дерева отображается команда Показать еще n, где `n` — параметр пагинации. При нажатии на нее будет развернуто указанное количество узлов связи.	целое число
`variant`	Да	Определяет, как будет отображаться представление. Доступные значения: `splitted` — вариант представления Каталог (два окна). `merged` — вариант представления Дерево в списочном представлении (одно окно). Ознакомьтесь с описанием поля `variant`.	перечисление
`ordering`	Нет (по умолчанию: `false`)	Булево поле, разрешающее изменять расположение узлов в дереве. Требует, чтобы в самом дереве (`trees`) был указан тип `orderable`.	булево
`list`	Да (для древовидных связей при `variant: splitted`)	Ссылка на идентификатор описания интерфейса списка объектов.	ViewID
`rootText`	Нет	Название корневого узла древовидной структуры узлов связи в окне слева. Доступно для древовидных связей при `variant: splitted`.	строка
`catalogTitle`	Да	Заголовок окна со списком объектов в листовых узлах. Доступно для древовидных связей при `variant: splitted`.	строка
`menuOptions`	Нет	Массив записей со ссылками на действия, доступные в представлении. Доступно для древовидных связей при `variant: splitted`. Действия отображаются при нажатии на иконку с тремя точками в правом окне. Ознакомьтесь с описанием поля `menuOptions`.	массив
`table`	Да	Настройки табличного отображения.	объект

tree

Да

Ссылка на идентификатор дерева, описанного в блоке trees схемы домена.

Data ID Ref

nodeChunkSize

Да

В интерфейсе рядом со свернутым узлом связи дерева отображается команда Показать еще n, где n — параметр пагинации. При нажатии на нее будет развернуто указанное количество узлов связи.

целое число

variant

Да

Определяет, как будет отображаться представление. Доступные значения:

splitted — вариант представления Каталог (два окна).
merged — вариант представления Дерево в списочном представлении (одно окно). Ознакомьтесь с описанием поля variant.

перечисление

ordering

Нет (по умолчанию: false)

Булево поле, разрешающее изменять расположение узлов в дереве. Требует, чтобы в самом дереве (trees) был указан тип orderable.

булево

list

Да (для древовидных связей при variant: splitted)

Ссылка на идентификатор описания интерфейса списка объектов.

ViewID

rootText

Нет

Название корневого узла древовидной структуры узлов связи в окне слева. Доступно для древовидных связей при variant: splitted.

строка

catalogTitle

Да

Заголовок окна со списком объектов в листовых узлах. Доступно для древовидных связей при variant: splitted.

строка

menuOptions

Нет

Массив записей со ссылками на действия, доступные в представлении. Доступно для древовидных связей при variant: splitted. Действия отображаются при нажатии на иконку с тремя точками в правом окне. Ознакомьтесь с описанием поля menuOptions.

массив

table

Да

Настройки табличного отображения.

объект

Поле `variant`

Значения поля variant определяет отображение представления древовидной связи:

Если в поле установлено значение splitted, в представлении отобразятся два окна:
- окно с деревом узлов связи;
- окно со списком объектов в листовых узлах, являющихся дочерними для узла, выбранного в окне с деревом.
Если установлено значение merged, в представлении отобразится одно окно, содержащее дерево узлов связи и список объектов в листовых узлах, являющихся дочерними для узла, выбранного в дереве.

Поле `menuOptions`

Поле menuOptions содержит массив записей со ссылками на действия, доступные в представлении варианта splitted.

Запись включает следующие поля:

Поле Обязательное поле Описание Тип данных

Поле	Обязательное поле	Описание	Тип данных
`action`	да	Ссылка на идентификатор действия над сущностью в представлении	Data ID Ref

action

да

Ссылка на идентификатор действия над сущностью в представлении

Data ID Ref

Структура `widgets`

Поле widgets представляет собой массив записей, описывающих виджеты — визуальные компоненты интерфейса. Каждая запись виджета включает общие поля, а также специфические поля, которые зависят от типа виджета, указанного в поле type.

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

Поле Обязательность и значение по умолчанию Описание Тип данных

Поле	Обязательность и значение по умолчанию	Описание	Тип данных
`id`	Да	Уникальный идентификатор виджета.	View ID
`type`	Да	Тип виджета. Определяет, какие специфические поля будут применяться. Ознакомьтесь со списком доступных типов.	перечисление
`description`	Нет	Описание виджета.	строка

id

Да

Уникальный идентификатор виджета.

View ID

type

Да

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

перечисление

description

Нет

Описание виджета.

строка

Допустимые типы виджетов (`type`)

Поле type в записи виджета может принимать следующие значения:

attribute — виджет атрибута, позволяющий отображать и редактировать значение атрибута объекта.
action — виджет действия, позволяющий запускать действие с передачей контекста.
linkage — виджет связи, позволяющий отображать и менять список связанных объектов.
visualization — виджет графического отображения (графики, диаграммы).
history — виджет истории изменений, отображающий события аудита.
comments — виджет комментариев.
linkage_list — виджет списка связей.
card — виджет для дашбордов.
conversation — виджет переписок.

Поля, применимые при `type: attribute`

Эта таблица описывает поля, применимые для виджетов типа attribute.

Поле Обязательность и значение по умолчанию Описание Тип данных

Поле	Обязательность и значение по умолчанию	Описание	Тип данных
`attribute`	Да	Ссылка на атрибут сущности, значение которого будет отображаться и редактироваться.	Data ID Ref
`control`	Нет	Элемент управления для отображения атрибута. Если не указан, определяется автоматически.	объект
`rowHeight`	Нет	Высота поля по умолчанию в количестве текстовых строк (только для атрибутов типа `array`).	целое число

attribute

Да

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

Data ID Ref

control

Нет

Элемент управления для отображения атрибута. Если не указан, определяется автоматически.

объект

rowHeight

Нет

Высота поля по умолчанию в количестве текстовых строк (только для атрибутов типа array).

целое число

Поля, применимые при `type: action`

Эта таблица описывает поля, применимые для виджетов типа action.

Поле Обязательность и значение по умолчанию Описание Тип данных

Поле	Обязательность и значение по умолчанию	Описание	Тип данных
`action`	Да (если `actions` не задано)	Ссылка на одно действие, которое будет выполняться. Нельзя использовать одновременно с `actions`.	View ID Ref
`actions`	Да (если `action` не задано)	Массив ссылок на действия. Формирует выпадающее меню. Нельзя использовать одновременно с `action`.	массив ссылок
`control`	Нет	Элемент управления (кнопка). Можно задать иконку.	объект

action

Да (если actions не задано)

Ссылка на одно действие, которое будет выполняться. Нельзя использовать одновременно с actions.

View ID Ref

actions

Да (если action не задано)

Массив ссылок на действия. Формирует выпадающее меню. Нельзя использовать одновременно с action.

массив ссылок

control

Нет

Элемент управления (кнопка). Можно задать иконку.

объект

Поля, применимые при `type: linkage`

Эта таблица описывает поля, применимые для виджетов типа linkage.

Поле Обязательность и значение по умолчанию Описание Тип данных

Поле	Обязательность и значение по умолчанию	Описание	Тип данных
`linkage`	Да	Ссылка на связь сущности, состав которой будет отображаться и редактироваться.	Data ID Ref
`side`	Да (для внешней связи) (по умолчанию: `2`)	Сторона связи. Возможные значения: `1` — виджет отображает сторону 1 (один объект). `2` — виджет отображает сторону 2 (несколько объектов).	перечисление
`label`	Нет (по умолчанию: пустая строка)	Наименование связи, отображаемое в виджете.	строка
`control`	Нет	Элемент управления для отображения связи. Возможные значения: `select` — для связей 1-1 или 1-N (со стороны `side: 1`). `multi_select` — для связей N-N или 1-N (со стороны `side: 2`). `table` — для связей N-N или 1-N (со стороны `side: 2`), рекомендуется для большого числа объектов.	объект

linkage

Да

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

Data ID Ref

side

Да (для внешней связи) (по умолчанию: 2)

Сторона связи. Возможные значения:

1 — виджет отображает сторону 1 (один объект).
2 — виджет отображает сторону 2 (несколько объектов).

перечисление

label

Нет (по умолчанию: пустая строка)

Наименование связи, отображаемое в виджете.

строка

control

Нет

Элемент управления для отображения связи. Возможные значения:

select — для связей 1-1 или 1-N (со стороны side: 1).
multi_select — для связей N-N или 1-N (со стороны side: 2).
table — для связей N-N или 1-N (со стороны side: 2), рекомендуется для большого числа объектов.

объект

Поля, применимые при `type: visualization`

Эта таблица описывает поля, применимые для виджетов типа visualization.

Поле Обязательность и значение по умолчанию Описание Тип данных

Поле	Обязательность и значение по умолчанию	Описание	Тип данных
`name`	Нет	Название визуализации.	строка
`rql`	Да	RQL-запрос для построения визуализации.	RQL-запрос
`arguments`	Да	Массив атрибутов сущности, используемых как переменные в RQL-запросе.	массив
`last`	Да	Временной период отображения данных.	объект
`limit`	Да	Ограничение на количество строк в результате RQL-запроса.	целое число
`source`	Да	Тип источника данных. Устанавливается значение `search`.	перечисление
`chartType`	Да	Тип визуализации. Доступные значения: `BAR_CHART` — столбчатая диаграмма; `LINE_CHART` — график; `PIE_CHART` — круговая диаграмма; `STACKED_BAR_CHART` — столбчатая диаграмма с накоплением; `TABLE` — таблица; `TOTAL` — итог.	перечисление
`searchEntity`	Да	Имя переменной, соответствующей хранилищу событий или активному списку.	массив
`nameMapping`	Да	Сопоставление полей данных с элементами графика (оси, группировка).	массив

name

Нет

Название визуализации.

строка

rql

Да

RQL-запрос для построения визуализации.

RQL-запрос

arguments

Да

Массив атрибутов сущности, используемых как переменные в RQL-запросе.

массив

last

Да

Временной период отображения данных.

объект

limit

Да

Ограничение на количество строк в результате RQL-запроса.

целое число

source

Да

Тип источника данных. Устанавливается значение search.

перечисление

chartType

Да

Тип визуализации. Доступные значения:

BAR_CHART — столбчатая диаграмма;
LINE_CHART — график;
PIE_CHART — круговая диаграмма;
STACKED_BAR_CHART — столбчатая диаграмма с накоплением;
TABLE — таблица;
TOTAL — итог.

перечисление

searchEntity

Да

Имя переменной, соответствующей хранилищу событий или активному списку.

массив

nameMapping

Да

Сопоставление полей данных с элементами графика (оси, группировка).

массив

Поля, применимые при `type: history`

Эта таблица описывает поля, применимые для виджетов типа history.

Поле Обязательность и значение по умолчанию Описание Тип данных

Поле	Обязательность и значение по умолчанию	Описание	Тип данных
`eventStorageId`	Да	Идентификатор хранилища событий, из которого загружаются события для отображения.	строка

eventStorageId

Да

Идентификатор хранилища событий, из которого загружаются события для отображения.

строка

Поля, применимые при `type: comments`

Виджет типа comments использует только общие поля, описанные в разделе Общие поля для всех типов виджетов. Дополнительных специфических полей для этого типа не требуется.

Поля, применимые при `type: linkage_list`

Эта таблица описывает поля, применимые для виджетов типа linkage_list.

Поле Обязательность и значение по умолчанию Описание Тип данных

Поле	Обязательность и значение по умолчанию	Описание	Тип данных
`rules`	Да	Правило, определяющее, какие связи доступны для просмотра и редактирования. Если не заполнено, доступны все связи.	объект

rules

Да

Правило, определяющее, какие связи доступны для просмотра и редактирования. Если не заполнено, доступны все связи.

объект

Поля, применимые при `type: card`

Эта таблица описывает поля, применимые для виджетов типа card (используются на дашбордах).

Поле Обязательность и значение по умолчанию Описание Тип данных

Поле	Обязательность и значение по умолчанию	Описание	Тип данных
`icon`	Нет	Ссылка на идентификатор медиаресурса (иконки).	View ID Ref
`action`	Да (в `actions` на уровне `views`)	Ссылка на действие, которое будет запускаться при клике на виджет.	View ID Ref

icon

Нет

Ссылка на идентификатор медиаресурса (иконки).

View ID Ref

action

Да (в actions на уровне views)

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

View ID Ref

Поля, применимые при `type: conversation`

Эта таблица описывает поля, применимые для виджетов типа conversation.

Поле Обязательность и значение по умолчанию Описание Тип данных

Поле	Обязательность и значение по умолчанию	Описание	Тип данных
`linkage`	Да	Ссылка на связь сущности из текущего домена с сущностью `Message`.	Data ID Ref
`conversationTransports`	Нет	Массив для ограничения доступных транспортов (например, только email). Если не указан, доступны все транспорты.	массив

linkage

Да

Ссылка на связь сущности из текущего домена с сущностью Message.

Data ID Ref

conversationTransports

Нет

Массив для ограничения доступных транспортов (например, только email). Если не указан, доступны все транспорты.

массив

Структура `groups`

Поле groups представляет собой массив записей визуальных элементов, на которые ссылается представление.

Поле groups включает следующие поля:

Поле Обязательное поле Значение по умолчанию Описание Тип данных Комментарий

Поле	Обязательное поле	Значение по умолчанию	Описание	Тип данных	Комментарий
`id`	да		Уникальный идентификатор группы представления.	View ID
`description`	нет	Пустая строка	Описание группы представления.	строка
`type`	да		Тип группы.	перечисление	Доступные значения: `block` — блок. `form` — форма создания или редактирования объекта. `resizable_block_pair` — блок, содержащий две секции с регулируемыми размерами. Используется в полноэкранной карточке объекта; `tab` — вкладка. `tabs` — панель вкладок полноэкранного представления объекта. Используется в полноэкранной карточке объекта. Блоки, вкладки и формы описаны ниже.
`layout`	нет		Настройки взаимного расположения компонентов в группе.	размещение компонентов группы представлений	Ознакомьтесь с описанием поля `layout`. Доступно только для типов `block` и `resizable_block_pair`.
`components`	да		Массив записей блоков, из которых состоит вкладка.	массив	Ознакомьтесь с описанием поля `components`.
`menu`	нет		Меню группы представления.	массив	Доступно только для типа `tab`
`label`	нет	Пустая строка	Наименование группы представления.	строка	Доступно только для типов: `block`; `tab`.

id

да

Уникальный идентификатор группы представления.

View ID

description

нет

Пустая строка

Описание группы представления.

строка

type

да

Тип группы.

перечисление

Доступные значения:

block — блок.
form — форма создания или редактирования объекта.
resizable_block_pair — блок, содержащий две секции с регулируемыми размерами. Используется в полноэкранной карточке объекта;
tab — вкладка.
tabs — панель вкладок полноэкранного представления объекта. Используется в полноэкранной карточке объекта.

Блоки, вкладки и формы описаны ниже.

layout

нет

Настройки взаимного расположения компонентов в группе.

размещение компонентов группы представлений

Ознакомьтесь с описанием поля layout.

Доступно только для типов block и resizable_block_pair.

components

да

Массив записей блоков, из которых состоит вкладка.

массив

Ознакомьтесь с описанием поля components.

menu

нет

Меню группы представления.

массив

Доступно только для типа tab

label

нет

Пустая строка

Наименование группы представления.

строка

Доступно только для типов:

block;
tab.

Структура `layout` (в группе представления)

Поле layout представляет собой массив записей настроек взаимного расположения элементов. Доступно только для типов block и resizable_block_pair.

Описание поля для типа block

Запись включает следующие поля:

Поле Обязательное поле Значение по умолчанию Описание Тип данных Комментарий

Поле	Обязательное поле	Значение по умолчанию	Описание	Тип данных	Комментарий
`direction`	да		Порядок отображения элементов в записи группы	строка	Направление размещения определяет, как будут располагаться компоненты внутри группы. Возможное значение — `column`, вертикальное размещение. Используется по умолчанию, если элемент размещения не был указан для группы.
`expandable`	нет	false	Возможность развернуть элемент	булево	Доступные значения: `true` — элемент можно развернуть; `false` — элемент нельзя развернуть.

direction

да

Порядок отображения элементов в записи группы

строка

Направление размещения определяет, как будут располагаться компоненты внутри группы.

Возможное значение — column, вертикальное размещение. Используется по умолчанию, если элемент размещения не был указан для группы.

expandable

нет

false

Возможность развернуть элемент

булево

Доступные значения:

true — элемент можно развернуть;
false — элемент нельзя развернуть.

Описание поля для типа resizable_block_pair

Запись включает следующие поля:

Поле Обязательное поле Значение по умолчанию Описание Тип данных Комментарий

Поле	Обязательное поле	Описание	Тип данных	Комментарий
`minHeight`	нет	Минимальная высота блока	строка	Задается в процентах или пикселях. Формат: числовое значение и единица измерения без пробелов. Например, `<25%>` или `<25px>`.
`maxHeight`	нет	Максимальная высота блока	строка	Задается в процентах или пикселях. Формат: числовое значение и единица измерения без пробелов. Например, `<25%>` или `<25px>`.
`sizeRatio`	нет	Соотношение размеров секций	строка	Можно указать либо одну из сторон, либо обе стороны. Сначала указывается значение для левой секции, а затем для правой. Формат: `{ left: 60, right: 40 }`

minHeight

нет

Минимальная высота блока

строка

Задается в процентах или пикселях.

Формат: числовое значение и единица измерения без пробелов. Например, <25%> или <25px>.

maxHeight

нет

Максимальная высота блока

строка

Задается в процентах или пикселях.

Формат: числовое значение и единица измерения без пробелов. Например, <25%> или <25px>.

sizeRatio

нет

Соотношение размеров секций

строка

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

Формат: { left: 60, right: 40 }

Структура `components`

Поле components используется для перечисления компонентов элемента поля groups. Такими компонентами могут быть:

виджеты — для блоков, форм и вкладок;
блоки — для форм, вкладок, панелей вкладок и блоков, содержащих две секции с регулируемыми размерами.

Поле components включает поля следующих типов:

Поле Описание Тип данных

Поле	Описание	Тип данных
`block`	Уникальный идентификатор блока. Блоки перечисляются только для типов `tab`, `tabs`, `form` и `resizable_block_pair`.	View ID Ref
`widget`	Уникальный идентификатор виджета.	View ID Ref

block

Уникальный идентификатор блока. Блоки перечисляются только для типов tab, tabs, form и resizable_block_pair.

View ID Ref

widget

Уникальный идентификатор виджета.

View ID Ref

Тип компонентов определяется типом группы:

Для групп типа block — ссылки на виджеты.
Для групп типа tab и form — ссылки на группы типа block, а также виджеты.
Для группы типа tabs — ссылки на группы типа tab.
Для группы типа resizable_block_pair — две ссылки на группы типа block или tabs.

Структура `views` (панели и модальные окна)

Конфигурация интерфейса объекта включает следующие поля:

Поле Обязательное поле Значение по умолчанию Описание Тип данных Комментарий

Поле	Обязательное поле	Значение по умолчанию	Описание	Тип данных	Комментарий
`id`	да		Уникальный идентификатор представления одного объекта.	View ID
`description`	нет	Пустая строка	Описание элемента домена.	строка
`type`	да		Тип представления одного объекта.	строка	Определяет тип представления одного объекта, который влияет на поведение и возможности интерфейса с учетом контекста использования. Возможные значения: `panel` — информационная панель, которая может отображать вкладки (группы представлений с типом `tab`); `modal` — модальное окно, которое может отображать форму (группу представлений с типом `form`).
`label`	нет	Пустая строка	Название, отображаемое в интерфейсе.	строка
`menu`	нет		Действия, отображаемые в меню панели.	массив	Доступно только для представлений с типом `panel`. Ознакомьтесь с описанием поля.
`tabs`	да		Вкладки, отображаемые в панели.	массив	Ознакомьтесь с описанием поля.
`form`			Ссылка на группу с типом `form`.	ссылка на форму
`buttons`			Массив записей кнопок, отображаемых в модальном окне.	массив	Доступно только для представлений с типом `modal`. Ознакомьтесь с описанием поля `buttons`.

id

да

Уникальный идентификатор представления одного объекта.

View ID

description

нет

Пустая строка

Описание элемента домена.

строка

type

да

Тип представления одного объекта.

строка

Определяет тип представления одного объекта, который влияет на поведение и возможности интерфейса с учетом контекста использования.

Возможные значения:

panel — информационная панель, которая может отображать вкладки (группы представлений с типом tab);
modal — модальное окно, которое может отображать форму (группу представлений с типом form).

label

нет

Пустая строка

Название, отображаемое в интерфейсе.

строка

menu

нет

Действия, отображаемые в меню панели.

массив

Доступно только для представлений с типом panel.

Ознакомьтесь с описанием поля.

tabs

да

Вкладки, отображаемые в панели.

массив

Ознакомьтесь с описанием поля.

form

Ссылка на группу с типом form.

ссылка на форму

buttons

Массив записей кнопок, отображаемых в модальном окне.

массив

Доступно только для представлений с типом modal.

Ознакомьтесь с описанием поля buttons.

Схема записи панели

 views:
      # Уникальный идентификатор.
      - id:
        # Описание.
        description:
        # Тип представления (панель).
        type: panel
        # Название панели.
        label:
       # Меню панели.
       menu:
          # Действие.
          - action:
            # Параметры управления.
      # Массив записей вкладок панели.
      tabs:
          # Идентификатор вкладки.
          - tab:

Схема записи модального окна

views:
 # Уникальный идентификатор.
 id:
 # Описание.
 description:
 # Тип представления (модальное окно).
 type: modal
 # Ссылка на форму (описывается в поле groups с типом form).
 form:
 # Название модального окна.
 label:

Схема записи блока из двух секций регулируемой ширины

groups:
   # Идентификатор записи в группе
   - id:
        # Описание записи в группе
        description:
        # Тип записи в группе
        type: resizable_block_pair
        # Настройки взаимного расположения элементов
        layout:
          # Минимальная высота секций
          minHeight:
          # Максимальная высота секций
          maxHeight:
          # Параметр расположения элементов
          sizeRatio:
        # Ссылки на блоки, отображаемые в блоке из двух секций
        components:
          # Ссылка на первый блок вкладки
          - block: deviceInfoBlock
          # Ссылка на второй блок вкладки
          - block: deviceConfigurationBlock

Структура `menu`

Поле menu представляет собой массив записей элементов меню.

Запись включает следующие поля:

Поле Обязательное поле Значение по умолчанию Описание Тип данных Комментарий

Поле	Обязательное поле	Значение по умолчанию	Описание	Тип данных	Комментарий
`action`	да		Ссылка на действие, вызываемое в меню.	View ID Ref	Действие, которое будет вызвано при нажатии на элемент меню. Действия, которые работают с контекстом списка, могут быть недоступны, если в списке не выбраны нужные данные. Например, действие массового удаления объектов не будет работать, если в списке не выбран ни один объект.

action

да

Ссылка на действие, вызываемое в меню.

View ID Ref

Действие, которое будет вызвано при нажатии на элемент меню.

Действия, которые работают с контекстом списка, могут быть недоступны, если в списке не выбраны нужные данные. Например, действие массового удаления объектов не будет работать, если в списке не выбран ни один объект.

Структура `buttons`

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

Запись включает следующие поля:

Поле Описание Тип данных Комментарий

Поле	Описание	Тип данных	Комментарий
`type`	Идентификатор модального окна.	строка	Доступные значения типа: `submit` — при нажатии на кнопку данные отправляются в систему; `close` — при нажатии на кнопку окно закрывается, а данные не отправляются.
`label`	Название кнопки.	строка	Необязательное поле. Если значение не указано, система добавляет название по умолчанию.

type

Идентификатор модального окна.

строка

Доступные значения типа:

submit — при нажатии на кнопку данные отправляются в систему;
close — при нажатии на кнопку окно закрывается, а данные не отправляются.

label

Название кнопки.

строка

Необязательное поле. Если значение не указано, система добавляет название по умолчанию.

Схема записи кнопки

buttons:
    # Название кнопки.
    label:
     # Описание типа кнопки.
     - type:
        # Описание настроек параметров управления.
        control:
            # Тип параметра управления (кнопка).
            type: regular_button
            # Идентификатор медиаресурса для иконки кнопки.
            icon:

Структура `layout` (в интерфейсе дашбордов)

В поле layout задаются настройки взаимного расположения компонентов в интерфейсе.

Оно включает следующие поля:

Поле Обязательное поле Значение по умолчанию Описание Тип данных Комментарий

Поле	Обязательное поле	Значение по умолчанию	Описание	Тип данных	Комментарий
`type`	нет	grid	Тип взаимного расположения виджетов в интерфейсе.	перечисление	Значение `grid` позволяет расположить виджеты в виде сетки
`columns`	нет	3	Количество столбцов в интерфейсе виджетов.	число	Значение указывается, если в поле `type` указано значение `grid`.

type

нет

grid

Тип взаимного расположения виджетов в интерфейсе.

перечисление

Значение grid позволяет расположить виджеты в виде сетки

columns

нет

Количество столбцов в интерфейсе виджетов.

число

Значение указывается, если в поле type указано значение grid.

Структура `table` (список объектов)

Поле table содержит настройки табличного отображения сведений о списке объектов.

Оно включает следующие поля:

Поле Обязательное поле Значение по умолчанию Описание Тип данных Комментарий

Поле	Обязательное поле	Значение по умолчанию	Описание	Тип данных	Комментарий
`columns`	да		Массив записей с описанием столбцов таблицы.	массив столбцов таблицы	Ознакомьтесь с описанием поля `columns`.
`filter`	нет		Настройки фильтрации столбцов.	объект	Ознакомьтесь с описанием поля `filter`.
`sortingBy`	нет		Ссылки на правила сортировки атрибутов сущности.	объект	Ознакомьтесь с описанием поля `sortingBy`.
`paging`	нет		Пагинация данных.	объект Ознакомьтесь с описанием поля `paging`.	refresh
`нет`		Обновление данных.	объект	Ознакомьтесь с описанием поля `refresh`.	selection
`нет`	`false`	Возможность выбора строки таблицы.	булево	Ознакомьтесь с описанием поля `selection`.	actions
`нет`	Пустой массив	Действие при нажатии на строку таблицы.	массив действий на события таблицы	Ознакомьтесь с описанием поля `actions`.	empty
`нет`			Информация, отображаемая в таблице, если данные отсутствуют.	сообщение при отсутствии строк в таблице	Ознакомьтесь с описанием поля `empty`.

columns

да

Массив записей с описанием столбцов таблицы.

массив столбцов таблицы

Ознакомьтесь с описанием поля columns.

filter

нет

Настройки фильтрации столбцов.

объект

Ознакомьтесь с описанием поля filter.

sortingBy

нет

Ссылки на правила сортировки атрибутов сущности.

объект

Ознакомьтесь с описанием поля sortingBy.

paging

нет

Пагинация данных.

объект Ознакомьтесь с описанием поля paging.

refresh

нет

Обновление данных.

объект

Ознакомьтесь с описанием поля refresh.

selection

нет

false

Возможность выбора строки таблицы.

булево

Ознакомьтесь с описанием поля selection.

actions

нет

Пустой массив

Действие при нажатии на строку таблицы.

массив действий на события таблицы

Ознакомьтесь с описанием поля actions.

empty

нет

Информация, отображаемая в таблице, если данные отсутствуют.

сообщение при отсутствии строк в таблице

Ознакомьтесь с описанием поля empty.

Структура `empty`

Поле empty содержит настройки отображения сообщения в таблице, если данные отсутствуют.

Настройка включает следующие поля:

Поле Описание Тип данных Комментарий

Поле	Описание	Тип данных	Комментарий
`message`	Отображение сообщения в таблице, если данные отсутствуют.	строка	Необходимо указать отображаемое сообщение в поле `message`.

message

Отображение сообщения в таблице, если данные отсутствуют.

строка

Необходимо указать отображаемое сообщение в поле message.

Структура `columns` (в таблице списка объектов)

Поле columns содержит массив записей столбцов таблицы.

Столбец включает следующие поля:

Поле Обязательное поле Значение по умолчанию Описание Тип данных Комментарий

Поле	Обязательное поле	Описание	Тип данных	Комментарий
`id`	да	Идентификатор столбца таблицы.	массив
`attribute`	да	Атрибут столбца.	строка	Можно использовать: обычные атрибуты; системные атрибуты; атрибуты связанной сущности; атрибуты таблицы. Таблица — атрибут пользовательского типа `Table`. При ее создании в блоке `attributes` указываются атрибуты таблицы. Атрибуты всех типов данных, поддерживаемых таблицей, можно отображать в столбце.
`join`	нет	Ссылка на идентификатор связи с сущностью, атрибут которой будет отображаться.	Data ID Ref	Значение в этом поле указывается, только если необходимо описать атрибут связанной сущности. Связь, на которую вы ссылаетесь, должна быть предварительно задана в поле `joins` в описании интерфейса списка объектов
`control`		Элемент управления для атрибута, отображаемого в колонке таблицы.	объект	Описывает элемент управления для атрибута, отображаемого в столбце таблицы, для древовидной связи — отображение пути от корня дерева до узла. Ознакомьтесь с описанием поля `control`.
`layout`	нет	Массив настроек размера и видимости столбца.	массив	Ознакомьтесь с описанием поля `layout`.
`label`	нет	Наименование столбца.	строка	Если значение этого поля не задано, в качестве наименования берется `id` столбца.

id

да

Идентификатор столбца таблицы.

массив

attribute

да

Атрибут столбца.

строка

Можно использовать:

обычные атрибуты;
системные атрибуты;
атрибуты связанной сущности;
атрибуты таблицы.

Таблица — атрибут пользовательского типа Table. При ее создании в блоке attributes указываются атрибуты таблицы. Атрибуты всех типов данных, поддерживаемых таблицей, можно отображать в столбце.

join

нет

Ссылка на идентификатор связи с сущностью, атрибут которой будет отображаться.

Data ID Ref

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

Связь, на которую вы ссылаетесь, должна быть предварительно задана в поле joins в описании интерфейса списка объектов

control

Элемент управления для атрибута, отображаемого в колонке таблицы.

объект

Описывает элемент управления для атрибута, отображаемого в столбце таблицы, для древовидной связи — отображение пути от корня дерева до узла. Ознакомьтесь с описанием поля control.

layout

нет

Массив настроек размера и видимости столбца.

массив

Ознакомьтесь с описанием поля layout.

label

нет

Наименование столбца.

строка

Если значение этого поля не задано, в качестве наименования берется id столбца.

Поле control в столбце таблицы

Поле control содержит настройку отображения в столбце значения атрибута, а также пути от корня дерева до узла при использовании таблицы в древовидной связи.

Настройка включает следующие поля:

Поле Обязательное поле Описание Тип данных Комментарий

Поле	Обязательное поле	Описание	Тип данных	Комментарий
`type`	да	Тип редактора, используемый в столбце, в соответствии с таблицей.	строка	В этом поле можно изменить используемый по умолчанию тип редактора в столбце на другой допустимый тип. Допустимые типы для разных контекстов представлены в таблице. Для пути от корня в представлении древовидной связи устанавливается значение `tree_path`
`treeFqid`	да (для древовидных связей)	Ссылка на идентификатор дерева	FQID Ref
`trueText`	да (при type: `bool_text`)	Отображаемая строка для значения `True`	строка
`falseText`	да (при type: `bool_text`)	Отображаемая строка для значения `False`	строка

type

да

Тип редактора, используемый в столбце, в соответствии с таблицей.

строка

В этом поле можно изменить используемый по умолчанию тип редактора в столбце на другой допустимый тип.

Допустимые типы для разных контекстов представлены в таблице.

Для пути от корня в представлении древовидной связи устанавливается значение tree_path

treeFqid

да (для древовидных связей)

Ссылка на идентификатор дерева

FQID Ref

trueText

да (при type: bool_text)

Отображаемая строка для значения True

строка

falseText

да (при type: bool_text)

Отображаемая строка для значения False

строка

Структура layout (в столбце списка объектов)

Поле layout содержит массив настроек размера и видимости.

Настройка включает следующие поля:

Поле Обязательное поле Значение по умолчанию Описание Тип данных Комментарий

Поле	Обязательное поле	Значение по умолчанию	Описание	Тип данных	Комментарий
`visible`	нет	`true`	Видимость столбца.	строка	В этом поле доступны следующие значения: `true` — столбец отображается (значение по умолчанию). `false` — столбец скрыт.
`width`	нет		Ширина столбца в пикселях.	объект	Ознакомьтесь с описанием поля `width`.

visible

нет

true

Видимость столбца.

строка

В этом поле доступны следующие значения:

true — столбец отображается (значение по умолчанию).
false — столбец скрыт.

width

нет

Ширина столбца в пикселях.

объект

Ознакомьтесь с описанием поля width.

Схема использования столбца

table:
  columns:
    # Идентификатор столбца.
    - id:
      # Атрибут столбца.
      attribute:
      # Тип данных в столбце.
      type
      # Массив настроек столбца.
      layout:
        # Параметр видимости столбца.
        visible:
        # Ширина столбца (по умолчанию, минимальная, максимальная).
        width:
          default:
          min:
          max:

Настройки ширины столбца (width)

Поле width содержит массив настроек ширины столбца.

Настройка включает следующие поля:

Поле Обязательное поле Значение по умолчанию Описание Тип данных

Поле	Обязательное поле	Описание	Тип данных
`default`	да	Ширина столбца по умолчанию, в пикселях.	целое положительное число
`min`	да	Максимальная ширина столбца в пикселях.	целое положительное число
`max`	да	Минимальная ширина столбца в пикселях.	целое положительное число

default

да

Ширина столбца по умолчанию, в пикселях.

целое положительное число

min

да

Максимальная ширина столбца в пикселях.

целое положительное число

max

да

Минимальная ширина столбца в пикселях.

целое положительное число

Структура `filter`

Данные, по которым осуществляется фильтрация, должны быть описаны в настройках фильтрации. Фильтрация по этим данным в системе доступна независимо от того, отображаются ли они в интерфейсе списка объектов (таблице).

Фильтровать данные можно:

по атрибутам сущности;
по лейблу и атрибутам связанного объекта.

Фильтрация по атрибутам связанного объекта невозможна, если связь установлена через атрибут типа Reference.

Для ссылки на атрибут в настройках фильтрации используйте значение поля id в описании атрибута сущности.

Поле filter содержит массив настроек фильтрации столбцов таблицы.

Фильтр включает следующие поля:

Поле Обязательное поле Значение по умолчанию Описание Тип данных Комментарий

attributes

нет

Массив ссылок на атрибуты сущности, по которым производится фильтрация.

Ознакомьтесь с описанием поля attributes.

linkages

нет

Массив ссылок на связи сущности, по которым производится фильтрация.

Ознакомьтесь с описанием поля linkages.

Структура attributes (в фильтре списка объектов)

Поле attributes содержит массив ссылок на атрибуты сущности, по которым производится фильтрация.

Оно включает следующие поля:

Поле Обязательное поля Описание Тип данных

type

да

тип фильтрации. Доступные значения:

specific — фильтрация осуществляется по атрибутам сущности, ссылки на которые приведены в поле use.
all — фильтрация осуществляется по всем атрибутам. При использовании этого типа ссылки на атрибуты в поле use приводить не нужно.

перечисление

use

да (при type: specific)

Массив ссылок на атрибуты, по которым производится фильтрация. Запись атрибута включает поля:

attribute: ссылка на атрибут;
use (для атрибутов типа Table) — массив атрибутов атрибута-таблицы.

Ознакомьтесь со схемой.

массив

Структура linkages (в фильтре списка объектов)

Поле linkages используется:

для задания ссылок на связи сущности, по которым производится фильтрация;
для задания атрибутов связанных сущностей, по которым производится фильтрация.

Структура включает следующие поля:

Поле Обязательное поле Значение по умолчанию Описание Тип данных Комментарий

type

да (при ссылках на связи)

Тип фильтрации.

Заполняется при задании ссылок на связи сущности. Можно указать следующие типы фильтрации:

specific — фильтрация осуществляется по связям, ссылки на которые приведены в поле use.
all — фильтрация осуществляется по всем связям. При использовании этого типа ссылки на связи в поле use приводить не нужно.

use

да (при ссылках на связи)

Массив ссылок на связи, по которым производится фильтрация.

Задается, если в поле type указано значение specific.

В этом поле перечисляются связи, по которым осуществляется фильтрация в таблице. Ознакомьтесь со схемой.

linkage

да (при ссылках на атрибуты)

Ссылка на связь с другой сущностью.

Заполняется при задании ссылок на атрибуты связанных сущностей. Поле linkedEntity этой связи содержит атрибуты связанной сущности, по которым будет доступна фильтрация.

Схема фильтрации по отдельным атрибутам и связям

table:
  # Поле фильтрации.
  filter:
    # Тип фильтрации по отдельным атрибутам, перечисленным в поле use.
    attributes:
      type: specific
      use:
        - attribute: <attribute_1>
        - attribute: <attribute_2>
        ...
        # Фильтрация по атрибутам атрибута-таблицы.
        - attribute: <table_attribute>
          use:
            - attribute: <table_attribute_1>
            - attribute: <table_attribute_2>
            ...
    # Тип фильтрации по отдельным связям, перечисленным в поле use.
    linkages:
      type: specific
      use:
          # Ссылка на связь с сущностью.
          - linkage: <entity_1>
            linkedEntity:
              # Ссылки на атрибуты связанной сущности, по которым будет производиться фильтрация.
              - attribute: <attribute_3>
              - attribute: <attribute_4>
              ...
          - linkage: <entity_2>
          ...

Сортировка в столбцах таблицы (`sortingBy`)

Поле sortingBy содержит описание сортировки в столбцах таблицы.

Настройки включают следующие поля:

Поле Обязательное поле Значение по умолчанию Описание Тип данных Комментарий

columns

да

Массив записей столбцов, для которых возможна сортировка в таблице.

массив привязок правил сортировки к столбцам

В этом поле указывается:

в поле column — столбец, по которому выполняется сортировка;
в поле sorting — правило, в соответствии с которым она выполняется.

defaults

нет

Массив записей столбцов с указанием направления сортировки по умолчанию.

сортировка таблицы по умолчанию

В этом поле указывается:

в поле column — столбец для направления сортировки;
в поле direction — направление сортировки:
- asc — сортировка по возрастанию;
- desc — сортировка по убыванию.

Настройки количества записей в таблице (`paging`)

Поле paging содержит настройки количества записей, показываемых в таблице.

Настройка включает следующие поля:

Поле Обязательное поле Значение по умолчанию Описание Тип данных Комментарий

sizes

да

Количество записей, показываемых в таблице.

массив целых положительных чисел

В этом поле указываются варианты количества записей, доступные для выбора в настройке. Например, [10, 50, 100].

defaultSize

да

Количество записей, показываемых по умолчанию.

целое положительное число

Структура `refresh`

Поле refresh содержит настройки обновления записей, показываемых в таблице.

Настройка включает следующие поля:

Поле Обязательное поле Значение по умолчанию Описание Тип данных Комментарий

mode

да

Режимы обновления.

перечисление

В этом поле указываются режимы обновления записей:

manual — обновление производится вручную;
auto — обновление производится автоматически с заданным интервалом;
all — обновление производится вручную и автоматически.

defaults

да

Настройки автообновления.

объект

Поле доступно только для настроек фильтров таблиц с типами:

all;
auto.

Ознакомьтесь с описанием поля defaults.

Структура defaults

Поле defaults содержит настройки автообновления записей, показываемых в таблице. Используется, если в поле mode установлено значение auto или all.

Настройка включает следующие поля:

Поле Описание Тип данных Комментарий

enabled

Включение и выключение автообновления.

булево

unit

Единица измерения интервала автообновления.

перечисление

Доступные значения:

second — секунды;
minute — минуты;
hour — часы.

interval

Количество единиц измерения интервала автообновления.

целое положительное число

Структура `selection`

Поле selection содержит настройки возможности выбора записей, показываемых в таблице.

Настройка включает следующие поля:

Поле Описание Тип данных Комментарий

selection

Возможность выбора записей.

булево

Доступные значения:

true — выбор записей возможен;
false — выбор записей невозможен (значение по умолчанию).

Структура `actions` (в списке объектов)

Поле actions содержит настройки действий в таблице.

Настройка включает следующие поля:

Поле Описание Тип данных Комментарий

type

Тип действия.

строка

Доступные значения:

row_click — действие при нажатии на строку.
row_double_click — действие при двойном нажатии на строку.
row_context_menu — отображение контекстного меню при нажатии правой кнопкой мыши на строку.

action

Ссылка на идентификатор действия.

строка

Доступно только для действия типа row_click.

items

Массив ссылок на идентификаторы действий в контекстном меню.

строка

Максимальное количество записей в массиве: 7.

Доступно только для действия типа row_context_menu.

Ознакомьтесь с описанием поля items.

Структура `items`

Поле items содержит массив ссылок на идентификаторы действий в контекстном меню.

Настройка включает следующие поля:

Поле Описание Тип данных Комментарий

action

Действие.

Ссылка на идентификатор действия

label

Название действия, отображаемое в контекстном меню.

строка

Если значение поля не задано, отображается значение поля name в описании действия.

icon

Иконка действия в контекстном меню.

Ссылка на идентификатор иконки

Настройка интерфейса полноэкранной карточки объекта

Полноэкранная карточка объекта отображается на всю рабочую область экрана. В полноэкранной карточке можно отображать следующие визуальные элементы интерфейса, которые должны быть предварительно описаны в схеме:

виджеты действий, отображаемые на панели действий над карточкой.
блоки контента полноэкранного представления, содержащие виджеты или наборы виджетов. Блоки могут содержать несколько вкладок.
панель вкладок полноэкранного представления. Каждая вкладка содержит по крайней мере один блок полноэкранного представления.

Возможны следующие варианты отображения полноэкранной карточки:

блок контента полноэкранного представления или несколько блоков. Блоки включают в себя виджеты или группы виджетов. Вкладки отсутствуют.
блок, включающий несколько вкладок с виджетами или группами виджетов.
панель вкладок, содержащих блоки контента. Блоки могут содержать вкладки.

В каждом варианте в зависимости от настроек может отображаться панель действий карточки.

Действия создания и редактирования объектов в полноэкранной карточке

Вы можете задать в схеме домена действие, использующее конфигурацию type = open_page и operation = create. Виджет действия, ссылающийся на это действие, позволяет отобразить полноэкранную карточку в режиме создания объекта. Здесь можно указать данные для создания нового объекта текущей сущности. В панели действий карточки в режиме создания всегда первой отображается кнопка Создать, позволяющая сохранить созданный объект.

Если действие использует конфигурацию type = open_page и operation = edit, его виджет позволяет отобразить полноэкранную карточку в режиме редактирования объекта. В карточке можно отредактировать объект текущей сущности. В панели действий карточки в режиме редактирования всегда первой отображается кнопка Сохранить, позволяющая сохранить внесенные изменения.

Перед сохранением данных карточки объекта убедитесь, что все необходимые поля заполнены.

Блок контента полноэкранной карточки

Ссылка на блок контента размещается в поле block интерфейса полноэкранной карточки. Блок контента может содержать набор виджетов или несколько вкладок с наборами виджетов.

Элемент Как задается в схеме домена

Заголовок

Поле label.

Набор виджетов в блоке контента

В поле groups нужно выбрать тип block.

Панель вкладок в блоке контента

Массив ссылок на вкладки в интерфейсе объекта.

Каждая вкладка содержит как минимум одну ссылку на блок с набором виджетов.
Все блоки для вкладок нужно описать в поле groups с помощью типа block.
Вкладку нужно описать в поле groups с помощью типа tab. В описании размещаются ссылки на блоки с набором виджетов.

Отображаемая вкладка или блок виджетов

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

Вкладка описывается в поле groups c помощью типа tab.
Набор виджетов в составе вкладки описывается в поле groups с помощью типа block.

Панель вкладок полноэкранной карточки

Ссылки на вкладки панели размещаются как записи массива в поле tabs интерфейса полноэкранной карточки. Каждая вкладка содержит по крайней мере один блок контента.

Элемент Как задается в схеме домена

Заголовок

Поле label.

Вкладка в панели вкладок

Описывается как ссылка на вкладку в массиве ссылок на вкладки в интерфейсе объекта. Каждая вкладка содержит как минимум одну ссылку на блок контента.

Отображаемая вкладка или блок виджетов

Описывается как ссылка на вкладку панели, размещенная первой в поле tabs. Вкладка описывается в поле groups с помощью типа tab.

Отображение в блоке контента двух секций регулируемой ширины

В блоке контента можно отображать две секции, каждая из которых представляет собой блок с виджетами. Для этого:

Опишите блок с двумя секциями:
1. Укажите в поле groups интерфейса объекта группу типа resizable_block_pair.
2. Укажите в группе ссылки на блоки, отображаемые в секциях блока контента.
3. Укажите параметры ширины секций.
Сошлитесь на идентификатор блока с двумя секциями при описании блока контента.

Размеры секций блока в интерфейсе можно изменять, перетаскивая их границы курсором мыши.

Была ли полезна эта страница?

Обратная связь

Описания интерфейса

Структура actions

Общие поля для всех типов действий

Допустимые значения для поля type

Поля, применимые при type: open_panel

Поля, применимые при type: open_modal

Поля, применимые при type: open_list

Поля, применимые при type: open_page

Поля, применимые при type: open_graph_view

Поля, применимые при type: remove

Поля, применимые при type: bulk

Структура attributes (в описании действия)

Поля, применимые при type: playbook

Поля, применимые при type: generate_qr_code

Поля, применимые при type: copy_entity_link

Структура menus

Структура items

Структура medias

Структура views

Общие поля для всех типов представлений

Допустимые типы представлений (type)

Поля, применимые при type: entity

Поля, применимые при type: page

Структура pinnedView

Поля, применимые при type: list

Структура source

Структура joins

Поля, применимые при type: tabs_list

Поля, применимые при type: dashboard

Структура layout (в интерфейсе дашбордов)

Поля, применимые при type: tree

Поле variant

Поле menuOptions

Структура widgets

Общие поля для всех типов виджетов

Допустимые типы виджетов (type)

Поля, применимые при type: attribute

Поля, применимые при type: action

Поля, применимые при type: linkage

Поля, применимые при type: visualization

Поля, применимые при type: history

Поля, применимые при type: comments

Поля, применимые при type: linkage_list

Поля, применимые при type: card

Поля, применимые при type: conversation

Структура groups

Структура layout (в группе представления)

Структура components

Структура views (панели и модальные окна)

Структура menu

Структура buttons

Структура layout (в интерфейсе дашбордов)

Структура table (список объектов)

Структура empty

Структура columns (в таблице списка объектов)

Структура filter

Сортировка в столбцах таблицы (sortingBy)

Настройки количества записей в таблице (paging)

Структура refresh

Структура selection

Структура actions (в списке объектов)

Структура items

Настройка интерфейса полноэкранной карточки объекта

Действия создания и редактирования объектов в полноэкранной карточке

Блок контента полноэкранной карточки

Панель вкладок полноэкранной карточки

Отображение в блоке контента двух секций регулируемой ширины

Структура `actions`

Допустимые значения для поля `type`

Поля, применимые при `type: open_panel`

Поля, применимые при `type: open_modal`

Поля, применимые при `type: open_list`

Поля, применимые при `type: open_page`

Поля, применимые при `type: open_graph_view`

Поля, применимые при `type: remove`

Поля, применимые при `type: bulk`

Структура `attributes` (в описании действия)

Поля, применимые при `type: playbook`

Поля, применимые при `type: generate_qr_code`

Поля, применимые при `type: copy_entity_link`

Структура `menus`

Структура `items`

Структура `medias`

Структура `views`

Допустимые типы представлений (`type`)

Поля, применимые при `type: entity`

Поля, применимые при `type: page`

Структура `pinnedView`

Поля, применимые при `type: list`

Структура `source`

Структура `joins`

Поля, применимые при `type: tabs_list`

Поля, применимые при `type: dashboard`

Структура `layout` (в интерфейсе дашбордов)

Поля, применимые при `type: tree`

Поле `variant`

Поле `menuOptions`

Структура `widgets`

Допустимые типы виджетов (`type`)

Поля, применимые при `type: attribute`

Поля, применимые при `type: action`

Поля, применимые при `type: linkage`

Поля, применимые при `type: visualization`

Поля, применимые при `type: history`

Поля, применимые при `type: comments`

Поля, применимые при `type: linkage_list`

Поля, применимые при `type: card`

Поля, применимые при `type: conversation`

Структура `groups`

Структура `layout` (в группе представления)

Структура `components`

Структура `views` (панели и модальные окна)

Структура `menu`

Структура `buttons`

Структура `layout` (в интерфейсе дашбордов)

Структура `table` (список объектов)

Структура `empty`

Структура `columns` (в таблице списка объектов)

Структура `filter`

Сортировка в столбцах таблицы (`sortingBy`)

Настройки количества записей в таблице (`paging`)

Структура `refresh`

Структура `selection`

Структура `actions` (в списке объектов)

Структура `items`