JOC API

/controllers/p

POST

Gets persistent Controller information

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	Contains collection of Controllers and Agents where each Controller has fields such as controllerId securityLevel clusterUrl (if not STANDALONE) role (STANDALONE, PRIMARY or BACKUP) host version javaVersion operating system name architecture and each Agent has fields such as controllerId agentId agentName agentNameAliases url	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" ] } } } } { "agents": [{ "agentId": "agent_primary", "agentName": "agent-primary", "disabled": false, "isClusterWatcher": true, "url": "https://agent-2-0-primary:4443" }, { "agentId": "agent_secondary", "agentName": "agent-secondary", "disabled": false, "isClusterWatcher": false, "url": "https://agent-2-0-secondary:4443" }], "controllers": [{ "clusterUrl": "https://controller-2-0-primary:4443", "controllerId": "testsuite", "host": "controller-2-0-primary", "id": 1, "isCoupled": false, "os": { "architecture": "amd64", "distribution": "3.10.0-957.1.3.el7.x86_64", "name": "Linux" }, "role": "PRIMARY", "securityLevel": "LOW", "startedAt": "2020-11-20T15:09:41Z", "surveyDate": "2020-11-22T22:15:04Z", "title": "PRIMARY", "url": "https://controller-2-0-primary:4443", "version": "2.0.0-SNAPSHOT" }, { "clusterUrl": "https://controller-2-0-backup:4443", "controllerId": "testsuite", "host": "controller-2-0-backup", "id": 2, "isCoupled": false, "os": { "architecture": "amd64", "distribution": "3.10.0-957.1.3.el7.x86_64", "name": "Linux" }, "role": "BACKUP", "securityLevel": "LOW", "startedAt": "2020-11-20T15:09:41Z", "surveyDate": "2020-11-22T15:03:03Z", "title": "BACKUP", "url": "https://controller-2-0-backup:4443", "version": "2.0.0-SNAPSHOT" }], "deliveryDate": "2020-11-22T22:15:07.038Z" } { "agents": [{ "agentId": "agent_primary", "agentName": "agent-primary", "disabled": false, "isClusterWatcher": true, "url": "https://agent-2-0-primary:4443" }, { "agentId": "agent_secondary", "agentName": "agent-secondary", "disabled": false, "isClusterWatcher": false, "url": "https://agent-2-0-secondary:4443" }], "controllers": [{ "clusterUrl": "https://controller-2-0-primary:4443", "controllerId": "testsuite", "host": "controller-2-0-primary", "id": 1, "isCoupled": false, "os": { "architecture": "amd64", "distribution": "3.10.0-957.1.3.el7.x86_64", "name": "Linux" }, "role": "PRIMARY", "securityLevel": "LOW", "startedAt": "2020-11-20T15:09:41Z", "surveyDate": "2020-11-22T22:15:04Z", "title": "PRIMARY", "url": "https://controller-2-0-primary:4443", "version": "2.0.0-SNAPSHOT" }, { "clusterUrl": "https://controller-2-0-backup:4443", "controllerId": "testsuite", "host": "controller-2-0-backup", "id": 2, "isCoupled": false, "os": { "architecture": "amd64", "distribution": "3.10.0-957.1.3.el7.x86_64", "name": "Linux" }, "role": "BACKUP", "securityLevel": "LOW", "startedAt": "2020-11-20T15:09:41Z", "surveyDate": "2020-11-22T15:03:03Z", "title": "BACKUP", "url": "https://controller-2-0-backup:4443", "version": "2.0.0-SNAPSHOT" }], "deliveryDate": "2020-11-22T22:15:07.038Z" }
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 'p'	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	'p' 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": "p failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "p 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 }