Box · Schema
File version
A standard representation of a file version
Cloud StorageCollaborationContent ManagementDocumentsEnterpriseFile Sharing
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/FileVersion",
"title": "File version",
"type": "object",
"x-box-resource-id": "file_version",
"x-box-variant": "standard",
"description": "A standard representation of a file version",
"allOf": [
{
"$ref": "#/components/schemas/FileVersion--Mini"
},
{
"properties": {
"name": {
"type": "string",
"description": "The name of the file version",
"example": "tigers.jpeg"
},
"size": {
"type": "integer",
"format": "int64",
"description": "Size of the file version in bytes",
"example": 629644
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "When the file version object was created",
"example": "2012-12-12T10:53:43-08:00"
},
"modified_at": {
"type": "string",
"format": "date-time",
"description": "When the file version object was last updated",
"example": "2012-12-12T10:53:43-08:00"
},
"modified_by": {
"allOf": [
{
"$ref": "#/components/schemas/User--Mini"
},
{
"description": "The user who last updated the file version"
}
]
},
"trashed_at": {
"type": "string",
"description": "When the file version object was trashed.",
"format": "date-time",
"nullable": true,
"example": "2012-12-12T10:53:43-08:00"
},
"trashed_by": {
"allOf": [
{
"$ref": "#/components/schemas/User--Mini"
},
{
"description": "The user who trashed the file version"
}
]
},
"restored_at": {
"type": "string",
"description": "When the file version was restored from the trash.",
"format": "date-time",
"nullable": true,
"example": "2012-12-12T10:53:43-08:00"
},
"restored_by": {
"allOf": [
{
"$ref": "#/components/schemas/User--Mini"
},
{
"description": "The user who restored the file version from the trash."
}
]
},
"purged_at": {
"type": "string",
"description": "When the file version object will be permanently deleted.",
"format": "date-time",
"nullable": true,
"example": "2012-12-12T10:53:43-08:00"
},
"uploader_display_name": {
"allOf": [
{
"title": "Uploader display name",
"type": "string",
"example": "Ellis Wiggins",
"nullable": false,
"description": "The display name of the user that uploaded the file. In most cases this is the\nname of the user logged in at the time of the upload.\n\nIf the file was uploaded using a File Request form that requires the user to\nprovide an email address, this field is populated with that email address. If\nan email address was not required in the File Request form, this field is set\nto return a value of `File Request`.\n\nIn all other anonymous cases where no email was provided this field\nwill default to a value of `Someone`."
}
]
}
}
}
]
}