Get classification on file

v1.0.0

Retrieves the classification metadata instance that has been applied to a file.

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

Input

{
  "type": "object",
  "properties": {
    "file_id": {
      "type": "string"
    }
  },
  "required": [
    "file_id"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "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": {
    "$canEdit": {
      "type": "boolean",
      "description": "Whether an end user can change the classification."
    },
    "$parent": {
      "type": "string",
      "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}`."
    },
    "$scope": {
      "type": "string",
      "description": "The scope of the enterprise that this classification has been\napplied for.\n\nThis will be in the format `enterprise_{enterprise_id}`."
    },
    "$template": {
      "type": "string",
      "description": "`securityClassification-6VMVochwUWo`",
      "enum": [
        "securityClassification-6VMVochwUWo"
      ]
    },
    "$type": {
      "type": "string",
      "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",
      "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."
    },
    "$version": {
      "type": "integer",
      "description": "The version of the metadata instance. This version starts at 0 and\nincreases every time a classification is updated."
    },
    "Box__Security__Classification__Key": {
      "type": "string",
      "description": "The name of the classification applied to the item."
    }
  }
}