/rest/api/metadata

Provides services to access any meta data like Entity- or AttributeMetaData.

GET v1/entities[/filter]}

Returns an EntityMetaDataContainerDTO containing meta data information of the entities defined by the given filters. If no filters were passed, meta data of all entities will be returned.

Response
application/json; charset=UTF-8

EntityMetaDataContainerDTO - DTO for entity meta data.

Request
application/json; charset=UTF-8

Parameter Type
Type
Name
Description
Optional
Default Value
MATRIX
String  
filter
Set of matrix parameter to filter the result. Available filters:

  • /filter;entities=A.*|C.* - Regular expression to match the entity name.
  • /filter;display=web/app - Quick filter on entities that are available for WebClient or App.

These filters are cumulative. So if you pass '/filter;entities=A.*;display=web'you will get all WebClient entities starting with 'A'. If no filter arguments were passed, ALL entity meta data will be returned.
true
 
QUERY
ClientType  
clientType
The type of the requesting client to include client specific fields into the result.
true
 

GET v1/fields[/filter]}

Returns an AttributeMetaDataContainerDTO containing meta data information of the fields defined by the given filters. If no filters were passed, meta data of all fields will be returned.

Response
application/json; charset=UTF-8

AttributeMetaDataContainerDTO - DTO for field meta data grouped by entity name.

Request
application/json; charset=UTF-8

Parameter Type
Type
Name
Description
Optional
Default Value
MATRIX
String  
filter
Set of matrix parameter to filter the result. Available filters:

  • /filter;fields=.*[.]Customer - Regular expression to match the internal field name.
  • /filter;preset=APP - Quick filter on all fields that are on app masks.

These filters are cumulative. So if you pass '/filter;fields=.*[.]Customer.*;preset=APP'you will get all meta data of Customer fields on app masks'. If no filters were passed, ALL field meta data will be returned.
true
 

GET v1/masks/dependent

Returns a DependentMaskConfigContainerDTO containing mask configurations of the subdata relations between the given master and slave entities.

Response
application/json; charset=UTF-8

DependentMaskConfigContainerDTO - DTO for dependent mask configurations grouped by entity name.

Request
application/json; charset=UTF-8

Parameter Type
Type
Name
Description
Optional
Default Value
QUERY
String  
master
List of the master entities.
false
 
QUERY
String  
slave
List of the slave entities.
false