Skip to navigation
APIsMetadata ResourcesMetadata Glossary

Create a metadata

Creates a metadata glossary field for your team.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Headers

X-Studies-Api-VersionstringOptional

Request

The attributes of the metadata glossary to create.
titlestring or nullRequired<=255 characters
The title of the metadata glossary.
slugstring or nullRequired<=255 characters
The unique slug of the metadata glossary. Generated from the title when omitted or null.
typeenum or nullRequired
The type of the metadata glossary.
field_typeenum or nullRequired
The field type of the metadata glossary.
activebooleanRequired
The active status of the metadata glossary.
read_onlybooleanRequired
The read only status of the metadata glossary.
optionslist of strings or nullOptional
The metadata options associated to the metadata glossary.
requiredboolean or nullOptional
When true, the field is mandatory on entities that use this glossary entry. Omitted or null is treated as false.

Response headers

X-RateLimit-LimitintegerOptional
The number of requests permitted in the current rate limit window.
X-RateLimit-RemainingintegerOptional

The number of requests still available in the current rate limit window. When several limits apply, this reflects the per-API-key limit, so a request can be rejected while this value is above zero.

X-RateLimit-ResetintegerOptional
The number of seconds until the current rate limit window resets.

Response

The metadata glossary was created.
idstringformat: "^mgl_[a-zA-Z0-9]{10,22}$"
Unique identifier for a metadata glossary field.
typeenum or null
The type of the metadata glossary.
titlestring<=255 characters
The title of the metadata glossary.
slugstring<=255 characters
The unique slug of the metadata glossary.
field_typeenum

The field type of a metadata glossary entry. Select and multi-select fields carry fixed options on the glossary itself; lookup select and lookup multi-select options are managed via the metadata options endpoints. The external API rejects datetime on create.

activeboolean
The active status of the metadata glossary.
read_onlyboolean
The read only status of the metadata glossary.
requiredboolean
When true, the field is mandatory on entities that use this glossary entry.
optionslist of stringsOptional

The metadata options associated to the metadata glossary. Present only for select and multi-select field types; omitted for all other field types.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error