Skip to navigation
APIsMetadata ResourcesMetadata Glossary

Update a metadata

Updates the specified metadata by setting the values of the parameters passed.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

metadataIdstringRequiredformat: "^mgl_[a-zA-Z0-9]{10,22}$"
The unique identifier of the metadata.

Headers

X-Studies-Api-VersionstringOptional

Request

The metadata glossary attributes to change.
titlestringOptional1-255 characters
The title of the metadata glossary.
slugstringOptional1-255 characters
The unique slug of the metadata glossary.
activebooleanOptional
The active status of the metadata glossary.
read_onlybooleanOptional
The read only status of the metadata glossary.
optionslist of stringsOptional

The metadata options associated to the metadata glossary. Only accepted for select and multi-select fields; must be a non-empty unique list.

requiredbooleanOptional
When true, the field is mandatory on entities that use this glossary entry.

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 updated metadata glossary.
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
404
Not Found Error
429
Too Many Requests Error