BObox
Metadata templates

Update metadata template

Changed on

Updates a metadata template.

The metadata template can only be updated if the template already exists.

The update is applied atomically. If any errors occur during the application of the operations, the metadata template will not be changed.

put/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.

Request body

op'editTemplate' | 'addField' | 'reorderFields' | 'addEnumOption' | 'reorderEnumOptions' | 'reorderMultiSelectOptions' | 'addMultiSelectOption' | 'editField' | 'removeField' | 'editEnumOption' | 'removeEnumOption' | 'editMultiSelectOption' | 'removeMultiSelectOption' required

The type of change to perform on the template. Some of these are hazardous as they will change existing templates.

dataobject

The data for the operation. This will vary depending on the operation being performed.

fieldKeystring

For operations that affect a single field this defines the key of the field that is affected.

fieldKeysstring[]

For operations that affect multiple fields this defines the keys of the fields that are affected.

enumOptionKeystring

For operations that affect a single enum option this defines the key of the option that is affected.

enumOptionKeysstring[]

For operations that affect multiple enum options this defines the keys of the options that are affected.

multiSelectOptionKeystring

For operations that affect a single multi select option this defines the key of the option that is affected.

multiSelectOptionKeysstring[]

For operations that affect multiple multi select options this defines the keys of the options that are affected.

Example request

[
  {
    "op": "addEnumOption",
    "data": {
      "name": "Aaron Levie"
    },
    "fieldKey": "category",
    "fieldKeys": [
      "category",
      "name"
    ],
    "enumOptionKey": "option1",
    "enumOptionKeys": [
      "option1",
      "option2",
      "option3"
    ],
    "multiSelectOptionKey": "option1",
    "multiSelectOptionKeys": [
      "option1",
      "option2",
      "option3"
    ]
  }
]

Response

Returns the updated metadata template, with the custom template data included.

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

    • warning

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