200 |
- Required fields are
- surveyDate
- path
- name
- usedByOrders
- usedByJobs
- Optional fields are
- title
- substitute (this field and substitutedBy are exclusive)
- substitutedBy
- configurationDate
|
|
application/json
model |
example
{
"title": "schedules (permanent part)",
"$schema": "http://json-schema.org/draft-04/schema#",
"javaType": "com.sos.joc.model.schedule.SchedulesP",
"type": "object",
"required": [
"deliveryDate",
"schedules"
],
"properties": {
"deliveryDate": {
"description": "Date time. Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ",
"type": "string",
"format": "date-time"
},
"schedules": {
"type": "array",
"items": {
"javaType": "com.sos.joc.model.schedule.ScheduleP",
"type": "object",
"required": [
"surveyDate",
"path",
"name",
"usedByOrders",
"usedByJobs"
],
"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"
},
"path": {
"description": "absolute path based on live folder of a JobScheduler object.",
"type": "string",
"pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
"maxLength": 255
},
"name": {
"type": "string"
},
"title": {
"type": "string"
},
"substitute": {
"javaType": "com.sos.joc.model.schedule.Substitute",
"type": "object",
"required": [
"path",
"validFrom",
"validTo"
],
"properties": {
"path": {
"description": "absolute path based on live folder of a JobScheduler object.",
"type": "string",
"pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
"maxLength": 255
},
"validFrom": {
"description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty",
"type": "string",
"format": "date-time"
},
"validTo": {
"description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty",
"type": "string",
"format": "date-time"
}
}
},
"substitutedBy": {
"type": "array",
"items": {
"javaType": "com.sos.joc.model.schedule.Substitute",
"type": "object",
"required": [
"path",
"validFrom",
"validTo"
],
"properties": {
"path": {
"description": "absolute path based on live folder of a JobScheduler object.",
"type": "string",
"pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
"maxLength": 255
},
"validFrom": {
"description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty",
"type": "string",
"format": "date-time"
},
"validTo": {
"description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty",
"type": "string",
"format": "date-time"
}
}
}
},
"usedByOrders": {
"type": "array",
"items": {
"type": "object",
"properties": {
"jobChain": {
"description": "absolute path based on live folder of a JobScheduler object.",
"type": "string",
"pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
"maxLength": 255
},
"orderId": {
"type": "string"
}
}
}
},
"usedByJobs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"job": {
"description": "absolute path based on live folder of a JobScheduler object.",
"type": "string",
"pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
"maxLength": 255
}
}
}
},
"configurationDate": {
"description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty",
"type": "string",
"format": "date-time"
},
"documentation": {
"description": "absolute path based on live folder of a JobScheduler object.",
"type": "string",
"pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
"maxLength": 255
}
}
}
}
}
}
{ "schedules": [{ "path": "/examples/20_SchedulingJobChains/MonthlySchedule", "title": "Run at Ultimo", "configurationDate": "2016-09-14T00:44:12Z", "name": "MonthlySchedule", "usedByOrders": [{ "jobChain": "/examples/20_SchedulingJobChains/01_JobChainMonthly", "orderId": "MonthlyOrder" }], "surveyDate": "2016-09-14T00:44:12Z" }, { "path": "/examples/10_RemoteExecutionUniversalAgent/schedule1", "configurationDate": "2016-09-14T00:44:13Z", "name": "schedule1", "usedByOrders": [{ "jobChain": "/examples/10_RemoteExecutionUniversalAgent/01_JobChainA", "orderId": "first_monday_of_month" }], "surveyDate": "2016-09-14T00:44:13Z" }, { "path": "/examples/20_SchedulingJobChains/DailySchedule", "title": "daily at fixed starttime", "configurationDate": "2016-09-14T00:44:13Z", "name": "DailySchedule", "usedByOrders": [{ "jobChain": "/examples/20_SchedulingJobChains/01_JobChainDaily", "orderId": "DailyOrder" }], "surveyDate": "2016-09-14T00:44:13Z" }, { "path": "/examples/20_SchedulingJobChains/WeeklySchedule", "title": "every friday", "configurationDate": "2016-09-14T00:44:13Z", "name": "WeeklySchedule", "usedByOrders": [{ "jobChain": "/examples/20_SchedulingJobChains/01_JobChainWeekly", "orderId": "WeeklyOrder" }], "surveyDate": "2016-09-14T00:44:13Z" }], "deliveryDate": "2016-09-14T00:44:12Z" }
{
"schedules": [{
"path": "/examples/20_SchedulingJobChains/MonthlySchedule",
"title": "Run at Ultimo",
"configurationDate": "2016-09-14T00:44:12Z",
"name": "MonthlySchedule",
"usedByOrders": [{
"jobChain": "/examples/20_SchedulingJobChains/01_JobChainMonthly",
"orderId": "MonthlyOrder"
}],
"surveyDate": "2016-09-14T00:44:12Z"
}, {
"path": "/examples/10_RemoteExecutionUniversalAgent/schedule1",
"configurationDate": "2016-09-14T00:44:13Z",
"name": "schedule1",
"usedByOrders": [{
"jobChain": "/examples/10_RemoteExecutionUniversalAgent/01_JobChainA",
"orderId": "first_monday_of_month"
}],
"surveyDate": "2016-09-14T00:44:13Z"
}, {
"path": "/examples/20_SchedulingJobChains/DailySchedule",
"title": "daily at fixed starttime",
"configurationDate": "2016-09-14T00:44:13Z",
"name": "DailySchedule",
"usedByOrders": [{
"jobChain": "/examples/20_SchedulingJobChains/01_JobChainDaily",
"orderId": "DailyOrder"
}],
"surveyDate": "2016-09-14T00:44:13Z"
}, {
"path": "/examples/20_SchedulingJobChains/WeeklySchedule",
"title": "every friday",
"configurationDate": "2016-09-14T00:44:13Z",
"name": "WeeklySchedule",
"usedByOrders": [{
"jobChain": "/examples/20_SchedulingJobChains/01_JobChainWeekly",
"orderId": "WeeklyOrder"
}],
"surveyDate": "2016-09-14T00:44:13Z"
}],
"deliveryDate": "2016-09-14T00:44:12Z"
}
|
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
}
|