JOC API

/controllers

POST

Gets Controllers

Parameters in the POST body schema

Name	Type	Description	Example	Default
`controllerId`	optional, string	Controller ID	myController

Request

Name

Description

Example

Type

Constraints

Default

Headers

X-Access-Token*

Request requires authentication!

550e8400-e29b-11d4-a716-446655440000

string

Body

application/json

model | example

{
    "title": "Controller id",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.controller.ControllerId",
    "type": "object",
    "properties": {
        "controllerId": {
            "type": "string",
            "pattern": "^[^/\\<>?:\"|*]*$",
            "maxLength": 100
        }
    }
}

{ "controllerId": "scheduler" }

{
    "controllerId": "scheduler"
}

Responses

Code	Description	Body
200	controller id host url clusterUrl (if not STANDALONE) role (STANDALONE, PRIMARY or BACKUP) version operating system name architecture connectionState - such as established unstable unreachable componentStatus - such as operational limited inoperable unknown clusterNodeState (if not STANDALONE) - such as active inactive unknown	application/json model \| example { "title": "Controllers", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.controller.Controllers", "type": "object", "required": [ "deliveryDate", "controllers" ], "properties": { "deliveryDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "controllers": { "type": "array", "items": { "javaType": "com.sos.joc.model.controller.Controller", "type": "object", "required": [ "id", "controllerId", "title", "url", "role", "isCoupled" ], "properties": { "id": { "type": "number", "format": "utc-millisec", "minimum": 0 }, "surveyDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "controllerId": { "type": "string", "pattern": "^[^/\\<>?:\"\|]$", "maxLength": 100 }, "title": { "type": "string" }, "host": { "type": "string" }, "url": { "type": "string" }, "clusterUrl": { "type": "string" }, "role": { "javaType": "com.sos.joc.model.controller.Role", "type": "string", "enum": [ "STANDALONE", "PRIMARY", "BACKUP" ] }, "isCoupled": { "type": "boolean", "default": false }, "startedAt": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "version": { "type": "string" }, "os": { "javaType": "com.sos.joc.model.controller.OperatingSystem", "type": "object", "required": [ "name", "architecture", "distribution" ], "properties": { "name": { "description": "Windows, Linux, AIX, Solaris, other", "type": "string" }, "architecture": { "type": "string" }, "distribution": { "description": "e.g. Windows 2012, CentOS Linux release 7.2.1511 (Core)", "type": "string" } } }, "securityLevel": { "javaType": "com.sos.joc.model.common.JocSecurityLevel", "type": "string", "enum": [ "LOW", "MEDIUM", "HIGH" ] }, "componentState": { "javaType": "com.sos.joc.model.controller.ComponentState", "type": "object", "required": [ "severity", "_text" ], "properties": { "severity": { "description": "0=operational, 1=limited, 2=inoperable, 3=unknown", "type": "integer" }, "_text": { "javaType": "com.sos.joc.model.controller.ComponentStateText", "type": "string", "enum": [ "operational", "limited", "inoperable", "unknown" ], "javaEnumNames": [ "operational", "limited", "inoperable", "unknown" ] } } }, "connectionState": { "javaType": "com.sos.joc.model.controller.ConnectionState", "type": "object", "required": [ "severity", "_text" ], "properties": { "severity": { "description": "0=established, 1=unstable, 2=unreachable, 3=unknown", "type": "integer" }, "_text": { "javaType": "com.sos.joc.model.controller.ConnectionStateText", "type": "string", "enum": [ "established", "unstable", "unreachable", "unknown" ], "javaEnumNames": [ "established", "unstable", "unreachable", "unknown" ] } } }, "clusterNodeState": { "javaType": "com.sos.joc.model.controller.ClusterNodeState", "type": "object", "required": [ "severity", "_text" ], "properties": { "severity": { "description": "0=active, 1=inactive, 3=unknown", "type": "integer" }, "_text": { "javaType": "com.sos.joc.model.controller.ClusterNodeStateText", "type": "string", "enum": [ "active", "inactive", "unknown" ], "javaEnumNames": [ "active", "inactive", "unknown" ] } } } } } }, "agents": { "type": "array", "items": { "javaType": "com.sos.joc.model.agent.Agent", "type": "object", "required": [ "agentId", "agentName", "url" ], "properties": { "controllerId": { "type": "string", "pattern": "^[^/\\<>?:\"\|]$", "maxLength": 100 }, "agentId": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "agentName": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "agentNameAliases": { "type": "array", "uniqueItems": true, "items": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 } }, "url": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "isClusterWatcher": { "type": "boolean", "default": false }, "disabled": { "type": "boolean", "default": false } } } }, "clusterAgents": { "type": "array", "items": { "javaType": "com.sos.joc.model.agent.Agent", "type": "object", "required": [ "agentId", "agentName", "url" ], "properties": { "controllerId": { "type": "string", "pattern": "^[^/\\<>?:\"\|]$", "maxLength": 100 }, "agentId": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "agentName": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "agentNameAliases": { "type": "array", "uniqueItems": true, "items": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 } }, "url": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "isClusterWatcher": { "type": "boolean", "default": false }, "disabled": { "type": "boolean", "default": false } } } }, "currentSecurityLevel": { "type": { "javaType": "com.sos.joc.model.common.JocSecurityLevel", "type": "string", "enum": [ "LOW", "MEDIUM", "HIGH" ] } } } }
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 'controllers'	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	'controllers' 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": "controllers failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "controllers failed!" } }
433	4-eyes principle: Forbidden! The user needs approval process for 'controllers'	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 }