Metadata instance (Full)

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

$parent

string

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

Example:

"folder_59449484661,"

$template

string

The name of the template.

Example:

"marketingCollateral"

$scope

string

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.

Example:

"enterprise_27335"

$version

integer

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

Example:

1

$canEdit

boolean

Whether the user can edit this metadata instance.

Example:

true

$id

string<uuid>

A UUID to identify the metadata instance.

Maximum string length: 36

Example:

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

$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

{key}

any

A value for each of the fields that are present on the metadata template. For the global.properties template this can be a list of zero or more fields, as this template allows for any generic key-value pairs to be stored stored in the template.

Example:

"Aaron Levie"

Documentation Index