| 200 |
Returns particularly status such as
- starting
- running
- paused
- waiting for activation
- waiting for database
- terminating
- dead
- unreachable
|
|
application/json
model |
example
{
"title": "jobscheduler with delivry date (volatile part)",
"$schema": "http://json-schema.org/draft-04/schema#",
"javaType": "com.sos.joc.model.jobscheduler.JobSchedulerV200",
"type": "object",
"required": [
"deliveryDate",
"jobscheduler"
],
"properties": {
"deliveryDate": {
"description": "Date time. Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ",
"type": "string",
"format": "date-time"
},
"jobscheduler": {
"javaType": "com.sos.joc.model.jobscheduler.JobSchedulerV",
"type": "object",
"oneOf": [{
"description": "if state.text=unreachable",
"required": [
"jobschedulerId",
"host",
"port",
"state"
]
}, {
"required": [
"surveyDate",
"jobschedulerId",
"host",
"port",
"state",
"startedAt"
]
}],
"properties": {
"surveyDate": {
"description": "Current date of the JobScheduler Master/Agent. Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ",
"type": "string",
"format": "date-time"
},
"jobschedulerId": {
"type": "string"
},
"host": {
"type": "string"
},
"port": {
"type": "integer",
"minimum": 0,
"maximum": 65535
},
"state": {
"javaType": "com.sos.joc.model.jobscheduler.JobSchedulerState",
"type": "object",
"required": [
"severity",
"_text"
],
"properties": {
"severity": {
"description": "0=running/starting, 1=paused, 3=waiting_for_activation/terminating, 2=waiting_for_database/dead/unreachable",
"type": "integer"
},
"_text": {
"javaType": "com.sos.joc.model.jobscheduler.JobSchedulerStateText",
"type": "string",
"enum": [
"STARTING",
"RUNNING",
"PAUSED",
"WAITING_FOR_ACTIVATION",
"TERMINATING",
"WAITING_FOR_DATABASE",
"DEAD",
"UNREACHABLE",
"UNKNOWN_AGENT"
]
}
}
},
"url": {
"type": "string"
},
"clusterType": {
"javaType": "com.sos.joc.model.jobscheduler.ClusterMemberType",
"type": "object",
"required": [
"_type"
],
"properties": {
"_type": {
"javaType": "com.sos.joc.model.jobscheduler.ClusterType",
"description": "Possible values are: 'standalone','active','passive'; JobScheduler doesn't run in a cluster (standalone) or is member of an active (distributed orders) or passive cluster (backup)",
"type": "string",
"enum": [
"standalone",
"active",
"passive"
]
},
"precedence": {
"type": "integer",
"minimum": 0
}
}
},
"startedAt": {
"description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty",
"type": "string",
"format": "date-time"
},
"error": {
"javaType": "com.sos.joc.model.common.Err",
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 255
},
"message": {
"type": "string"
}
}
}
}
}
}
}
{ "deliveryDate": "2016-05-05T21:13:45Z", "jobscheduler": { "surveyDate": "2016-05-05T21:13:45Z", "jobschedulerId": "schedulerId", "host": "test.sos", "port": 4444, "clusterType": { "type": "passive", "precedence": 0 }, "state": { "severity": 0, "_text": "running" }, "startedAt": "2016-04-21T14:52:09Z" } }
{
"deliveryDate": "2016-05-05T21:13:45Z",
"jobscheduler": {
"surveyDate": "2016-05-05T21:13:45Z",
"jobschedulerId": "schedulerId",
"host": "test.sos",
"port": 4444,
"clusterType": {
"type": "passive",
"precedence": 0
},
"state": {
"severity": 0,
"_text": "running"
},
"startedAt": "2016-04-21T14:52:09Z"
}
}
|
| 401 |
Unauthorized! |
|
application/json
model |
example
{
"title": "security",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": [
"isAuthenticated"
],
"properties": {
"user": {
"type": "string"
},
"accessToken": {
"type": "string"
},
"message": {
"type": "string"
},
"hasRole": {
"type": "boolean",
"default": false
},
"isAuthenticated": {
"type": "boolean"
},
"isPermitted": {
"type": "boolean",
"default": false
},
"sessionTimeout": {
"type": "integer",
"default": 1800
},
"enableTouch": {
"type": "boolean",
"default": true
}
}
}
{ "user": "root", "message": "Oops!", "hasRole": false, "isAuthenticated": false, "isPermitted": false }
{
"user": "root",
"message": "Oops!",
"hasRole": false,
"isAuthenticated": false,
"isPermitted": false
}
|
| 403 |
Forbidden!
The user doesn't have sufficient permissions for 'jobscheduler' |
|
application/json
model |
example
{
"title": "security",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": [
"isAuthenticated"
],
"properties": {
"user": {
"type": "string"
},
"accessToken": {
"type": "string"
},
"message": {
"type": "string"
},
"hasRole": {
"type": "boolean",
"default": false
},
"isAuthenticated": {
"type": "boolean"
},
"isPermitted": {
"type": "boolean",
"default": false
},
"sessionTimeout": {
"type": "integer",
"default": 1800
},
"enableTouch": {
"type": "boolean",
"default": true
}
}
}
{ "user": "root", "message": "You don't have sufficient permissions for ...", "hasRole": false, "isAuthenticated": true, "isPermitted": false }
{
"user": "root",
"message": "You don't have sufficient permissions for ...",
"hasRole": false,
"isAuthenticated": true,
"isPermitted": false
}
|
| 420 |
'jobscheduler' failed! |
|
application/json
model |
example
{
"title": "error object with delivery date",
"$schema": "http://json-schema.org/draft-04/schema#",
"javaType": "com.sos.joc.model.common.Err420",
"type": "object",
"required": [
"deliveryDate",
"error"
],
"properties": {
"deliveryDate": {
"description": "Date time. Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ",
"type": "string",
"format": "date-time"
},
"surveyDate": {
"description": "is also required for permanent or volatile requests",
"type": "string",
"format": "date-time"
},
"error": {
"javaType": "com.sos.joc.model.common.Err",
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 255
},
"message": {
"type": "string"
}
}
}
}
}
{ "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "jobscheduler failed!" } }
{
"deliveryDate": "2016-05-05T21:13:35Z",
"surveyDate": "2016-05-05T21:13:33Z",
"error": {
"code": "JOC-420",
"message": "jobscheduler failed!"
}
}
|
| 440 |
Login Timeout!
The client's session has expired and must log in again. |
|
application/json
model |
example
{
"title": "security",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": [
"isAuthenticated"
],
"properties": {
"user": {
"type": "string"
},
"accessToken": {
"type": "string"
},
"message": {
"type": "string"
},
"hasRole": {
"type": "boolean",
"default": false
},
"isAuthenticated": {
"type": "boolean"
},
"isPermitted": {
"type": "boolean",
"default": false
},
"sessionTimeout": {
"type": "integer",
"default": 1800
},
"enableTouch": {
"type": "boolean",
"default": true
}
}
}
{ "user": "root", "message": "Session has expired. Please log in again", "hasRole": false, "isAuthenticated": false, "isPermitted": false }
{
"user": "root",
"message": "Session has expired. Please log in again",
"hasRole": false,
"isAuthenticated": false,
"isPermitted": false
}
|