TakeoutResponseDto

Endpoints · All schemas

Field	Required	Description
action	Yes	What the latest job did or is doing
albums	Yes	array
counts	Yes	See definition below
createdAt	Yes	string
error	Yes	string
errorCode	Yes	string
id	Yes	string
name	Yes	string
operationId	Yes	The latest job, as Activity lists it
options	Yes	See definition below
phase	Yes	See definition below
processed	Yes	Units the latest job has finished
sources	Yes	array
state	Yes	See definition below
total	Yes	Units the latest job knows of so far; grows while a scan reads its sources
updatedAt	Yes	string

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: TakeoutAction, TakeoutAlbumDto, TakeoutCountsDto, TakeoutOptionsResponseDto, TakeoutPhase, TakeoutSourceResponseDto, TakeoutState

{
  "properties": {
    "action": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TakeoutAction"
        }
      ],
      "description": "What the latest job did or is doing",
      "nullable": true
    },
    "albums": {
      "items": {
        "$ref": "#/components/schemas/TakeoutAlbumDto"
      },
      "type": "array"
    },
    "counts": {
      "$ref": "#/components/schemas/TakeoutCountsDto"
    },
    "createdAt": {
      "type": "string"
    },
    "error": {
      "nullable": true,
      "type": "string"
    },
    "errorCode": {
      "nullable": true,
      "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"
    },
    "name": {
      "type": "string"
    },
    "operationId": {
      "description": "The latest job, as Activity lists 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"
    },
    "options": {
      "$ref": "#/components/schemas/TakeoutOptionsResponseDto"
    },
    "phase": {
      "$ref": "#/components/schemas/TakeoutPhase"
    },
    "processed": {
      "description": "Units the latest job has finished",
      "maximum": 9007199254740991,
      "minimum": -9007199254740991,
      "type": "integer"
    },
    "sources": {
      "items": {
        "$ref": "#/components/schemas/TakeoutSourceResponseDto"
      },
      "type": "array"
    },
    "state": {
      "$ref": "#/components/schemas/TakeoutState"
    },
    "total": {
      "description": "Units the latest job knows of so far; grows while a scan reads its sources",
      "maximum": 9007199254740991,
      "minimum": -9007199254740991,
      "nullable": true,
      "type": "integer"
    },
    "updatedAt": {
      "type": "string"
    }
  },
  "required": [
    "action",
    "albums",
    "counts",
    "createdAt",
    "error",
    "errorCode",
    "id",
    "name",
    "operationId",
    "options",
    "phase",
    "processed",
    "sources",
    "state",
    "total",
    "updatedAt"
  ],
  "type": "object"
}