DownloadArchiveDto

Endpoints · All schemas

Field	Required	Description
archiveName	No	The name of the archive to download, without extension
assetIds	Yes	Asset IDs
edited	No	Download edited asset if available

Complete definition

required lists fields that must be present. nullable allows a null value; it does not make the field optional. Response enums retain exact wire values for compatibility.

{
  "properties": {
    "archiveName": {
      "description": "The name of the archive to download, without extension",
      "type": "string"
    },
    "assetIds": {
      "description": "Asset IDs",
      "items": {
        "format": "uuid",
        "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
        "type": "string"
      },
      "type": "array"
    },
    "edited": {
      "description": "Download edited asset if available",
      "type": "boolean"
    }
  },
  "required": [
    "assetIds"
  ],
  "type": "object"
}