| 200 |
Returns permanent information such as
- jobscheduler id
- version
- host
- port
- operating system
- time zone
- cluster type
|
|
application/json
model |
example
{
"title": "jobscheduler with delivry date (permanent part)",
"$schema": "http://json-schema.org/draft-04/schema#",
"javaType": "com.sos.joc.model.jobscheduler.JobSchedulerP200",
"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.JobSchedulerP",
"type": "object",
"required": [
"surveyDate",
"jobschedulerId",
"version",
"host",
"port",
"os",
"timeZone",
"clusterType",
"startedAt"
],
"properties": {
"surveyDate": {
"description": "Date of the inventory data. Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ",
"type": "string",
"format": "date-time"
},
"jobschedulerId": {
"type": "string"
},
"version": {
"type": "string"
},
"host": {
"type": "string"
},
"port": {
"type": "integer",
"minimum": 0,
"maximum": 65535
},
"os": {
"javaType": "com.sos.joc.model.jobscheduler.OperatingSystem",
"type": "object",
"required": [
"name",
"architecture",
"distribution"
],
"properties": {
"name": {
"description": "Windows, Linux, AIX, Solaris, other",
"type": "string"
},
"architecture": {
"type": "string"
},
"distribution": {
"description": "e.g. Windows 2012, CentOS Linux release 7.2.1511 (Core)",
"type": "string"
}
}
},
"timeZone": {
"type": "string"
},
"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"
},
"supervisor": {
"javaType": "com.sos.joc.model.jobscheduler.HostPortParameter",
"type": "object",
"properties": {
"jobschedulerId": {
"type": "string",
"pattern": "^[^/\\<>?:\"|*]*$",
"maxLength": 100
},
"host": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 255
},
"port": {
"type": "integer",
"minimum": 0,
"maximum": 65535
},
"filename": {
"type": "string",
"pattern": "^[^/\\<>?:\"|*]*$",
"maxLength": 255
},
"auditLog": {
"javaType": "com.sos.joc.model.audit.AuditParams",
"type": "object",
"properties": {
"comment": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 255
},
"timeSpent": {
"type": "integer",
"minimum": 0
},
"ticketLink": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 255
}
}
}
}
}
}
}
}
}
{ "deliveryDate": "2016-05-05T21:13:35Z", "jobscheduler": { "surveyDate": "2016-05-05T20:34:51Z", "jobschedulerId": "schedulerId", "version": "1.11.0", "host": "test.sos", "port": 4444, "os": { "name": "linux", "architecture": 64, "distribution": "CentOS Linux release 7.2.1511" }, "startedAt": "2016-05-05T20:34:18Z", "timeZone": "Europe/Berlin", "clusterType": { "type": "passive", "precedence": 0 }, "supervisor": { "jobschedulerId": "supervisor", "host": "super.sos", "port": 4444 } } }
{
"deliveryDate": "2016-05-05T21:13:35Z",
"jobscheduler": {
"surveyDate": "2016-05-05T20:34:51Z",
"jobschedulerId": "schedulerId",
"version": "1.11.0",
"host": "test.sos",
"port": 4444,
"os": {
"name": "linux",
"architecture": 64,
"distribution": "CentOS Linux release 7.2.1511"
},
"startedAt": "2016-05-05T20:34:18Z",
"timeZone": "Europe/Berlin",
"clusterType": {
"type": "passive",
"precedence": 0
},
"supervisor": {
"jobschedulerId": "supervisor",
"host": "super.sos",
"port": 4444
}
}
}
|
| 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 'p' |
|
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 |
'p' 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": "p failed!" } }
{
"deliveryDate": "2016-05-05T21:13:35Z",
"surveyDate": "2016-05-05T21:13:33Z",
"error": {
"code": "JOC-420",
"message": "p 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
}
|