Taxonomies
Taxonomies and taxonomy entries, which extend metadata filters across a hierarchy of values. Metadata, filters and taxonomies describes taxonomy filters.
List taxonomies
Returns a page of taxonomies that the key can read. The response is a paginated envelope. Results can be filtered by field and ordered, as described in [API conventions](../01-api-conventions.md).
Create a taxonomy
Creates a taxonomy. A taxonomy is independent of any pipeline, so one taxonomy can serve several pipelines. Entries are added with a separate operation. The response body is the new taxonomy.
Get a taxonomy
Returns a taxonomy by identifier. The response body is the taxonomy.
Update a taxonomy
Changes the name or description of a taxonomy. The response body is the updated taxonomy.
Delete a taxonomy
Deletes a taxonomy and every entry in the taxonomy. The response has no body.
List taxonomy entries
Returns a page of the entries of a taxonomy. Each entry links a parent field and value to a child field and value. The response is a paginated envelope. Results can be filtered by field and ordered, as described in [API conventions](../01-api-conventions.md).
Create taxonomy entries
Adds entries to a taxonomy. The request body is a JSON array of entries, each linking a parent field and value to a child field and value. The response body is the array of entries that were created. Changes take effect in the next search, without reprocessing any document.
Delete taxonomy entries
Deletes taxonomy entries by identifier. The identifiers are given in the `entry_id` query parameter, repeated once for each entry. The response has no body.