200 |
Returns the process class configuration in a Json representation |
|
application/json
model |
example
{
"title": "edit process_class configuration",
"$schema": "http://json-schema.org/draft-04/schema#",
"javaType": "com.sos.joc.model.joe.processclass.ProcessClassEdit",
"type": "object",
"required": [
"configuration"
],
"extends": {
"javaType": "com.sos.joc.model.joe.common.JSObjectEdit"
},
"properties": {
"configuration": {
"javaType": "com.sos.joc.model.joe.processclass.ProcessClass",
"javaInterfaces": [
"com.sos.joc.model.joe.common.IJSObject"
],
"xmlElement": "process_class",
"type": "object",
"required": [
"maxProcesses"
],
"properties": {
"maxProcesses": {
"type": "integer",
"minimum": 0
},
"timeout": {
"type": "integer",
"minimum": 0
},
"remoteScheduler": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 255
},
"remoteSchedulers": {
"xmlElement": "remote_schedulers",
"type": "object",
"javaType": "com.sos.joc.model.joe.processclass.RemoteSchedulers",
"required": [
"remoteSchedulerList"
],
"properties": {
"select": {
"description": "first, next",
"type": "string",
"pattern": "^(first|next)?$"
},
"remoteSchedulerList": {
"type": "array",
"xmlElement": "remote_scheduler",
"items": {
"javaType": "com.sos.joc.model.joe.processclass.RemoteScheduler",
"type": "object",
"required": [
"remoteScheduler"
],
"properties": {
"remoteScheduler": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 255
},
"httpHeartbeatTimeout": {
"type": "integer",
"minimum": 0
},
"httpHeartbeatPeriod": {
"type": "integer",
"minimum": 0
}
}
}
}
}
}
}
}
}
}
|
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 'read' |
|
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 |
'read' 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": "read failed!" } }
{
"deliveryDate": "2016-05-05T21:13:35Z",
"surveyDate": "2016-05-05T21:13:33Z",
"error": {
"code": "JOC-420",
"message": "read 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
}
|