| 200 |
Contains collection of Agents where each Agent has the fields
- controllerId
- agentId
- agentName
- url (only for standalone agent)
- processLimit (optional)
- version (only for standalone agent)
- hidden
- disabled (only for standalone agent)
- state (only for standalone agent; COUPLED, COUPLINGFAILED, INITIALISED, RESETTING, SHUTDOWN, UNKNOWN)
- reason (for state INITIALISED: FRESH, RESET, RESTARTED)
- healthstate (ALL_SUBAGENTS_ARE_COUPLED_AND_ENABLED, ONLY_SOME_SUBAGENTS_ARE_COUPLED_AND_ENABLED, NO_SUBAGENTS_ARE_COUPLED_AND_ENABLED, UNKNOWN)
- runningTasks (for cluster agent the sum of the running tasks over all subagents)
- orders (only for standalone agent, of running tasks if
compact == false)
- errorMessage (if COUPLINGFAILED or UNKNOWN)
- subagents (only for cluster agent; collection of subagent where each subagent has the fields)
- agentId
- subagentId
- url
- version
- disabled
- isDirector
- state (COUPLED, COUPLINGFAILED, INITIALISED, RESETTING, SHUTDOWN, UNKNOWN)
- reason (for state INITIALISED: FRESH, RESET, RESTARTED)
- 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",
"extends": {
"javaType": "com.sos.joc.model.agent.AgentStateV",
"type": "object",
"required": [
"agentId"
],
"properties": {
"controllerId": {
"type": "string",
"pattern": "^[^/\\<>?:\"|*]*$",
"maxLength": 100
},
"agentId": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 255,
"minLength": 1
},
"agentName": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 255
},
"subagentId": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 255
},
"url": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 255,
"minLength": 1
},
"version": {
"type": "string"
},
"processLimit": {
"type": "integer",
"minimum": 0
},
"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",
"INITIALISED",
"COUPLINGFAILED",
"SHUTDOWN",
"UNKNOWN"
]
},
"_reason": {
"javaType": "com.sos.joc.model.agent.AgentStateReason",
"type": "string",
"enum": [
"FRESH",
"RESTARTED",
"RESET"
]
}
},
"additionalProperties": false
},
"healthState": {
"javaType": "com.sos.joc.model.agent.AgentClusterState",
"type": "object",
"required": [
"severity",
"_text"
],
"properties": {
"severity": {
"description": "0=ALL_SUBAGENTS_ARE_COUPLED_AND_ENABLED, 1=ONLY_SOME_SUBAGENTS_ARE_COUPLED_AND_ENABLED, 2=NO_SUBAGENTS_ARE_COUPLED_AND_ENABLED, 2=UNKNOWN",
"type": "integer"
},
"_text": {
"javaType": "com.sos.joc.model.agent.AgentClusterStateText",
"type": "string",
"enum": [
"ALL_SUBAGENTS_ARE_COUPLED_AND_ENABLED",
"ONLY_SOME_SUBAGENTS_ARE_COUPLED_AND_ENABLED",
"NO_SUBAGENTS_ARE_COUPLED_AND_ENABLED",
"UNKNOWN"
]
}
},
"additionalProperties": false
},
"clusterState": {
"javaType": "com.sos.joc.model.controller.ClusterState",
"type": "object",
"required": [
"severity",
"_text"
],
"properties": {
"severity": {
"description": "0=ClusterCoupled, 1=ClusterNodesAppointed,ClusterPassiveLost,ClusterSwitchedOver,ClusterFailOver 2=ClusterPreparedToBeCoupled,ClusterEmpty 3=ClusterUnknown",
"type": "integer"
},
"_text": {
"type": "string"
},
"lossNode": {
"type": "string"
}
}
},
"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,
"minLength": 1
},
"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_NOTICES",
"WAITING_FOR_LOCK",
"BETWEEN_CYCLES"
]
}
},
"additionalProperties": false
},
"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
},
"expectedNotices": {
"description": "if state._reason == EXPECTING_NOTICES",
"type": "array",
"items": {
"type": "object",
"javaType": "com.sos.controller.model.order.ExpectedNotice",
"properties": {
"boardName": {
"alias": "boardPath",
"type": "string"
},
"noticeId": {
"type": "string"
}
},
"additionalProperties": false
}
},
"label": {
"description": "a label is only in the response if the request restricts the orders to one workflow",
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 255
},
"position": {
"description": "Actually, each even item is a string, each odd item is an integer",
"type": "array",
"minItems": 1,
"items": {
"anyOf": [{
"type": "integer"
}, {
"type": "string"
}]
}
},
"positionString": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 255
},
"positionIsImplicitEnd": {
"type": "boolean"
},
"endPositions": {
"type": "array",
"items": {
"anyOf": [{
"description": "Actually, each even item is a string, each odd item is an integer",
"type": "array",
"items": {
"anyOf": [{
"type": "integer"
}, {
"type": "string"
}]
}
}, {
"type": "string"
}]
}
},
"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"
],
"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",
"description": "parameters only for parameter type 'List'",
"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
}
},
"facet": {
"description": "a regular expression to check the value of the parameter",
"type": "string"
},
"list": {
"description": "enumeration of possible parameter values",
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"description": "a message if the value doesn't match the facet",
"type": "string"
}
},
"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"
}
}
},
"hasChildOrders": {
"type": "boolean",
"default": false
}
},
"additionalProperties": false
}
},
"runningTasks": {
"type": "integer",
"minimum": 0
},
"disabled": {
"type": "boolean",
"default": false
}
},
"additionalProperties": false
},
"required": [
"agentId",
"agentName"
],
"properties": {
"subagents": {
"type": "array",
"items": {
"javaType": "com.sos.joc.model.agent.SubagentV",
"type": "object",
"extends": {
"javaType": "com.sos.joc.model.agent.AgentStateV",
"type": "object",
"required": [
"agentId"
],
"properties": {
"controllerId": {
"type": "string",
"pattern": "^[^/\\<>?:\"|*]*$",
"maxLength": 100
},
"agentId": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 255,
"minLength": 1
},
"agentName": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 255
},
"subagentId": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 255
},
"url": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 255,
"minLength": 1
},
"version": {
"type": "string"
},
"processLimit": {
"type": "integer",
"minimum": 0
},
"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",
"INITIALISED",
"COUPLINGFAILED",
"SHUTDOWN",
"UNKNOWN"
]
},
"_reason": {
"javaType": "com.sos.joc.model.agent.AgentStateReason",
"type": "string",
"enum": [
"FRESH",
"RESTARTED",
"RESET"
]
}
},
"additionalProperties": false
},
"healthState": {
"javaType": "com.sos.joc.model.agent.AgentClusterState",
"type": "object",
"required": [
"severity",
"_text"
],
"properties": {
"severity": {
"description": "0=ALL_SUBAGENTS_ARE_COUPLED_AND_ENABLED, 1=ONLY_SOME_SUBAGENTS_ARE_COUPLED_AND_ENABLED, 2=NO_SUBAGENTS_ARE_COUPLED_AND_ENABLED, 2=UNKNOWN",
"type": "integer"
},
"_text": {
"javaType": "com.sos.joc.model.agent.AgentClusterStateText",
"type": "string",
"enum": [
"ALL_SUBAGENTS_ARE_COUPLED_AND_ENABLED",
"ONLY_SOME_SUBAGENTS_ARE_COUPLED_AND_ENABLED",
"NO_SUBAGENTS_ARE_COUPLED_AND_ENABLED",
"UNKNOWN"
]
}
},
"additionalProperties": false
},
"clusterState": {
"javaType": "com.sos.joc.model.controller.ClusterState",
"type": "object",
"required": [
"severity",
"_text"
],
"properties": {
"severity": {
"description": "0=ClusterCoupled, 1=ClusterNodesAppointed,ClusterPassiveLost,ClusterSwitchedOver,ClusterFailOver 2=ClusterPreparedToBeCoupled,ClusterEmpty 3=ClusterUnknown",
"type": "integer"
},
"_text": {
"type": "string"
},
"lossNode": {
"type": "string"
}
}
},
"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,
"minLength": 1
},
"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_NOTICES",
"WAITING_FOR_LOCK",
"BETWEEN_CYCLES"
]
}
},
"additionalProperties": false
},
"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
},
"expectedNotices": {
"description": "if state._reason == EXPECTING_NOTICES",
"type": "array",
"items": {
"type": "object",
"javaType": "com.sos.controller.model.order.ExpectedNotice",
"properties": {
"boardName": {
"alias": "boardPath",
"type": "string"
},
"noticeId": {
"type": "string"
}
},
"additionalProperties": false
}
},
"label": {
"description": "a label is only in the response if the request restricts the orders to one workflow",
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 255
},
"position": {
"description": "Actually, each even item is a string, each odd item is an integer",
"type": "array",
"minItems": 1,
"items": {
"anyOf": [{
"type": "integer"
}, {
"type": "string"
}]
}
},
"positionString": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 255
},
"positionIsImplicitEnd": {
"type": "boolean"
},
"endPositions": {
"type": "array",
"items": {
"anyOf": [{
"description": "Actually, each even item is a string, each odd item is an integer",
"type": "array",
"items": {
"anyOf": [{
"type": "integer"
}, {
"type": "string"
}]
}
}, {
"type": "string"
}]
}
},
"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"
],
"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",
"description": "parameters only for parameter type 'List'",
"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
}
},
"facet": {
"description": "a regular expression to check the value of the parameter",
"type": "string"
},
"list": {
"description": "enumeration of possible parameter values",
"type": "array",
"items": {
"type": "string"
}
},
"message": {
"description": "a message if the value doesn't match the facet",
"type": "string"
}
},
"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"
}
}
},
"hasChildOrders": {
"type": "boolean",
"default": false
}
},
"additionalProperties": false
}
},
"runningTasks": {
"type": "integer",
"minimum": 0
},
"disabled": {
"type": "boolean",
"default": false
}
},
"additionalProperties": false
},
"required": [
"agentId",
"subagentId"
],
"properties": {
"isDirector": {
"javaType": "com.sos.joc.model.agent.SubagentDirectorType",
"type": "string",
"enum": [
"NO_DIRECTOR",
"PRIMARY_DIRECTOR",
"SECONDARY_DIRECTOR"
],
"default": "NO_DIRECTOR"
},
"clusterNodeState": {
"javaType": "com.sos.joc.model.controller.ClusterNodeState",
"type": "object",
"required": [
"severity",
"_text"
],
"description": "not relevant for JOC as API server only",
"properties": {
"severity": {
"description": "0=active, 1=inactive, 1=API-server, 3=unknown",
"type": "integer"
},
"_text": {
"javaType": "com.sos.joc.model.controller.ClusterNodeStateText",
"type": "string",
"enum": [
"active",
"inactive",
"api-server",
"unknown"
],
"javaEnumNames": [
"active",
"inactive",
"api-server",
"unknown"
]
}
}
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
{ "agents": [{ "agentId": "agent_001", "agentName": "primaryAgent", "controllerId": "testsuite", "isClusterWatcher": true, "runningTasks": 0, "state": { "_text": "COUPLED", "severity": 0 }, "url": "https://whereever:4443" }, { "agentId": "agent_002", "agentName": "secondaryAgent", "controllerId": "testsuite", "isClusterWatcher": false, "runningTasks": 0, "state": { "_text": "COUPLED", "severity": 0 }, "url": "https://whereever2:4443" }, { "agentId": "agent_004", "agentName": "testAgent", "controllerId": "testsuite", "isClusterWatcher": false, "runningTasks": 0, "state": { "_text": "COUPLED", "severity": 0 }, "url": "http://whereever:4245" }, { "agentId": "agent_005", "agentName": "myAgent", "controllerId": "testsuite", "isClusterWatcher": false, "runningTasks": 0, "state": { "_text": "UNKNOWN", "severity": 2 }, "url": "http://whereever:4449" }, { "agentId": "agent_006", "agentName": "myAgent2", "controllerId": "testsuite", "isClusterWatcher": false, "runningTasks": 0, "state": { "_text": "UNKNOWN", "severity": 2 }, "url": "http://whereever2:4245" }, { "agentId": "agent_101", "agentName": "agent17", "controllerId": "testsuite", "isClusterWatcher": false, "runningTasks": 0, "state": { "_text": "COUPLED", "severity": 0 }, "url": "http://whereever:7775" }, { "agentId": "agent_009", "agentName": "agent18", "controllerId": "testsuite", "isClusterWatcher": false, "runningTasks": 0, "state": { "_text": "COUPLED", "severity": 0 }, "url": "http://whereever3:4445" }, { "agentId": "agent_cluster_001", "agentName": "AgentCluster001", "controllerId": "testsuite", "runningTasks": 0, "subagents": [{ "agentId": "agent_cluster_001", "runningTasks": 0, "state": { "_text": "RESET", "severity": 1 }, "subagentId": "director_primary_001", "url": "http://whereever4:4445" }, { "agentId": "agent_cluster_001", "runningTasks": 0, "state": { "_text": "COUPLED", "severity": 0 }, "subagentId": "subagent_primary_001", "url": "http://whereever5:4445" }, { "agentId": "agent_cluster_001", "runningTasks": 0, "state": { "_text": "COUPLED", "severity": 0 }, "subagentId": "subagent_secondary_001", "url": "http://whereever6:4445" }] }, { "agentId": "agent_014", "agentName": "agent14", "controllerId": "testsuite", "isClusterWatcher": false, "runningTasks": 0, "state": { "_text": "COUPLED", "severity": 0 }, "url": "http://whereever7:4445" }], "deliveryDate": "2022-03-31T19:00:02.051Z", "surveyDate": "2022-03-31T18:50:31.685Z" }
{
"agents": [{
"agentId": "agent_001",
"agentName": "primaryAgent",
"controllerId": "testsuite",
"isClusterWatcher": true,
"runningTasks": 0,
"state": {
"_text": "COUPLED",
"severity": 0
},
"url": "https://whereever:4443"
}, {
"agentId": "agent_002",
"agentName": "secondaryAgent",
"controllerId": "testsuite",
"isClusterWatcher": false,
"runningTasks": 0,
"state": {
"_text": "COUPLED",
"severity": 0
},
"url": "https://whereever2:4443"
}, {
"agentId": "agent_004",
"agentName": "testAgent",
"controllerId": "testsuite",
"isClusterWatcher": false,
"runningTasks": 0,
"state": {
"_text": "COUPLED",
"severity": 0
},
"url": "http://whereever:4245"
}, {
"agentId": "agent_005",
"agentName": "myAgent",
"controllerId": "testsuite",
"isClusterWatcher": false,
"runningTasks": 0,
"state": {
"_text": "UNKNOWN",
"severity": 2
},
"url": "http://whereever:4449"
}, {
"agentId": "agent_006",
"agentName": "myAgent2",
"controllerId": "testsuite",
"isClusterWatcher": false,
"runningTasks": 0,
"state": {
"_text": "UNKNOWN",
"severity": 2
},
"url": "http://whereever2:4245"
}, {
"agentId": "agent_101",
"agentName": "agent17",
"controllerId": "testsuite",
"isClusterWatcher": false,
"runningTasks": 0,
"state": {
"_text": "COUPLED",
"severity": 0
},
"url": "http://whereever:7775"
}, {
"agentId": "agent_009",
"agentName": "agent18",
"controllerId": "testsuite",
"isClusterWatcher": false,
"runningTasks": 0,
"state": {
"_text": "COUPLED",
"severity": 0
},
"url": "http://whereever3:4445"
}, {
"agentId": "agent_cluster_001",
"agentName": "AgentCluster001",
"controllerId": "testsuite",
"runningTasks": 0,
"subagents": [{
"agentId": "agent_cluster_001",
"runningTasks": 0,
"state": {
"_text": "RESET",
"severity": 1
},
"subagentId": "director_primary_001",
"url": "http://whereever4:4445"
}, {
"agentId": "agent_cluster_001",
"runningTasks": 0,
"state": {
"_text": "COUPLED",
"severity": 0
},
"subagentId": "subagent_primary_001",
"url": "http://whereever5:4445"
}, {
"agentId": "agent_cluster_001",
"runningTasks": 0,
"state": {
"_text": "COUPLED",
"severity": 0
},
"subagentId": "subagent_secondary_001",
"url": "http://whereever6:4445"
}]
}, {
"agentId": "agent_014",
"agentName": "agent14",
"controllerId": "testsuite",
"isClusterWatcher": false,
"runningTasks": 0,
"state": {
"_text": "COUPLED",
"severity": 0
},
"url": "http://whereever7:4445"
}],
"deliveryDate": "2022-03-31T19:00:02.051Z",
"surveyDate": "2022-03-31T18:50:31.685Z"
}
|