| 200 |
Each job chain can have a brief, compact or detailed response.
It depends on the parameter compact.
- Required fields of a compact view are
- surveyDate
- path
- name
- numOfOrders
- numOfNodes
- state
- ordersSummary
- The compact view have further optional fields
- The detailed view has the following required fields in addition to the compact view
- The detailed view has the following optional fields in addition to the compact view
|
|
application/json
model |
example
{
"title": "job chain with delivery date (volatile part)",
"$schema": "http://json-schema.org/draft-04/schema#",
"javaType": "com.sos.joc.model.jobChain.JobChainV200",
"type": "object",
"required": [
"deliveryDate",
"jobChain"
],
"properties": {
"deliveryDate": {
"description": "Date time. Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ",
"type": "string",
"format": "date-time"
},
"jobChain": {
"javaType": "com.sos.joc.model.jobChain.JobChainV",
"type": "object",
"oneOf": [{
"description": "parameter compact=true",
"required": [
"surveyDate",
"path",
"name",
"state",
"numOfOrders",
"numOfNodes",
"ordersSummary"
]
}, {
"description": "parameter compact=false or unset",
"required": [
"surveyDate",
"path",
"name",
"state",
"numOfOrders",
"numOfNodes",
"nodes",
"ordersSummary"
]
}],
"properties": {
"surveyDate": {
"description": "Current date of the JobScheduler Master/Agent. Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ",
"type": "string",
"format": "date-time"
},
"path": {
"description": "absolute path based on live folder of a JobScheduler object.",
"type": "string",
"pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
"maxLength": 255
},
"name": {
"type": "string"
},
"state": {
"javaType": "com.sos.joc.model.jobChain.JobChainState",
"type": "object",
"required": [
"severity",
"_text"
],
"properties": {
"severity": {
"description": "0=running, 4=active, 3=initialized, 2=under_construction/stopped/not_initialized",
"type": "integer"
},
"_text": {
"javaType": "com.sos.joc.model.jobChain.JobChainStateText",
"type": "string",
"enum": [
"NOT_INITIALIZED",
"INITIALIZED",
"ACTIVE",
"UNDER_CONSTRUCTION",
"STOPPED"
]
}
}
},
"numOfNodes": {
"type": "integer",
"minimum": 0
},
"nodes": {
"type": "array",
"minItems": 1,
"items": {
"javaType": "com.sos.joc.model.jobChain.JobChainNodeV",
"type": "object",
"oneOf": [{
"description": "job chain node object with assigned a job and parameter compact=true",
"required": [
"name",
"state",
"job",
"level",
"numOfOrders"
]
}, {
"description": "job chain node object with assigned a job and parameter compact=false",
"required": [
"name",
"state",
"job",
"level",
"numOfOrders",
"orders"
]
}, {
"description": "job chain node object with assigned a job chain",
"required": [
"name",
"state",
"jobChain",
"numOfOrders"
]
}],
"properties": {
"name": {
"type": "string"
},
"state": {
"javaType": "com.sos.joc.model.jobChain.JobChainNodeState",
"type": "object",
"required": [
"severity",
"_text"
],
"properties": {
"severity": {
"description": "5=skipped, 4=active, 2=stopped",
"type": "integer"
},
"_text": {
"javaType": "com.sos.joc.model.jobChain.JobChainNodeStateText",
"type": "string",
"enum": [
"ACTIVE",
"SKIPPED",
"STOPPED"
]
}
}
},
"job": {
"javaType": "com.sos.joc.model.jobChain.JobChainNodeJobV",
"type": "object",
"required": [
"path"
],
"properties": {
"path": {
"description": "absolute path based on live folder of a JobScheduler object.",
"type": "string",
"pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
"maxLength": 255
},
"state": {
"javaType": "com.sos.joc.model.job.JobState",
"type": "object",
"required": [
"severity",
"_text"
],
"properties": {
"severity": {
"description": "0=running; 1=pending; 2=not_initialized/waiting_for_agent/stopping/stopped/error, 3=initialized/loaded/waiting_for_process/waiting_for_lock/waiting_for_task/not_in_period, 4=disabled/unknown",
"type": "integer"
},
"_text": {
"javaType": "com.sos.joc.model.job.JobStateText",
"type": "string",
"enum": [
"INITIALIZED",
"NOT_INITIALIZED",
"LOADED",
"PENDING",
"RUNNING",
"WAITING_FOR_PROCESS",
"WAITING_FOR_LOCK",
"WAITING_FOR_AGENT",
"WAITING_FOR_TASK",
"NOT_IN_PERIOD",
"STOPPING",
"STOPPED",
"DISABLED",
"ERROR",
"UNKNOWN"
]
},
"manually": {
"type": "boolean"
}
}
},
"configurationStatus": {
"javaType": "com.sos.joc.model.common.ConfigurationState",
"type": "object",
"required": [
"severity",
"_text"
],
"properties": {
"severity": {
"description": "4=ok; 5=replacement_is_standing_by,removing_delayed; 2=error_in_configuration_file,changed_file_not_loaded,resource_is_missing",
"type": "integer"
},
"_text": {
"javaType": "com.sos.joc.model.common.ConfigurationStateText",
"type": "string",
"enum": [
"ERROR_IN_CONFIGURATION_FILE",
"CHANGED_FILE_NOT_LOADED",
"REMOVING_DELAYED",
"RESOURCE_IS_MISSING",
"REPLACEMENT_IS_STANDING_BY",
"OK"
]
},
"message": {
"description": "contains e.g. error message",
"type": "string"
}
}
},
"documentation": {
"description": "absolute path based on live folder of a JobScheduler object.",
"type": "string",
"pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
"maxLength": 255
}
}
},
"level": {
"description": "Only relevant for job chain with splits and syncs. For example to imagine splits/sync in the job chain list view with different indents",
"type": "integer"
},
"jobChain": {
"description": "job chain object is included in nestedJobChains collection",
"javaType": "com.sos.joc.model.jobChain.JobChainNodeJobChainV",
"type": "object",
"required": [
"path"
],
"properties": {
"path": {
"description": "absolute path based on live folder of a JobScheduler object.",
"type": "string",
"pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
"maxLength": 255
},
"documentation": {
"description": "absolute path based on live folder of a JobScheduler object.",
"type": "string",
"pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
"maxLength": 255
}
}
},
"numOfOrders": {
"type": "integer",
"minimum": 0
},
"orders": {
"type": "array",
"items": {
"javaType": "com.sos.joc.model.order.OrderV",
"type": "object",
"allOf": [{
"description": "compact=true then ONLY path, id, jobChain, _type, surveyDate, state, processingState, runTimeIsTemporary, job(except blacklisted orders) are required and only title, processedBy, configurationStatus are optional",
"required": [
"path",
"orderId",
"jobChain",
"surveyDate",
"state",
"processingState",
"_type",
"runTimeIsTemporary"
]
}, {
"oneOf": [{
"description": "pending order",
"required": [
"nextStartTime"
]
}, {
"description": "running order",
"required": [
"historyId",
"startedAt",
"taskId",
"inProcessSince"
]
}, {
"description": "suspended, waitingForResource, blacklist order",
"required": [
"historyId",
"startedAt"
]
}, {
"description": "setback order",
"required": [
"historyId",
"startedAt",
"setback"
]
}]
}],
"properties": {
"path": {
"description": "absolute path based on live folder of a JobScheduler object.",
"type": "string",
"pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
"maxLength": 255
},
"orderId": {
"type": "string"
},
"jobChain": {
"description": "absolute path based on live folder of a JobScheduler object.",
"type": "string",
"pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
"maxLength": 255
},
"priority": {
"type": "integer",
"minimum": 0
},
"params": {
"type": "array",
"items": {
"javaType": "com.sos.joc.model.common.NameValuePair",
"type": "object",
"required": [
"name",
"value"
],
"properties": {
"name": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 255
},
"value": {
"type": "string",
"pattern": "^(?s)((?!<script( |>)|<svg/on).)*$"
}
}
}
},
"_type": {
"javaType": "com.sos.joc.model.order.OrderType",
"type": "string",
"description": "the type of the order",
"enum": [
"PERMANENT",
"AD_HOC",
"FILE_ORDER"
]
},
"surveyDate": {
"description": "Current date of the JobScheduler Master/Agent. Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ",
"type": "string",
"format": "date-time"
},
"state": {
"description": "the name of the node",
"type": "string"
},
"title": {
"type": "string"
},
"job": {
"description": "absolute path based on live folder of a JobScheduler object.",
"type": "string",
"pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
"maxLength": 255
},
"stateText": {
"type": "string"
},
"configurationStatus": {
"javaType": "com.sos.joc.model.common.ConfigurationState",
"type": "object",
"required": [
"severity",
"_text"
],
"properties": {
"severity": {
"description": "4=ok; 5=replacement_is_standing_by,removing_delayed; 2=error_in_configuration_file,changed_file_not_loaded,resource_is_missing",
"type": "integer"
},
"_text": {
"javaType": "com.sos.joc.model.common.ConfigurationStateText",
"type": "string",
"enum": [
"ERROR_IN_CONFIGURATION_FILE",
"CHANGED_FILE_NOT_LOADED",
"REMOVING_DELAYED",
"RESOURCE_IS_MISSING",
"REPLACEMENT_IS_STANDING_BY",
"OK"
]
},
"message": {
"description": "contains e.g. error message",
"type": "string"
}
}
},
"endState": {
"description": "the name of the end node",
"type": "string"
},
"processingState": {
"javaType": "com.sos.joc.model.order.OrderState",
"type": "object",
"required": [
"severity",
"_text"
],
"properties": {
"severity": {
"description": "0=running, 4=active, 3=initialized, 2=under_construction/stopped/not_initialized",
"type": "integer"
},
"_text": {
"javaType": "com.sos.joc.model.order.OrderStateText",
"type": "string",
"enum": [
"PENDING",
"RUNNING",
"SUSPENDED",
"SETBACK",
"BLACKLIST",
"JOB_NOT_IN_PERIOD",
"NODE_DELAY",
"WAITING_FOR_LOCK",
"WAITING_FOR_PROCESS",
"WAITING_FOR_AGENT",
"JOB_CHAIN_STOPPED",
"NODE_STOPPED",
"JOB_STOPPED",
"WAITING_FOR_TASK"
]
},
"manually": {
"type": "boolean"
}
}
},
"nextStartTime": {
"description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty",
"type": "string",
"format": "date-time"
},
"nextStartNever": {
"type": "boolean"
},
"historyId": {
"description": "for all orders except pending orders",
"type": "string"
},
"startedAt": {
"description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty",
"type": "string",
"format": "date-time"
},
"processedBy": {
"description": "ONLY for running or blacklist order, contains Host/port of an active cluster member or URL of a JobScheduler Agent",
"type": "string"
},
"taskId": {
"description": "ONLY for running order",
"type": "string"
},
"inProcessSince": {
"description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty",
"type": "string",
"format": "date-time"
},
"setback": {
"description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty",
"type": "string",
"format": "date-time"
},
"lock": {
"description": "absolute path based on live folder of a JobScheduler object.",
"type": "string",
"pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
"maxLength": 255
},
"processClass": {
"description": "absolute path based on live folder of a JobScheduler object.",
"type": "string",
"pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
"maxLength": 255
},
"runTimeIsTemporary": {
"type": "boolean",
"default": false
},
"documentation": {
"description": "absolute path based on live folder of a JobScheduler object.",
"type": "string",
"pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
"maxLength": 255
}
}
}
}
}
}
},
"fileOrderSources": {
"type": "array",
"items": {
"javaType": "com.sos.joc.model.jobChain.FileWatchingNodeV",
"type": "object",
"required": [
"directory",
"regex"
],
"properties": {
"directory": {
"type": "string"
},
"regex": {
"type": "string"
},
"files": {
"type": "array",
"items": {
"javaType": "com.sos.joc.model.jobChain.FileWatchingNodeFile",
"type": "object",
"properties": {
"path": {
"description": "absolute path based on live folder of a JobScheduler object.",
"type": "string",
"pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
"maxLength": 255
},
"modified": {
"description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty",
"type": "string",
"format": "date-time"
}
}
}
},
"repeat": {
"type": "integer",
"minimum": 0
},
"delayAfterError": {
"type": "integer",
"minimum": 0
},
"alertWhenDirectoryMissing": {
"type": "boolean"
}
}
}
},
"blacklist": {
"type": "array",
"items": {
"javaType": "com.sos.joc.model.order.OrderV",
"type": "object",
"allOf": [{
"description": "compact=true then ONLY path, id, jobChain, _type, surveyDate, state, processingState, runTimeIsTemporary, job(except blacklisted orders) are required and only title, processedBy, configurationStatus are optional",
"required": [
"path",
"orderId",
"jobChain",
"surveyDate",
"state",
"processingState",
"_type",
"runTimeIsTemporary"
]
}, {
"oneOf": [{
"description": "pending order",
"required": [
"nextStartTime"
]
}, {
"description": "running order",
"required": [
"historyId",
"startedAt",
"taskId",
"inProcessSince"
]
}, {
"description": "suspended, waitingForResource, blacklist order",
"required": [
"historyId",
"startedAt"
]
}, {
"description": "setback order",
"required": [
"historyId",
"startedAt",
"setback"
]
}]
}],
"properties": {
"path": {
"description": "absolute path based on live folder of a JobScheduler object.",
"type": "string",
"pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
"maxLength": 255
},
"orderId": {
"type": "string"
},
"jobChain": {
"description": "absolute path based on live folder of a JobScheduler object.",
"type": "string",
"pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
"maxLength": 255
},
"priority": {
"type": "integer",
"minimum": 0
},
"params": {
"type": "array",
"items": {
"javaType": "com.sos.joc.model.common.NameValuePair",
"type": "object",
"required": [
"name",
"value"
],
"properties": {
"name": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 255
},
"value": {
"type": "string",
"pattern": "^(?s)((?!<script( |>)|<svg/on).)*$"
}
}
}
},
"_type": {
"javaType": "com.sos.joc.model.order.OrderType",
"type": "string",
"description": "the type of the order",
"enum": [
"PERMANENT",
"AD_HOC",
"FILE_ORDER"
]
},
"surveyDate": {
"description": "Current date of the JobScheduler Master/Agent. Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ",
"type": "string",
"format": "date-time"
},
"state": {
"description": "the name of the node",
"type": "string"
},
"title": {
"type": "string"
},
"job": {
"description": "absolute path based on live folder of a JobScheduler object.",
"type": "string",
"pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
"maxLength": 255
},
"stateText": {
"type": "string"
},
"configurationStatus": {
"javaType": "com.sos.joc.model.common.ConfigurationState",
"type": "object",
"required": [
"severity",
"_text"
],
"properties": {
"severity": {
"description": "4=ok; 5=replacement_is_standing_by,removing_delayed; 2=error_in_configuration_file,changed_file_not_loaded,resource_is_missing",
"type": "integer"
},
"_text": {
"javaType": "com.sos.joc.model.common.ConfigurationStateText",
"type": "string",
"enum": [
"ERROR_IN_CONFIGURATION_FILE",
"CHANGED_FILE_NOT_LOADED",
"REMOVING_DELAYED",
"RESOURCE_IS_MISSING",
"REPLACEMENT_IS_STANDING_BY",
"OK"
]
},
"message": {
"description": "contains e.g. error message",
"type": "string"
}
}
},
"endState": {
"description": "the name of the end node",
"type": "string"
},
"processingState": {
"javaType": "com.sos.joc.model.order.OrderState",
"type": "object",
"required": [
"severity",
"_text"
],
"properties": {
"severity": {
"description": "0=running, 4=active, 3=initialized, 2=under_construction/stopped/not_initialized",
"type": "integer"
},
"_text": {
"javaType": "com.sos.joc.model.order.OrderStateText",
"type": "string",
"enum": [
"PENDING",
"RUNNING",
"SUSPENDED",
"SETBACK",
"BLACKLIST",
"JOB_NOT_IN_PERIOD",
"NODE_DELAY",
"WAITING_FOR_LOCK",
"WAITING_FOR_PROCESS",
"WAITING_FOR_AGENT",
"JOB_CHAIN_STOPPED",
"NODE_STOPPED",
"JOB_STOPPED",
"WAITING_FOR_TASK"
]
},
"manually": {
"type": "boolean"
}
}
},
"nextStartTime": {
"description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty",
"type": "string",
"format": "date-time"
},
"nextStartNever": {
"type": "boolean"
},
"historyId": {
"description": "for all orders except pending orders",
"type": "string"
},
"startedAt": {
"description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty",
"type": "string",
"format": "date-time"
},
"processedBy": {
"description": "ONLY for running or blacklist order, contains Host/port of an active cluster member or URL of a JobScheduler Agent",
"type": "string"
},
"taskId": {
"description": "ONLY for running order",
"type": "string"
},
"inProcessSince": {
"description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty",
"type": "string",
"format": "date-time"
},
"setback": {
"description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty",
"type": "string",
"format": "date-time"
},
"lock": {
"description": "absolute path based on live folder of a JobScheduler object.",
"type": "string",
"pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
"maxLength": 255
},
"processClass": {
"description": "absolute path based on live folder of a JobScheduler object.",
"type": "string",
"pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
"maxLength": 255
},
"runTimeIsTemporary": {
"type": "boolean",
"default": false
},
"documentation": {
"description": "absolute path based on live folder of a JobScheduler object.",
"type": "string",
"pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
"maxLength": 255
}
}
}
},
"numOfOrders": {
"type": "integer",
"minimum": 0
},
"configurationStatus": {
"javaType": "com.sos.joc.model.common.ConfigurationState",
"type": "object",
"required": [
"severity",
"_text"
],
"properties": {
"severity": {
"description": "4=ok; 5=replacement_is_standing_by,removing_delayed; 2=error_in_configuration_file,changed_file_not_loaded,resource_is_missing",
"type": "integer"
},
"_text": {
"javaType": "com.sos.joc.model.common.ConfigurationStateText",
"type": "string",
"enum": [
"ERROR_IN_CONFIGURATION_FILE",
"CHANGED_FILE_NOT_LOADED",
"REMOVING_DELAYED",
"RESOURCE_IS_MISSING",
"REPLACEMENT_IS_STANDING_BY",
"OK"
]
},
"message": {
"description": "contains e.g. error message",
"type": "string"
}
}
},
"ordersSummary": {
"description": "only relevant for order jobs and is empty if job's order queue is empty",
"javaType": "com.sos.joc.model.order.OrdersSummary",
"type": "object",
"properties": {
"pending": {
"type": "integer",
"minimum": 0
},
"running": {
"type": "integer",
"minimum": 0
},
"suspended": {
"type": "integer",
"minimum": 0
},
"setback": {
"type": "integer",
"minimum": 0
},
"waitingForResource": {
"type": "integer",
"minimum": 0
},
"blacklist": {
"type": "integer",
"minimum": 0
}
}
}
}
},
"nestedJobChains": {
"type": "array",
"items": {
"javaType": "com.sos.joc.model.jobChain.JobChainV",
"type": "object",
"oneOf": [{
"description": "parameter compact=true",
"required": [
"surveyDate",
"path",
"name",
"state",
"numOfOrders",
"numOfNodes",
"ordersSummary"
]
}, {
"description": "parameter compact=false or unset",
"required": [
"surveyDate",
"path",
"name",
"state",
"numOfOrders",
"numOfNodes",
"nodes",
"ordersSummary"
]
}],
"properties": {
"surveyDate": {
"description": "Current date of the JobScheduler Master/Agent. Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ",
"type": "string",
"format": "date-time"
},
"path": {
"description": "absolute path based on live folder of a JobScheduler object.",
"type": "string",
"pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
"maxLength": 255
},
"name": {
"type": "string"
},
"state": {
"javaType": "com.sos.joc.model.jobChain.JobChainState",
"type": "object",
"required": [
"severity",
"_text"
],
"properties": {
"severity": {
"description": "0=running, 4=active, 3=initialized, 2=under_construction/stopped/not_initialized",
"type": "integer"
},
"_text": {
"javaType": "com.sos.joc.model.jobChain.JobChainStateText",
"type": "string",
"enum": [
"NOT_INITIALIZED",
"INITIALIZED",
"ACTIVE",
"UNDER_CONSTRUCTION",
"STOPPED"
]
}
}
},
"numOfNodes": {
"type": "integer",
"minimum": 0
},
"nodes": {
"type": "array",
"minItems": 1,
"items": {
"javaType": "com.sos.joc.model.jobChain.JobChainNodeV",
"type": "object",
"oneOf": [{
"description": "job chain node object with assigned a job and parameter compact=true",
"required": [
"name",
"state",
"job",
"level",
"numOfOrders"
]
}, {
"description": "job chain node object with assigned a job and parameter compact=false",
"required": [
"name",
"state",
"job",
"level",
"numOfOrders",
"orders"
]
}, {
"description": "job chain node object with assigned a job chain",
"required": [
"name",
"state",
"jobChain",
"numOfOrders"
]
}],
"properties": {
"name": {
"type": "string"
},
"state": {
"javaType": "com.sos.joc.model.jobChain.JobChainNodeState",
"type": "object",
"required": [
"severity",
"_text"
],
"properties": {
"severity": {
"description": "5=skipped, 4=active, 2=stopped",
"type": "integer"
},
"_text": {
"javaType": "com.sos.joc.model.jobChain.JobChainNodeStateText",
"type": "string",
"enum": [
"ACTIVE",
"SKIPPED",
"STOPPED"
]
}
}
},
"job": {
"javaType": "com.sos.joc.model.jobChain.JobChainNodeJobV",
"type": "object",
"required": [
"path"
],
"properties": {
"path": {
"description": "absolute path based on live folder of a JobScheduler object.",
"type": "string",
"pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
"maxLength": 255
},
"state": {
"javaType": "com.sos.joc.model.job.JobState",
"type": "object",
"required": [
"severity",
"_text"
],
"properties": {
"severity": {
"description": "0=running; 1=pending; 2=not_initialized/waiting_for_agent/stopping/stopped/error, 3=initialized/loaded/waiting_for_process/waiting_for_lock/waiting_for_task/not_in_period, 4=disabled/unknown",
"type": "integer"
},
"_text": {
"javaType": "com.sos.joc.model.job.JobStateText",
"type": "string",
"enum": [
"INITIALIZED",
"NOT_INITIALIZED",
"LOADED",
"PENDING",
"RUNNING",
"WAITING_FOR_PROCESS",
"WAITING_FOR_LOCK",
"WAITING_FOR_AGENT",
"WAITING_FOR_TASK",
"NOT_IN_PERIOD",
"STOPPING",
"STOPPED",
"DISABLED",
"ERROR",
"UNKNOWN"
]
},
"manually": {
"type": "boolean"
}
}
},
"configurationStatus": {
"javaType": "com.sos.joc.model.common.ConfigurationState",
"type": "object",
"required": [
"severity",
"_text"
],
"properties": {
"severity": {
"description": "4=ok; 5=replacement_is_standing_by,removing_delayed; 2=error_in_configuration_file,changed_file_not_loaded,resource_is_missing",
"type": "integer"
},
"_text": {
"javaType": "com.sos.joc.model.common.ConfigurationStateText",
"type": "string",
"enum": [
"ERROR_IN_CONFIGURATION_FILE",
"CHANGED_FILE_NOT_LOADED",
"REMOVING_DELAYED",
"RESOURCE_IS_MISSING",
"REPLACEMENT_IS_STANDING_BY",
"OK"
]
},
"message": {
"description": "contains e.g. error message",
"type": "string"
}
}
},
"documentation": {
"description": "absolute path based on live folder of a JobScheduler object.",
"type": "string",
"pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
"maxLength": 255
}
}
},
"level": {
"description": "Only relevant for job chain with splits and syncs. For example to imagine splits/sync in the job chain list view with different indents",
"type": "integer"
},
"jobChain": {
"description": "job chain object is included in nestedJobChains collection",
"javaType": "com.sos.joc.model.jobChain.JobChainNodeJobChainV",
"type": "object",
"required": [
"path"
],
"properties": {
"path": {
"description": "absolute path based on live folder of a JobScheduler object.",
"type": "string",
"pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
"maxLength": 255
},
"documentation": {
"description": "absolute path based on live folder of a JobScheduler object.",
"type": "string",
"pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
"maxLength": 255
}
}
},
"numOfOrders": {
"type": "integer",
"minimum": 0
},
"orders": {
"type": "array",
"items": {
"javaType": "com.sos.joc.model.order.OrderV",
"type": "object",
"allOf": [{
"description": "compact=true then ONLY path, id, jobChain, _type, surveyDate, state, processingState, runTimeIsTemporary, job(except blacklisted orders) are required and only title, processedBy, configurationStatus are optional",
"required": [
"path",
"orderId",
"jobChain",
"surveyDate",
"state",
"processingState",
"_type",
"runTimeIsTemporary"
]
}, {
"oneOf": [{
"description": "pending order",
"required": [
"nextStartTime"
]
}, {
"description": "running order",
"required": [
"historyId",
"startedAt",
"taskId",
"inProcessSince"
]
}, {
"description": "suspended, waitingForResource, blacklist order",
"required": [
"historyId",
"startedAt"
]
}, {
"description": "setback order",
"required": [
"historyId",
"startedAt",
"setback"
]
}]
}],
"properties": {
"path": {
"description": "absolute path based on live folder of a JobScheduler object.",
"type": "string",
"pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
"maxLength": 255
},
"orderId": {
"type": "string"
},
"jobChain": {
"description": "absolute path based on live folder of a JobScheduler object.",
"type": "string",
"pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
"maxLength": 255
},
"priority": {
"type": "integer",
"minimum": 0
},
"params": {
"type": "array",
"items": {
"javaType": "com.sos.joc.model.common.NameValuePair",
"type": "object",
"required": [
"name",
"value"
],
"properties": {
"name": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 255
},
"value": {
"type": "string",
"pattern": "^(?s)((?!<script( |>)|<svg/on).)*$"
}
}
}
},
"_type": {
"javaType": "com.sos.joc.model.order.OrderType",
"type": "string",
"description": "the type of the order",
"enum": [
"PERMANENT",
"AD_HOC",
"FILE_ORDER"
]
},
"surveyDate": {
"description": "Current date of the JobScheduler Master/Agent. Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ",
"type": "string",
"format": "date-time"
},
"state": {
"description": "the name of the node",
"type": "string"
},
"title": {
"type": "string"
},
"job": {
"description": "absolute path based on live folder of a JobScheduler object.",
"type": "string",
"pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
"maxLength": 255
},
"stateText": {
"type": "string"
},
"configurationStatus": {
"javaType": "com.sos.joc.model.common.ConfigurationState",
"type": "object",
"required": [
"severity",
"_text"
],
"properties": {
"severity": {
"description": "4=ok; 5=replacement_is_standing_by,removing_delayed; 2=error_in_configuration_file,changed_file_not_loaded,resource_is_missing",
"type": "integer"
},
"_text": {
"javaType": "com.sos.joc.model.common.ConfigurationStateText",
"type": "string",
"enum": [
"ERROR_IN_CONFIGURATION_FILE",
"CHANGED_FILE_NOT_LOADED",
"REMOVING_DELAYED",
"RESOURCE_IS_MISSING",
"REPLACEMENT_IS_STANDING_BY",
"OK"
]
},
"message": {
"description": "contains e.g. error message",
"type": "string"
}
}
},
"endState": {
"description": "the name of the end node",
"type": "string"
},
"processingState": {
"javaType": "com.sos.joc.model.order.OrderState",
"type": "object",
"required": [
"severity",
"_text"
],
"properties": {
"severity": {
"description": "0=running, 4=active, 3=initialized, 2=under_construction/stopped/not_initialized",
"type": "integer"
},
"_text": {
"javaType": "com.sos.joc.model.order.OrderStateText",
"type": "string",
"enum": [
"PENDING",
"RUNNING",
"SUSPENDED",
"SETBACK",
"BLACKLIST",
"JOB_NOT_IN_PERIOD",
"NODE_DELAY",
"WAITING_FOR_LOCK",
"WAITING_FOR_PROCESS",
"WAITING_FOR_AGENT",
"JOB_CHAIN_STOPPED",
"NODE_STOPPED",
"JOB_STOPPED",
"WAITING_FOR_TASK"
]
},
"manually": {
"type": "boolean"
}
}
},
"nextStartTime": {
"description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty",
"type": "string",
"format": "date-time"
},
"nextStartNever": {
"type": "boolean"
},
"historyId": {
"description": "for all orders except pending orders",
"type": "string"
},
"startedAt": {
"description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty",
"type": "string",
"format": "date-time"
},
"processedBy": {
"description": "ONLY for running or blacklist order, contains Host/port of an active cluster member or URL of a JobScheduler Agent",
"type": "string"
},
"taskId": {
"description": "ONLY for running order",
"type": "string"
},
"inProcessSince": {
"description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty",
"type": "string",
"format": "date-time"
},
"setback": {
"description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty",
"type": "string",
"format": "date-time"
},
"lock": {
"description": "absolute path based on live folder of a JobScheduler object.",
"type": "string",
"pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
"maxLength": 255
},
"processClass": {
"description": "absolute path based on live folder of a JobScheduler object.",
"type": "string",
"pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
"maxLength": 255
},
"runTimeIsTemporary": {
"type": "boolean",
"default": false
},
"documentation": {
"description": "absolute path based on live folder of a JobScheduler object.",
"type": "string",
"pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
"maxLength": 255
}
}
}
}
}
}
},
"fileOrderSources": {
"type": "array",
"items": {
"javaType": "com.sos.joc.model.jobChain.FileWatchingNodeV",
"type": "object",
"required": [
"directory",
"regex"
],
"properties": {
"directory": {
"type": "string"
},
"regex": {
"type": "string"
},
"files": {
"type": "array",
"items": {
"javaType": "com.sos.joc.model.jobChain.FileWatchingNodeFile",
"type": "object",
"properties": {
"path": {
"description": "absolute path based on live folder of a JobScheduler object.",
"type": "string",
"pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
"maxLength": 255
},
"modified": {
"description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty",
"type": "string",
"format": "date-time"
}
}
}
},
"repeat": {
"type": "integer",
"minimum": 0
},
"delayAfterError": {
"type": "integer",
"minimum": 0
},
"alertWhenDirectoryMissing": {
"type": "boolean"
}
}
}
},
"blacklist": {
"type": "array",
"items": {
"javaType": "com.sos.joc.model.order.OrderV",
"type": "object",
"allOf": [{
"description": "compact=true then ONLY path, id, jobChain, _type, surveyDate, state, processingState, runTimeIsTemporary, job(except blacklisted orders) are required and only title, processedBy, configurationStatus are optional",
"required": [
"path",
"orderId",
"jobChain",
"surveyDate",
"state",
"processingState",
"_type",
"runTimeIsTemporary"
]
}, {
"oneOf": [{
"description": "pending order",
"required": [
"nextStartTime"
]
}, {
"description": "running order",
"required": [
"historyId",
"startedAt",
"taskId",
"inProcessSince"
]
}, {
"description": "suspended, waitingForResource, blacklist order",
"required": [
"historyId",
"startedAt"
]
}, {
"description": "setback order",
"required": [
"historyId",
"startedAt",
"setback"
]
}]
}],
"properties": {
"path": {
"description": "absolute path based on live folder of a JobScheduler object.",
"type": "string",
"pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
"maxLength": 255
},
"orderId": {
"type": "string"
},
"jobChain": {
"description": "absolute path based on live folder of a JobScheduler object.",
"type": "string",
"pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
"maxLength": 255
},
"priority": {
"type": "integer",
"minimum": 0
},
"params": {
"type": "array",
"items": {
"javaType": "com.sos.joc.model.common.NameValuePair",
"type": "object",
"required": [
"name",
"value"
],
"properties": {
"name": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 255
},
"value": {
"type": "string",
"pattern": "^(?s)((?!<script( |>)|<svg/on).)*$"
}
}
}
},
"_type": {
"javaType": "com.sos.joc.model.order.OrderType",
"type": "string",
"description": "the type of the order",
"enum": [
"PERMANENT",
"AD_HOC",
"FILE_ORDER"
]
},
"surveyDate": {
"description": "Current date of the JobScheduler Master/Agent. Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ",
"type": "string",
"format": "date-time"
},
"state": {
"description": "the name of the node",
"type": "string"
},
"title": {
"type": "string"
},
"job": {
"description": "absolute path based on live folder of a JobScheduler object.",
"type": "string",
"pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
"maxLength": 255
},
"stateText": {
"type": "string"
},
"configurationStatus": {
"javaType": "com.sos.joc.model.common.ConfigurationState",
"type": "object",
"required": [
"severity",
"_text"
],
"properties": {
"severity": {
"description": "4=ok; 5=replacement_is_standing_by,removing_delayed; 2=error_in_configuration_file,changed_file_not_loaded,resource_is_missing",
"type": "integer"
},
"_text": {
"javaType": "com.sos.joc.model.common.ConfigurationStateText",
"type": "string",
"enum": [
"ERROR_IN_CONFIGURATION_FILE",
"CHANGED_FILE_NOT_LOADED",
"REMOVING_DELAYED",
"RESOURCE_IS_MISSING",
"REPLACEMENT_IS_STANDING_BY",
"OK"
]
},
"message": {
"description": "contains e.g. error message",
"type": "string"
}
}
},
"endState": {
"description": "the name of the end node",
"type": "string"
},
"processingState": {
"javaType": "com.sos.joc.model.order.OrderState",
"type": "object",
"required": [
"severity",
"_text"
],
"properties": {
"severity": {
"description": "0=running, 4=active, 3=initialized, 2=under_construction/stopped/not_initialized",
"type": "integer"
},
"_text": {
"javaType": "com.sos.joc.model.order.OrderStateText",
"type": "string",
"enum": [
"PENDING",
"RUNNING",
"SUSPENDED",
"SETBACK",
"BLACKLIST",
"JOB_NOT_IN_PERIOD",
"NODE_DELAY",
"WAITING_FOR_LOCK",
"WAITING_FOR_PROCESS",
"WAITING_FOR_AGENT",
"JOB_CHAIN_STOPPED",
"NODE_STOPPED",
"JOB_STOPPED",
"WAITING_FOR_TASK"
]
},
"manually": {
"type": "boolean"
}
}
},
"nextStartTime": {
"description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty",
"type": "string",
"format": "date-time"
},
"nextStartNever": {
"type": "boolean"
},
"historyId": {
"description": "for all orders except pending orders",
"type": "string"
},
"startedAt": {
"description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty",
"type": "string",
"format": "date-time"
},
"processedBy": {
"description": "ONLY for running or blacklist order, contains Host/port of an active cluster member or URL of a JobScheduler Agent",
"type": "string"
},
"taskId": {
"description": "ONLY for running order",
"type": "string"
},
"inProcessSince": {
"description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty",
"type": "string",
"format": "date-time"
},
"setback": {
"description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty",
"type": "string",
"format": "date-time"
},
"lock": {
"description": "absolute path based on live folder of a JobScheduler object.",
"type": "string",
"pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
"maxLength": 255
},
"processClass": {
"description": "absolute path based on live folder of a JobScheduler object.",
"type": "string",
"pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
"maxLength": 255
},
"runTimeIsTemporary": {
"type": "boolean",
"default": false
},
"documentation": {
"description": "absolute path based on live folder of a JobScheduler object.",
"type": "string",
"pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
"maxLength": 255
}
}
}
},
"numOfOrders": {
"type": "integer",
"minimum": 0
},
"configurationStatus": {
"javaType": "com.sos.joc.model.common.ConfigurationState",
"type": "object",
"required": [
"severity",
"_text"
],
"properties": {
"severity": {
"description": "4=ok; 5=replacement_is_standing_by,removing_delayed; 2=error_in_configuration_file,changed_file_not_loaded,resource_is_missing",
"type": "integer"
},
"_text": {
"javaType": "com.sos.joc.model.common.ConfigurationStateText",
"type": "string",
"enum": [
"ERROR_IN_CONFIGURATION_FILE",
"CHANGED_FILE_NOT_LOADED",
"REMOVING_DELAYED",
"RESOURCE_IS_MISSING",
"REPLACEMENT_IS_STANDING_BY",
"OK"
]
},
"message": {
"description": "contains e.g. error message",
"type": "string"
}
}
},
"ordersSummary": {
"description": "only relevant for order jobs and is empty if job's order queue is empty",
"javaType": "com.sos.joc.model.order.OrdersSummary",
"type": "object",
"properties": {
"pending": {
"type": "integer",
"minimum": 0
},
"running": {
"type": "integer",
"minimum": 0
},
"suspended": {
"type": "integer",
"minimum": 0
},
"setback": {
"type": "integer",
"minimum": 0
},
"waitingForResource": {
"type": "integer",
"minimum": 0
},
"blacklist": {
"type": "integer",
"minimum": 0
}
}
}
}
}
}
}
}
{ "jobChain": { "path": "/examples/56_NestedJobChains/JobChainB", "numOfNodes": 4, "ordersSummary": { "suspended": 0, "running": 0, "blacklist": 0, "waitingForResource": 0, "setback": 0, "pending": 0 }, "numOfOrders": 0, "state": { "_text": "ACTIVE", "severity": 4 }, "name": "JobChainB", "nodes": [{ "job": { "nextPeriodBegin": "", "name": "JobB100", "numOfQueuedTasks": 0, "allTasks": 78, "stateText": "JobB100 : job starting", "state": { "_text": "PENDING", "severity": 1 }, "numOfRunningTasks": 0, "path": "/examples/56_NestedJobChains/JobB100", "surveyDate": "2016-09-23T11:14:00Z", "allSteps": 78 }, "numOfOrders": 0, "name": "1", "state": { "_text": "ACTIVE", "severity": 4 } }, { "job": { "nextPeriodBegin": "", "name": "JobB200", "numOfQueuedTasks": 0, "allTasks": 78, "stateText": "JobB200 : job starting", "state": { "_text": "PENDING", "severity": 1 }, "numOfRunningTasks": 0, "path": "/examples/56_NestedJobChains/JobB200", "surveyDate": "2016-09-23T11:14:00Z", "allSteps": 78 }, "numOfOrders": 0, "name": "2", "state": { "_text": "ACTIVE", "severity": 4 } }, { "job": { "nextPeriodBegin": "", "name": "JobB300", "numOfQueuedTasks": 0, "allTasks": 78, "stateText": "JobB300 : job starting", "state": { "_text": "PENDING", "severity": 1 }, "numOfRunningTasks": 0, "path": "/examples/56_NestedJobChains/JobB300", "surveyDate": "2016-09-23T11:14:00Z", "allSteps": 78 }, "numOfOrders": 0, "name": "3", "state": { "_text": "ACTIVE", "severity": 4 } }, { "job": { "nextPeriodBegin": "", "name": "JobB400", "numOfQueuedTasks": 0, "allTasks": 78, "stateText": "JobB400 : job starting", "state": { "_text": "PENDING", "severity": 1 }, "numOfRunningTasks": 0, "path": "/examples/56_NestedJobChains/JobB400", "surveyDate": "2016-09-23T11:14:01Z", "allSteps": 78 }, "numOfOrders": 0, "name": "4", "state": { "_text": "ACTIVE", "severity": 4 } }], "surveyDate": "2016-09-23T11:14:00Z" }, "deliveryDate": "2016-09-23T11:14:00Z" }
{
"jobChain": {
"path": "/examples/56_NestedJobChains/JobChainB",
"numOfNodes": 4,
"ordersSummary": {
"suspended": 0,
"running": 0,
"blacklist": 0,
"waitingForResource": 0,
"setback": 0,
"pending": 0
},
"numOfOrders": 0,
"state": {
"_text": "ACTIVE",
"severity": 4
},
"name": "JobChainB",
"nodes": [{
"job": {
"nextPeriodBegin": "",
"name": "JobB100",
"numOfQueuedTasks": 0,
"allTasks": 78,
"stateText": "JobB100 : job starting",
"state": {
"_text": "PENDING",
"severity": 1
},
"numOfRunningTasks": 0,
"path": "/examples/56_NestedJobChains/JobB100",
"surveyDate": "2016-09-23T11:14:00Z",
"allSteps": 78
},
"numOfOrders": 0,
"name": "1",
"state": {
"_text": "ACTIVE",
"severity": 4
}
}, {
"job": {
"nextPeriodBegin": "",
"name": "JobB200",
"numOfQueuedTasks": 0,
"allTasks": 78,
"stateText": "JobB200 : job starting",
"state": {
"_text": "PENDING",
"severity": 1
},
"numOfRunningTasks": 0,
"path": "/examples/56_NestedJobChains/JobB200",
"surveyDate": "2016-09-23T11:14:00Z",
"allSteps": 78
},
"numOfOrders": 0,
"name": "2",
"state": {
"_text": "ACTIVE",
"severity": 4
}
}, {
"job": {
"nextPeriodBegin": "",
"name": "JobB300",
"numOfQueuedTasks": 0,
"allTasks": 78,
"stateText": "JobB300 : job starting",
"state": {
"_text": "PENDING",
"severity": 1
},
"numOfRunningTasks": 0,
"path": "/examples/56_NestedJobChains/JobB300",
"surveyDate": "2016-09-23T11:14:00Z",
"allSteps": 78
},
"numOfOrders": 0,
"name": "3",
"state": {
"_text": "ACTIVE",
"severity": 4
}
}, {
"job": {
"nextPeriodBegin": "",
"name": "JobB400",
"numOfQueuedTasks": 0,
"allTasks": 78,
"stateText": "JobB400 : job starting",
"state": {
"_text": "PENDING",
"severity": 1
},
"numOfRunningTasks": 0,
"path": "/examples/56_NestedJobChains/JobB400",
"surveyDate": "2016-09-23T11:14:01Z",
"allSteps": 78
},
"numOfOrders": 0,
"name": "4",
"state": {
"_text": "ACTIVE",
"severity": 4
}
}],
"surveyDate": "2016-09-23T11:14:00Z"
},
"deliveryDate": "2016-09-23T11:14:00Z"
}
|