200 |
It returns an ok and a collection of tasks with the new taskId. . This reply code comes only for bulk operations if all commands were successful. |
|
application/json
model |
example
{
"title": "start task response",
"id": "schemas/job/startTasks",
"$schema": "http://json-schema.org/draft-04/schema#",
"javaType": "com.sos.joc.model.job.StartedTasks",
"type": "object",
"description": "if ok=true then tasks collection is required",
"required": [
"deliveryDate"
],
"properties": {
"deliveryDate": {
"id": "schemas/common/deliveryDate",
"description": "Current date of the JOC server/REST service. Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ",
"type": "string",
"format": "date-time"
},
"tasks": {
"type": "array",
"items": {
"id": "schemas/job/taskPath200",
"javaType": "com.sos.joc.model.job.TaskPath200",
"type": "object",
"required": [
"job",
"taskId",
"surveyDate"
],
"properties": {
"job": {
"id": "schemas/common/path",
"description": "absolute path based on live folder of a JobScheduler object.",
"type": "string",
"pattern": "/([^/]+/)*[^/]+"
},
"taskId": {
"type": "string"
},
"surveyDate": {
"id": "schemas/common/surveyDate_v",
"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"
}
}
}
},
"ok": {
"type": "boolean"
},
"errors": {
"type": "array",
"items": {
"id": "schemas/common/error419",
"javaType": "com.sos.joc.model.common.Err419",
"type": "object",
"required": [
"surveyDate",
"path",
"code",
"message"
],
"properties": {
"surveyDate": {
"id": "schemas/common/surveyDate_v",
"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"
},
"path": {
"id": "schemas/common/path",
"description": "absolute path based on live folder of a JobScheduler object.",
"type": "string",
"pattern": "/([^/]+/)*[^/]+"
},
"code": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
}
}
}
{ "deliveryDate": "2016-05-05T21:13:35Z", "ok": true, "tasks": [{ "surveyDate": "2016-05-05T21:13:34Z", "job": "/path/to/job", "taskId": "4711" }] }
{
"deliveryDate": "2016-05-05T21:13:35Z",
"ok": true,
"tasks": [{
"surveyDate": "2016-05-05T21:13:34Z",
"job": "/path/to/job",
"taskId": "4711"
}]
}
|
401 |
Unauthorized! |
|
application/json
model |
example
{
"title": "security",
"id": "schemas/user/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 'start' |
|
application/json
model |
example
{
"title": "security",
"id": "schemas/user/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
}
|
419 |
It returns an array of error items for each failed command and the new taskId in an tasks collection for each successful command at bulk operations. |
|
application/json
model |
{
"title": "start task response",
"id": "schemas/job/startTasks",
"$schema": "http://json-schema.org/draft-04/schema#",
"javaType": "com.sos.joc.model.job.StartedTasks",
"type": "object",
"description": "if ok=true then tasks collection is required",
"required": [
"deliveryDate"
],
"properties": {
"deliveryDate": {
"id": "schemas/common/deliveryDate",
"description": "Current date of the JOC server/REST service. Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ",
"type": "string",
"format": "date-time"
},
"tasks": {
"type": "array",
"items": {
"id": "schemas/job/taskPath200",
"javaType": "com.sos.joc.model.job.TaskPath200",
"type": "object",
"required": [
"job",
"taskId",
"surveyDate"
],
"properties": {
"job": {
"id": "schemas/common/path",
"description": "absolute path based on live folder of a JobScheduler object.",
"type": "string",
"pattern": "/([^/]+/)*[^/]+"
},
"taskId": {
"type": "string"
},
"surveyDate": {
"id": "schemas/common/surveyDate_v",
"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"
}
}
}
},
"ok": {
"type": "boolean"
},
"errors": {
"type": "array",
"items": {
"id": "schemas/common/error419",
"javaType": "com.sos.joc.model.common.Err419",
"type": "object",
"required": [
"surveyDate",
"path",
"code",
"message"
],
"properties": {
"surveyDate": {
"id": "schemas/common/surveyDate_v",
"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"
},
"path": {
"id": "schemas/common/path",
"description": "absolute path based on live folder of a JobScheduler object.",
"type": "string",
"pattern": "/([^/]+/)*[^/]+"
},
"code": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
}
}
}
|
420 |
'start' failed! |
|
application/json
model |
example
{
"title": "error object with delivery date",
"id": "schemas/common/error420",
"$schema": "http://json-schema.org/draft-04/schema#",
"javaType": "com.sos.joc.model.common.Err420",
"type": "object",
"required": [
"deliveryDate",
"error"
],
"properties": {
"deliveryDate": {
"id": "schemas/common/deliveryDate",
"description": "Current date of the JOC server/REST service. 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": {
"id": "schemas/common/error",
"javaType": "com.sos.joc.model.common.Err",
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
}
}
{ "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "start failed!" } }
{
"deliveryDate": "2016-05-05T21:13:35Z",
"surveyDate": "2016-05-05T21:13:33Z",
"error": {
"code": "JOC-420",
"message": "start failed!"
}
}
|
440 |
Login Timeout! The client's session has expired and must log in again. |
|
application/json
model |
example
{
"title": "security",
"id": "schemas/user/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
}
|