Retrieve masks

GET /api/v1/mask/{HEAD|CURRENT|<version>}[/<name>]?token=<token>[&format=<format>]

Retrieve the mask definitions for the CURRENT or HEAD version. If the parameter name is given, retrieve just one mask.

Path parameters

The version that is currently active is CURRENT. A new HEAD version is created when the user updates the maskset. Use /api/v1/schema/commit to commit changes, so that the HEAD version becomes the new CURRENT.

Query String

Available formats:

• xml: mask set as XML document (this is the default format)
• json: mask set as JSON object

Output

A maskset containing all masks or just the mask name for the requested version.

Permissions

This call requires an authenticated session. Frontends can use the “system.datamodel.current” right to decide if they show the maskset to the user.

HTTP status codes

Generate masks with all fields

GET /api/v1/mask/{HEAD|CURRENT}/_all_fields?token=<token>[&format=<format>]

Retrieve the mask definitions containing all fields for the CURRENT or HEAD version.

This call generates a mask for each table in the schema that contains all fields. Notice that this call does not return actual masks, but generated ones. The idea is that the frontend can have a default mask that can be used as such or changed. However, in order to be able to use it, it should be updated in the HEAD maskset using the POST method.

Path parameters

Query String

Output

A maskset containing the generated masks.

Permissions

This call requires an authenticated session. Frontends can use the “system.datamodel.current” right to decide if they show the maskset to the user.

HTTP status codes

Update user mask definition

POST /api/v1/mask/HEAD?token=<token>

Update the mask definition for the HEAD schema version.

The mask definition has to be in JSON format.

Query String

Input

The new maskset.

Output

The updated mask definition.

Permissions

The user needs the “system.datamodel.development” right.

HTTP status codes