200 |
Contains collection of Agents where each Agent has fields such as
- controllerId
- agentId
- agentName
- url
- isClusterWatcher
- state (COUPLED, DECOUPLED, COUPLINGFAILED, SHUTDOWN, UNKNOWN)
- runningTasks
- orders (of running tasks if
compact == false)
- errorMessage (if COUPLINGFAILED or UNKNOWN)
|
|
application/json
model |
example
{
"title": "agents",
"$schema": "http://json-schema.org/draft-04/schema#",
"javaType": "com.sos.joc.model.agent.AgentsV",
"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"
},
"surveyDate": {
"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.AgentV",
"type": "object",
"required": [
"agentId",
"agentName"
],
"properties": {
"controllerId": {
"type": "string",
"pattern": "^[^/\\<>?:\"|*]*$",
"maxLength": 100
},
"agentId": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 255,
"minLength": 1
},
"agentName": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 255,
"minLength": 1
},
"url": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 255,
"minLength": 1
},
"state": {
"javaType": "com.sos.joc.model.agent.AgentState",
"type": "object",
"required": [
"severity",
"_text"
],
"properties": {
"severity": {
"description": "0=COUPLED, 1=RESETTING, 1=RESET, 2=COUPLINGFAILED, 3=UNKNOWN",
"type": "integer"
},
"_text": {
"javaType": "com.sos.joc.model.agent.AgentStateText",
"type": "string",
"enum": [
"COUPLED",
"RESETTING",
"RESET",
"COUPLINGFAILED",
"SHUTDOWN",
"UNKNOWN"
]
}
}
},
"errorMessage": {
"description": "if state == couplngFailed or unknown",
"type": "string"
},
"orders": {
"type": "array",
"items": {
"javaType": "com.sos.joc.model.order.OrderV",
"type": "object",
"required": [
"orderId",
"workflowId",
"state"
],
"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"
},
"orderId": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 255
},
"arguments": {
"description": "a map for arbitrary key-value pairs",
"javaType": "com.sos.inventory.model.common.Variables",
"type": "object",
"additionalProperties": true
},
"workflowId": {
"javaType": "com.sos.controller.model.workflow.WorkflowId",
"type": "object",
"required": [
"path"
],
"properties": {
"path": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 255
},
"versionId": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 255
}
},
"additionalProperties": false
},
"state": {
"javaType": "com.sos.joc.model.order.OrderState",
"type": "object",
"required": [
"severity",
"_text"
],
"properties": {
"severity": {
"type": "integer"
},
"_text": {
"javaType": "com.sos.joc.model.order.OrderStateText",
"type": "string",
"enum": [
"PLANNED",
"PENDING",
"SCHEDULED",
"RUNNING",
"INPROGRESS",
"PROMPTING",
"SUSPENDED",
"FAILED",
"WAITING",
"BLOCKED",
"CANCELLED",
"FINISHED",
"BROKEN",
"UNKNOWN"
]
},
"_reason": {
"javaType": "com.sos.joc.model.order.OrderWaitingReason",
"type": "string",
"enum": [
"DELAYED_AFTER_ERROR",
"FORKED",
"EXPECTING_NOTICE",
"WAITING_FOR_LOCK",
"BETWEEN_CYCLES"
]
}
}
},
"marked": {
"javaType": "com.sos.joc.model.order.OrderMark",
"type": "object",
"required": [
"severity",
"_text"
],
"properties": {
"severity": {
"type": "integer"
},
"_text": {
"javaType": "com.sos.joc.model.order.OrderMarkText",
"type": "string",
"enum": [
"CANCELLING",
"RESUMING",
"SUSPENDING"
]
}
}
},
"attachedState": {
"javaType": "com.sos.controller.model.order.OrderAttachedState",
"type": "object",
"properties": {
"TYPE": {
"description": "Attaching, Attached, ...",
"type": "string"
},
"agentName": {
"type": "string"
}
},
"additionalProperties": false
},
"agentId": {
"type": "string"
},
"subagentId": {
"type": "string"
},
"cycleState": {
"type": "object",
"javaType": "com.sos.controller.model.order.OrderCycleState",
"description": "set if state == BetweenCycles or processing inside a cycle",
"properties": {
"next": {
"description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty",
"type": "string",
"format": "date-time"
},
"since": {
"description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty",
"type": "string",
"format": "date-time"
},
"index": {
"type": "integer"
}
},
"additionalProperties": false
},
"position": {
"description": "Actually, each even item is a string, each odd item is an integer",
"type": "array",
"items": {
"anyOf": [{
"type": "integer"
}, {
"type": "string"
}]
}
},
"positionString": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 255
},
"positionIsImplicitEnd": {
"type": "boolean"
},
"scheduledFor": {
"type": "number",
"format": "utc-millisec",
"minimum": 0
},
"scheduledNever": {
"description": "deprecated -> is State.PENDING",
"type": "boolean",
"default": false
},
"question": {
"description": "only relevant for state PROMPTING",
"type": "string"
},
"lastOutcome": {
"javaType": "com.sos.controller.model.common.Outcome",
"type": "object",
"required": [
"TYPE"
],
"properties": {
"TYPE": {
"description": "Succeeded, Failed, Disrupted, Cancelled, Killed, TimedOut",
"type": "string"
},
"namedValues": {
"description": "a map for arbitrary key-value pairs",
"javaType": "com.sos.inventory.model.common.Variables",
"type": "object",
"additionalProperties": true
},
"outcome": {
"description": "outcome-schema.json"
}
},
"additionalProperties": false
},
"historicOutcome": {
"description": "only for compact parameter is false",
"type": "array",
"items": {
"type": "object",
"javaType": "com.sos.controller.model.workflow.HistoricOutcome",
"properties": {
"position": {
"description": "Actually, each even item is a string, each odd item is an integer",
"type": "array",
"items": {
"anyOf": [{
"type": "integer"
}, {
"type": "string"
}]
}
},
"outcome": {
"javaType": "com.sos.controller.model.common.Outcome",
"type": "object",
"required": [
"TYPE"
],
"properties": {
"TYPE": {
"description": "Succeeded, Failed, Disrupted, Cancelled, Killed, TimedOut",
"type": "string"
},
"namedValues": {
"description": "a map for arbitrary key-value pairs",
"javaType": "com.sos.inventory.model.common.Variables",
"type": "object",
"additionalProperties": true
},
"outcome": {
"description": "outcome-schema.json"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"requirements": {
"javaType": "com.sos.inventory.model.workflow.Requirements",
"type": "object",
"alias": "orderRequirements",
"properties": {
"parameters": {
"javaType": "com.sos.inventory.model.workflow.Parameters",
"type": "object",
"additionalProperties": {
"javaType": "com.sos.inventory.model.workflow.Parameter",
"type": "object",
"required": [
"type"
],
"description": "parameters only for parameter type 'List'",
"properties": {
"type": {
"javaType": "com.sos.inventory.model.workflow.ParameterType",
"type": "string",
"enum": [
"String",
"Number",
"Boolean",
"List"
],
"javaEnumNames": [
"String",
"Number",
"Boolean",
"List"
]
},
"default": {
"description": "this value has to have the data type of the 'type' attribute",
"anyOf": [{
"type": "string"
}, {
"type": "number"
}, {
"type": "boolean"
}, {
"type": "array"
}],
"javaType": "java.lang.Object"
},
"final": {
"type": "string"
},
"listParameters": {
"javaType": "com.sos.inventory.model.workflow.ListParameters",
"type": "object",
"additionalProperties": {
"javaType": "com.sos.inventory.model.workflow.ListParameter",
"type": "object",
"required": [
"type"
],
"description": "parameter type only Number, Boolean or String",
"properties": {
"type": {
"javaType": "com.sos.inventory.model.workflow.ListParameterType",
"type": "string",
"enum": [
"String",
"Number",
"Boolean"
],
"javaEnumNames": [
"String",
"Number",
"Boolean"
]
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"allowUndeclared": {
"type": "boolean",
"default": false
}
},
"additionalProperties": false
},
"cyclicOrder": {
"type": "object",
"javaType": "com.sos.joc.model.dailyplan.CyclicOrderInfos",
"properties": {
"count": {
"type": "integer",
"minimum": 0
},
"firstOrderId": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 255
},
"lastOrderId": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 255
},
"firstStart": {
"description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty",
"type": "string",
"format": "date-time"
},
"lastStart": {
"description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty",
"type": "string",
"format": "date-time"
}
}
}
},
"additionalProperties": false
}
},
"runningTasks": {
"type": "integer",
"minimum": 0
},
"isClusterWatcher": {
"type": "boolean",
"default": false
}
}
}
}
},
"additionalProperties": false
}
{ "agents": [{ "agentId": "agent_primary", "agentName": "agent-primary", "controllerId": "testsuite", "isClusterWatcher": true, "orders": [], "runningTasks": 0, "state": { "_text": "COUPLED", "severity": 0 }, "url": "https://agent-2-0-primary:4443" }, { "agentId": "agent_secondary", "agentName": "agent-secondary", "controllerId": "testsuite", "errorMessage": "Connection refused", "isClusterWatcher": false, "orders": [], "runningTasks": 0, "state": { "_text": "COUPLINGFAILED", "severity": 2 }, "url": "http://agent-2-0-secondary:4444" }], "deliveryDate": "2020-12-04T15:42:40.185Z", "surveyDate": "2020-12-04T15:24:20.744Z" }
{
"agents": [{
"agentId": "agent_primary",
"agentName": "agent-primary",
"controllerId": "testsuite",
"isClusterWatcher": true,
"orders": [],
"runningTasks": 0,
"state": {
"_text": "COUPLED",
"severity": 0
},
"url": "https://agent-2-0-primary:4443"
}, {
"agentId": "agent_secondary",
"agentName": "agent-secondary",
"controllerId": "testsuite",
"errorMessage": "Connection refused",
"isClusterWatcher": false,
"orders": [],
"runningTasks": 0,
"state": {
"_text": "COUPLINGFAILED",
"severity": 2
},
"url": "http://agent-2-0-secondary:4444"
}],
"deliveryDate": "2020-12-04T15:42:40.185Z",
"surveyDate": "2020-12-04T15:24:20.744Z"
}
|