Archive Metadata

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/cesium/main/json-schema/cesium-archive-metadata2-schema.json",
  "title": "Archive Metadata",
  "x-generated": "2026-10-13",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/_original/cesium-api-openapi.yml#/components/schemas/ArchiveMetadata2",
  "type": "object",
  "properties": {
    "id": {
      "$ref": "#/$defs/ArchiveIdentifier"
    },
    "name": {
      "type": "string"
    },
    "assetIds": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/AssetIdentifier"
      }
    },
    "format": {
      "$ref": "#/$defs/ArchiveFormat"
    },
    "status": {
      "$ref": "#/$defs/ArchiveStatus"
    },
    "bytesArchived": {
      "type": "integer",
      "description": "The total number of bytes of the archive that has been processed.",
      "minimum": 0,
      "readOnly": true
    },
    "type": {
      "$ref": "#/$defs/ArchiveType"
    }
  },
  "$defs": {
    "ArchiveFormat": {
      "type": "string",
      "enum": [
        "ZIP",
        "TILESET",
        "GLTF"
      ],
      "description": "Specifies the format of the archive:\n\n| Value | Description |\n| - | - |\n| ZIP | Create a .zip archive containing a full copy of the asset as-hosted on ion.  Used only type FULL |\n| TILESET | Create a .zip archive containing a 3D Tiles 1.1 tileset.  Used only with type CLIP_LATITUDE_LONGITUDE_RECTANGLE |\n| GLTF | Create a GLB file. Used only with type CLIP_LATITUDE_LONGITUDE_RECTANGLE |\n"
    },
    "ArchiveIdentifier": {
      "type": "integer",
      "description": "The unique identifier of this archive.",
      "readOnly": true
    },
    "ArchiveStatus": {
      "type": "string",
      "enum": [
        "NOT_STARTED",
        "IN_PROGRESS",
        "COMPLETE",
        "ERROR"
      ],
      "description": "Describes the state of the asset during the archival processes:\n\n| Value | Description |\n| - | - |\n| NOT_STARTED | The server was notified that the asset is to be archived and is waiting for the archival process to start. |\n| IN_PROGRESS | The asset is being archived, see `bytesArchived` to monitor progress. |\n| COMPLETE | The asset was archived successfully. |\n| ERROR | An error occurred during the archival process. Please retry the archival process again. |\n",
      "readOnly": true
    },
    "ArchiveType": {
      "type": "string",
      "enum": [
        "FULL",
        "CLIP_LATITUDE_LONGITUDE_RECTANGLE"
      ],
      "description": "Describes the type of clip region for this archive:\n\n| Value | Description |\n| - | - |\n| FULL | The archive contains the full data of the asset.  Only valid for use with a single asset. |\n| CLIP_LATITUDE_LONGITUDE_RECTANGLE | Archive contains data around a rectangle defined by latitude and longitude. |\n"
    },
    "AssetIdentifier": {
      "type": "integer",
      "description": "The unique identifier for this asset."
    }
  }
}