200 |
Returns the job chain configuration in XML or HTML format |
|
application/json
model |
example
{
"title": "configuration",
"$schema": "http://json-schema.org/draft-04/schema#",
"javaType": "com.sos.joc.model.common.Configuration200",
"type": "object",
"required": [
"deliveryDate",
"configuration"
],
"properties": {
"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"
},
"configuration": {
"javaType": "com.sos.joc.model.common.Configuration",
"type": "object",
"required": [
"surveyDate",
"path",
"configurationDate",
"content"
],
"properties": {
"surveyDate": {
"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": {
"description": "absolute path based on live folder of a JobScheduler object.",
"type": "string",
"pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
"maxLength": 255
},
"type": {
"javaType": "com.sos.joc.model.common.JobSchedulerObjectType",
"type": "string",
"enum": [
"JOB",
"JOBCHAIN",
"ORDER",
"PROCESSCLASS",
"AGENTCLUSTER",
"LOCK",
"SCHEDULE",
"WORKINGDAYSCALENDAR",
"NONWORKINGDAYSCALENDAR",
"FOLDER",
"JOBSCHEDULER",
"DOCUMENTATION",
"MONITOR",
"NODEPARAMS",
"HOLIDAYS",
"JOE",
"OTHER"
]
},
"configurationDate": {
"description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty",
"type": "string",
"format": "date-time"
},
"content": {
"javaType": "com.sos.joc.model.common.ConfigurationContent",
"type": "object",
"description": "A parameter can specify if the content is xml or html. Either 'xml' or 'html' is required",
"oneOf": [{
"required": [
"xml"
]
}, {
"required": [
"html"
]
}],
"properties": {
"xml": {
"type": "string"
},
"html": {
"type": "string"
}
}
}
}
}
}
}
{ "deliveryDate": "2016-05-05T21:13:45Z", "configuration": { "surveyDate": "2016-05-05T21:13:45Z", "path": "/sos/reporting/Inventory", "configurationDate": "2015-12-11T10:06:39Z", "content": { "xml": "<job_chain orders_recoverable=\"no\" visible=\"yes\" title=\"Inventory of existing jobs, job chains and orders\">\n <job_chain_node state=\"inventory\" job=\"Inventory\" next_state=\"success\" error_state=\"error\"/>\n <job_chain_node state=\"success\"/>\n <job_chain_node state=\"error\"/>\n</job_chain>", "html": "<span class=\"bracket\" style=\"padding-left:20px;\"><</span><span class=\"element_name\">job_chain</span> <span class=\"attribute_name\">orders_recoverable=</span><span class=\"attribute_val\">\"no\"</span> <span class=\"attribute_name\">title=</span><span class=\"attribute_val\">\"Inventory of existing jobs, job chains and orders\"</span> <span class=\"attribute_name\">visible=</span><span class=\"attribute_val\">\"yes\"</span><span class=\"bracket\">></span><br><span class=\"bracket\" style=\"padding-left:40px;\"><</span><span class=\"element_name\">job_chain_node</span> <span class=\"attribute_name\">error_state=</span><span class=\"attribute_val\">\"error\"</span> <span class=\"attribute_name\">job=</span><span class=\"attribute_val\">\"Inventory\"</span> <span class=\"attribute_name\">next_state=</span><span class=\"attribute_val\">\"success\"</span> <span class=\"attribute_name\">state=</span><span class=\"attribute_val\">\"inventory\"</span><span class=\"bracket\">/></span><br><span class=\"bracket\" style=\"padding-left:40px;\"><</span><span class=\"element_name\">job_chain_node</span> <span class=\"attribute_name\">state=</span><span class=\"attribute_val\">\"success\"</span><span class=\"bracket\">/></span><br><span class=\"bracket\" style=\"padding-left:40px;\"><</span><span class=\"element_name\">job_chain_node</span> <span class=\"attribute_name\">state=</span><span class=\"attribute_val\">\"error\"</span><span class=\"bracket\">/></span><br><span class=\"bracket\" style=\"padding-left:20px;\"></</span><span class=\"element_name\">job_chain</span><span class=\"bracket\">></span>" } } }
{
"deliveryDate": "2016-05-05T21:13:45Z",
"configuration": {
"surveyDate": "2016-05-05T21:13:45Z",
"path": "/sos/reporting/Inventory",
"configurationDate": "2015-12-11T10:06:39Z",
"content": {
"xml": "<job_chain orders_recoverable=\"no\" visible=\"yes\" title=\"Inventory of existing jobs, job chains and orders\">\n <job_chain_node state=\"inventory\" job=\"Inventory\" next_state=\"success\" error_state=\"error\"/>\n <job_chain_node state=\"success\"/>\n <job_chain_node state=\"error\"/>\n</job_chain>",
"html": "<span class=\"bracket\" style=\"padding-left:20px;\"><</span><span class=\"element_name\">job_chain</span> <span class=\"attribute_name\">orders_recoverable=</span><span class=\"attribute_val\">\"no\"</span> <span class=\"attribute_name\">title=</span><span class=\"attribute_val\">\"Inventory of existing jobs, job chains and orders\"</span> <span class=\"attribute_name\">visible=</span><span class=\"attribute_val\">\"yes\"</span><span class=\"bracket\">></span><br><span class=\"bracket\" style=\"padding-left:40px;\"><</span><span class=\"element_name\">job_chain_node</span> <span class=\"attribute_name\">error_state=</span><span class=\"attribute_val\">\"error\"</span> <span class=\"attribute_name\">job=</span><span class=\"attribute_val\">\"Inventory\"</span> <span class=\"attribute_name\">next_state=</span><span class=\"attribute_val\">\"success\"</span> <span class=\"attribute_name\">state=</span><span class=\"attribute_val\">\"inventory\"</span><span class=\"bracket\">/></span><br><span class=\"bracket\" style=\"padding-left:40px;\"><</span><span class=\"element_name\">job_chain_node</span> <span class=\"attribute_name\">state=</span><span class=\"attribute_val\">\"success\"</span><span class=\"bracket\">/></span><br><span class=\"bracket\" style=\"padding-left:40px;\"><</span><span class=\"element_name\">job_chain_node</span> <span class=\"attribute_name\">state=</span><span class=\"attribute_val\">\"error\"</span><span class=\"bracket\">/></span><br><span class=\"bracket\" style=\"padding-left:20px;\"></</span><span class=\"element_name\">job_chain</span><span class=\"bracket\">></span>"
}
}
}
|
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 'configuration' |
|
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 |
'configuration' 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": "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": {
"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": "configuration failed!" } }
{
"deliveryDate": "2016-05-05T21:13:35Z",
"surveyDate": "2016-05-05T21:13:33Z",
"error": {
"code": "JOC-420",
"message": "configuration 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
}
|