Run Schedule

POST/api/v2/orchestration/schedules/{scheduleRid}/run

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

Path parameters

scheduleRid

string

The RID of a Schedule.

Response body

ScheduleRun

object

Hide child attributes

rid

string

The RID of a schedule run

scheduleRid

string

The 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

Examples

Request

Copied!

curl -X POST \
	-H "Authorization: Bearer $TOKEN" \
	"https://$HOSTNAME/api/v2/orchestration/schedules/ri.scheduler.main.schedule.5ad5c340-59f3-4a60-9fc6-161bb984f871/run"

Response

Copied!

{
  "scheduleVersionRid": "ri.scheduler.main.schedule-version.4d1eb55f-6c13-411c-a911-5d84e08d8017",
  "createdBy": "f05f8da4-b84c-4fca-9c77-8af0b13d11de",
  "scheduleRid": "ri.scheduler.main.schedule.5ad5c340-59f3-4a60-9fc6-161bb984f871",
  "createdTime": "2003-05-06T12:34:56.789Z",
  "rid": "ri.scheduler.main.run.d2a5e9c6-298d-4788-a71d-42885d7bebb3"
}

Error responses

Error Name
`RunSchedulePermissionDenied`	Error Code	`PERMISSION_DENIED`
	Status Code	403
	Description	Could not run the Schedule.
	Parameters	`scheduleRid`

See Errors for a general overview of errors in the platform.