> ## Documentation Index > Fetch the complete documentation index at: https://docs.getcargo.ai/llms.txt > Use this file to discover all available pages before exploring further. # Preview batch > Preview batch data before execution ## OpenAPI ````yaml https://api.getcargo.io/openapi.json post /orchestration/batches/preview openapi: 3.1.0 info: title: Cargo API version: 1.0.0 description: Cargo Platform API v1 servers: - url: https://api.getcargo.io/v1 description: Cargo API security: - bearerAuth: [] paths: /orchestration/batches/preview: post: tags: - Orchestration - Batches summary: Preview batch description: Preview batch data before execution requestBody: required: true content: application/json: schema: type: object properties: workflowUuid: title: Workflow UUID description: Workflow identifier. type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$ data: anyOf: - type: object properties: kind: type: string enum: - segment title: Kind description: Data kind. segmentUuid: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$ title: Segment UUID description: Segment identifier. required: - kind - segmentUuid - type: object properties: kind: type: string enum: - change title: Kind description: Data kind. changeUuid: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$ title: Change UUID description: Change identifier. changeKinds: type: array items: type: string enum: - added - updated - removed - unchanged title: Change kinds description: Change kinds to include. required: - kind - changeUuid - changeKinds - type: object properties: kind: type: string enum: - filter title: Kind description: Data kind. modelUuid: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$ title: Model UUID description: Model identifier. filter: title: Filter description: Filter criteria. type: object properties: conjonction: type: string enum: - or - and groups: type: array items: type: object properties: conjonction: type: string enum: - or - and conditions: type: array items: anyOf: - type: object properties: kind: type: string const: sql name: type: string clause: type: string required: - kind - name - clause - allOf: - type: object properties: kind: type: string const: string relatedModelUuid: type: string columnSlug: type: string required: - kind - columnSlug - anyOf: - type: object properties: operator: type: string enum: - is - isNot - contains - doesNotContain - startsWith - endsWith values: anyOf: - type: string - type: array items: type: string required: - operator - values - type: object properties: operator: type: string enum: - isNull - isNotNull - isEmpty - isNotEmpty required: - operator - allOf: - type: object properties: kind: type: string const: number relatedModelUuid: type: string columnSlug: type: string required: - kind - columnSlug - anyOf: - type: object properties: operator: type: string enum: - is - isNot - greaterThan - lowerThan value: type: number required: - operator - value - type: object properties: operator: type: string const: between firstValue: type: number lastValue: type: number required: - operator - firstValue - lastValue - type: object properties: operator: type: string enum: - isNull - isNotNull required: - operator - allOf: - type: object properties: kind: type: string const: objectProperty relatedModelUuid: type: string columnSlug: type: string propertyName: type: string required: - kind - columnSlug - propertyName - anyOf: - type: object properties: operator: type: string enum: - is - isNot - contains - greaterThan - lowerThan - doesNotContain - startsWith - endsWith value: type: string required: - operator - value - type: object properties: operator: type: string enum: - isNull - isNotNull - isEmpty - isNotEmpty required: - operator - type: object properties: operator: type: string const: between value: type: string otherValue: type: string required: - operator - value - otherValue - allOf: - type: object properties: kind: type: string const: object relatedModelUuid: type: string columnSlug: type: string required: - kind - columnSlug - anyOf: - type: object properties: operator: type: string const: isNull required: - operator - type: object properties: operator: type: string const: isNotNull required: - operator - type: object properties: operator: type: string const: matchConditions conjonction: type: string enum: - or - and propertyConditions: type: array items: allOf: - type: object properties: kind: type: string const: objectProperty relatedModelUuid: type: string columnSlug: type: string propertyName: type: string required: - kind - columnSlug - propertyName - anyOf: - type: object properties: operator: type: string enum: - is - isNot - contains - greaterThan - lowerThan - doesNotContain - startsWith - endsWith value: type: string required: - operator - value - type: object properties: operator: type: string enum: - isNull - isNotNull - isEmpty - isNotEmpty required: - operator - type: object properties: operator: type: string const: between value: type: string otherValue: type: string required: - operator - value - otherValue required: - operator - conjonction - propertyConditions - allOf: - type: object properties: kind: type: string const: array relatedModelUuid: type: string columnSlug: type: string required: - kind - columnSlug - anyOf: - type: object properties: operator: type: string const: isNull required: - operator - type: object properties: operator: type: string const: isNotNull required: - operator - type: object properties: operator: type: string const: matchConditions conjonction: type: string enum: - or - and propertyConditions: type: array items: allOf: - type: object properties: kind: type: string const: objectProperty relatedModelUuid: type: string columnSlug: type: string propertyName: type: string required: - kind - columnSlug - propertyName - anyOf: - type: object properties: operator: type: string enum: - is - isNot - contains - greaterThan - lowerThan - doesNotContain - startsWith - endsWith value: type: string required: - operator - value - type: object properties: operator: type: string enum: - isNull - isNotNull - isEmpty - isNotEmpty required: - operator - type: object properties: operator: type: string const: between value: type: string otherValue: type: string required: - operator - value - otherValue required: - operator - conjonction - propertyConditions - type: object properties: kind: type: string const: any relatedModelUuid: type: string columnSlug: type: string operator: type: string enum: - isNull - isNotNull required: - kind - columnSlug - operator - type: object properties: kind: type: string const: vector relatedModelUuid: type: string columnSlug: type: string operator: type: string enum: - isNull - isNotNull required: - kind - columnSlug - operator - allOf: - type: object properties: kind: type: string const: date relatedModelUuid: type: string columnSlug: type: string required: - kind - columnSlug - anyOf: - type: object properties: operator: type: string enum: - is - isNot - greaterThan - lowerThan value: type: string required: - operator - value - type: object properties: operator: type: string const: between firstValue: type: string lastValue: type: string required: - operator - firstValue - lastValue - type: object properties: operator: type: string enum: - isNull - isNotNull required: - operator - type: object properties: kind: type: string const: boolean relatedModelUuid: type: string columnSlug: type: string operator: type: string enum: - isTrue - isFalse - isNull - isNotNull required: - kind - columnSlug - operator - type: object properties: kind: type: string const: occurrence relatedModelUuid: type: string frequency: anyOf: - type: object properties: operator: type: string const: not required: - operator - type: object properties: operator: type: string enum: - moreThan - lessThan - exactly value: type: number required: - operator - value period: type: object properties: operator: type: string enum: - lessThan - moreThan - exactly value: type: number unit: type: string const: day required: - operator - value - unit conjonction: type: string enum: - or - and conditions: type: array items: anyOf: - allOf: - type: object properties: kind: type: string const: string relatedModelUuid: type: string columnSlug: type: string required: - kind - columnSlug - anyOf: - type: object properties: operator: type: string enum: - is - isNot - contains - doesNotContain - startsWith - endsWith values: anyOf: - type: string - type: array items: type: {} required: - operator - values - type: object properties: operator: type: string enum: - isNull - isNotNull - isEmpty - isNotEmpty required: - operator - allOf: - type: object properties: kind: type: string const: number relatedModelUuid: type: string columnSlug: type: string required: - kind - columnSlug - anyOf: - type: object properties: operator: type: string enum: - is - isNot - greaterThan - lowerThan value: type: number required: - operator - value - type: object properties: operator: type: string const: between firstValue: type: number lastValue: type: number required: - operator - firstValue - lastValue - type: object properties: operator: type: string enum: - isNull - isNotNull required: - operator - allOf: - type: object properties: kind: type: string const: object relatedModelUuid: type: string columnSlug: type: string required: - kind - columnSlug - anyOf: - type: object properties: operator: type: string const: isNull required: - operator - type: object properties: operator: type: string const: isNotNull required: - operator - type: object properties: operator: type: string const: matchConditions conjonction: type: string enum: - or - and propertyConditions: type: array items: allOf: - type: {} properties: {} required: {} - anyOf: {} required: - operator - conjonction - propertyConditions - allOf: - type: object properties: kind: type: string const: array relatedModelUuid: type: string columnSlug: type: string required: - kind - columnSlug - anyOf: - type: object properties: operator: type: string const: isNull required: - operator - type: object properties: operator: type: string const: isNotNull required: - operator - type: object properties: operator: type: string const: matchConditions conjonction: type: string enum: - or - and propertyConditions: type: array items: allOf: - type: {} properties: {} required: {} - anyOf: {} required: - operator - conjonction - propertyConditions - type: object properties: kind: type: string const: any relatedModelUuid: type: string columnSlug: type: string operator: type: string enum: - isNull - isNotNull required: - kind - columnSlug - operator - type: object properties: kind: type: string const: vector relatedModelUuid: type: string columnSlug: type: string operator: type: string enum: - isNull - isNotNull required: - kind - columnSlug - operator - allOf: - type: object properties: kind: type: string const: date relatedModelUuid: type: string columnSlug: type: string required: - kind - columnSlug - anyOf: - type: object properties: operator: type: string enum: - is - isNot - greaterThan - lowerThan value: type: string required: - operator - value - type: object properties: operator: type: string const: between firstValue: type: string lastValue: type: string required: - operator - firstValue - lastValue - type: object properties: operator: type: string enum: - isNull - isNotNull required: - operator - type: object properties: kind: type: string const: boolean relatedModelUuid: type: string columnSlug: type: string operator: type: string enum: - isTrue - isFalse - isNull - isNotNull required: - kind - columnSlug - operator required: - kind - relatedModelUuid - frequency - period - conjonction - conditions - type: object properties: kind: type: string const: enrollment workflowUuid: type: string activityKind: type: string enum: - workflowEntered - workflowNodeExecuted - workflowLeft nodeSlug: type: string frequency: anyOf: - type: object properties: operator: type: string const: not required: - operator - type: object properties: operator: type: string enum: - moreThan - lessThan - exactly value: type: number required: - operator - value period: type: object properties: operator: type: string enum: - lessThan - moreThan - exactly value: type: number unit: type: string const: day required: - operator - value - unit required: - kind - workflowUuid - activityKind - frequency - period - type: object properties: kind: type: string const: segment segmentUuid: type: string operator: type: string enum: - in - notIn required: - kind - segmentUuid - operator required: - conjonction - conditions required: - conjonction - groups sort: title: Sort description: Sort criteria. type: array items: type: object properties: columnSlug: type: string kind: type: string enum: - asc - desc required: - columnSlug - kind limit: title: Limit description: Maximum number of records. type: number required: - kind - modelUuid - type: object properties: kind: type: string enum: - file title: Kind description: Data kind. s3Filename: type: string title: S3 filename description: S3 file identifier. required: - kind - s3Filename - type: object properties: kind: type: string enum: - runs title: Kind description: Data kind. filter: allOf: - type: object properties: batchUuid: title: Batch UUID description: Batch identifier to filter by. type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$ releaseUuid: title: Release UUID description: Release identifier to filter by. type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$ parentBatchUuid: title: Parent batch UUID description: Parent batch identifier. type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$ parentRunUuid: title: Parent run UUID description: Parent run identifier. type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$ parentNodeUuid: title: Parent node UUID description: Parent node identifier. type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$ isGroupParent: title: Is group parent description: Whether the run is a group parent. type: boolean executionsFilter: title: Executions filter description: Executions filter criteria. type: object properties: conjonction: type: string enum: - or - and groups: type: array items: type: object properties: conjonction: type: string enum: - or - and conditions: type: array items: type: object properties: kind: type: string const: node nodeSlug: type: string status: type: string enum: - absent - pending - success - error value: type: string required: - kind - nodeSlug - status required: - conjonction - conditions required: - conjonction - groups - anyOf: - type: object properties: kind: type: string const: runs title: Kind description: Filter kind. uuids: title: UUIDs description: Run identifiers to include. type: array items: type: string statuses: title: Statuses description: Run statuses to include. type: array items: type: string enum: - idle - pending - running - success - error - cancelling - cancelled - skipped required: - kind - type: object properties: kind: type: string const: records title: Kind description: Filter kind. ids: title: IDs description: Record identifiers to include. type: array items: type: string title: title: Title description: Record title to filter by. type: string required: - kind title: Filter description: Runs filter criteria. reset: anyOf: - type: object properties: from: type: string const: lastNode title: From description: Reset from the last node. required: - from - type: object properties: from: type: string const: firstNode title: From description: Reset from the first node. required: - from - type: object properties: from: type: string const: nextNode title: From description: Reset from the next node. required: - from - type: object properties: from: type: string const: node title: From description: Reset from a specific node. nodeUuid: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$ title: Node UUID description: Node identifier to reset from. required: - from - nodeUuid title: Reset description: Reset options. required: - kind - filter - reset - type: object properties: kind: type: string enum: - recordIds title: Kind description: Data kind. modelUuid: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$ title: Model UUID description: Model identifier. ids: type: array items: type: string title: IDs description: Record identifiers. required: - kind - modelUuid - ids - type: object properties: kind: type: string enum: - group title: Kind description: Data kind. parentBatchUuid: title: Parent batch UUID description: Parent batch identifier. type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$ parentRunUuid: title: Parent run UUID description: Parent run identifier. type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$ parentNodeUuid: title: Parent node UUID description: Parent node identifier. type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$ items: type: array items: {} title: Items description: Grouped items. required: - kind - parentRunUuid - parentNodeUuid - items - type: object properties: kind: type: string enum: - records title: Kind description: Data kind. records: type: array items: type: object propertyNames: type: string additionalProperties: {} title: Records description: Inline records. required: - kind - records - type: object properties: kind: type: string enum: - schedule title: Kind description: Data kind. modelUuid: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$ title: Model UUID description: Model identifier. segmentUuid: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$ title: Segment UUID description: Segment identifier. changeKinds: type: array items: type: string enum: - added - updated - removed - unchanged title: Change kinds description: Change kinds to include. required: - kind - modelUuid - segmentUuid - changeKinds title: Data description: Batch input data. required: - workflowUuid - data additionalProperties: false title: Request body description: Request body schema. responses: '200': description: Successful response content: application/json: schema: type: object properties: outcome: type: string const: previewed title: Outcome description: Preview outcome. count: type: number title: Count description: Total number of records. records: type: array items: type: object propertyNames: type: string additionalProperties: {} title: Records description: Previewed records. required: - outcome - count - records additionalProperties: false '400': description: Bad request '401': description: Unauthorized '404': description: Not found '500': description: Internal server error components: securitySchemes: bearerAuth: type: http scheme: bearer ````