- Home
- Resources
- ScheduleResource
REST end point for all scheduler operations.
GET /scheduler
Response Body
media type |
data type |
text/plain |
(custom)
|
POST /scheduler/jobs
Request Parameters
name |
type |
description |
default |
action |
query |
|
|
sessionid |
query |
|
|
Request Body
media type |
data type |
application/json |
XJob
(JSON) |
application/json |
XJob
(JSON) |
application/xml |
x_job
(XML) |
GET /scheduler/jobs/stats
Request Parameters
name |
type |
description |
default |
constraints |
end |
query |
|
-1 |
long |
name |
query |
|
|
|
sessionid |
query |
|
|
|
start |
query |
|
-1 |
long |
status |
query |
|
running |
|
user |
query |
|
user |
|
GET /scheduler/jobs/{jobHandle}
Request Parameters
name |
type |
description |
jobHandle |
path |
|
sessionid |
query |
|
Response Body
media type |
data type |
application/json |
object
(JSON) |
application/json |
object
(JSON) |
application/xml |
anyType
(XML) |
DELETE /scheduler/jobs/{jobHandle}
Request Parameters
name |
type |
description |
jobHandle |
path |
|
sessionid |
query |
|
PUT /scheduler/jobs/{jobHandle}
Request Parameters
name |
type |
description |
jobHandle |
path |
|
sessionid |
query |
|
Request Body
media type |
data type |
application/json |
XJob
(JSON) |
application/json |
XJob
(JSON) |
application/xml |
x_job
(XML) |
POST /scheduler/jobs/{jobHandle}
Request Parameters
name |
type |
description |
default |
constraints |
jobHandle |
path |
|
|
|
action |
query |
|
schedule |
"EXPIRE" or "RESUME" or "SCHEDULE" or "SUSPEND" |
sessionid |
query |
|
|
|
GET /scheduler/jobs/{jobHandle}/info
Request Parameters
name |
type |
description |
jobHandle |
path |
|
sessionid |
query |
|
GET /scheduler/jobs/{jobHandle}/instances
Request Parameters
name |
type |
description |
constraints |
jobHandle |
path |
|
|
numResults |
query |
|
long |
sessionid |
query |
|
|
GET /scheduler/instances/{instanceHandle}
Request Parameters
name |
type |
description |
instanceHandle |
path |
|
sessionid |
query |
|
POST /scheduler/instances/{instanceHandle}
Request Parameters
name |
type |
description |
constraints |
instanceHandle |
path |
|
|
action |
query |
|
"KILL" or "RERUN" |
sessionid |
query |
|
|