Sample - Box Platform API
GET/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema

List all classifications

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.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

4 status codes
200Returns the `securityClassification` metadata template, which contains a `Box__Security__Classification__Key` field that lists all the classifications available to this enterprise.
idstringrequired
The ID of the classification template.
typestringrequired
The value will always be `metadata_template`.
Allowed:metadata_template
scopestringrequired
The scope of the classification template. This is in the format `enterprise_{id}` where the `id` is the enterprise ID.
templateKeystringrequired
The value will always be `securityClassification-6VMVochwUWo`.
Allowed:securityClassification-6VMVochwUWo
displayNamestringrequired
The name of this template as shown in web and mobile interfaces.
Allowed:Classification
hiddenbooleanoptional
Determines if the template is always available in web and mobile interfaces.
copyInstanceOnItemCopybooleanoptional
Determines if classifications are copied along when the file or folder is copied.
fieldsarray<object>required
A list of fields for this classification template. This includes only one field, the `Box__Security__Classification__Key`, which defines the different classifications available in this enterprise.
400Returned if any of the request parameters are not valid.
typestringoptional
The value will always be `error`.
Allowed:error
statusintegeroptional
The HTTP status of the response.
codestringoptional
A Box-specific error code.
Allowed:createdacceptedno_contentredirectnot_modifiedbad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictprecondition_failed
messagestringoptional
A short message describing the error.
context_infoobjectoptional
A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.
help_urlstringoptional
A URL that links to more information about why this error occurred.
request_idstringoptional
A unique identifier for this response, which can be used when contacting Box support.
404Returned when a template name is not correct. Please make sure the URL for the request is correct.
typestringoptional
The value will always be `error`.
Allowed:error
statusintegeroptional
The HTTP status of the response.
codestringoptional
A Box-specific error code.
Allowed:createdacceptedno_contentredirectnot_modifiedbad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictprecondition_failed
messagestringoptional
A short message describing the error.
context_infoobjectoptional
A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.
help_urlstringoptional
A URL that links to more information about why this error occurred.
request_idstringoptional
A unique identifier for this response, which can be used when contacting Box support.
defaultAn unexpected client error.
typestringoptional
The value will always be `error`.
Allowed:error
statusintegeroptional
The HTTP status of the response.
codestringoptional
A Box-specific error code.
Allowed:createdacceptedno_contentredirectnot_modifiedbad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictprecondition_failed
messagestringoptional
A short message describing the error.
context_infoobjectoptional
A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.
help_urlstringoptional
A URL that links to more information about why this error occurred.
request_idstringoptional
A unique identifier for this response, which can be used when contacting Box support.

Error handling

A 400 is returned: Returned if any of the request parameters are not valid. A 404 is returned: Returned when a template name is not correct. Please make sure the URL for the request is correct. Any other status is an error: An unexpected client error.