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

Metadata instance

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 standard variant are generally returned when the resource is requested via its own API endpoints. For example, when retrieving a file by ID, it will return these fields unless the fields parameter has been specified.

$parent string

examplefolder_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}.

$scope string

exampleenterprise_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.

$template string

examplemarketingCollateral

The name of the template

$version integer

example1

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

Response Example

{
  "$parent": "folder_59449484661,",
  "$scope": "enterprise_27335",
  "$template": "marketingCollateral",
  "$version": 1
}