| 200 |
Contains collection of Solo Agents where each Agent has following fields
- controllerId
- agentId
- agentName
- agentNameAliases
- url
- title (optional)
- syncState
- isClusterWatcher
|
|
application/json
model |
example
{
"title": "single agents",
"$schema": "http://json-schema.org/draft-04/schema#",
"javaType": "com.sos.joc.model.agent.Agents",
"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.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
},
"title": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 255
},
"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",
"type": "string",
"enum": [
"IN_SYNC",
"NOT_IN_SYNC",
"NOT_DEPLOYED",
"UNKNOWN"
]
}
}
},
"deployed": {
"type": "boolean",
"default": false
},
"ordering": {
"type": "integer",
"minimum": 1
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
{ "agents": [{ "agentId": "agent_primary", "agentName": "agent-primary", "disabled": false, "isClusterWatcher": true, "url": "https://agent-2-0-primary:4443" }, { "agentId": "agent_secondary", "agentName": "agent-secondary", "disabled": false, "isClusterWatcher": false, "url": "https://agent-2-0-secondary:4443" }], "controllerId": "testsuite", "deliveryDate": "2020-11-19T15:17:19.346Z" }
{
"agents": [{
"agentId": "agent_primary",
"agentName": "agent-primary",
"disabled": false,
"isClusterWatcher": true,
"url": "https://agent-2-0-primary:4443"
}, {
"agentId": "agent_secondary",
"agentName": "agent-secondary",
"disabled": false,
"isClusterWatcher": false,
"url": "https://agent-2-0-secondary:4443"
}],
"controllerId": "testsuite",
"deliveryDate": "2020-11-19T15:17:19.346Z"
}
|
| 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 'inventory' |
|
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 |
'inventory' 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": "inventory failed!" } }
{
"deliveryDate": "2016-05-05T21:13:35Z",
"surveyDate": "2016-05-05T21:13:33Z",
"error": {
"code": "JOC-420",
"message": "inventory 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
}
|