Resource for managing the scheduler
Get the scheduler status
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. |
media type | data type | description |
---|---|---|
application/json | SchedulerStatusResponse (JSON) | status |
GET /scheduler/status Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
{
"status" : "suspended",
"allowRun" : [ 12345, 12345 ],
"messages" : [ {
"fieldName" : "...",
"message" : "...",
"type" : "NEUTRAL",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
}, {
"fieldName" : "...",
"message" : "...",
"type" : "WARNING",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
} ],
"responseInfo" : {
"responseCode" : "PERMISSION",
"responseMessage" : "...",
"property" : "..."
}
}
Suspend the scheduler
media type | data type | description |
---|---|---|
application/json | SuspendRequest (JSON) | suspend request |
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. |
media type | data type | description |
---|---|---|
application/json | SchedulerStatusResponse (JSON) | status |
PUT /scheduler/suspend
Content-Type: application/json
Accept: application/json
{
"allowRun" : [ 12345, 12345 ]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"status" : "suspending",
"allowRun" : [ 12345, 12345 ],
"messages" : [ {
"fieldName" : "...",
"message" : "...",
"type" : "WARNING",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
}, {
"fieldName" : "...",
"message" : "...",
"type" : "NEUTRAL",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
} ],
"responseInfo" : {
"responseCode" : "MAINTENANCEMODE",
"responseMessage" : "...",
"property" : "..."
}
}
Resume the scheduler
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. |
media type | data type | description |
---|---|---|
application/json | SchedulerStatusResponse (JSON) | status |
PUT /scheduler/resume Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
{
"status" : "running",
"allowRun" : [ 12345, 12345 ],
"messages" : [ {
"fieldName" : "...",
"message" : "...",
"type" : "CRITICAL",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
}, {
"fieldName" : "...",
"message" : "...",
"type" : "INFO",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
} ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}