Object taxonomies
The classification schemes objects are filed under. Several independent trees coexist, and an object may sit in as many of them as it needs.
List taxonomy nodes
Beta — this operation may change on 30 days notice. See versioning.
The nodes of a scheme, in display order — filter to one with tax_type. Ask for a whole tree with a limit that covers it: a page cut through a tree leaves children whose parent is missing. Pass counts=true for the number of objects filed under each node, and root=true for the top level only.
Requires the module-objects license feature. Without it the request is refused with 403 license_required — see plans and modules.
query Parameters
countscursor^[A-Za-z0-9_-]+$limitoffsetrootsort^-?[a-z0-9_]+$tax_activetax_idtax_keytax_nametax_parenttax_typeHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
List taxonomy nodes › Responses
Success
has_moreWhether more rows exist past this page.
next_cursorPass back as cursor for the next page. Null on the last page.
Create a taxonomy node
Beta — this operation may change on 30 days notice. See versioning.
A node with no tax_parent starts a new tree. A node with one must share its parent's tax_type — a tree belongs to a single scheme.
Requires the module-objects license feature. Without it the request is refused with 403 license_required — see plans and modules.
Headers
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Create a taxonomy node › Request Body
tax_typetax_nametax_keytax_parenttax_ordertax_metadataCreate a taxonomy node › Responses
Created
tax_idtax_activetax_createdtax_updatedtax_typetax_nametax_keytax_parenttax_ordertax_metadataobject_countHow many objects are filed directly under this node.
Get a taxonomy node
Beta — this operation may change on 30 days notice. See versioning.
Returns one node of a classification scheme.
Requires the module-objects license feature. Without it the request is refused with 403 license_required — see plans and modules.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Get a taxonomy node › Responses
Success
tax_idtax_activetax_createdtax_updatedtax_typetax_nametax_keytax_parenttax_ordertax_metadataobject_countHow many objects are filed directly under this node.
Delete a taxonomy node
Beta — this operation may change on 30 days notice. See versioning.
Refused while the node still has children, unless reparent_children=true attaches them to its parent. Objects filed under it stop being classified there but are otherwise untouched.
Requires the module-objects license feature. Without it the request is refused with 403 license_required — see plans and modules.
path Parameters
idquery Parameters
reparent_childrenHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Delete a taxonomy node › Responses
Success. No content.
Update a taxonomy node
Beta — this operation may change on 30 days notice. See versioning.
Setting tax_parent moves the node and everything under it. A move that would put a node inside its own subtree is refused. tax_type cannot be changed.
Requires the module-objects license feature. Without it the request is refused with 403 license_required — see plans and modules.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Update a taxonomy node › Request Body
tax_typetax_nametax_keytax_parenttax_ordertax_metadataUpdate a taxonomy node › Responses
Success
tax_idtax_activetax_createdtax_updatedtax_typetax_nametax_keytax_parenttax_ordertax_metadataobject_countHow many objects are filed directly under this node.