Box · Schema
Metadata instance (Base)
The base representation of a metadata instance.
Cloud StorageCollaborationContent ManagementDocumentsEnterpriseFile Sharing
Properties
| Name | Type | Description |
|---|---|---|
| $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}`. |
| $template | string | The name of the template |
| $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 ava |
| $version | integer | The version of the metadata instance. This version starts at 0 and increases every time a user-defined property is modified. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/Metadata--Base",
"title": "Metadata instance (Base)",
"type": "object",
"x-box-resource-id": "metadata--base",
"x-box-sanitized": true,
"x-box-tag": "file_metadata",
"x-box-variants": [
"base",
"standard",
"full"
],
"x-box-variant": "base",
"description": "The base representation of a metadata instance.",
"properties": {
"$parent": {
"type": "string",
"example": "folder_59449484661,",
"description": "The identifier of the item that this metadata instance\nhas been attached to. This combines the `type` and the `id`\nof the parent in the form `{type}_{id}`."
},
"$template": {
"type": "string",
"example": "marketingCollateral",
"description": "The name of the template"
},
"$scope": {
"type": "string",
"example": "enterprise_27335",
"description": "An ID for the scope in which this template\nhas been applied. This will be `enterprise_{enterprise_id}` for templates\ndefined for use in this enterprise, and `global` for general templates\nthat are available to all enterprises using Box."
},
"$version": {
"type": "integer",
"example": 1,
"description": "The version of the metadata instance. This version starts at 0 and\nincreases every time a user-defined property is modified."
}
}
}