Box · Schema
File (Mini)
A mini representation of a file, used when nested under another resource.
Cloud StorageCollaborationContent ManagementDocumentsEnterpriseFile Sharing
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/File--Mini",
"title": "File (Mini)",
"type": "object",
"x-box-resource-id": "file--mini",
"x-box-variant": "mini",
"description": "A mini representation of a file, used when\nnested under another resource.",
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/File--Base"
},
{
"properties": {
"sequence_id": {
"allOf": [
{
"type": "string",
"example": "3",
"nullable": true,
"description": "A numeric identifier that represents the most recent user event\nthat has been applied to this item.\n\nThis can be used in combination with the `GET /events`-endpoint\nto filter out user events that would have occurred before this\nidentifier was read.\n\nAn example would be where a Box Drive-like application\nwould fetch an item via the API, and then listen to incoming\nuser events for changes to the item. The application would\nignore any user events where the `sequence_id` in the event\nis smaller than or equal to the `sequence_id` in the originally\nfetched resource."
},
{
"nullable": false
}
]
},
"name": {
"type": "string",
"description": "The name of the file",
"example": "Contract.pdf"
},
"sha1": {
"type": "string",
"format": "digest",
"nullable": false,
"example": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
"description": "The SHA1 hash of the file. This can be used to compare the contents\nof a file on Box with a local file."
},
"file_version": {
"allOf": [
{
"$ref": "#/components/schemas/FileVersion--Mini"
},
{
"description": "The information about the current version of the file."
}
]
}
}
}
]
}