Export enumeration value configuration

The endpoint enums returns information about the definition of all or a subset of the enumerations in the Alfabet meta-model. Enumerations define a predefined set of values that are allowed to be set for an object class property.

Endpoint name: enums

HTTP method: GET

Service call: URLOfTheAlfabetAPIServer/api/v2/enums?names=Enum1,Enum2&emptyValues=true

Authorization Header Field: Authorization:TypeValue

Click for details about authorization.

Return value: The return value is a JSON object with two fields:

• alias: The name of the server alias of the Alfabet Web Application answering the request.
• enums: A JSON list of enumerations and their enumeration items.

The enums field consists of a JSON list of objects. Each enumeration is an object in the JSON list. If all enumerations in the Alfabet meta-model are returned, they are listed in alphabetical order. If only a defined list of enumerations specified in the service call are returned, they are listed in the order defined in the service call.

For each enumeration, the return value includes:

• Attributes of the enumeration

  Each relevant attribute defined for the enumeration in the Alfabet meta-model is defined as a field in the JSON object. The field names are similar to the names of the attributes. The attributes specify the technical data about the enumeration. The list of attributes is limited to the attributes that may be relevant for external applications. For example, the date of the last update or tags defined for the object are not exported.

• Enumeration items and their attributes

  The enumeration items defined for the enumeration are listed in the Items field. The Items field provides a JSON list of objects. Each enumeration item is an object in the list and the fields of the objects return the relevant attributes of the enumeration item. The field names are similar to the names of the attributes.