Schedules
Use the scheduler service and its associated endpoints to manage and monitor scheduled jobs:
| URI | HTTP Operation | Description | |
|---|---|---|---|
/openidm/scheduler?_action=validateQuartzCronExpression |
POST |
Validates a cron expression. |
|
/openidm/scheduler/job/id |
PUT |
Creates or updates a schedule with the specified ID. |
|
GET |
Returns the details of the specified schedule. |
||
POST with ?_action=trigger
|
Manually triggers the specified schedule. |
||
POST with ?_action=pause
|
Suspends the specified schedule. |
||
POST with ?_action=resume
|
Resumes the specified schedule. |
||
DELETE |
Deletes the specified schedule. |
||
/openidm/scheduler/job?_action=create |
POST |
Creates a schedule with a system-generated ID. |
|
/openidm/scheduler/job?_queryFilter=query |
GET |
Queries the existing defined schedules. |
|
/openidm/scheduler/job?_action=listCurrentlyExecutingJobs |
POST |
Returns a list of the jobs that are currently running. |
|
/openidm/scheduler/job?_action=pauseJobs |
POST |
Suspends all scheduled jobs. |
|
/openidm/scheduler/job?_action=resumeJobs |
POST |
Resumes all suspended scheduled jobs. |
|
/openidm/scheduler/trigger?_queryFilter=query |
GET |
Queries the existing triggers. |
|
/openidm/scheduler/trigger/id |
GET |
Returns the details of the specified trigger. |
|
/openidm/scheduler/acquiredTriggers |
GET |
Returns an array of the triggers that have been acquired, per node. |
|
/openidm/scheduler/waitingTriggers |
GET |
Returns an array of the triggers that have not yet been acquired. |