Metadata instance

A piece of metadata as specified by a metadata template and applied to a file or folder.

$canEdit boolean

exampletrue

Whether the user can edit this metadata

$id string / uuid

example01234500-12f1-1234-aa12-b1d234cb567eMax Length36

A UUID to identify the metadata object

$parent string

examplefolder_59449484661,

An ID for the parent folder

$scope string

exampleenterprise_27335

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

$template string

exampleproperties

The name of the template

$type string

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

$typeVersion integer

example2

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

example1

The version of the metadata object. 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": "properties",
  "$type": "properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0",
  "$typeVersion": 2,
  "$version": 1
}