List plays

List all plays

GET /orchestration/plays/list

List plays

cURL

curl --request GET \
  --url https://api.getcargo.io/v1/orchestration/plays/list \
  --header 'Authorization: Bearer <token>'

import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.getcargo.io/v1/orchestration/plays/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/plays/list",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.getcargo.io/v1/orchestration/plays/list")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

200

{
  "plays": [
    {
      "uuid": "<string>",
      "workspaceUuid": "<string>",
      "workflowUuid": "<string>",
      "userUuid": "<string>",
      "modelUuid": "<string>",
      "segmentUuid": "<string>",
      "changeKinds": [
        "<string>"
      ],
      "name": "<string>",
      "description": "<string>",
      "schedule": {
        "type": "<string>",
        "temporalScheduleWorkflowId": "<string>",
        "meta": {}
      },
      "isEnabled": true,
      "healthThreshold": 123,
      "healthAlertActions": [
        {
          "actionSlug": "<string>",
          "connectorUuid": "<string>",
          "config": {}
        }
      ],
      "folderUuid": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "deletedAt": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

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

Query Parameters

isEnabled · boolean

Filter plays by enabled state.

modelUuid · string<uuid>

Filter plays by model 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})$

segmentUuid · string<uuid>

Filter plays by segment 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})$

scheduleType · enum<string>

Filter plays by schedule type stored on the play schedule.

Available options: dbt, cron, realtime, dependency, watch

Response

200

application/json

Successful response

plays · Plays · object[] · required

List of plays.

Show child attributes