Metadata
Metadata management operations
Get all metadata
Returns a paginated list of all metadata
Update every metadata matching a selection
Applies one patch to every metadata an explicit id list or a GET /metadata filter resolves to, minus excludeIds, in one transaction. Only metadata whose type is of category METADATA is updated: a filter is narrowed to that category, and an id of another category fails the request with a 400. Ids that are not active metadata are skipped. The patch may set name, description, properties and dateTimePeriod; a field left null is unchanged, and properties merge into each metadata's existing properties (a null value removes that key). A patch that sets nothing is rejected with a 400, as is a selection resolving to more than 5000 metadata, in which case nothing is written. Only one bulk update runs at a time per environment: a second request while one is running gets a 429.
Create metadata
Creates new metadata with the provided data
Get metadata by type
Returns metadata for a specific type.
Get metadata by type and code
Returns a single metadata by its type and code
Get metadata children by type and code
Returns child metadata for a specific parent identified by type and code. Optional pagination parameters available for hierarchies with many children. For large hierarchical structures, consider using pagination parameters.
Get metadata parents by type and code
Returns the metadata entries that the metadata identified by type and code is linked under, through active links only.
Delete metadata
Deletes an existing metadata by its ID
Get metadata by ID
Returns a single metadata by its ID
Update metadata
Updates existing metadata with the provided data
Delete children of metadata
Deletes child metadata for the specified parent
Get metadata children
Returns child metadata for a specific parent. Optional pagination parameters available for hierarchies with many children. For large hierarchical structures, consider using pagination parameters.
Link children under metadata
Links existing metadata entries as children of the specified parent. A metadata entry has at most one parent of each metadata type: a child already linked under another parent of this parent's type is moved here. Parents of other types are kept, and links that already exist are left unchanged.
Get metadata parents
Returns the metadata entries that the specified metadata is linked under, through active links only.