BObox
Metadata templates

Find metadata template by instance ID

Changed on

Finds a metadata template by searching for the ID of an instance of the template.

get/metadata_templates

Request

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

Query parameters

metadata_instance_idstring uuid required

The ID of an instance of the metadata template to find.

markerstring

Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.

This requires usemarker to be set to true.

limitinteger

The maximum number of items to return per page.

Response

Returns a list containing the 1 metadata template that matches the instance ID.

limitinteger

The limit that was used for these entries. This will be the same as the limit query parameter unless that value exceeded the maximum value allowed. The maximum value varies by API.

next_markerstring nullable

The marker for the start of the next page of results.

prev_markerstring nullable

The marker for the start of the previous page of results.

Example response

{
  "limit": 1000,
  "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
  "prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih",
  "entries": [
    {
      "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

    • info

      added subschema #1 subschema #2 to the response body allOf list for the response status

    • info

      removed subschema #1 subschema #2 from the response body allOf list for the response status