| 200 |
|
|
application/json
model |
example
{
"title": "Permissions",
"$schema": "http://json-schema.org/draft-04/schema#",
"javaType": "com.sos.joc.model.security.permissions.Permissions",
"type": "object",
"required": [
"identityServiceName",
"controllerId",
"roleName",
"permissions"
],
"properties": {
"identityServiceName": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 255,
"minLength": 1
},
"controllerId": {
"type": "string",
"pattern": "^[^/\\<>?:\"|*]*$",
"maxLength": 100
},
"roleName": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 255,
"minLength": 1
},
"permissions": {
"type": "array",
"items": {
"javaType": "com.sos.joc.model.security.permissions.Permission",
"type": "object",
"required": [
"permissionPath"
],
"properties": {
"permissionPath": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 255,
"minLength": 1
},
"excluded": {
"type": "boolean"
}
},
"additionalProperties": false
}
},
"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
}
}
}
},
"additionalProperties": false
}
{ "joc": { "administration": { "accounts": { "view": true, "manage": true }, "settings": { "view": true, "manage": true }, "controllers": { "view": true, "manage": true }, "certificates": { "view": true, "manage": true } }, "cluster": { "manage": true }, "inventory": { "view": true, "manage": true, "deploy": true }, "calendars": { "view": true }, "documentations": { "view": true, "manage": true }, "auditLog": { "view": true }, "dailyPlan": { "view": true, "manage": true }, "fileTransfer": { "view": true, "manage": true }, "notification": { "view": true, "manage": true }, "others": { "view": true, "manage": true } }, "controllerDefaults": { "view": true, "restart": true, "terminate": true, "switchOver": true, "deployments": { "view": true, "deploy": true }, "orders": { "view": true, "create": true, "cancel": true, "suspendResume": true, "modify": true }, "agents": { "view": true }, "locks": { "view": true }, "noticeBoards": { "view": true, "post": true, "delete": true }, "workflows": { "view": true } }, "controllers": { "standalone": { "view": false, "restart": false, "terminate": false, "switchOver": false, "deployments": { "view": false, "deploy": false }, "orders": { "view": false, "create": false, "cancel": false, "suspendResume": false, "modify": false }, "agents": { "view": false }, "locks": { "view": false }, "noticeBoards": { "view": false, "post": false, "delete": false }, "workflows": { "view": false } } } }
{
"joc": {
"administration": {
"accounts": {
"view": true,
"manage": true
},
"settings": {
"view": true,
"manage": true
},
"controllers": {
"view": true,
"manage": true
},
"certificates": {
"view": true,
"manage": true
}
},
"cluster": {
"manage": true
},
"inventory": {
"view": true,
"manage": true,
"deploy": true
},
"calendars": {
"view": true
},
"documentations": {
"view": true,
"manage": true
},
"auditLog": {
"view": true
},
"dailyPlan": {
"view": true,
"manage": true
},
"fileTransfer": {
"view": true,
"manage": true
},
"notification": {
"view": true,
"manage": true
},
"others": {
"view": true,
"manage": true
}
},
"controllerDefaults": {
"view": true,
"restart": true,
"terminate": true,
"switchOver": true,
"deployments": {
"view": true,
"deploy": true
},
"orders": {
"view": true,
"create": true,
"cancel": true,
"suspendResume": true,
"modify": true
},
"agents": {
"view": true
},
"locks": {
"view": true
},
"noticeBoards": {
"view": true,
"post": true,
"delete": true
},
"workflows": {
"view": true
}
},
"controllers": {
"standalone": {
"view": false,
"restart": false,
"terminate": false,
"switchOver": false,
"deployments": {
"view": false,
"deploy": false
},
"orders": {
"view": false,
"create": false,
"cancel": false,
"suspendResume": false,
"modify": false
},
"agents": {
"view": false
},
"locks": {
"view": false
},
"noticeBoards": {
"view": false,
"post": false,
"delete": false
},
"workflows": {
"view": false
}
}
}
}
|
| 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 'joc_cockpit_permissions' |
|
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 |
'joc_cockpit_permissions' 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": "joc_cockpit_permissions failed!" } }
{
"deliveryDate": "2016-05-05T21:13:35Z",
"surveyDate": "2016-05-05T21:13:33Z",
"error": {
"code": "JOC-420",
"message": "joc_cockpit_permissions failed!"
}
}
|
| 433 |
4-eyes principle: Forbidden!
The user needs approval process for 'joc_cockpit_permissions' |
|
application/json
model |
example
{
"title": "FourEyesResponse",
"$schema": "http://json-schema.org/draft-04/schema#",
"javaType": "com.sos.joc.model.security.foureyes.FourEyesResponse",
"type": "object",
"extends": {
"javaType": "com.sos.joc.model.security.foureyes.ApprovalBase",
"type": "object",
"properties": {
"requestor": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 255,
"minLength": 1
},
"requestUrl": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 255,
"minLength": 1
},
"requestBody": {
"type": "object",
"javaType": "com.sos.joc.model.security.foureyes.RequestBody",
"additionalProperties": true
},
"category": {
"javaType": "com.sos.joc.model.audit.CategoryType",
"type": "string",
"enum": [
"INVENTORY",
"CONTROLLER",
"DAILYPLAN",
"OTHERS",
"DEPLOYMENT",
"DOCUMENTATIONS",
"CERTIFICATES",
"IDENTITY",
"SETTINGS",
"MONITORING",
"UNKNOWN"
]
}
},
"additionalProperties": false
},
"properties": {
"deliveryDate": {
"description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty",
"type": "string",
"format": "date-time"
},
"message": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 255,
"minLength": 1
},
"approvers": {
"type": "array",
"items": {
"javaType": "com.sos.joc.model.security.foureyes.Approver",
"type": "object",
"required": [
"accountName",
"firstName",
"lastName"
],
"properties": {
"accountName": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 255,
"minLength": 1
},
"firstName": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 30,
"minLength": 1
},
"lastName": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 30,
"minLength": 1
},
"email": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 255
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
{ "deliveryDate": "2025-05-12T21:13:35Z", "accountName": "user1", "request": "./orders/add", "requestBody": { "controllerId": "standalone", "orders": [{ "workflowPath": "myWorkflow", "scheduledFor": "now" }] }, "category": "CONTROLLER", "objectType": "WORKFLOW" "objectName": "myWorkflow", "numOfObjects": 1, "action": "add orders" }
{
"deliveryDate": "2025-05-12T21:13:35Z",
"accountName": "user1",
"request": "./orders/add",
"requestBody": {
"controllerId": "standalone",
"orders": [{
"workflowPath": "myWorkflow",
"scheduledFor": "now"
}]
},
"category": "CONTROLLER",
"objectType": "WORKFLOW"
"objectName": "myWorkflow",
"numOfObjects": 1,
"action": "add orders"
}
|
| 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
}
|