Skip to main content

BatchExportResponse

Response model for starting an export batch.

export_case_id object

Export case ID associated with the batch

anyOf
string
export_idsstring[]required

Export IDs successfully queued

results object[]required

Per-item batch export results

  • Array [
  • cameraCamera (string)required

    Camera name for this export attempt

    export_id object

    The export ID when the export was successfully queued

    anyOf
    string
    successSuccess (boolean)required

    Whether the export was successfully queued

    status object

    Queue status for this camera export

    anyOf
    string
    error object

    Validation or queueing error for this item, if any

    anyOf
    string
    item_index object

    Zero-based index of this result within the request items list

    anyOf
    integer
    client_item_id object

    Opaque client-supplied item identifier echoed from the request

    anyOf
    string
  • ]
  • BatchExportResponse
    {
    "export_case_id": "string",
    "export_ids": [
    "string"
    ],
    "results": [
    {
    "camera": "string",
    "export_id": "string",
    "success": true,
    "status": "string",
    "error": "string",
    "item_index": 0,
    "client_item_id": "string"
    }
    ]
    }