Box · Schema
Items
A list of files, folders, and web links in their mini representation.
Cloud StorageCollaborationContent ManagementDocumentsEnterpriseFile Sharing
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/Items",
"title": "Items",
"type": "object",
"x-box-resource-id": "items",
"x-box-tag": "folders",
"description": "A list of files, folders, and web links in\ntheir mini representation.",
"allOf": [
{
"type": "object",
"description": "The part of an API response that describes pagination",
"properties": {
"total_count": {
"description": "One greater than the offset of the last entry in the entire collection.\nThe total number of entries in the collection may be less than\n`total_count`.\n\nThis field is only returned for calls that use offset-based pagination.\nFor marker-based paginated APIs, this field will be omitted.",
"example": 5000,
"type": "integer",
"format": "int64"
},
"limit": {
"description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.",
"example": 1000,
"type": "integer",
"format": "int64"
},
"offset": {
"description": "The 0-based offset of the first entry in this set. This will be the same\nas the `offset` query parameter.\n\nThis field is only returned for calls that use offset-based pagination.\nFor marker-based paginated APIs, this field will be omitted.",
"example": 2000,
"type": "integer",
"format": "int64"
},
"order": {
"description": "The order by which items are returned.\n\nThis field is only returned for calls that use offset-based pagination.\nFor marker-based paginated APIs, this field will be omitted.",
"type": "array",
"items": {
"type": "object",
"description": "The order in which a pagination is ordered",
"properties": {
"by": {
"description": "The field to order by",
"example": "type",
"type": "string"
},
"direction": {
"type": "string",
"description": "The direction to order by, either ascending or descending",
"example": "ASC",
"enum": [
"ASC",
"DESC"
]
}
}
}
}
}
},
{
"properties": {
"entries": {
"description": "The items in this collection.",
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/File--Full"
},
{
"$ref": "#/components/schemas/Folder--Mini"
},
{
"$ref": "#/components/schemas/WebLink"
}
]
}
}
}
}
]
}