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.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:orchestration-write.
objectunionThe targets of the schedule.
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 build 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.
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.
objectstringThe RID of a build
stringThe branch that the build is running on.
stringThe timestamp that the build was created.
stringThe user who created the build.
list<BranchName>The branches to retrieve JobSpecs from if no JobSpec is found on the target branch.
stringThe name of a Branch.
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.
string (enum)The status of the build.
Enum values: RUNNING, SUCCEEDED, FAILED, CANCELED
1
2
3
4
5
curl -X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/orchestration/builds/create?preview=true" \
-d '{"retryBackoffDuration":{"unit":"SECONDS","value":30},"fallbackBranches":["master"],"branchName":"master"}'1
2
3
4
5
6
7
8
9
10
11
12
13
{
"createdBy": "f05f8da4-b84c-4fca-9c77-8af0b13d11de",
"retryBackoffDuration": {
"unit": "SECONDS",
"value": 30
},
"fallbackBranches": [
"master"
],
"branchName": "master",
"rid": "ri.foundry.main.build.a4386b7e-d546-49be-8a36-eefc355f5c58",
"status": "RUNNING"
}