JOC API

/agents/cluster/store

POST

Stores Cluster Agents persistently

Parameters in the POST body schema

Name	Type	Description	Example	Default
`controllerId`	required, string	Controller ID	myController
`clusterAgents`	required, array[object]	Collection of Agents each Cluster Agent has the following fields
`agentId`	required, integer	The `agentId` is the (technical) name that is used in the Controller to identify an Agent. This value is set once and cannot be overwritten
`agentName`	required, string	The `agentName` is the (logical) name that is used for the configuration of a Job to identify an Agent
`agentNameAliases`	optional, array[string]	Aliases of the `agentName`
`disabled`	optional, boolean	A disabled Agent will not be offered in JOC Cockpit during the Job configuration		false
`subagents`	required, array[object]	Collection of Subagents each Subagent has the following fields where one of them has to be a primary director and another optionally a standby director
`subagentId`	required, string	The `subagentId` is the name that is used in the Controller to identify a Subagent. This value is set once and cannot be overwritten
`url`	required, string	URL of the Subagent
`isDirector`	required, string	Possible values are NO_DIRECTOR PRIMARY_DIRECTOR SECONDARY_DIRECTOR
`position`	required, integer	It indicates the ordering in a passive cluster. The higher the position the lower the priority
`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.	5
`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": "store cluster agents",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.agent.StoreClusterAgents",
    "type": "object",
    "required": [
        "controllerId",
        "clusterAgents"
    ],
    "properties": {
        "controllerId": {
            "type": "string",
            "pattern": "^[^/\\<>?:\"|*]*$",
            "maxLength": 100,
            "minLength": 1
        },
        "clusterAgents": {
            "type": "array",
            "minItems": 1,
            "items": {
                "javaType": "com.sos.joc.model.agent.ClusterAgent",
                "type": "object",
                "extends": {
                    "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
                        }
                    },
                    "additionalProperties": false
                },
                "required": [
                    "agentId",
                    "agentName"
                ],
                "properties": {
                    "subagents": {
                        "type": "array",
                        "items": {
                            "javaType": "com.sos.joc.model.agent.SubAgent",
                            "type": "object",
                            "required": [
                                "subagentId",
                                "url",
                                "isDirector"
                            ],
                            "properties": {
                                "agentId": {
                                    "type": "string",
                                    "pattern": "^[^<>]*$",
                                    "maxLength": 255,
                                    "minLength": 1
                                },
                                "subagentId": {
                                    "type": "string",
                                    "pattern": "^[^<>]*$",
                                    "maxLength": 255,
                                    "minLength": 1
                                },
                                "url": {
                                    "type": "string",
                                    "pattern": "^[^<>]*$",
                                    "maxLength": 255,
                                    "minLength": 1
                                },
                                "isDirector": {
                                    "javaType": "com.sos.joc.model.agent.SubagentDirectorType",
                                    "type": "string",
                                    "enum": [
                                        "NO_DIRECTOR",
                                        "PRIMARY_DIRECTOR",
                                        "SECONDARY_DIRECTOR"
                                    ]
                                },
                                "isClusterWatcher": {
                                    "type": "boolean",
                                    "default": false
                                },
                                "position": {
                                    "type": "integer",
                                    "minimum": 1
                                }
                            },
                            "additionalProperties": 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
                }
            }
        }
    },
    "additionalProperties": false
}

Responses

Code	Description	Body
200	Confirm store 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 'store'	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	'store' 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": "store failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "store 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 }