Box · Schema

Skills metadata instance

The metadata assigned to a using for Box skills.

Cloud StorageCollaborationContent ManagementDocumentsEnterpriseFile Sharing

Properties

Name	Type	Description
$canEdit	boolean	Whether the user can edit this metadata
$id	string	A UUID to identify the metadata object
$parent	string	An ID for the parent folder
$scope	string	An ID for the scope in which this template has been applied
$template	string	The name of the template
$type	string	A unique identifier for the "type" of this instance. This is an internal system property and should not be used by a client application.
$typeVersion	integer	The last-known version of the template of the object. This is an internal system property and should not be used by a client application.
$version	integer	The version of the metadata object. Starts at 0 and increases every time a user-defined property is modified.
cards	array	A list of Box Skill cards that have been applied to this file.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SkillCardsMetadata",
  "title": "Skills metadata instance",
  "type": "object",
  "x-box-resource-id": "skill_cards_metadata",
  "x-box-tag": "skills",
  "description": "The metadata assigned to a using for Box skills.",
  "properties": {
    "$canEdit": {
      "type": "boolean",
      "example": true,
      "description": "Whether the user can edit this metadata"
    },
    "$id": {
      "type": "string",
      "format": "uuid",
      "example": "01234500-12f1-1234-aa12-b1d234cb567e",
      "maxLength": 36,
      "description": "A UUID to identify the metadata object"
    },
    "$parent": {
      "type": "string",
      "example": "folder_59449484661,",
      "description": "An ID for the parent folder"
    },
    "$scope": {
      "type": "string",
      "example": "enterprise_27335",
      "description": "An ID for the scope in which this template\nhas been applied"
    },
    "$template": {
      "type": "string",
      "example": "properties",
      "description": "The name of the template"
    },
    "$type": {
      "type": "string",
      "example": "properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0",
      "description": "A unique identifier for the \"type\" of this instance. This is an internal\nsystem property and should not be used by a client application."
    },
    "$typeVersion": {
      "type": "integer",
      "example": 2,
      "description": "The last-known version of the template of the object. This is an internal\nsystem property and should not be used by a client application."
    },
    "$version": {
      "type": "integer",
      "example": 1,
      "description": "The version of the metadata object. Starts at 0 and increases every time\na user-defined property is modified."
    },
    "cards": {
      "type": "array",
      "description": "A list of Box Skill cards that have been applied to this file.",
      "items": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/KeywordSkillCard"
          },
          {
            "$ref": "#/components/schemas/TimelineSkillCard"
          },
          {
            "$ref": "#/components/schemas/TranscriptSkillCard"
          },
          {
            "$ref": "#/components/schemas/StatusSkillCard"
          }
        ]
      }
    }
  }
}