JOC API

/agents/inventory/cluster

POST

Gets persistent Cluster Agent information

Parameters in the POST body schema

Name	Type	Description	Example	Default
`controllerId`	optional, string	Controller ID	myController
`agentIds`	optional, array[string]	Filters the response for specified Agent IDs

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": "read agents",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.agent.ReadAgents",
    "type": "object",
    "properties": {
        "controllerId": {
            "type": "string",
            "pattern": "^[^/\\<>?:\"|*]*$",
            "maxLength": 100
        },
        "agentIds": {
            "type": "array",
            "items": {
                "type": "string",
                "pattern": "^[^<>]*$",
                "maxLength": 255,
                "minLength": 1
            }
        },
        "onlyVisibleAgents": {
            "type": "boolean",
            "default": false
        }
    },
    "additionalProperties": false
}

{ "controllerId": "controller" }

{
    "controllerId": "controller"
}

Responses

Code	Description	Body
200	Contains collection of Cluster Agents where each Agent following fields controllerId agentId agentName agentNameAliases processLimit (optional) subagents where each Subagent has following fields subagentId url title (optional) syncState disabled isDirector (NO_DIRECTOR, PRIMARY_DIRECTOR, SECONDARY_DIRECTOR)	application/json model \| example { "title": "cluster agents", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.agent.ClusterAgents", "type": "object", "required": [ "deliveryDate" ], "properties": { "deliveryDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "agents": { "type": "array", "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 }, "title": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "processLimit": { "type": "integer", "minimum": 0 }, "hidden": { "type": "boolean", "default": false }, "disabled": { "type": "boolean", "default": false }, "syncState": { "javaType": "com.sos.controller.model.common.SyncState", "type": "object", "required": [ "severity", "_text" ], "properties": { "severity": { "type": "integer" }, "_text": { "javaType": "com.sos.controller.model.common.SyncStateText", "description": "SUSPENDED, OUTSTANDING only for Workflows", "type": "string", "enum": [ "IN_SYNC", "NOT_IN_SYNC", "NOT_DEPLOYED", "SUSPENDED", "OUTSTANDING", "UNKNOWN" ] } } }, "deployed": { "type": "boolean", "default": false }, "ordering": { "type": "integer", "minimum": 1 }, "version": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 } }, "additionalProperties": false }, "required": [ "agentId", "agentName", "subagents" ], "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" ], "default": "NO_DIRECTOR" }, "title": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "syncState": { "javaType": "com.sos.controller.model.common.SyncState", "type": "object", "required": [ "severity", "_text" ], "properties": { "severity": { "type": "integer" }, "_text": { "javaType": "com.sos.controller.model.common.SyncStateText", "description": "SUSPENDED, OUTSTANDING only for Workflows", "type": "string", "enum": [ "IN_SYNC", "NOT_IN_SYNC", "NOT_DEPLOYED", "SUSPENDED", "OUTSTANDING", "UNKNOWN" ] } } }, "disabled": { "type": "boolean", "default": false }, "deployed": { "type": "boolean", "default": false }, "withGenerateSubagentCluster": { "type": "boolean", "default": false }, "ordering": { "alias": "position", "type": "integer", "minimum": 1 }, "version": { "type": "string", "pattern": "^[^<>]*$", "maxLength": 255 } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false }
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 'cluster'	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	'cluster' 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": "cluster failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "cluster 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 }