HTTP API
JobSchedule
The schedule record defining when and how a job runs.
Shape: object
| Property | Required | Type | Description | Rules |
|---|---|---|---|---|
id |
no | string (uuid) |
The schedule identifier. | — |
tenantId |
yes | string |
The tenant the schedule belongs to. | — |
name |
yes | string |
The schedule name, unique within the tenant. | — |
handlerKey |
yes | string |
The key of the IJobHandler the jobs this schedule produces are dispatched to. See JobHandlerKeys. | — |
lane |
no | string |
The lane the jobs this schedule produces run in. See JobLanes. Both a cron-dispatched run and a manual POST .../trigger inherit this value. |
— |
targetName |
yes | string |
The agent or workflow name to run. | — |
cron |
no | string |
The five-field cron expression (minute hour day-of-month month day-of-week). If null, the schedule is triggered only manually. |
— |
timeZone |
no | string |
The time zone the Cron expression is interpreted in. |
— |
payload |
no | JsonElement |
The input set or parameters. Interpreted by the job’s handler. | — |
enabled |
no | boolean |
Whether the schedule is enabled. If disabled, it is not triggered automatically. | — |
nextRunAt |
no | string (date-time) |
The next automatic run time (UTC). null if there is no cron. |
— |
lastRunAt |
no | string (date-time) |
The last run time (UTC). null if it never ran. |
— |
createdBy |
no | string |
The identifier of the user/service that created the schedule. | — |
createdAt |
yes | string (date-time) |
The creation time (UTC). | — |
updatedAt |
yes | string (date-time) |
The last-updated time (UTC). | — |