---
title: "Preview batch"
method: POST
path: "/orchestration/batches/preview"
tags: ["Orchestration - Batches"]
---

# Preview batch

`POST /orchestration/batches/preview`

Preview batch data before execution

## Request body

- object — Request body schema.
  - `workflowUuid` string, uuid, required — Workflow identifier.
  - `data` union, required — Batch input data.
    - object
      - `kind` 'segment', required — Data kind.
      - `segmentUuid` string, uuid, required — Segment identifier.
    - object
      - `kind` 'change', required — Data kind.
      - `changeUuid` string, uuid, required — Change identifier.
      - `changeKinds` string[], required — Change kinds to include.
    - object
      - `kind` 'filter', required — Data kind.
      - `modelUuid` string, uuid, required — Model identifier.
      - `filter` object — Filter criteria.
        - `conjonction` 'or' | 'and', required
        - `groups` object[], required
          - `conjonction` 'or' | 'and', required
          - `conditions` union[], required
            - union
              - …
      - `sort` object[] — Sort criteria.
        - `columnSlug` string, required
        - `kind` 'asc' | 'desc', required
      - `limit` number — Maximum number of records.
    - object
      - `kind` 'file', required — Data kind.
      - `s3Filename` string, required — S3 file identifier.
    - object
      - `kind` 'runs', required — Data kind.
      - `filter` union, required
        - object — Runs filter criteria.
          - `batchUuid` string, uuid — Batch identifier to filter by.
          - `releaseUuid` string, uuid — Release identifier to filter by.
          - `parentBatchUuid` string, uuid — Parent batch identifier.
          - `parentRunUuid` string, uuid — Parent run identifier.
          - `parentNodeUuid` string, uuid — Parent node identifier.
          - `isGroupParent` boolean — Whether the run is a group parent.
          - `executionsFilter` object — Executions filter criteria.
            - `conjonction` 'or' | 'and', required
            - `groups` object[], required
              - …
          - `kind` 'runs', required — Filter kind.
          - `uuids` string[] — Run identifiers to include.
          - `statuses` string[] — Run statuses to include.
        - object — Runs filter criteria.
          - `batchUuid` string, uuid — Batch identifier to filter by.
          - `releaseUuid` string, uuid — Release identifier to filter by.
          - `parentBatchUuid` string, uuid — Parent batch identifier.
          - `parentRunUuid` string, uuid — Parent run identifier.
          - `parentNodeUuid` string, uuid — Parent node identifier.
          - `isGroupParent` boolean — Whether the run is a group parent.
          - `executionsFilter` object — Executions filter criteria.
            - `conjonction` 'or' | 'and', required
            - `groups` object[], required
              - …
          - `kind` 'records', required — Filter kind.
          - `ids` string[] — Record identifiers to include.
          - `title` string — Record title to filter by.
      - `reset` union, required — Reset options.
        - object
          - `from` 'lastNode', required — Reset from the last node.
        - object
          - `from` 'firstNode', required — Reset from the first node.
        - object
          - `from` 'nextNode', required — Reset from the next node.
        - object
          - `from` 'node', required — Reset from a specific node.
          - `nodeUuid` string, uuid, required — Node identifier to reset from.
    - object
      - `kind` 'recordIds', required — Data kind.
      - `modelUuid` string, uuid, required — Model identifier.
      - `ids` string[], required — Record identifiers.
    - object
      - `kind` 'group', required — Data kind.
      - `parentBatchUuid` string, uuid — Parent batch identifier.
      - `parentRunUuid` string, uuid, required — Parent run identifier.
      - `parentNodeUuid` string, uuid, required — Parent node identifier.
      - `items` unknown[], required — Grouped items.
        - unknown
    - object
      - `kind` 'records', required — Data kind.
      - `records` object[], required — Inline records.
    - object
      - `kind` 'schedule', required — Data kind.
      - `modelUuid` string, uuid, required — Model identifier.
      - `segmentUuid` string, uuid, required — Segment identifier.
      - `changeKinds` string[], required — Change kinds to include.

## Response `200`

Successful response

- object
  - `outcome` 'previewed', required — Preview outcome.
  - `count` number, required — Total number of records.
  - `records` object[], required — Previewed records.

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `404` — Not found
- `500` — Internal server error

---

[API](https://skmtc.net/getcargo/apis/cargo-api.md) · [All operations](https://skmtc.net/getcargo/apis/cargo-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/getcargo/cargo-api/revisions/1d5a19e01d83/schema)