Liking cljdoc? Tell your friends :D

Jobs API (/api/jobs)
┌────────┬───────────────────────┬─────────────────────────────────────────────────────────┐
│ Method │ Endpoint │ Description │
├────────┼───────────────────────┼─────────────────────────────────────────────────────────┤
│ GET │ /api/jobs │ List jobs (filters: ?status=, ?queue=, ?tags=, ?limit=) │
├────────┼───────────────────────┼─────────────────────────────────────────────────────────┤
│ GET │ /api/jobs/stats │ Get job statistics │
├────────┼───────────────────────┼─────────────────────────────────────────────────────────┤
│ GET │ /api/jobs/due │ Get scheduled jobs due for execution │
├────────┼───────────────────────┼─────────────────────────────────────────────────────────┤
│ GET │ /api/jobs/running │ Get currently running jobs │
├────────┼───────────────────────┼─────────────────────────────────────────────────────────┤
│ GET │ /api/jobs/:id │ Get a specific job │
├────────┼───────────────────────┼─────────────────────────────────────────────────────────┤
│ POST │ /api/jobs │ Create a scheduled job │
├────────┼───────────────────────┼─────────────────────────────────────────────────────────┤
│ POST │ /api/jobs/triggered │ Create a triggered job │
├────────┼───────────────────────┼─────────────────────────────────────────────────────────┤
│ POST │ /api/jobs/recurring │ Create a recurring job │
├────────┼───────────────────────┼─────────────────────────────────────────────────────────┤
│ POST │ /api/jobs/:id/cancel │ Cancel a pending job │
├────────┼───────────────────────┼─────────────────────────────────────────────────────────┤
│ POST │ /api/jobs/:id/pause │ Pause a job │
├────────┼───────────────────────┼─────────────────────────────────────────────────────────┤
│ POST │ /api/jobs/:id/resume │ Resume a paused job │
├────────┼───────────────────────┼─────────────────────────────────────────────────────────┤
│ POST │ /api/jobs/:id/execute │ Execute a job immediately │
└────────┴───────────────────────┴─────────────────────────────────────────────────────────┘
Workflows API (/api/workflows)
┌────────┬────────────────────────────────┬───────────────────────────────┐
│ Method │ Endpoint │ Description │
├────────┼────────────────────────────────┼───────────────────────────────┤
│ GET │ /api/workflows │ List all workflow definitions │
├────────┼────────────────────────────────┼───────────────────────────────┤
│ GET │ /api/workflows/:ns/:name │ Get a workflow definition │
├────────┼────────────────────────────────┼───────────────────────────────┤
│ POST │ /api/workflows │ Create a workflow definition │
├────────┼────────────────────────────────┼───────────────────────────────┤
│ GET │ /api/workflows/:ns/:name/stats │ Get workflow statistics │
└────────┴────────────────────────────────┴───────────────────────────────┘
Processes API (/api/processes)
┌────────┬────────────────────────────────┬─────────────────────────────────────────────────────────────────────────────────┐
│ Method │ Endpoint │ Description │
├────────┼────────────────────────────────┼─────────────────────────────────────────────────────────────────────────────────┤
│ GET │ /api/processes │ List processes (filters: ?workflow=, ?state=, ?active=, ?completed=, ?subject=) │
├────────┼────────────────────────────────┼─────────────────────────────────────────────────────────────────────────────────┤
│ GET │ /api/processes/:id │ Get a specific process │
├────────┼────────────────────────────────┼─────────────────────────────────────────────────────────────────────────────────┤
│ POST │ /api/processes │ Start a new workflow process │
├────────┼────────────────────────────────┼─────────────────────────────────────────────────────────────────────────────────┤
│ GET │ /api/processes/:id/transitions │ Get available transitions │
├────────┼────────────────────────────────┼─────────────────────────────────────────────────────────────────────────────────┤
│ POST │ /api/processes/:id/transition │ Execute a transition │
├────────┼────────────────────────────────┼─────────────────────────────────────────────────────────────────────────────────┤
│ GET │ /api/processes/:id/history │ Get process transition history │
└────────┴────────────────────────────────┴─────────────────────────────────────────────────────────────────────────────────┘

Can you improve this documentation?Edit on GitHub

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
Move to previous article
Move to next article
Ctrl+/Jump to the search field
× close