JOC API

/controller/register

POST

Registers a Controller

A Controllers consists of a standalone instance or cluster with primary and secondary nodes.

This resource adds a Controller to JOC Cockpit. Updates Controller instance information such as the URL.

Parameters in the POST body schema

Name	Type	Description	Example	Default
`controllerId`	optional, string	Controller ID (can be empty if and only if a new Controller (Cluster) will be registered)	scheduler
`controllers`	required, array	Controllers of a cluster or one standalone Controller each Controller has the following fields
`url`	required, string	URL of the Controller instance
`clusterUrl`	optional, string	Only for a Cluster: A URL that the Controller instances use to connect to each other		`url`
`role`	required, string	Role (STANDALONE, PRIMARY or BACKUP) of the Controller
`title`	optional, string	A title that is used when displaying the Controller in JOC Cockpit
`clusterWatcher`	optional, object	Agent as Cluster Watcher with the following fields. It is required for a Controller Cluster otherwise it will be ignored.
`agentId`	required, string	The `agentId` is the (technical) name that is used by the Controller to identify an Agent. This value is set once and cannot be changed
`agentName`	required, string	The `agentName` is the (logical) name that is used with the configuration of a Job to reference an Agent
`url`	required, string	URL of the Agent
`asStandaloneAgent`	optional, boolean	A new Cluster Watch Agent will be registered per default as a Cluster Agent. ATTENTION! If the Cluster Watch Agent is already registered then this parameter will be ignored.		false
`primaryDirectorId`	optional, string	If the Cluster Watch Agent is a Cluster Agent then this parameter specifies the ID of its primary director		`agentId`
`auditLog`	optional, object	Object that contains `comment`, `timeSpent` and `ticketLink`.	{ "comment": "Operational requirement!", "timeSpent": 2 }
`comment`	optional, string	Field in `auditLog` to comment this action, e.g. the reason.
`timeSpent`	optional, integer	Field in `auditLog` to enter the time spent in minutes.
`ticketLink`	optional, string	Field in `auditLog` to enter a link to a corresponding ticket.

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": "register params",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.controller.RegisterParameters",
    "type": "object",
    "required": [
        "controllers"
    ],
    "properties": {
        "controllerId": {
            "type": "string",
            "pattern": "^[^/\\<>?:\"|*]*$",
            "maxLength": 100
        },
        "controllers": {
            "type": "array",
            "minItems": 1,
            "maxItems": 2,
            "items": {
                "type": "object",
                "javaType": "com.sos.joc.model.controller.RegisterParameter",
                "required": [
                    "url",
                    "role"
                ],
                "properties": {
                    "id": {
                        "type": "number",
                        "format": "utc-millisec",
                        "minimum": 0
                    },
                    "title": {
                        "type": "string"
                    },
                    "url": {
                        "description": "URI of a Controller",
                        "type": "string",
                        "format": "uri"
                    },
                    "clusterUrl": {
                        "description": "URI of a Controller",
                        "type": "string",
                        "format": "uri"
                    },
                    "role": {
                        "javaType": "com.sos.joc.model.controller.Role",
                        "type": "string",
                        "enum": [
                            "STANDALONE",
                            "PRIMARY",
                            "BACKUP"
                        ]
                    }
                }
            }
        },
        "clusterWatcher": {
            "javaType": "com.sos.joc.model.agent.RegisterClusterWatchAgent",
            "type": "object",
            "required": [
                "agentId",
                "agentName",
                "url"
            ],
            "properties": {
                "agentId": {
                    "type": "string",
                    "pattern": "^[^<>]*$",
                    "maxLength": 255,
                    "minLength": 1
                },
                "agentName": {
                    "type": "string",
                    "pattern": "^[^<>]*$",
                    "maxLength": 255,
                    "minLength": 1
                },
                "url": {
                    "type": "string",
                    "pattern": "^[^<>]*$",
                    "maxLength": 255,
                    "minLength": 1
                },
                "asStandaloneAgent": {
                    "type": "boolean",
                    "default": false
                }
            },
            "additionalProperties": false
        },
        "auditLog": {
            "javaType": "com.sos.joc.model.audit.AuditParams",
            "type": "object",
            "properties": {
                "comment": {
                    "type": "string",
                    "pattern": "^[^<>]*$",
                    "maxLength": 255
                },
                "timeSpent": {
                    "type": "integer",
                    "minimum": 0
                },
                "ticketLink": {
                    "type": "string",
                    "pattern": "^[^<>]*$",
                    "maxLength": 255
                }
            }
        }
    }
}

{ "controllers": [{ "url": "https://controller-2-0-primary:4443", "title": "PRIMARY", "role": "PRIMARY", "clusterUrl": "https://controller-2-0-primary:4443" }, { "url": "https://controller-2-0-secondary:4443", "role": "BACKUP", "clusterUrl": "https://controller-2-0-secondary:4443", "title": "SECONDARY" }], "controllerId": "testsuite", "clusterWatcher": { "agentId": "agent_primary", "agentName": "agent-primary", "url": "https://agent-2-0-primary:4443" } }

{
    "controllers": [{
        "url": "https://controller-2-0-primary:4443",
        "title": "PRIMARY",
        "role": "PRIMARY",
        "clusterUrl": "https://controller-2-0-primary:4443"
    }, {
        "url": "https://controller-2-0-secondary:4443",
        "role": "BACKUP",
        "clusterUrl": "https://controller-2-0-secondary:4443",
        "title": "SECONDARY"
    }],
    "controllerId": "testsuite",
    "clusterWatcher": {
        "agentId": "agent_primary",
        "agentName": "agent-primary",
        "url": "https://agent-2-0-primary:4443"
    }
}

Responses

Code	Description	Body
200	Confirm register successfully	application/json model \| example { "title": "ok answer", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.common.Ok", "type": "object", "required": [ "deliveryDate", "ok" ], "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" }, "ok": { "type": "boolean" } } } { "deliveryDate": "2016-05-05T21:13:35Z", "ok": true } { "deliveryDate": "2016-05-05T21:13:35Z", "ok": true }
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 'register'	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	'register' 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": "register failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "register 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 }

Registers a Controller

A Controllers consists of a standalone instance or cluster with primary and secondary nodes. This resource adds a Controller to JOC Cockpit. Updates Controller instance information such as the URL.

Parameters in the POST body schema

A Controllers consists of a standalone instance or cluster with primary and secondary nodes.

This resource adds a Controller to JOC Cockpit. Updates Controller instance information such as the URL.