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-read.
objectstringThe 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.
objectunionThe boundaries for the schedule build.
1
2
3
curl \
\t-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/orchestration/scheduleVersions/ri.scheduler.main.schedule-version.4d1eb55f-6c13-411c-a911-5d84e08d8017/schedule?preview=true"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
38
{
"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
},
"retryCount": 1,
"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.5ad5c340-59f3-4a60-9fc6-161bb984f871",
"scopeMode": {
"type": "user"
}
}