SchedulerResource Resource

Resource for managing the scheduler

GET /scheduler/jobs

List scheduler jobs

Request Parameters
name type description default constraints
active query If set to true, only active jobs will be returned. If set to false, only inactive jobs will be returned. If not set (default), all jobs will be returned.   boolean
failed query If set to true, only failed jobs will be returned. If set to false, only successful jobs will be returned (include jobs that were not yet executed). If not set (default), all jobs will be returned.   boolean
page query Returned page, if paging is used. Paging starts with 1 1 int
pageSize query Page size for paging. If this is set to -1 no paging is used (all matching items are returned). Setting this to 0 will return no items. -1 int
q query Query string for filtering    
sort query Comma separated list of sorted attributes. Each attribute name may be prefixed with + for sorting in ascending order or - for sorting in descending order name  
Response Codes
code condition
200 Jobs are returned.
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions on the scheduler.
Response Body
media type data type description
application/json JobsResponse (JSON) list of jobs

Example

Request
GET /scheduler/jobs
Accept: application/json
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "items" : [ { }, { } ],
  "hasMoreItems" : true,
  "numItems" : 12345,
  "perms" : {
    "property1" : [ "view", "create" ],
    "property2" : [ "delete", "create" ]
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

PUT /scheduler/resume

Resume the scheduler

Response Codes
code condition
200 Scheduler is resumed.
405 Feature suspend_scheduler is not activated.
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions on the scheduler.
Response Body
media type data type description
application/json SchedulerStatusResponse (JSON) status

Example

Request
PUT /scheduler/resume
Accept: application/json
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "status" : "suspending",
  "allowRun" : [ 12345, 12345 ],
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

GET /scheduler/status

Get the scheduler status

Response Codes
code condition
200 Scheduler status is returned.
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions on the scheduler.
Response Body
media type data type description
application/json SchedulerStatusResponse (JSON) status

Example

Request
GET /scheduler/status
Accept: application/json
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "status" : "suspended",
  "allowRun" : [ 12345, 12345 ],
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

PUT /scheduler/suspend

Suspend the scheduler

Request Body
media type data type description
application/json SuspendRequest (JSON) suspend request
Response Codes
code condition
200 Scheduler is suspended.
405 Feature suspend_scheduler is not activated.
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions on the scheduler.
Response Body
media type data type description
application/json SchedulerStatusResponse (JSON) status

Example

Request
PUT /scheduler/suspend
Content-Type: application/json
Accept: application/json

                
{
  "allowRun" : [ 12345, 12345 ]
}
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "status" : "suspended",
  "allowRun" : [ 12345, 12345 ],
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}