Box · Schema

Classification

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.

Cloud StorageCollaborationContent ManagementDocumentsEnterpriseFile Sharing

Properties

Name	Type	Description
Box__Security__Classification__Key	string	The name of the classification applied to the item.
$parent	string	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}`.
$template	string	`securityClassification-6VMVochwUWo`
$scope	string	The scope of the enterprise that this classification has been applied for. This will be in the format `enterprise_{enterprise_id}`.
$version	integer	The version of the metadata instance. This version starts at 0 and increases every time a classification is updated.
$type	string	The unique ID of this classification instance. This will be include the name of the classification template and a unique ID.
$typeVersion	number	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.
$canEdit	boolean	Whether an end user can change the classification.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Classification",
  "title": "Classification",
  "type": "object",
  "x-box-resource-id": "classification",
  "x-box-tag": "classifications",
  "description": "An instance of the classification metadata template, containing\nthe classification applied to the file or folder.\n\nTo get more details about the classification applied to an item,\nrequest the classification metadata template.",
  "properties": {
    "Box__Security__Classification__Key": {
      "type": "string",
      "example": "Sensitive",
      "description": "The name of the classification applied to the item."
    },
    "$parent": {
      "type": "string",
      "example": "folder_59449484661,",
      "description": "The identifier of the item that this metadata instance\nhas been attached to. This combines the `type` and the `id`\nof the parent in the form `{type}_{id}`."
    },
    "$template": {
      "type": "string",
      "example": "securityClassification-6VMVochwUWo",
      "description": "`securityClassification-6VMVochwUWo`",
      "enum": [
        "securityClassification-6VMVochwUWo"
      ]
    },
    "$scope": {
      "type": "string",
      "example": "enterprise_27335",
      "description": "The scope of the enterprise that this classification has been\napplied for.\n\nThis will be in the format `enterprise_{enterprise_id}`."
    },
    "$version": {
      "type": "integer",
      "example": 1,
      "description": "The version of the metadata instance. This version starts at 0 and\nincreases every time a classification is updated."
    },
    "$type": {
      "type": "string",
      "example": "securityClassification-6VMVochwUWo-fd31537a-0f95-4d86-9f2b-5974a29978f8",
      "description": "The unique ID of this classification instance. This will be include\nthe name of the classification template and a unique ID."
    },
    "$typeVersion": {
      "type": "number",
      "example": 5,
      "description": "The version of the metadata template. This version starts at 0 and\nincreases every time the template is updated. This is mostly for internal\nuse."
    },
    "$canEdit": {
      "type": "boolean",
      "example": true,
      "description": "Whether an end user can change the classification."
    }
  }
}