200 |
|
|
application/json
model |
example
{
"title": "abstract super class for editing all JobScheduler Objects",
"$schema": "http://json-schema.org/draft-04/schema#",
"javaType": "com.sos.joc.model.joe.common.JSObjectEdit",
"type": "object",
"description": "oldPath is used for a move/rename, auditLog only for deploy",
"required": [
"jobschedulerId",
"path"
],
"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"
},
"configurationDate": {
"description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty",
"type": "string",
"format": "date-time"
},
"jobschedulerId": {
"type": "string",
"pattern": "^[^/\\<>?:\"|*]*$",
"maxLength": 100
},
"path": {
"description": "absolute path based on live folder of a JobScheduler object.",
"type": "string",
"pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
"maxLength": 255
},
"oldPath": {
"description": "absolute path based on live folder of a JobScheduler object.",
"type": "string",
"pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
"maxLength": 255
},
"objectType": {
"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"
]
},
"objectVersionStatus": {
"javaType": "com.sos.joc.model.joe.common.JoeObjectStatus",
"type": "object",
"description": "Describes the situation live/draft",
"properties": {
"message": {
"javaType": "com.sos.joc.model.joe.common.JoeMessage",
"type": "object",
"properties": {
"messageText": {
"type": "string"
},
"_messageCode": {
"type": "string"
}
}
},
"versionState": {
"javaType": "com.sos.joc.model.joe.common.VersionStateText",
"type": "string",
"enum": [
"LIVE_IS_NEWER",
"DRAFT_IS_NEWER",
"LIVE_NOT_EXIST",
"DRAFT_NOT_EXIST",
"NO_CONFIGURATION_EXIST"
]
},
"deployed": {
"type": "boolean"
}
}
},
"configuration": {
"description": "interface for different json representations of a configuration item",
"type": "object",
"javaType": "com.sos.joc.model.joe.common.IJSObject"
},
"account": {
"type": "string",
"pattern": "^[^/\\<>?:\"|*]*$",
"maxLength": 255
},
"docPath": {
"description": "absolute path based on live folder of a JobScheduler object.",
"type": "string",
"pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
"maxLength": 255
},
"auditLog": {
"javaType": "com.sos.joc.model.audit.AuditParams",
"type": "object",
"properties": {
"comment": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 255
},
"timeSpent": {
"type": "integer",
"minimum": 0
},
"ticketLink": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 255
}
}
},
"isJitlJob": {
"type": "boolean",
"default": false
}
}
}
{ "deliveryDate": "2019-09-20T00:27:32.374Z", "jobschedulerId": "myJobScheduler", "path": "/path/to/job", "objectType": "JOB", "account": "John Doe", "deployed": false, "configurationDate": "2019-09-20T13:41:33.000Z", "configuration": { "title": "myJob", "isOrderJob": "yes", "maxTasks": 5, "stopOnError": "no", "settings": { "logLevel": "debug9" }, "params": { "paramList": [{ "name": "myParam", "value": "myParamVal" }, { "name": "myParam2", "value": "myParamVal2" }] }, "environment": { "variables": [{ "name": "myEnv", "value": "myEnvVal" }] }, "login": { "user": "me", "password": "secret" }, "script": { "language": "shell", "content": "\necho hello\necho world\n" } } }
{
"deliveryDate": "2019-09-20T00:27:32.374Z",
"jobschedulerId": "myJobScheduler",
"path": "/path/to/job",
"objectType": "JOB",
"account": "John Doe",
"deployed": false,
"configurationDate": "2019-09-20T13:41:33.000Z",
"configuration": {
"title": "myJob",
"isOrderJob": "yes",
"maxTasks": 5,
"stopOnError": "no",
"settings": {
"logLevel": "debug9"
},
"params": {
"paramList": [{
"name": "myParam",
"value": "myParamVal"
}, {
"name": "myParam2",
"value": "myParamVal2"
}]
},
"environment": {
"variables": [{
"name": "myEnv",
"value": "myEnvVal"
}]
},
"login": {
"user": "me",
"password": "secret"
},
"script": {
"language": "shell",
"content": "\necho hello\necho world\n"
}
}
}
|
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 'file' |
|
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 |
'file' 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": "file failed!" } }
{
"deliveryDate": "2016-05-05T21:13:35Z",
"surveyDate": "2016-05-05T21:13:33Z",
"error": {
"code": "JOC-420",
"message": "file 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
}
|