Reserved Form mode names

We use form modes to specify what data can be read or written to documents using the form name in their form item. While you are generally free to pick any name (lower case, no special characters), there are names with a special purpose, namely:

default

The default mode is, as the name implies, the default when creating or reading documents and in the absence of an explicityly specified mode= parameter

dql

When data is queried by DQL, forms need a dql mode to return values. The mode specified what data gets returned. If a form doesn't have a dql mode, no data will be returned for that form in a DQL query.

odata

The odata mode lets you define the data that comes through our odata endpoints. The API support the odata standard Open Data Protocol(oData). If a form does not have a odata mode, then an odata will not return any data for that form.

raw

Needed for /api/v1/raw endpoint. The endpoint /api/v1/raw will only return data when the mode raw exists for the form requested exists and the user has the permission, expressed in the @formula of the raw mode definition. Typically you want to restrict raw access to admin and support users.

Note

raw mode returns all fields without translation or adjustment.