Quick Start: Execute and Monitor a Schedule

Run an existing schedule through CRD and check its execution status.

Before running a schedule, retrieve its ScheduleType and UniqueId from CRD. Use the returned values; ScheduleType is a string.

Submit the run

Call POST /api/Schedule/ExecuteScheduleAsync with a bearer token and a RunScheduleModel body:

{"ScheduleType": "<schedule type from CRD>", "UniqueId": <schedule id>, "RunBy": "<caller name>", "ScheduleName": "<optional name>"}

The response contains an ExecutionId. Save it to track this run.

Check status

Call GET /api/Schedule/GetExecutionStatus?ExecutionId={executionId}. The response includes execution and schedule identifiers, status, timestamps, process ID, and result data when supplied.

GET /api/Schedule/GetExecutionQueue returns queue records. Poll status at an interval appropriate for your application, and display the status returned by CRD. See the API Reference for response fields.


Did this page help you?