JOC API

/joc/versions

POST

Reads the versions of the specified JS7 components.

Parameters in the POST body schema

Name	Type	Description	Example	Default
`controllerIds`	optional, array	Filter collection of JS7 Controllers, specified by their controllerId.	"controllerIds" : [ "testsuite", "standalone" ]
`agentIds`	optional, array	Filter collection of JS7 agents, specified by their agentId.	"agentIds" : [ "agent_cluster_001", "standaloneAgentID" ]

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": "Filter to get versions of controllers, agents and JOC Cockpit",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.joc.VersionsFilter",
    "type": "object",
    "properties": {
        "controllerIds": {
            "type": "array",
            "items": {
                "type": "string",
                "pattern": "^[^<>]*$",
                "maxLength": 255
            }
        },
        "agentIds": {
            "type": "array",
            "items": {
                "type": "string",
                "pattern": "^[^<>]*$",
                "maxLength": 255
            }
        }
    }
}

{ "controllerIds": ["controller", "standalone", "testsuite"], "agentIds": ["primaryAgentID", "standaloneAgentID", "agent_cluster_001"] }

{
    "controllerIds": ["controller", "standalone", "testsuite"],
    "agentIds": ["primaryAgentID", "standaloneAgentID", "agent_cluster_001"]
}

Responses

Code	Description	Body
200		application/json model \| example { "title": "version response with agent and controller versions", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.joc.VersionResponse", "type": "object", "required": [ "version" ], "properties": { "controllerVersions": { "type": "array", "items": { "javaType": "com.sos.joc.model.joc.ControllerVersion", "type": "object", "required": [ "controllerId", "uri", "version" ], "properties": { "controllerId": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "uri": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "version": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "compatibility": { "javaType": "com.sos.joc.model.joc.CompatibilityLevel", "type": "string", "enum": [ "COMPATIBLE", "PARTIALLY_COMPATIBLE", "NOT_COMPATIBLE" ], "javaEnumNames": [ "COMPATIBLE", "PARTIALLY_COMPATIBLE", "NOT_COMPATIBLE" ] } } } }, "agentVersions": { "type": "array", "items": { "javaType": "com.sos.joc.model.joc.AgentVersion", "type": "object", "required": [ "agentId", "uri", "version" ], "properties": { "agentId": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "subagentId": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "uri": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "version": { "type": "string", "pattern": "^[^<>]*$", "maxLength": 255 }, "compatibility": { "javaType": "com.sos.joc.model.joc.CompatibilityLevel", "type": "string", "enum": [ "COMPATIBLE", "PARTIALLY_COMPATIBLE", "NOT_COMPATIBLE" ], "javaEnumNames": [ "COMPATIBLE", "PARTIALLY_COMPATIBLE", "NOT_COMPATIBLE" ] } } } }, "jocVersion": { "type": "string" } } } { "agentVersions": [{ "agentId": "primaryAgentID", "uri": "https://sp:22222" }, { "agentId": "standaloneAgentID", "compatibility": "COMPATIBLE", "uri": "http://localhost:3333", "version": "2.4.1-beta.20220816" }, { "agentId": "agent_cluster_001", "uri": "https://diragent-2-0-primary:4443" }, { "agentId": "agent_cluster_001", "subagentId": "director_primary_001", "uri": "https://diragent-2-0-primary:4443" }, { "agentId": "agent_cluster_001", "subagentId": "subagent_primary_001", "uri": "https://subagent-2-0-primary:4443" }, { "agentId": "agent_cluster_001", "subagentId": "subagent_third_001", "uri": "https://subagent-2-0-third:4443" }, { "agentId": "agent_cluster_001", "subagentId": "subagent_secondary_001", "uri": "https://subagent-2-0-secondary:4443" }], "controllerVersions": [{ "compatibility": "NOT_COMPATIBLE", "controllerId": "controller", "uri": "https://sp.sos:11111", "version": "2.3.0" }, { "compatibility": "NOT_COMPATIBLE", "controllerId": "controller", "uri": "https://sp.sos:11112", "version": "2.3.0" }, { "compatibility": "COMPATIBLE", "controllerId": "standalone", "uri": "http://localhost:1113", "version": "2.4.1-beta.20220816" }], "jocVersion": "2.4.1-SNAPSHOT" } { "agentVersions": [{ "agentId": "primaryAgentID", "uri": "https://sp:22222" }, { "agentId": "standaloneAgentID", "compatibility": "COMPATIBLE", "uri": "http://localhost:3333", "version": "2.4.1-beta.20220816" }, { "agentId": "agent_cluster_001", "uri": "https://diragent-2-0-primary:4443" }, { "agentId": "agent_cluster_001", "subagentId": "director_primary_001", "uri": "https://diragent-2-0-primary:4443" }, { "agentId": "agent_cluster_001", "subagentId": "subagent_primary_001", "uri": "https://subagent-2-0-primary:4443" }, { "agentId": "agent_cluster_001", "subagentId": "subagent_third_001", "uri": "https://subagent-2-0-third:4443" }, { "agentId": "agent_cluster_001", "subagentId": "subagent_secondary_001", "uri": "https://subagent-2-0-secondary:4443" }], "controllerVersions": [{ "compatibility": "NOT_COMPATIBLE", "controllerId": "controller", "uri": "https://sp.sos:11111", "version": "2.3.0" }, { "compatibility": "NOT_COMPATIBLE", "controllerId": "controller", "uri": "https://sp.sos:11112", "version": "2.3.0" }, { "compatibility": "COMPATIBLE", "controllerId": "standalone", "uri": "http://localhost:1113", "version": "2.4.1-beta.20220816" }], "jocVersion": "2.4.1-SNAPSHOT" }
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 'versions'	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	'versions' 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": "versions failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "versions 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 }