BObox
Metadata taxonomies

Get metadata taxonomy by taxonomy key

Changed on

Used to retrieve a metadata taxonomy by taxonomy key.

get/metadata_taxonomies/{namespace}/{taxonomy_key}

Request

  • Base URL
    https://api.box.com/2.0
  • URL
    https://api.box.com/2.0/metadata_taxonomies/{namespace}/{taxonomy_key}
  • 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.

Response

Returns the metadata taxonomy identified by the taxonomy key.

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