TakeoutItemResponseDto

Endpoints · All schemas

Field	Required	Description
albums	Yes	array
assetId	Yes	The library item it became or matched, when this session may open it
candidates	Yes	array
error	Yes	string
folder	Yes	string
id	Yes	string
kind	Yes	See definition below
locked	Yes	boolean
metadata	Yes	See definition below
path	Yes	Path inside the export
sidecarId	Yes	string
size	Yes	integer
source	Yes	The archive or directory the file came from
state	Yes	See definition below
warnings	Yes	array

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.

Field definitions: TakeoutSidecarCandidateDto, TakeoutItemKind, TakeoutMetadataDto, TakeoutItemState, TakeoutWarning

{
  "properties": {
    "albums": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "assetId": {
      "description": "The library item it became or matched, when this session may open it",
      "format": "uuid",
      "nullable": true,
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "type": "string"
    },
    "candidates": {
      "items": {
        "$ref": "#/components/schemas/TakeoutSidecarCandidateDto"
      },
      "type": "array"
    },
    "error": {
      "nullable": true,
      "type": "string"
    },
    "folder": {
      "type": "string"
    },
    "id": {
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "type": "string"
    },
    "kind": {
      "$ref": "#/components/schemas/TakeoutItemKind"
    },
    "locked": {
      "type": "boolean"
    },
    "metadata": {
      "$ref": "#/components/schemas/TakeoutMetadataDto"
    },
    "path": {
      "description": "Path inside the export",
      "type": "string"
    },
    "sidecarId": {
      "format": "uuid",
      "nullable": true,
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "type": "string"
    },
    "size": {
      "maximum": 9007199254740991,
      "minimum": -9007199254740991,
      "type": "integer"
    },
    "source": {
      "description": "The archive or directory the file came from",
      "type": "string"
    },
    "state": {
      "$ref": "#/components/schemas/TakeoutItemState"
    },
    "warnings": {
      "items": {
        "$ref": "#/components/schemas/TakeoutWarning"
      },
      "type": "array"
    }
  },
  "required": [
    "albums",
    "assetId",
    "candidates",
    "error",
    "folder",
    "id",
    "kind",
    "locked",
    "metadata",
    "path",
    "sidecarId",
    "size",
    "source",
    "state",
    "warnings"
  ],
  "type": "object"
}