This endpoint is in preview and may be modified or removed at any time.
To use this endpoint, add preview=true to the request query parameters.
Creates a new Schedule.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:orchestration-write.
objectstringstringobjectbooleanIf any job in the build is unsuccessful, immediately finish the build by cancelling all other jobs.
booleanWhether to ignore staleness information when running the build.
objectThe duration to wait before retrying after a Job fails.
integerThe duration value.
string (enum)The unit of duration.
Enum values: MILLISECONDS, SECONDS, MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS
integerThe number of retry attempts for failed Jobs within the Build. A Job's failure is not considered final until all retries have been attempted or an error occurs indicating that retries cannot be performed. Be aware, not all types of failures can be retried.
list<BranchName>The branches to retrieve JobSpecs from if no JobSpec is found on the target branch.
stringThe name of a Branch.
stringThe target branch the schedule should run on.
booleanWhether to receive a notification at the end of scheduled builds.
unionThe targets of the build.
objectlist<BuildableRid>The datasets to ignore when calculating the final set of dataset to build.
stringThe Resource Identifier (RID) of a Resource that can be built. For example, this is a Dataset RID, Media Set RID or Restricted View RID.
list<BuildableRid>The target datasets.
stringThe Resource Identifier (RID) of a Resource that can be built. For example, this is a Dataset RID, Media Set RID or Restricted View RID.
objectlist<BuildableRid>stringThe Resource Identifier (RID) of a Resource that can be built. For example, this is a Dataset RID, Media Set RID or Restricted View RID.
objectlist<BuildableRid>The datasets between the input datasets and target datasets to exclude.
stringThe Resource Identifier (RID) of a Resource that can be built. For example, this is a Dataset RID, Media Set RID or Restricted View RID.
list<BuildableRid>The downstream target datasets (inclusive).
stringThe Resource Identifier (RID) of a Resource that can be built. For example, this is a Dataset RID, Media Set RID or Restricted View RID.
list<BuildableRid>The upstream input datasets (exclusive).
stringThe Resource Identifier (RID) of a Resource that can be built. For example, this is a Dataset RID, Media Set RID or Restricted View RID.
unionThe schedule trigger. If the requesting user does not have permission to see the trigger, this will be empty.
objectTrigger whenever a job succeeds on the dataset and on the target branch.
stringThe Resource Identifier (RID) of a Dataset.
stringThe name of a Branch.
objectTrigger whenever any of the given triggers emit an event.
list<Trigger>unionobjectTrigger whenever a job succeeds on the dataset and on the target branch.
stringThe Resource Identifier (RID) of a Dataset.
stringThe name of a Branch.
objectTrigger whenever any of the given triggers emit an event.
list<Trigger>unionobjectTrigger whenever a new JobSpec is put on the dataset and on that branch.
stringThe name of a Branch.
stringThe Resource Identifier (RID) of a Dataset.
objectTrigger after all of the given triggers emit an event.
list<Trigger>unionobjectTrigger whenever a new transaction is committed to the dataset on the target branch.
stringThe Resource Identifier (RID) of a Dataset.
stringThe name of a Branch.
objectTrigger whenever the specified schedule completes its action successfully.
stringThe Resource Identifier (RID) of a Schedule.
objectTrigger whenever an update is made to a media set on the target branch. For transactional media sets, this happens when a transaction is committed. For non-transactional media sets, this event happens eventually (but not necessary immediately) after an update.
stringThe Resource Identifier (RID) of a Media Set
stringThe name of a Branch.
objectTrigger on a time based schedule.
stringA standard CRON expression with minute, hour, day, month and day of week.
stringA string representation of a java.time.ZoneId
objectTrigger whenever a new JobSpec is put on the dataset and on that branch.
stringThe name of a Branch.
stringThe Resource Identifier (RID) of a Dataset.
objectTrigger after all of the given triggers emit an event.
list<Trigger>unionobjectTrigger whenever a job succeeds on the dataset and on the target branch.
stringThe Resource Identifier (RID) of a Dataset.
stringThe name of a Branch.
objectTrigger whenever any of the given triggers emit an event.
list<Trigger>unionobjectTrigger whenever a new JobSpec is put on the dataset and on that branch.
stringThe name of a Branch.
stringThe Resource Identifier (RID) of a Dataset.
objectTrigger after all of the given triggers emit an event.
list<Trigger>unionobjectTrigger whenever a new transaction is committed to the dataset on the target branch.
stringThe Resource Identifier (RID) of a Dataset.
stringThe name of a Branch.
objectTrigger whenever the specified schedule completes its action successfully.
stringThe Resource Identifier (RID) of a Schedule.
objectTrigger whenever an update is made to a media set on the target branch. For transactional media sets, this happens when a transaction is committed. For non-transactional media sets, this event happens eventually (but not necessary immediately) after an update.
stringThe Resource Identifier (RID) of a Media Set
stringThe name of a Branch.
objectTrigger on a time based schedule.
stringA standard CRON expression with minute, hour, day, month and day of week.
stringA string representation of a java.time.ZoneId
objectTrigger whenever a new transaction is committed to the dataset on the target branch.
stringThe Resource Identifier (RID) of a Dataset.
stringThe name of a Branch.
objectTrigger whenever the specified schedule completes its action successfully.
stringThe Resource Identifier (RID) of a Schedule.
objectTrigger whenever an update is made to a media set on the target branch. For transactional media sets, this happens when a transaction is committed. For non-transactional media sets, this event happens eventually (but not necessary immediately) after an update.
stringThe Resource Identifier (RID) of a Media Set
stringThe name of a Branch.
objectTrigger on a time based schedule.
stringA standard CRON expression with minute, hour, day, month and day of week.
stringA string representation of a java.time.ZoneId
unionThe boundaries for the schedule build.
objectlist<ProjectRid>stringThe unique resource identifier (RID) of a Project.
objectobjectThe created Schedule
stringThe Resource Identifier (RID) of a Schedule.
stringstringstringThe RID of the current schedule version
stringThe time at which the resource was created.
stringThe Foundry user who created this resource
stringThe time at which the resource was most recently updated.
stringThe Foundry user who last updated this resource
booleanunionThe schedule trigger. If the requesting user does not have permission to see the trigger, this will be empty.
objectTrigger whenever a job succeeds on the dataset and on the target branch.
stringThe Resource Identifier (RID) of a Dataset.
stringThe name of a Branch.
objectTrigger whenever any of the given triggers emit an event.
list<Trigger>unionobjectTrigger whenever a job succeeds on the dataset and on the target branch.
stringThe Resource Identifier (RID) of a Dataset.
stringThe name of a Branch.
objectTrigger whenever any of the given triggers emit an event.
list<Trigger>unionobjectTrigger whenever a new JobSpec is put on the dataset and on that branch.
stringThe name of a Branch.
stringThe Resource Identifier (RID) of a Dataset.
objectTrigger after all of the given triggers emit an event.
list<Trigger>unionobjectTrigger whenever a new transaction is committed to the dataset on the target branch.
stringThe Resource Identifier (RID) of a Dataset.
stringThe name of a Branch.
objectTrigger whenever the specified schedule completes its action successfully.
stringThe Resource Identifier (RID) of a Schedule.
objectTrigger whenever an update is made to a media set on the target branch. For transactional media sets, this happens when a transaction is committed. For non-transactional media sets, this event happens eventually (but not necessary immediately) after an update.
stringThe Resource Identifier (RID) of a Media Set
stringThe name of a Branch.
objectTrigger on a time based schedule.
stringA standard CRON expression with minute, hour, day, month and day of week.
stringA string representation of a java.time.ZoneId
objectTrigger whenever a new JobSpec is put on the dataset and on that branch.
stringThe name of a Branch.
stringThe Resource Identifier (RID) of a Dataset.
objectTrigger after all of the given triggers emit an event.
list<Trigger>unionobjectTrigger whenever a job succeeds on the dataset and on the target branch.
stringThe Resource Identifier (RID) of a Dataset.
stringThe name of a Branch.
objectTrigger whenever any of the given triggers emit an event.
list<Trigger>unionobjectTrigger whenever a new JobSpec is put on the dataset and on that branch.
stringThe name of a Branch.
stringThe Resource Identifier (RID) of a Dataset.
objectTrigger after all of the given triggers emit an event.
list<Trigger>unionobjectTrigger whenever a new transaction is committed to the dataset on the target branch.
stringThe Resource Identifier (RID) of a Dataset.
stringThe name of a Branch.
objectTrigger whenever the specified schedule completes its action successfully.
stringThe Resource Identifier (RID) of a Schedule.
objectTrigger whenever an update is made to a media set on the target branch. For transactional media sets, this happens when a transaction is committed. For non-transactional media sets, this event happens eventually (but not necessary immediately) after an update.
stringThe Resource Identifier (RID) of a Media Set
stringThe name of a Branch.
objectTrigger on a time based schedule.
stringA standard CRON expression with minute, hour, day, month and day of week.
stringA string representation of a java.time.ZoneId
objectTrigger whenever a new transaction is committed to the dataset on the target branch.
stringThe Resource Identifier (RID) of a Dataset.
stringThe name of a Branch.
objectTrigger whenever the specified schedule completes its action successfully.
stringThe Resource Identifier (RID) of a Schedule.
objectTrigger whenever an update is made to a media set on the target branch. For transactional media sets, this happens when a transaction is committed. For non-transactional media sets, this event happens eventually (but not necessary immediately) after an update.
stringThe Resource Identifier (RID) of a Media Set
stringThe name of a Branch.
objectTrigger on a time based schedule.
stringA standard CRON expression with minute, hour, day, month and day of week.
stringA string representation of a java.time.ZoneId
objectunionThe targets of the build.
objectTarget the specified datasets along with all upstream datasets except the ignored datasets.
list<BuildableRid>The target datasets.
stringThe Resource Identifier (RID) of a Resource that can be built. For example, this is a Dataset RID, Media Set RID or Restricted View RID.
list<BuildableRid>The datasets to ignore when calculating the final set of dataset to build.
stringThe Resource Identifier (RID) of a Resource that can be built. For example, this is a Dataset RID, Media Set RID or Restricted View RID.
objectManually specify all datasets to build.
list<BuildableRid>stringThe Resource Identifier (RID) of a Resource that can be built. For example, this is a Dataset RID, Media Set RID or Restricted View RID.
objectAll datasets between the input datasets (exclusive) and the target datasets (inclusive) except for the datasets to ignore.
list<BuildableRid>The upstream input datasets (exclusive).
stringThe Resource Identifier (RID) of a Resource that can be built. For example, this is a Dataset RID, Media Set RID or Restricted View RID.
list<BuildableRid>The downstream target datasets (inclusive).
stringThe Resource Identifier (RID) of a Resource that can be built. For example, this is a Dataset RID, Media Set RID or Restricted View RID.
list<BuildableRid>The datasets between the input datasets and target datasets to exclude.
stringThe Resource Identifier (RID) of a Resource that can be built. For example, this is a Dataset RID, Media Set RID or Restricted View RID.
stringThe target branch the schedule should run on.
list<BranchName>The branches to retrieve JobSpecs from if no JobSpec is found on the target branch.
stringThe name of a Branch.
booleanWhether to ignore staleness information when running the build.
integerThe number of retry attempts for failed Jobs within the Build. A Job's failure is not considered final until all retries have been attempted or an error occurs indicating that retries cannot be performed. Be aware, not all types of failures can be retried.
objectThe duration to wait before retrying after a Job fails.
integerThe duration value.
string (enum)The unit of duration.
Enum values: MILLISECONDS, SECONDS, MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS
booleanIf any job in the build is unsuccessful, immediately finish the build by cancelling all other jobs.
booleanWhether to receive a notification at the end of scheduled builds.
unionThe boundaries for the schedule build.
objectThe schedule will only build resources in the following projects.
list<ProjectRid>stringThe unique resource identifier (RID) of a Project.
objectWhen triggered, the schedule will build all resources that the associated user is permitted to build.
1
2
3
4
5
curl -X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/orchestration/schedules?preview=true" \
-d '{"displayName":"My Daily Schedule","description":"Run all the transforms at midnight","action":{"abortOnFailure":false,"forceBuild":false,"retryBackoffDuration":{"unit":"SECONDS","value":30},"fallbackBranches":[],"branchName":"master","notificationsEnabled":false,"target":{"type":"manual","targetRids":["ri.foundry.main.dataset.b737e24d-6b19-43aa-93d5-da9fc4073f6e","ri.foundry.main.dataset.d2452a94-a755-4778-8bfc-a315ab52fc43"]}},"trigger":{"type":"time","cronExpression":"0 0 * * *","timeZone":"UTC"},"scopeMode":{"type":"user"}}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
{
"updatedTime": "2024-09-25T17:29:35.974Z",
"paused": false,
"updatedBy": "f05f8da4-b84c-4fca-9c77-8af0b13d11de",
"createdBy": "f05f8da4-b84c-4fca-9c77-8af0b13d11de",
"displayName": "My Daily Schedule",
"currentVersionRid": "ri.scheduler.main.schedule-version.4d1eb55f-6c13-411c-a911-5d84e08d8017",
"description": "Run all the transforms at midnight",
"createdTime": "2024-09-25T17:29:35.974Z",
"action": {
"abortOnFailure": false,
"forceBuild": false,
"retryBackoffDuration": {
"unit": "SECONDS",
"value": 30
},
"fallbackBranches": [],
"branchName": "master",
"notificationsEnabled": false,
"target": {
"type": "manual",
"targetRids": [
"ri.foundry.main.dataset.b737e24d-6b19-43aa-93d5-da9fc4073f6e",
"ri.foundry.main.dataset.d2452a94-a755-4778-8bfc-a315ab52fc43"
]
}
},
"trigger": {
"type": "time",
"cronExpression": "0 0 * * *",
"timeZone": "UTC"
},
"rid": "ri.scheduler.main.schedule.8843955e-37d1-4363-85eb-539833e10a41",
"scopeMode": {
"type": "user"
}
}