| 200 |
|
|
application/json
model |
example
{
"title": "properties",
"$schema": "http://json-schema.org/draft-04/schema#",
"javaType": "com.sos.joc.model.Properties",
"type": "object",
"required": [
"deliveryDate",
"forceCommentsForAuditLog",
"comments",
"showViews",
"securityLevel",
"defaultProfileAccount",
"apiVersion",
"inventoryVersion",
"jocVersion"
],
"properties": {
"deliveryDate": {
"description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty",
"type": "string",
"format": "date-time"
},
"title": {
"type": "string"
},
"securityLevel": {
"javaType": "com.sos.joc.model.common.JocSecurityLevel",
"type": "string",
"enum": [
"LOW",
"MEDIUM",
"HIGH"
]
},
"defaultProfileAccount": {
"type": "string"
},
"apiVersion": {
"type": "string"
},
"inventoryVersion": {
"type": "string"
},
"forceCommentsForAuditLog": {
"type": "boolean",
"default": false
},
"comments": {
"type": "array",
"items": {
"type": "string"
}
},
"copy": {
"javaType": "com.sos.joc.model.SuffixPrefix",
"type": "object",
"properties": {
"suffix": {
"type": "string"
},
"prefix": {
"type": "string"
}
}
},
"restore": {
"javaType": "com.sos.joc.model.SuffixPrefix",
"type": "object",
"properties": {
"suffix": {
"type": "string"
},
"prefix": {
"type": "string"
}
}
},
"import": {
"javaType": "com.sos.joc.model.SuffixPrefix",
"type": "object",
"properties": {
"suffix": {
"type": "string"
},
"prefix": {
"type": "string"
}
}
},
"showViews": {
"javaType": "com.sos.joc.model.ShowViewProperties",
"type": "object",
"properties": {
"dashboard": {
"type": "boolean"
},
"dailyPlan": {
"type": "boolean"
},
"workflows": {
"type": "boolean"
},
"orders": {
"type": "boolean"
},
"jobStreams": {
"type": "boolean"
},
"fileTransfers": {
"type": "boolean"
},
"resources": {
"type": "boolean"
},
"history": {
"type": "boolean"
},
"auditLog": {
"type": "boolean"
},
"conditions": {
"type": "boolean"
},
"configuration": {
"type": "boolean"
},
"monitor": {
"type": "boolean"
}
}
},
"welcomeDoNotRemindMe": {
"type": "boolean",
"default": false
},
"welcomeGotIt": {
"type": "boolean",
"default": false
},
"allowEmptyArguments": {
"type": "boolean",
"default": false
},
"clusterLicense": {
"type": "boolean",
"default": false
},
"licenseValidFrom": {
"description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty",
"type": "string",
"format": "date-time"
},
"licenseValidUntil": {
"description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty",
"type": "string",
"format": "date-time"
},
"licenseType": {
"javaType": "com.sos.joc.model.joc.LicenseType",
"type": "string",
"enum": [
"OPENSOURCE",
"COMMERCIAL_VALID",
"COMMERCIAL_INVALID"
]
}
}
}
{ "comments": [ "System maintenance", "Repeat execution", "Business requirement", "Restart failed execution", "Re-instantiate stopped object", "Temporary stop", "Change of Controller object", "Rerun with parameter changes", "Change of external dependency", "Application deployment and upgrade" ], "deliveryDate": "2020-02-02T00:27:32.374Z", "forceCommentsForAuditLog": false, "showViews": { "dashboard": true, "fileTransfers": false }, "securityLevel": "LOW", "apiVersion": "2.0.0", "inventoryVersion": "1.0.0", "defaultProfileAccount": "root", "title": "My primary JOC Cockpit" }
{
"comments": [
"System maintenance",
"Repeat execution",
"Business requirement",
"Restart failed execution",
"Re-instantiate stopped object",
"Temporary stop",
"Change of Controller object",
"Rerun with parameter changes",
"Change of external dependency",
"Application deployment and upgrade"
],
"deliveryDate": "2020-02-02T00:27:32.374Z",
"forceCommentsForAuditLog": false,
"showViews": {
"dashboard": true,
"fileTransfers": false
},
"securityLevel": "LOW",
"apiVersion": "2.0.0",
"inventoryVersion": "1.0.0",
"defaultProfileAccount": "root",
"title": "My primary JOC Cockpit"
}
|
| 401 |
Unauthorized! |
|
application/json
model |
example
{
"title": "authentication",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": [
"isAuthenticated"
],
"properties": {
"user": {
"type": "string"
},
"accessToken": {
"type": "string"
},
"message": {
"type": "string"
},
"role": {
"type": "string"
},
"isAuthenticated": {
"type": "boolean"
},
"isPermitted": {
"type": "boolean",
"default": false
},
"sessionTimeout": {
"type": "integer",
"default": 1800
},
"enableTouch": {
"type": "boolean",
"default": true
}
}
}
{ "user": "root", "message": "Oops!", "isAuthenticated": false, "isPermitted": false }
{
"user": "root",
"message": "Oops!",
"isAuthenticated": false,
"isPermitted": false
}
|
| 403 |
Forbidden!
The user doesn't have sufficient permissions for 'properties' |
|
application/json
model |
example
{
"title": "authentication",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": [
"isAuthenticated"
],
"properties": {
"user": {
"type": "string"
},
"accessToken": {
"type": "string"
},
"message": {
"type": "string"
},
"role": {
"type": "string"
},
"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 ...", "role": "all", "isAuthenticated": true, "isPermitted": false }
{
"user": "root",
"message": "You don't have sufficient permissions for ...",
"role": "all",
"isAuthenticated": true,
"isPermitted": false
}
|
| 420 |
'properties' 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": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty",
"type": "string",
"format": "date-time"
},
"surveyDate": {
"description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty",
"type": "string",
"format": "date-time"
},
"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": "properties failed!" } }
{
"deliveryDate": "2016-05-05T21:13:35Z",
"surveyDate": "2016-05-05T21:13:33Z",
"error": {
"code": "JOC-420",
"message": "properties failed!"
}
}
|
| 440 |
Login Timeout!
The client's session has expired and must log in again. |
|
application/json
model |
example
{
"title": "authentication",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": [
"isAuthenticated"
],
"properties": {
"user": {
"type": "string"
},
"accessToken": {
"type": "string"
},
"message": {
"type": "string"
},
"role": {
"type": "string"
},
"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", "role": "all", "isAuthenticated": false, "isPermitted": false }
{
"user": "root",
"message": "Session has expired. Please log in again",
"role": "all",
"isAuthenticated": false,
"isPermitted": false
}
|