BObox
Metadata taxonomies

Update metadata taxonomy node

Changed on

Updates an existing metadata taxonomy node.

patch/metadata_taxonomies/{namespace}/{taxonomy_key}/nodes/{node_id}

Request

  • Base URL
    https://api.box.com/2.0
  • URL
    https://api.box.com/2.0/metadata_taxonomies/{namespace}/{taxonomy_key}/nodes/{node_id}
  • Auth
    OAuth 2
    Authorization code: https://account.box.com/api/oauth2/authorize
    Token URL: https://api.box.com/oauth2/token

Path parameters

namespacestring required

The namespace of the metadata taxonomy.

taxonomy_keystring required

The key of the metadata taxonomy.

node_idstring required

The identifier of the metadata taxonomy node.

Request body

displayNamestring

The display name of the taxonomy node.

Example request

{
  "displayName": "France"
}

Response

The schema representing the updated taxonomy node.

idstring required

A unique identifier of the metadata taxonomy node.

displayNamestring required

The display name of the metadata taxonomy node.

levelinteger required

An index of the level to which the node belongs.

parentIdstring

The identifier of the parent node.

nodePathstring[]

An array of identifiers for all ancestor nodes.
Not returned for root-level nodes.

Example response

{
  "id": "14d3d433-c77f-49c5-b146-9dea370f6e32",
  "displayName": "France",
  "level": 2,
  "parentId": "99df4513-7102-4896-8228-94635ee9d330",
  "nodePath": [
    "99df4513-7102-4896-8228-94635ee9d330"
  ],
  "ancestors": [
    {
      "id": "14d3d433-c77f-49c5-b146-9dea370f6e32",
      "displayName": "France",
      "level": 2
    }
  ]
}

Changes

  • c4d5303fa5c3Revision changes
    • warning

      added the new unprocessable_entity enum value to the response property for the response status

    • warning

      added the new unprocessable_entity enum value to the response property for the response status

    • warning

      added the new unprocessable_entity enum value to the response property for the response status