Object management application metadata (entities)

Overview

Metadata applications for managing data and domain settings (domain administration).

The files are located in the child structure of the directory era_env/priv/rest_metadata/<SOLUTION>/entities. If there is no current solenoid in the directory, the file is given from the directory era_env/priv/rest_metadata/common/entities

Available in any domains.

Requests

HTTP verb Endpoint Description

GET

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

Getting navigation bar metadata

GET

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

Getting metadata of list mapping of class entities

GET

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

Getting metadata of class entity editing window

Getting navigation bar metadata

Returns the metadata for displaying the navigation bar.

Contains the composition of entity classes and their grouping.

The file is located by path (in descending order of priority):

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

including for the master domain (<SOLUTION> = master).

Request

Request example
GET /rest/v1/metadata/entities/nav.json HTTP/1.1

Response

Response example
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

json data

Getting metadata of list mapping of class entities

Returns metadata on an entity class to display a list of entities.

Contains entity field composition, parameters for UI in list display mode, list of operations.

Files are arranged by path (in descending order of priority):

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

including for the master domain (<SOLUTION> = master).

So, for a domain with type abc and entity class user, the path looks like this:

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

and when there’s no file there:

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

Request

Request example
GET /rest/v1/metadata/entities/user/tab.json HTTP/1.1

Response

Response example
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

json data

Getting metadata of class entity editing window

Returns metadata on the entity class for editing entity fields.

Contains the entity’s field composition, restrictions and editing features.

Files are arranged by path (in descending order of priority):

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

including for the master domain (<SOLUTION> = master).

So, for a domain with type abc and entity class user, the path looks like this:

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

and when there’s no file there:

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

Request

Request example
GET /rest/v1/metadata/entities/user/form.json HTTP/1.1

Response

Response example
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

json data

See also