Search documentation
karat

+

K

User Documentation ↗

Run Schedule

POST/api/v2/orchestration/schedules/{scheduleRid}/run
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.

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

Path parameters

scheduleRid
string

The Resource Identifier (RID) of a Schedule.

Query parameters

preview
boolean
optional

Enables the use of preview functionality.

Response body

ScheduleRun
object
Hide child attributes

Hide child attributes

rid
string

The RID of a schedule run

scheduleRid
string

The Resource Identifier (RID) of a Schedule.

scheduleVersionRid
string

The RID of a schedule version

createdTime
string

The time at which the schedule run was created.

createdBy
string
optional

The Foundry user who manually invoked this schedule run. Automatic trigger runs have this field set to empty.

result
union
optional

The result of triggering the schedule. If empty, it means the service is still working on triggering the schedule.

Show child attributes

Show child attributes

Examples

Request

Copied!
1 2 3 curl -X POST \ -H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/v2/orchestration/schedules/ri.scheduler.main.schedule.8843955e-37d1-4363-85eb-539833e10a41/run?preview=true"

Response

Copied!
1 2 3 4 5 6 7 { "scheduleVersionRid": "ri.scheduler.main.schedule-version.4d1eb55f-6c13-411c-a911-5d84e08d8017", "createdBy": "f05f8da4-b84c-4fca-9c77-8af0b13d11de", "scheduleRid": "ri.scheduler.main.schedule.8843955e-37d1-4363-85eb-539833e10a41", "createdTime": "2003-05-06T12:34:56.789Z", "rid": "ri.scheduler.main.run.d2a5e9c6-298d-4788-a71d-42885d7bebb3" }