Skip to main content
POST
/
orchestration
/
plays
Create play
curl --request POST \
  --url https://api.getcargo.io/v1/orchestration/plays \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "modelUuid": "<string>",
  "changeKinds": [
    "added"
  ],
  "runCreationRule": "always",
  "description": "<string>",
  "filter": {
    "conjonction": "or",
    "groups": [
      {}
    ]
  },
  "sort": [
    {
      "columnSlug": "<string>",
      "kind": "asc"
    }
  ],
  "limit": 123,
  "trackingColumnSlugs": [
    "<string>"
  ],
  "schedule": {
    "type": "<string>",
    "jobId": "<string>"
  },
  "folderUuid": "<string>"
}
'
{
  "play": {
    "uuid": "<string>",
    "workspaceUuid": "<string>",
    "workflowUuid": "<string>",
    "userUuid": "<string>",
    "modelUuid": "<string>",
    "segmentUuid": "<string>",
    "changeKinds": [
      "<string>"
    ],
    "runCreationRule": "always",
    "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
required

Model identifier.

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.

sort
Sort · object[]

Sort criteria.

limit
number

Maximum number of records.

trackingColumnSlugs
string[]

Tracking column identifiers.

schedule
Schedule · object

Play schedule configuration.

folderUuid
string

Folder identifier.

Response

Successful response

play
Play · object
required

Created play details.