curl --request PUT \
--url https://api.getcargo.io/v1/orchestration/plays/{uuid} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"isEnabled": true,
"filter": {
"conjonction": "or",
"groups": [
{}
]
},
"sort": [
{
"columnSlug": "<string>",
"kind": "asc"
}
],
"limit": 123,
"trackingColumnSlugs": [
"<string>"
],
"changeKinds": [
"added"
],
"runCreationRule": "always",
"schedule": {
"type": "<string>",
"jobId": "<string>"
},
"healthThreshold": 123,
"healthAlertActions": [
{
"actionSlug": "<string>",
"connectorUuid": "<string>",
"config": {}
}
],
"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>"
}
}Update a play
curl --request PUT \
--url https://api.getcargo.io/v1/orchestration/plays/{uuid} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"isEnabled": true,
"filter": {
"conjonction": "or",
"groups": [
{}
]
},
"sort": [
{
"columnSlug": "<string>",
"kind": "asc"
}
],
"limit": 123,
"trackingColumnSlugs": [
"<string>"
],
"changeKinds": [
"added"
],
"runCreationRule": "always",
"schedule": {
"type": "<string>",
"jobId": "<string>"
},
"healthThreshold": 123,
"healthAlertActions": [
{
"actionSlug": "<string>",
"connectorUuid": "<string>",
"config": {}
}
],
"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>"
}
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Resource UUID
Request body schema.
Play name.
Play description.
Whether the play is enabled.
Segment filter criteria.
Show child attributes
Sort criteria.
Show child attributes
Maximum number of records.
Tracking column identifiers.
Change kinds to include.
added, updated, removed, unchanged Run creation rule.
always, once, noConcurrency Play schedule configuration.
Show child attributes
Health threshold for alerts.
Health alert actions configuration.
Show child attributes
Folder identifier.
Successful response
Updated play details.
Show child attributes
Was this page helpful?