Box · Schema

Zip download status

The status of a `zip` archive being downloaded.

Cloud StorageCollaborationContent ManagementDocumentsEnterpriseFile Sharing

Properties

Name Type Description
total_file_count integer The total number of files in the archive.
downloaded_file_count integer The number of files that have already been downloaded.
skipped_file_count integer The number of files that have been skipped as they could not be downloaded. In many cases this is due to permission issues that have surfaced between the creation of the request for the archive and th
skipped_folder_count integer The number of folders that have been skipped as they could not be downloaded. In many cases this is due to permission issues that have surfaced between the creation of the request for the archive and
state string The state of the archive being downloaded.
View JSON Schema on GitHub

JSON Schema

box-zipdownloadstatus-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ZipDownloadStatus",
  "title": "Zip download status",
  "type": "object",
  "x-box-resource-id": "zip_download_status",
  "x-box-tag": "zip_downloads",
  "x-box-reference-category": "zip_downloads",
  "description": "The status of a `zip` archive being downloaded.",
  "properties": {
    "total_file_count": {
      "type": "integer",
      "description": "The total number of files in the archive.",
      "example": 20,
      "minimum": 0,
      "maximum": 10000
    },
    "downloaded_file_count": {
      "type": "integer",
      "description": "The number of files that have already been downloaded.",
      "example": 10,
      "minimum": 0
    },
    "skipped_file_count": {
      "type": "integer",
      "description": "The number of files that have been skipped as they could not be\ndownloaded. In many cases this is due to permission issues that have\nsurfaced between the creation of the request for the archive and the\narchive being downloaded.",
      "example": 5,
      "minimum": 0
    },
    "skipped_folder_count": {
      "type": "integer",
      "description": "The number of folders that have been skipped as they could not be\ndownloaded. In many cases this is due to permission issues that have\nsurfaced between the creation of the request for the archive and the\narchive being downloaded.",
      "example": 5,
      "minimum": 0
    },
    "state": {
      "type": "string",
      "description": "The state of the archive being downloaded.",
      "default": "in_progress",
      "example": "succeeded",
      "enum": [
        "in_progress",
        "failed",
        "succeeded"
      ]
    }
  }
}