| 200 |
|
|
application/json
model |
example
{
"title": "order log",
"$schema": "http://json-schema.org/draft-04/schema#",
"javaType": "com.sos.joc.model.order.OrderLog",
"type": "array",
"required": [
"complete",
"eventId",
"logEvents"
],
"properties": {
"complete": {
"type": "boolean",
"default": false
},
"eventId": {
"type": "number",
"format": "utc-millisec",
"minimum": 0
},
"historyId": {
"type": "number",
"format": "utc-millisec",
"minimum": 0
},
"logEvents": {
"type": "array",
"items": {
"javaType": "com.sos.joc.model.history.order.OrderLogEntry",
"type": "object",
"required": [
"controllerDatetime",
"orderId",
"logLevel",
"logEvent",
"position"
],
"properties": {
"controllerDatetime": {
"type": "string"
},
"agentDatetime": {
"type": "string"
},
"orderId": {
"type": "string"
},
"logLevel": {
"type": "string"
},
"logEvent": {
"javaType": "com.sos.controller.model.event.EventType",
"type": "string",
"enum": [
"VersionAdded",
"FileBasedChanged",
"ControllerReady",
"AgentReady",
"OrderAdded",
"OrderAttachable",
"OrderStarted",
"OrderTransferredToAgent",
"OrderProcessingStarted",
"OrderStdoutWritten",
"OrderStderrWritten",
"OrderProcessed",
"OrderResumed",
"OrderResumeMarked",
"OrderForked",
"OrderJoined",
"OrderOffered",
"OrderRetrying",
"OrderAwaiting",
"OrderMoved",
"OrderDetachable",
"OrderDetached",
"OrderFailed",
"OrderCatched",
"OrderAwoke",
"OrderFailedinFork",
"OrderSuspended",
"OrderSuspendMarked",
"OrderBroken",
"OrderCancelled",
"OrderFinished",
"OrderLockAcquired",
"OrderLockQueued",
"OrderLockReleased"
],
"javaEnumNames": [
"VersionAdded",
"FileBasedChanged",
"ControllerReady",
"AgentReady",
"OrderAdded",
"OrderAttachable",
"OrderStarted",
"OrderTransferredToAgent",
"OrderProcessingStarted",
"OrderStdoutWritten",
"OrderStderrWritten",
"OrderProcessed",
"OrderResumed",
"OrderResumeMarked",
"OrderForked",
"OrderJoined",
"OrderOffered",
"OrderRetrying",
"OrderAwaiting",
"OrderMoved",
"OrderDetachable",
"OrderDetached",
"OrderFailed",
"OrderCatched",
"OrderAwoke",
"OrderFailedinFork",
"OrderSuspended",
"OrderSuspendMarked",
"OrderBroken",
"OrderCancelled",
"OrderFinished",
"OrderLockAcquired",
"OrderLockQueued",
"OrderLockReleased"
]
},
"position": {
"type": "string"
},
"agentId": {
"alias": "agentPath",
"type": "string"
},
"agentName": {
"type": "string"
},
"agentUrl": {
"type": "string"
},
"subagentClusterId": {
"type": "string"
},
"job": {
"type": "string"
},
"taskId": {
"type": "number",
"format": "utc-millisec",
"minimum": 0
},
"returnCode": {
"type": "number",
"format": "utc-millisec"
},
"error": {
"type": "object",
"javaType": "com.sos.joc.model.history.order.OrderLogEntryError",
"properties": {
"errorState": {
"type": "string"
},
"errorReason": {
"type": "string"
},
"errorCode": {
"type": "string"
},
"errorText": {
"type": "string"
}
},
"additionalProperties": false
},
"lock": {
"type": "object",
"javaType": "com.sos.joc.model.history.order.Lock",
"required": [
"lockName",
"limit"
],
"properties": {
"lockName": {
"alias": "lockId,lockPath",
"type": "string"
},
"limit": {
"type": "integer",
"minimum": 0,
"default": 1
},
"count": {
"type": "integer"
},
"lockState": {
"type": "object",
"javaType": "com.sos.joc.model.history.order.LockState",
"properties": {
"orderIds": {
"type": "string"
},
"queuedOrderIds": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": 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 'running' |
|
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 |
'running' 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": "running failed!" } }
{
"deliveryDate": "2016-05-05T21:13:35Z",
"surveyDate": "2016-05-05T21:13:33Z",
"error": {
"code": "JOC-420",
"message": "running failed!"
}
}
|
| 433 |
4-eyes principle: Forbidden!
The user needs approval process for 'running' |
|
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
}
|