Search documentation
karat

+

K

User Documentation ↗

Get Schedule Version

GET/api/v2/orchestration/scheduleVersions/{scheduleVersionRid}
Warning

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.

Get the ScheduleVersion with the specified rid.

Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:orchestration-read.

Path parameters

scheduleVersionRid
string

The RID of a schedule version

Query parameters

preview
boolean
optional

Enables the use of preview functionality.

Response body

ScheduleVersion
object
Hide child attributes

Hide child attributes

rid
string

The RID of a schedule version

scheduleRid
string

The Resource Identifier (RID) of a Schedule.

createdTime
string

The time the schedule version was created

createdBy
string

The Foundry user who created the schedule version

trigger
union
optional
Show child attributes

Show child attributes

action
object
Show child attributes

Show child attributes

scopeMode
union

The boundaries for the schedule build.

Show child attributes

Show child attributes

Examples

Request

Copied!
1 2 3 curl \ -H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/v2/orchestration/scheduleVersions/ri.scheduler.main.schedule-version.4d1eb55f-6c13-411c-a911-5d84e08d8017?preview=true"

Response

Copied!
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 { "createdBy": "f05f8da4-b84c-4fca-9c77-8af0b13d11de", "scheduleRid": "ri.scheduler.main.schedule.8843955e-37d1-4363-85eb-539833e10a41", "createdTime": "2003-05-06T12:34:56.789Z", "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-version.4d1eb55f-6c13-411c-a911-5d84e08d8017", "scopeMode": { "type": "user" } }

Error responses

Error Name
ScheduleVersionNotFoundError CodeNOT_FOUND
Status Code404
DescriptionThe given ScheduleVersion could not be found.
ParametersscheduleVersionRid