JOC API

/jocs

POST

Gets JOC Cockpit instances

Parameters in the POST body schema

Name	Type	Description	Example	Default
`onlyApiServer`	optional, boolean	request only JOC Cockpit instances that are installed as API server.		false
`onlyNonApiServer`	optional, boolean	request only JOC Cockpit instances that are installed completely (with GUI).		false

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": "joc cockpit request filter",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.joc.CockpitFilter",
    "type": "object",
    "properties": {
        "onlyApiServer": {
            "type": "boolean",
            "default": false
        },
        "onlyNonApiServer": {
            "type": "boolean",
            "default": false
        }
    },
    "additionalProperties": false
}

TODO

TODO

Responses

Code	Description	Body
200		application/json model \| example { "title": "components", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.joc.Cockpits", "type": "object", "required": [ "deliveryDate", "jocs" ], "properties": { "deliveryDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "jocs": { "type": "array", "items": { "type": "object", "javaType": "com.sos.joc.model.joc.Cockpit", "required": [ "id", "instanceId", "memberId", "version", "current", "connectionState", "componentState", "clusterNodeState", "controllerConnectionStates" ], "properties": { "id": { "type": "number", "format": "utc-millisec", "minimum": 0 }, "instanceId": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "memberId": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "title": { "type": "string" }, "current": { "description": "true if joc is that joc which sends this response", "type": "boolean" }, "host": { "type": "string" }, "url": { "type": "string" }, "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" }, "isApiServer": { "type": "boolean", "default": false }, "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" ] } } }, "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" ] } } }, "clusterNodeState": { "javaType": "com.sos.joc.model.controller.ClusterNodeState", "type": "object", "required": [ "severity", "_text" ], "description": "not relevant for JOC as API server only", "properties": { "severity": { "description": "0=active, 1=inactive, 1=API-server, 3=unknown", "type": "integer" }, "_text": { "javaType": "com.sos.joc.model.controller.ClusterNodeStateText", "type": "string", "enum": [ "active", "inactive", "api-server", "unknown" ], "javaEnumNames": [ "active", "inactive", "api-server", "unknown" ] } } }, "controllerConnectionStates": { "description": "not relevant for JOC as API server only", "type": "array", "items": { "type": "object", "javaType": "com.sos.joc.model.joc.ControllerConnectionState", "required": [ "role", "state" ], "properties": { "role": { "javaType": "com.sos.joc.model.controller.Role", "type": "string", "enum": [ "STANDALONE", "PRIMARY", "BACKUP" ] }, "state": { "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" ] } } } }, "additionalProperties": false } }, "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" ] }, "lastHeartbeat": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" } }, "additionalProperties": false } } }, "additionalProperties": false } TODO TODO
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 'jocs'	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	'jocs' 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": "jocs failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "jocs 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 }