Skip to main content
GET
/
files
/
{file_id}
/
metadata
/
global
/
boxSkillsCards
cURL
curl -i -X PUT "https://api.box.com/2.0/files/12345/metadata/global/boxSkillsCards" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
{
  "$canEdit": true,
  "$id": "01234500-12f1-1234-aa12-b1d234cb567e",
  "$parent": "folder_59449484661,",
  "$scope": "enterprise_27335",
  "$template": "properties",
  "$type": "properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0",
  "$typeVersion": 2,
  "$version": 1,
  "cards": [
    {
      "type": "skill_card",
      "skill_card_type": "keyword",
      "skill": {
        "type": "service",
        "id": "image-recognition-service"
      },
      "invocation": {
        "type": "skill_invocation",
        "id": "image-recognition-service-123"
      },
      "entries": [
        {
          "text": "keyword1"
        }
      ],
      "created_at": "2018-04-13T13:53:23-07:00",
      "skill_card_title": {
        "message": "Labels",
        "code": "labels"
      }
    }
  ]
}
This endpoint is in the version 2024.0. No changes are required to continue using it. For more details, see Box API versioning.Learn more about Box SDK versioning strategy.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
file_id
string
required

The unique identifier that represents a file.

The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.

Response

Returns all the metadata associated with a file.

This API does not support pagination and will therefore always return all of the metadata associated to the file.

The metadata assigned to a using for Box skills.

​
$canEdit
boolean

Whether the user can edit this metadata.

Example:

true

​
$id
string<uuid>

A UUID to identify the metadata object.

Maximum string length: 36
Example:

"01234500-12f1-1234-aa12-b1d234cb567e"

​
$parent
string

An ID for the parent folder.

Example:

"folder_59449484661,"

​
$scope
string

An ID for the scope in which this template has been applied.

Example:

"enterprise_27335"

​
$template
string

The name of the template.

Example:

"properties"

​
$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.

Example:

"properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0"

​
$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.

Example:

2

​
$version
integer

The version of the metadata object. Starts at 0 and increases every time a user-defined property is modified.

Example:

1

​
cards
(Keyword Skill Card · object | Timeline Skill Card · object | Transcript Skill Card. · object | Status Skill Card · object)[]

A list of Box Skill cards that have been applied to this file.

A skill card that contains a set of keywords.