BObox
Metadata templates

Get metadata template by name

Changed on

Retrieves a metadata template by its scope and templateKey values.

To find the scope and templateKey for a template, list all templates for an enterprise or globally, or list all templates applied to a file or folder.

get/metadata_templates/{scope}/{template_key}/schema

Request

  • Base URL
    https://api.box.com/2.0
  • URL
    https://api.box.com/2.0/metadata_templates/{scope}/{template_key}/schema
  • Auth
    OAuth 2
    Authorization code: https://account.box.com/api/oauth2/authorize
    Token URL: https://api.box.com/oauth2/token

Path parameters

scope'global' | 'enterprise' required

The scope of the metadata template.

template_keystring required

The name of the metadata template.

Response

Returns the metadata template matching the scope and template name.

idstring required

The ID of the metadata template.

type'metadata_template' required

The value will always be metadata_template.

scopestring

The scope of the metadata template can either be global or enterprise_*. The global scope is used for templates that are available to any Box enterprise. The enterprise_* scope represents templates that have been created within a specific enterprise, where * will be the ID of that enterprise.

templateKeystring

A unique identifier for the template. This identifier is unique across the scope of the enterprise to which the metadata template is being applied, yet is not necessarily unique across different enterprises.

displayNamestring

The display name of the template. This can be seen in the Box web app and mobile apps.

hiddenboolean

Defines if this template is visible in the Box web app UI, or if it is purely intended for usage through the API.

copyInstanceOnItemCopyboolean

Whether or not to include the metadata when a file or folder is copied.

Example response

{
  "id": "58063d82-4128-7b43-bba9-92f706befcdf",
  "type": "metadata_template",
  "scope": "enterprise_123456",
  "templateKey": "productInfo",
  "displayName": "Product Info",
  "hidden": true,
  "fields": [
    {
      "type": "string",
      "key": "category",
      "displayName": "Category",
      "description": "The category",
      "hidden": true,
      "options": [
        {
          "key": "Category 1",
          "id": "45dc2849-a4a7-40a9-a751-4a699a589190"
        }
      ],
      "taxonomyKey": "locationTaxonomy",
      "taxonomyId": "05ece6d7-fec4-4d3f-bfd2-36fd4dddea97",
      "namespace": "enterprise_123456",
      "optionsRules": {
        "multiSelect": true,
        "selectableLevels": [
          1,
          2
        ]
      },
      "id": "822227e0-47a5-921b-88a8-494760b2e6d2"
    }
  ],
  "copyInstanceOnItemCopy": true
}

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