Box · Schema
Metadata instance (Full)
An instance of a metadata template, which has been applied to a file or folder.
Cloud StorageCollaborationContent ManagementDocumentsEnterpriseFile Sharing
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/Metadata--Full",
"title": "Metadata instance (Full)",
"type": "object",
"x-box-resource-id": "metadata--full",
"x-box-variant": "full",
"description": "An instance of a metadata template, which has been applied to a file or\nfolder.",
"allOf": [
{
"$ref": "#/components/schemas/Metadata"
},
{
"properties": {
"$canEdit": {
"type": "boolean",
"example": true,
"description": "Whether the user can edit this metadata instance."
},
"$id": {
"type": "string",
"format": "uuid",
"example": "01234500-12f1-1234-aa12-b1d234cb567e",
"maxLength": 36,
"description": "A UUID to identify the metadata instance."
},
"$type": {
"type": "string",
"example": "properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0",
"description": "A unique identifier for the \"type\" of this instance. This is an\ninternal system property and should not be used by a client\napplication."
},
"$typeVersion": {
"type": "integer",
"example": 2,
"description": "The last-known version of the template of the object. This is an\ninternal system property and should not be used by a client\napplication."
}
}
},
{
"additionalProperties": {
"allOf": [
{},
{
"example": "Aaron Levie"
},
{
"description": "A value for each of the fields that are present\non the metadata template.\nFor the `global.properties` template this can be\na list of zero or more fields,\nas this template allows for any generic key-value pairs \nto be stored stored in the template."
}
],
"x-box-example-key": "name"
}
}
]
}