FOformbricks
Taxonomy

Rename a taxonomy node

Changed on

Renames a taxonomy node's label and records a rename event attributed to actor_id. Tenant-scoped; returns 404 if the node does not belong to the tenant. While a tenant data purge runs for the same tenant_id, the request is rejected with HTTP 409 (code tenant_write_conflict) and may be retried.

patch/v1/taxonomy/nodes/{node_id}

Request

  • Base URL
    http://localhost:8080
  • URL
    http://localhost:8080/v1/taxonomy/nodes/{node_id}
  • Auth
    HTTP bearer

Path parameters

node_idstring uuid required
Example:019f177f-9abe-78cd-8008-f40b58e3147d

Taxonomy node ID.

Request body

tenant_idstring required
actor_idstring required
labelstring required

New node label.

Response

The updated node

idstring uuid required
run_idstring uuid required
parent_idstring uuid

Parent node ID; absent for the root node.

cluster_idstring uuid

Cluster this node summarizes; typically present on leaf nodes.

node_type'root' | 'branch' | 'leaf' required

Position of a node within the taxonomy tree.

labelstring required
original_labelstring

Label as originally generated, before any rename.

descriptionstring
levelinteger required

Depth in the tree; the root is level 0.

sort_orderinteger required
metadataobject
removed_atstring date-time

Set when the node has been soft-removed.

removed_bystring

Actor that soft-removed the node.

created_atstring date-time required
updated_atstring date-time required
childrenTaxonomyNodeData[] circular

Changes

  • ec67528c61ecRevision changes
    • warning

      the request property's maxLength was set to 2048

  • ac72ae0de955Revision changes
    • warning

      changed the pattern of the request property from ^[^\x00]*$ to ^[^\x00\uFFFD]*$

    • info

      added the non-success response with the status