| 200 |
TODO |
|
application/json
model |
example
{
"title": "step history collection of one order run",
"$schema": "http://json-schema.org/draft-04/schema#",
"javaType": "com.sos.joc.model.order.OrderStepHistory",
"type": "object",
"required": [
"deliveryDate",
"history"
],
"properties": {
"deliveryDate": {
"description": "Date time. Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ",
"type": "string",
"format": "date-time"
},
"history": {
"type": "object",
"required": [
"historyId",
"steps"
],
"properties": {
"historyId": {
"type": "string"
},
"steps": {
"type": "array",
"items": {
"javaType": "com.sos.joc.model.order.OrderStepHistoryItem",
"type": "object",
"required": [
"node",
"job",
"step",
"startTime",
"taskId"
],
"properties": {
"node": {
"type": "string"
},
"job": {
"description": "absolute path based on live folder of a JobScheduler object.",
"type": "string",
"pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
"maxLength": 255
},
"step": {
"type": "integer",
"minimum": 0
},
"startTime": {
"description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty",
"type": "string",
"format": "date-time"
},
"endTime": {
"description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty",
"type": "string",
"format": "date-time"
},
"taskId": {
"type": "string"
},
"clusterMember": {
"type": "integer",
"minimum": 0
},
"exitCode": {
"type": "integer",
"minimum": 0
},
"error": {
"javaType": "com.sos.joc.model.common.Err",
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 255
},
"message": {
"type": "string"
}
}
},
"agent": {
"description": "agent url",
"type": "string"
}
}
}
}
}
}
}
}
{ "deliveryDate": "2016-09-14T00:46:01Z", "historyId": 1003322, "steps": [{ "node": "CheckDBTbl", "step": 1, "job": "examples/55_JobSchedulerLaunchQueue/01_JobSchedulerLaunchQueue/check_jobchain_launch_queue", "startTime": "2016-08-17 10:40:21Z", "endTime": "2016-08-17 10:40:28Z", "taskId": 3861156, "exitCode": 0 }, { "node": "DispatchOrder", "step": 2, "job": "examples/55_JobSchedulerLaunchQueue/01_JobSchedulerLaunchQueue/launch_job_chain", "startTime": "2016-08-17 10:40:28Z", "endTime": "2016-08-17 10:40:30Z", "taskId": 3861157, "exitCode": 0 }] }
{
"deliveryDate": "2016-09-14T00:46:01Z",
"historyId": 1003322,
"steps": [{
"node": "CheckDBTbl",
"step": 1,
"job": "examples/55_JobSchedulerLaunchQueue/01_JobSchedulerLaunchQueue/check_jobchain_launch_queue",
"startTime": "2016-08-17 10:40:21Z",
"endTime": "2016-08-17 10:40:28Z",
"taskId": 3861156,
"exitCode": 0
}, {
"node": "DispatchOrder",
"step": 2,
"job": "examples/55_JobSchedulerLaunchQueue/01_JobSchedulerLaunchQueue/launch_job_chain",
"startTime": "2016-08-17 10:40:28Z",
"endTime": "2016-08-17 10:40:30Z",
"taskId": 3861157,
"exitCode": 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 'history' |
|
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 |
'history' 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": "history failed!" } }
{
"deliveryDate": "2016-05-05T21:13:35Z",
"surveyDate": "2016-05-05T21:13:33Z",
"error": {
"code": "JOC-420",
"message": "history 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
}
|