List runs

List orchestration runs

POST /orchestration/runs/list

List runs

cURL

curl --request POST \
  --url https://api.getcargo.io/v1/orchestration/runs/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workflowUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "userUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "releaseUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "batchUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "statuses": [],
  "recordId": "<string>",
  "recordTitle": "<string>",
  "recordTitleOrId": "<string>",
  "parentBatchUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "parentUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "parentNodeUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "isGroupParent": true,
  "createdAfter": "<string>",
  "createdBefore": "<string>",
  "updatedAfter": "<string>",
  "updatedBefore": "<string>",
  "limit": 123,
  "offset": 123
}
'

import requests

url = "https://api.getcargo.io/v1/orchestration/runs/list"

payload = {
    "workflowUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "userUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "releaseUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "batchUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "statuses": [],
    "recordId": "<string>",
    "recordTitle": "<string>",
    "recordTitleOrId": "<string>",
    "parentBatchUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "parentUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "parentNodeUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "isGroupParent": True,
    "createdAfter": "<string>",
    "createdBefore": "<string>",
    "updatedAfter": "<string>",
    "updatedBefore": "<string>",
    "limit": 123,
    "offset": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    workflowUuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    userUuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    releaseUuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    batchUuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    statuses: [],
    recordId: '<string>',
    recordTitle: '<string>',
    recordTitleOrId: '<string>',
    parentBatchUuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    parentUuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    parentNodeUuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    isGroupParent: true,
    createdAfter: '<string>',
    createdBefore: '<string>',
    updatedAfter: '<string>',
    updatedBefore: '<string>',
    limit: 123,
    offset: 123
  })
};

fetch('https://api.getcargo.io/v1/orchestration/runs/list', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getcargo.io/v1/orchestration/runs/list",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'workflowUuid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'userUuid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'releaseUuid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'batchUuid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'statuses' => [
        
    ],
    'recordId' => '<string>',
    'recordTitle' => '<string>',
    'recordTitleOrId' => '<string>',
    'parentBatchUuid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'parentUuid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'parentNodeUuid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'isGroupParent' => true,
    'createdAfter' => '<string>',
    'createdBefore' => '<string>',
    'updatedAfter' => '<string>',
    'updatedBefore' => '<string>',
    'limit' => 123,
    'offset' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getcargo.io/v1/orchestration/runs/list"

	payload := strings.NewReader("{\n  \"workflowUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"userUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"releaseUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"batchUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"statuses\": [],\n  \"recordId\": \"<string>\",\n  \"recordTitle\": \"<string>\",\n  \"recordTitleOrId\": \"<string>\",\n  \"parentBatchUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"parentUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"parentNodeUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"isGroupParent\": true,\n  \"createdAfter\": \"<string>\",\n  \"createdBefore\": \"<string>\",\n  \"updatedAfter\": \"<string>\",\n  \"updatedBefore\": \"<string>\",\n  \"limit\": 123,\n  \"offset\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.getcargo.io/v1/orchestration/runs/list")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"workflowUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"userUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"releaseUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"batchUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"statuses\": [],\n  \"recordId\": \"<string>\",\n  \"recordTitle\": \"<string>\",\n  \"recordTitleOrId\": \"<string>\",\n  \"parentBatchUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"parentUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"parentNodeUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"isGroupParent\": true,\n  \"createdAfter\": \"<string>\",\n  \"createdBefore\": \"<string>\",\n  \"updatedAfter\": \"<string>\",\n  \"updatedBefore\": \"<string>\",\n  \"limit\": 123,\n  \"offset\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getcargo.io/v1/orchestration/runs/list")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"workflowUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"userUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"releaseUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"batchUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"statuses\": [],\n  \"recordId\": \"<string>\",\n  \"recordTitle\": \"<string>\",\n  \"recordTitleOrId\": \"<string>\",\n  \"parentBatchUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"parentUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"parentNodeUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"isGroupParent\": true,\n  \"createdAfter\": \"<string>\",\n  \"createdBefore\": \"<string>\",\n  \"updatedAfter\": \"<string>\",\n  \"updatedBefore\": \"<string>\",\n  \"limit\": 123,\n  \"offset\": 123\n}"

response = http.request(request)
puts response.read_body

200

{
  "runs": [
    {
      "uuid": "<string>",
      "workspaceUuid": "<string>",
      "workflowUuid": "<string>",
      "userUuid": "<string>",
      "releaseUuid": "<string>",
      "nodes": [
        {
          "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "slug": "<string>",
          "config": {},
          "childrenUuids": [
            "<string>"
          ],
          "fallbackOnFailure": true,
          "position": {
            "x": 123,
            "y": 123
          },
          "kind": "native",
          "actionSlug": "<string>",
          "name": "<string>",
          "description": "<string>",
          "retry": {
            "maximumAttempts": 123,
            "initialInterval": 123,
            "backoffCoefficient": 123
          },
          "fallbackChildUuid": "<string>"
        }
      ],
      "batchUuid": "<string>",
      "traceUuid": "<string>",
      "temporalWorkflowId": "<string>",
      "recordId": "<string>",
      "recordTitle": "<string>",
      "contextS3Filename": "<string>",
      "computedConfigsS3Filename": "<string>",
      "parentUuid": "<string>",
      "parentNodeUuid": "<string>",
      "parentBatchUuid": "<string>",
      "parentAgentUuid": "<string>",
      "parentChatUuid": "<string>",
      "parentMessageUuid": "<string>",
      "isGroupParent": true,
      "errorMessage": "<string>",
      "executions": [
        {
          "nodeUuid": "<string>",
          "nodeSlug": "<string>",
          "nodeBatchUuid": "<string>",
          "nodeRunUuid": "<string>",
          "nodeMessageUuid": "<string>",
          "nodeChildIndex": 123,
          "nextNodeUuid": "<string>",
          "errorMessage": "<string>",
          "title": "<string>",
          "iconUrl": "<string>",
          "creditsUsedCount": 123,
          "nodeWaitUntilFinished": true,
          "nodeKind": "<string>",
          "nodeActionSlug": "<string>"
        }
      ],
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "finishedAt": "<string>",
      "deletedAt": "<string>"
    }
  ],
  "count": 123
}

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})$

userUuid · string<uuid>

User 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})$

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>[]

Run statuses to include.

Available options: idle, pending, running, success, error, cancelling, cancelled, skipped

recordId · string

Record ID to filter by.

recordTitle · string

Record title to filter by.

recordTitleOrId · string

Record title or ID to filter by.

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})$

parentUuid · 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 runs.

executionsFilter · Executions filter · object

Execution filters for matching runs.

Show child attributes

createdAfter · string

Include runs created after this timestamp.

createdBefore · string

Include runs created before this timestamp.

updatedAfter · string

Include runs updated after this timestamp.

updatedBefore · string

Include runs updated before this timestamp.

limit · number

Maximum number of runs to return.

offset · number

Number of runs to skip.

Response

200

application/json

Successful response

runs · Runs · object[] · required

Runs matching the filter.

Show child attributes

count · number · required

Total count of matching runs.