Skip to main content

BatchExportBody

items object[]required

List of export items. Each item has its own camera and time range.

Possible values: >= 1, <= 50

  • Array [
    • cameraCamera name (string)required
    start_timeStart time (number)required
    end_timeEnd time (number)required
    image_path object

    Optional existing image to use as the export thumbnail

    anyOf
    string
    friendly_name object

    Optional friendly name for this specific export item

    anyOf
    string

    Possible values: <= 256 characters

    client_item_id object

    Optional opaque client identifier echoed back in results

    anyOf
    string

    Possible values: <= 128 characters

  • ]
    • export_case_id object

    Existing export case ID to assign all exports to. Attaching to an existing case is temporarily admin-only until case-level ACLs exist.

    anyOf
    string

    Possible values: <= 30 characters

    new_case_name object

    Name of a new export case to create when export_case_id is omitted

    anyOf
    string

    Possible values: <= 100 characters

    new_case_description object

    Optional description for a newly created export case

    anyOf
    string
    BatchExportBody
    {
      "items": [
        {
          "camera": "string",
          "start_time": 0,
          "end_time": 0,
          "image_path": "string",
          "friendly_name": "string",
          "client_item_id": "string"
        }
      ],
      "export_case_id": "string",
      "new_case_name": "string",
      "new_case_description": "string"
    }