Join BoxWorks 2024 to discover what's possible with content and AI!

List all classifications

get

https://api.box.com/2.0

/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema

Retrieves the classification metadata template and lists all the classifications available to this enterprise.

This API can also be called by including the enterprise ID in the URL explicitly, for example /metadata_templates/enterprise_12345/securityClassification-6VMVochwUWo/schema.

Response

200application/jsonClassification Template

Returns the securityClassification metadata template, which contains a Box__Security__Classification__Key field that lists all the classifications available to this enterprise.

400application/jsonClient error

Returned if any of the request parameters are not valid.

404application/jsonClient error

Returned when a template name is not correct. Please make sure the URL for the request is correct.

defaultapplication/jsonClient error

An unexpected client error.

get

List all classifications

You can now try out some of our APIs live, right here in the documentation.

Request Example

cURL

curl -i -X GET "https://api.box.com/2.0/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema" \
     -H "authorization: Bearer <ACCESS_TOKEN>"

TypeScript Gen

await client.classifications.getClassificationTemplate();

Python Gen

client.classifications.get_classification_template()

.NET Gen

await client.Classifications.GetClassificationTemplateAsync();

Swift Gen (Beta)

try await client.classifications.getClassificationTemplate()

Java

MetadataTemplate template = MetadataTemplate.getMetadataTemplate(api, Metadata.CLASSIFICATION_TEMPLATE_KEY);

Python

template = client.metadata_template('enterprise', 'securityClassification-6VMVochwUWo').get()

.NET

var template = await client.MetadataManager.GetMetadataTemplate("enterprise", "securityClassification-6VMVochwUWo");

Node

client.metadata.getTemplateSchema('enterprise', 'securityClassification-6VMVochwUWo')
	.then(template => {
		// the classification template
	});

Response Example

{
  "id": "58063d82-4128-7b43-bba9-92f706befcdf",
  "type": "metadata_template",
  "copyInstanceOnItemCopy": true,
  "displayName": "Classification",
  "fields": [
    {
      "id": "822227e0-47a5-921b-88a8-494760b2e6d2",
      "type": "enum",
      "key": "Box__Security__Classification__Key",
      "displayName": "Classification",
      "hidden": false,
      "options": [
        {
          "id": "46aea176-3483-4431-856c-6b5b13d1cc50",
          "key": "Sensitive",
          "staticConfig": {
            "classification": {
              "classificationDefinition": "Sensitive information",
              "colorID": 4
            }
          }
        }
      ]
    }
  ],
  "hidden": false,
  "scope": "enterprise_123456",
  "templateKey": "securityClassification-6VMVochwUWo"
}