JOC API

/controller/test

POST

Tests Controller instance connection and Controller ID

Parameters in the POST body schema

Name	Type	Description	Example	Default
`controllerId`	optional, string	Controller ID is used to check if the Controller is registered for the given Controller ID.	scheduler
`url`	required, string	URL of the Controller instance Connection test is performed.

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": "url params",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.controller.TestConnect",
    "type": "object",
    "required": [
        "url"
    ],
    "properties": {
        "controllerId": {
            "type": "string",
            "pattern": "^[^/\\<>?:\"|*]*$",
            "maxLength": 100
        },
        "url": {
            "type": "string",
            "pattern": "^[^<>]*$",
            "maxLength": 255,
            "minLength": 1
        }
    }
}

{ "controllerId": "scheduler", "url": "http://jobSchedulerHost:40444" }

{
    "controllerId": "scheduler",
    "url": "http://jobSchedulerHost:40444"
}

Responses

Code	Description	Body
200	controller id url connectionState - such as established unreachable	application/json model \| example { "title": "jobscheduler with delivery date", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.controller.JobScheduler200", "type": "object", "required": [ "deliveryDate", "controller" ], "properties": { "deliveryDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "controller": { "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" ] } } } } } } } { "deliveryDate": "2020-04-02T12:03:09.998Z", "connectionState": { "_text": "established", "severity": 0 }, "controllerId": "controller.2.0", "url": "http://someHost:40444" } { "deliveryDate": "2020-04-02T12:03:09.998Z", "connectionState": { "_text": "established", "severity": 0 }, "controllerId": "controller.2.0", "url": "http://someHost:40444" }
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 'test'	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	'test' 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": "test failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "test 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 }