Метаданные приложения управления объектами (entities)

Обзор

Метаданные приложения управления данными и настройками доменов (администрирование домена).

Файлы располагаются в дочерней структуре каталога era_env/priv/rest_metadata/<SOLUTION>/entities. При отсутствии в каталоге текущего солюшена файл отдается из каталога era_env/priv/rest_metadata/common/entities

Доступно в любых доменах.

Запросы

HTTP verb Endpoint Описание

GET

/rest/v1/metadata/entities/nav.json

Получение метаданных панели навигации

GET

/rest/v1/metadata/entities/<CLASS>/tab.json

Получение метаданных списочного отображения сущностей класса

GET

/rest/v1/metadata/entities/<CLASS>/form.json

Получение метаданных окна редактирования сущности класса

Получение метаданных панели навигации

Возвращает метаданные для отображения панели навигации.

Содержит состав классов сущностей и их группировку.

Файл располагается по пути (в порядке убывания приоритета):

/era_env/priv/rest_metadata/<SOLUTION>/entities/nav.json
/era_env/priv/rest_metadata/common/entities/nav.json

в том числе для мастер-домена (<SOLUTION> = master).

Запрос

Пример запроса
GET /rest/v1/metadata/entities/nav.json HTTP/1.1

Ответ

Пример ответа
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

json data

Получение метаданных списочного отображения сущностей класса

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

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

Файлы располагаются по пути (в порядке убывания приоритета):

/era_env/priv/rest_metadata/<SOLUTION>/entities/<CLASS>/tab.json
/era_env/priv/rest_metadata/common/entities/<CLASS>/tab.json

в том числе для мастер-домена (<SOLUTION> = master).

Так, для домена с типом abc и класса сущностей user путь выглядит:

/era_env/priv/rest_metadata/abc/entities/user/tab.json

а при отсутствии там файла:

/era_env/priv/rest_metadata/common/entities/user/tab.json

Запрос

Пример запроса
GET /rest/v1/metadata/entities/user/tab.json HTTP/1.1

Ответ

Пример ответа
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

json data

Получение метаданных окна редактирования сущности класса

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

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

Файлы располагаются по пути (в порядке убывания приоритета):

/era_env/priv/rest_metadata/<SOLUTION>/entities/<CLASS>/form.json
/era_env/priv/rest_metadata/common/entities/<CLASS>/form.json

в том числе для мастер-домена (<SOLUTION> = master).

Так, для домена с типом abc и класса сущностей user путь выглядит:

/era_env/priv/rest_metadata/abc/entities/user/form.json

а при отсутствии там файла:

/era_env/priv/rest_metadata/common/entities/user/form.json

Запрос

Пример запроса
GET /rest/v1/metadata/entities/user/form.json HTTP/1.1

Ответ

Пример ответа
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

json data

См. также