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: - Content-Type – application/json
Status Codes: - 200 OK – OK
-
GET
/scheduler/jobs
¶ Returns a list of jobs which is in specified state.
Query Parameters: - state (string) – Optional. One of the two values:
planned
orpaused
. - skip (int) – Optional. By default -
0
. - take (int) – Optional. By default -
10
.
Response Headers: - Content-Type – application/json
Status Codes: - 200 OK – OK
- state (string) – Optional. One of the two values:
-
GET
/scheduler/jobs/
(string: id)¶ Returns status of the specified job.
Parameters: - id (string) – The job unique identifier.
Response Headers: - Content-Type – application/json
Status Codes: - 200 OK – OK
-
POST
/scheduler/jobs/
(string: id)¶ Adds or updates the specified job.
Parameters: - id (string) – The job unique identifier.
Form Parameters: - body – The job info.
Request Headers: - Content-Type – application/json
Response Headers: - Content-Type – application/json
Status Codes: - 200 OK – OK
-
DELETE
/scheduler/jobs/
(string: id)¶ Deletes the specified job.
Parameters: - id (int) – The job unique identifier.
Response Headers: - Content-Type – application/json
Status Codes: - 200 OK – OK
-
POST
/scheduler/pause
¶ Pauses the specified jobs.
Query Parameters: - ids (string) – Optional. Job identifiers, listed by comma.
Response Headers: - Content-Type – application/json
Status Codes: - 200 OK – OK
-
POST
/scheduler/resume
¶ Resumes the specified jobs.
Query Parameters: - ids (string) – Optional. Job identifiers, listed by comma.
Response Headers: - Content-Type – application/json
Status Codes: - 200 OK – OK
-
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: - Content-Type – application/json
Response Headers: - Content-Type – application/json
Status Codes: - 200 OK – OK