api:tools:scheduledjobs:start
Tools : Scheduled jobs
Scheduled jobs are rows in the ScheduledJobs collection that describe an HTTP call and a when timestamp. tcx-scheduler polls the collection every 5 seconds and performs the call once it is due. A job may run once and be archived, or carry a recurrence and repeat indefinitely.
See Recurrence and run handling for the cadences, the timezone rules and what happens to a job when it succeeds or fails.
| Scheduled jobs | |
|---|---|
| List | List the jobs waiting to run |
| Get | Get a single pending job |
| Failed | List failed runs, newest first |
| Completed | List completed runs, newest first |
| Create | Create a scheduled job |
| Update | Update a scheduled job |
| Delete | Delete a pending job |
| Enabled | Pause or resume a recurring job |
| Run now | Make a job due immediately |
| Preview | Resolve the next occurrences of a recurrence |
| Restart failed | Re-queue a failed run |
| Delete failed | Delete a failed run record |
Admin UI
The jobs are managed from Admin > System > Scheduled jobs, next to MVNO Jobs. The page shows three panels - Pending, Failed and Completed - and a New job button. Access requires the Admin access level.
api/tools/scheduledjobs/start.txt · Last modified: by Per Møller