BObox
Metadata taxonomies

Create metadata taxonomy

Changed on

Creates a new metadata taxonomy that can be used in metadata templates.

post/metadata_taxonomies

Request

  • Base URL
    https://api.box.com/2.0
  • URL
    https://api.box.com/2.0/metadata_taxonomies
  • Auth
    OAuth 2
    Authorization code: https://account.box.com/api/oauth2/authorize
    Token URL: https://api.box.com/oauth2/token

Request body

keystring

The taxonomy key. If it is not provided in the request body, it will be generated from the displayName. The displayName would be converted to lower case, and all spaces and non-alphanumeric characters replaced with underscores.

displayNamestring required

The display name of the taxonomy.

namespacestring required

The namespace of the metadata taxonomy to create.

Example request

{
  "key": "geography",
  "displayName": "Geography",
  "namespace": "enterprise_123456"
}

Response

The schema representing the metadata taxonomy created.

idstring required

A unique identifier of the metadata taxonomy.

keystring

A unique identifier of the metadata taxonomy. The identifier must be unique within the namespace to which it belongs.

displayNamestring required

The display name of the metadata taxonomy. This can be seen in the Box web app.

namespacestring required

A namespace that the metadata taxonomy is associated with.

Example response

{
  "id": "822227e0-47a5-921b-88a8-494760b2e6d2",
  "key": "geography",
  "displayName": "Geography",
  "namespace": "enterprise_123456",
  "levels": [
    {
      "displayName": "Continent",
      "description": "Continent",
      "level": 1
    }
  ]
}

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