Box Developer Documentation
Log in

Classification

This resource is used by endpoints in the version 2024.0. For more details, see Box API versioning.

An instance of the classification metadata template, containing the classification applied to the file or folder.

To get more details about the classification applied to an item, request the classification metadata template.

boolean
true

Whether an end user can change the classification.

string
folder_59449484661,

The identifier of the item that this metadata instance has been attached to. This combines the type and the id of the parent in the form {type}_{id}.

string
enterprise_27335

The scope of the enterprise that this classification has been applied for.

This will be in the format enterprise_{enterprise_id}.

string
securityClassification-6VMVochwUWo

The value will always be securityClassification-6VMVochwUWo.

Value is always securityClassification-6VMVochwUWo

string
securityClassification-6VMVochwUWo-fd31537a-0f95-4d86-9f2b-5974a29978f8

The unique ID of this classification instance. This will be include the name of the classification template and a unique ID.

number
5

The version of the metadata template. This version starts at 0 and increases every time the template is updated. This is mostly for internal use.

integer
1

The version of the metadata instance. This version starts at 0 and increases every time a classification is updated.

string
Sensitive

The name of the classification applied to the item.

Response Example

{
  "$canEdit": true,
  "$parent": "folder_59449484661,",
  "$scope": "enterprise_27335",
  "$template": "securityClassification-6VMVochwUWo",
  "$type": "securityClassification-6VMVochwUWo-fd31537a-0f95-4d86-9f2b-5974a29978f8",
  "$typeVersion": 5,
  "$version": 1,
  "Box__Security__Classification__Key": "Sensitive"
}