Skip to main content
POST
/
orchestration
/
records
/
download-outputs
Download record outputs
curl --request POST \
  --url https://api.getcargo.io/v1/orchestration/records/download-outputs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workflowUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "outputNodeSlug": "<string>",
  "format": "csv",
  "ids": [
    "<string>"
  ],
  "title": "<string>",
  "releaseUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "batchUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "statuses": [
    "pending"
  ],
  "parentBatchUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "parentRunUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "parentNodeUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "isGroupParent": true,
  "executionsFilter": {
    "conjonction": "or",
    "groups": [
      {
        "conjonction": "or",
        "conditions": [
          {
            "kind": "<string>",
            "nodeSlug": "<string>",
            "operator": "<string>"
          }
        ]
      }
    ]
  },
  "createdAfter": "<string>",
  "createdBefore": "<string>"
}
'
{
  "url": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request body schema.

workflowUuid
string<uuid>
required

Workflow identifier.

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})$
outputNodeSlug
string
required

Output node slug for download.

format
enum<string>

Export format. Defaults to csv.

Available options:
csv,
json
ids
string[]

Record IDs to include.

title
string

Record title to match.

releaseUuid
string<uuid>

Release identifier to filter by.

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})$
batchUuid
string<uuid>

Batch identifier to filter by.

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})$
statuses
enum<string>[]

Record statuses to include.

Available options:
pending,
running,
success,
error,
cancelled,
cancelling
parentBatchUuid
string<uuid>

Parent batch identifier to filter by.

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
string<uuid>

Parent run identifier to filter by.

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
string<uuid>

Parent node identifier to filter by.

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
boolean

Whether to select group parent records.

executionsFilter
Executions filter · object

Execution filters for matching records.

createdAfter
string

Include records created after this timestamp.

createdBefore
string

Include records created before this timestamp.

Response

Successful response

url
string
required

Download URL for the exported record outputs.