Create play

Create a new play

POST /orchestration/plays

Create play

cURL

curl --request POST \
  --url https://api.getcargo.io/v1/orchestration/plays \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "modelUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "changeKinds": [],
  "description": "<string>",
  "sort": [
    {
      "columnSlug": "<string>"
    }
  ],
  "limit": 123,
  "trackingColumnSlugs": [
    "<string>"
  ],
  "schedule": {
    "type": "<string>",
    "jobId": "<string>"
  },
  "folderUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

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

payload = {
    "name": "<string>",
    "modelUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "changeKinds": [],
    "description": "<string>",
    "sort": [{ "columnSlug": "<string>" }],
    "limit": 123,
    "trackingColumnSlugs": ["<string>"],
    "schedule": {
        "type": "<string>",
        "jobId": "<string>"
    },
    "folderUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
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({
    name: '<string>',
    modelUuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    changeKinds: [],
    description: '<string>',
    sort: [{columnSlug: '<string>'}],
    limit: 123,
    trackingColumnSlugs: ['<string>'],
    schedule: {type: '<string>', jobId: '<string>'},
    folderUuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://api.getcargo.io/v1/orchestration/plays', 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",
  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([
    'name' => '<string>',
    'modelUuid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'changeKinds' => [
        
    ],
    'description' => '<string>',
    'sort' => [
        [
                'columnSlug' => '<string>'
        ]
    ],
    'limit' => 123,
    'trackingColumnSlugs' => [
        '<string>'
    ],
    'schedule' => [
        'type' => '<string>',
        'jobId' => '<string>'
    ],
    'folderUuid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  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/plays"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"modelUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"changeKinds\": [],\n  \"description\": \"<string>\",\n  \"sort\": [\n    {\n      \"columnSlug\": \"<string>\"\n    }\n  ],\n  \"limit\": 123,\n  \"trackingColumnSlugs\": [\n    \"<string>\"\n  ],\n  \"schedule\": {\n    \"type\": \"<string>\",\n    \"jobId\": \"<string>\"\n  },\n  \"folderUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\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/plays")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"modelUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"changeKinds\": [],\n  \"description\": \"<string>\",\n  \"sort\": [\n    {\n      \"columnSlug\": \"<string>\"\n    }\n  ],\n  \"limit\": 123,\n  \"trackingColumnSlugs\": [\n    \"<string>\"\n  ],\n  \"schedule\": {\n    \"type\": \"<string>\",\n    \"jobId\": \"<string>\"\n  },\n  \"folderUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"name\": \"<string>\",\n  \"modelUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"changeKinds\": [],\n  \"description\": \"<string>\",\n  \"sort\": [\n    {\n      \"columnSlug\": \"<string>\"\n    }\n  ],\n  \"limit\": 123,\n  \"trackingColumnSlugs\": [\n    \"<string>\"\n  ],\n  \"schedule\": {\n    \"type\": \"<string>\",\n    \"jobId\": \"<string>\"\n  },\n  \"folderUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

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

200

{
  "play": {
    "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.

Body

application/json

Request body schema.

name · string · required

Play name.

modelUuid · string<uuid> · required

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

changeKinds · enum<string>[] · required

Change kinds to include.

Available options: added, updated, removed, unchanged

runCreationRule · enum<string> · required

Run creation rule.

Available options: always, once, noConcurrency

description · string

Play description.

filter · Filter · object

Segment filter criteria.

Show child attributes

sort · Sort · object[]

Sort criteria.

Show child attributes

limit · number

Maximum number of records.

trackingColumnSlugs · string[]

Tracking column identifiers.

schedule · Schedule · object

Play schedule configuration.

Schedule

Schedule

Schedule

Schedule

Schedule

Show child attributes

folderUuid · string<uuid>

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

Response

200

application/json

Successful response

play · Play · object · required

Created play details.

Show child attributes