Job Scheduler via REST Services

There is the REST service to manage the job scheduler. By security reasons this service available only on a host where the application works.

GET /scheduler/

Checks whether the scheduler is started and returns the number of planned and paused jobs.

Response Headers:
 
Status Codes:
GET /scheduler/jobs

Returns a list of jobs which is in specified state.

Query Parameters:
 
  • state (string) – Optional. One of the two values: planned or paused.
  • skip (int) – Optional. By default - 0.
  • take (int) – Optional. By default - 10.
Response Headers:
 
Status Codes:
GET /scheduler/jobs/(string: id)

Returns status of the specified job.

Parameters:
  • id (string) – The job unique identifier.
Response Headers:
 
Status Codes:
POST /scheduler/jobs/(string: id)

Adds or updates the specified job.

Parameters:
  • id (string) – The job unique identifier.
Form Parameters:
 
Request Headers:
 
Response Headers:
 
Status Codes:
DELETE /scheduler/jobs/(string: id)

Deletes the specified job.

Parameters:
  • id (int) – The job unique identifier.
Response Headers:
 
Status Codes:
POST /scheduler/pause

Pauses the specified jobs.

Query Parameters:
 
  • ids (string) – Optional. Job identifiers, listed by comma.
Response Headers:
 
Status Codes:
POST /scheduler/resume

Resumes the specified jobs.

Query Parameters:
 
  • ids (string) – Optional. Job identifiers, listed by comma.
Response Headers:
 
Status Codes:
POST /scheduler/trigger

Invokes processing the specified jobs despite their schedule.

Query Parameters:
 
  • ids (string) – Optional. Job identifiers, listed by comma.
Form Parameters:
 
  • body – The data to job processing.
Request Headers:
 
Response Headers:
 
Status Codes: