Box Developer Documentation
Log in

Join BoxWorks 2024 to discover what's possible with content and AI!

Register now!

Metadata instance (Full)

An instance of a metadata template, which has been applied to a file or folder.

This resource has a few variations that can be encountered when using the API.

The fields that are part of the full variant can be returned by API endpoints that support the fields parameter. For example, by defining the fields request parameter as id,type when requesting a file by ID, only those fields will be returned in the API response.

boolean
true

Whether the user can edit this metadata instance.

string (uuid)
01234500-12f1-1234-aa12-b1d234cb567e36

A UUID to identify the metadata instance.

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

An ID for the scope in which this template has been applied. This will be enterprise_{enterprise_id} for templates defined for use in this enterprise, and global for general templates that are available to all enterprises using Box.

string
marketingCollateral

The name of the template

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

A unique identifier for the "type" of this instance. This is an internal system property and should not be used by a client application.

integer
2

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.

integer
1

The version of the metadata instance. This version starts at 0 and increases every time a user-defined property is modified.

Response Example

{
  "$canEdit": true,
  "$id": "01234500-12f1-1234-aa12-b1d234cb567e",
  "$parent": "folder_59449484661,",
  "$scope": "enterprise_27335",
  "$template": "marketingCollateral",
  "$type": "properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0",
  "$typeVersion": 2,
  "$version": 1
}