Metadata Groups
Metadata group management operations
Get all metadata groups
Returns a paginated list of metadata groups based on the provided filter criteria
Create a new metadata group
Creates a new metadata group with the provided data
Get a metadata group by code
Returns a single metadata group by its code
Get metadata for a metadata group by code
Returns metadata associated with the specified metadata group code, optionally narrowed to the given metadataIds (a membership check) or a code/name search. metadataIds travel in the query string, so at most 50 per request.
Get a member of a metadata group by codes
Returns the metadata with the given type code and code if it is a member of the metadata group. Codes match case-insensitively. A group or metadata outside its active date window is treated as not found. This is the check behind the inMetadataGroup rule operator.
Delete a metadata group
Deletes an existing metadata group
Get a metadata group by ID
Returns a single metadata group by its ID
Update a metadata group
Updates an existing metadata group with the provided data
Remove metadata from a metadata group
Removes metadata items from the specified metadata group
Get metadata for a metadata group
Returns metadata associated with the specified metadata group, optionally narrowed to the given metadataIds (a membership check) or a code/name search. metadataIds travel in the query string, so at most 50 per request.
Associate metadata with a metadata group
Associates metadata items with the specified metadata group
Add a metadata selection to a metadata group
Adds every metadata an explicit id list or a metadata filter resolves to, minus excludeIds. The filter is resolved server-side, narrowed to the group's metadata type, and stored as a static list. Existing members are kept; re-adding a member is a no-op. Ids that are not active metadata are ignored, and a filter whose typeCode differs from the group's type resolves to nothing. A filter matching more than 10000 metadata is rejected with a 400.
Replace a metadata group's membership with a selection
Makes the group's membership exactly what an explicit id list or a metadata filter resolves to, minus excludeIds. The filter is resolved server-side, narrowed to the group's metadata type, and stored as a static list. Ids that are not active metadata are ignored, and a filter whose typeCode differs from the group's type resolves to nothing. A filter matching more than 10000 metadata is rejected with a 400. Because a replace also removes members, it needs both the metadata-groups write and delete scopes.