200 |
Each order can have a compact or detailed response. It depends on the parameter compact .
- Fix required fields are
- surveyDate
- path
- id
- jobChain
- state (name of the node)
- job
- processingState (e.g. suspended, waiting_for_agent, ...)
- _type (permanent, ad_hoc, file_order)
- Additional variable required fields depends on the orders' processingState
(pending, running, waitingForResource, setback, suspended, blacklist) where waitingForResource means orders which have the processingState (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)
- nextStartTime (for pending, job_not_in_period, node_delay orders)
- historyId (for all except pending orders)
- startedAt (for all except pending orders)
- taskId (for running orders)
- setback (for setback orders)
- lock (for waiting_for_lock orders)
- processClass (for waiting_for_process, waiting_for_agent orders)
- The compact view has the following optional fields
- title
- processedBy (for running, blacklist orders)
- configurationStatus
- The detailed view has the following optional fields in addition to the compact view
- stateText
- endState (name of the end node)
- priority
- params
|
|
application/json
model |
example
{
"title": "order with delivery date (volatile part)",
"$schema": "http://json-schema.org/draft-04/schema#",
"javaType": "com.sos.joc.model.order.OrderV200",
"type": "object",
"required": [
"deliveryDate",
"order"
],
"properties": {
"deliveryDate": {
"description": "Current date of the JOC server/REST service. Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ",
"type": "string",
"format": "date-time"
},
"order": {
"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
}
}
}
}
}
{ "deliveryDate": "2016-09-23T11:13:44Z", "order": { "processedBy": "", "job": "/sos/jitl/JobChainStart", "jobChain": "/examples/37_JobChainExitCodeHandling/01_JobChainA", "orderId": "ExitCode_3", "lock": "", "endState": "", "nextStartTime": "2016-07-20T06:00:00.000Z", "processClass": "", "stateText": "", "inProcessSince": "", "processingState": { "_text": "PENDING", "severity": 1 }, "taskId": 0, "state": "Start", "setback": "", "path": "/examples/37_JobChainExitCodeHandling/01_JobChainA,ExitCode_3", "surveyDate": "2016-09-23T11:13:47Z", "_type": "permanent", "params": [{ "value": "3", "name": "order_param_exit_code" }] } }
{
"deliveryDate": "2016-09-23T11:13:44Z",
"order": {
"processedBy": "",
"job": "/sos/jitl/JobChainStart",
"jobChain": "/examples/37_JobChainExitCodeHandling/01_JobChainA",
"orderId": "ExitCode_3",
"lock": "",
"endState": "",
"nextStartTime": "2016-07-20T06:00:00.000Z",
"processClass": "",
"stateText": "",
"inProcessSince": "",
"processingState": {
"_text": "PENDING",
"severity": 1
},
"taskId": 0,
"state": "Start",
"setback": "",
"path": "/examples/37_JobChainExitCodeHandling/01_JobChainA,ExitCode_3",
"surveyDate": "2016-09-23T11:13:47Z",
"_type": "permanent",
"params": [{
"value": "3",
"name": "order_param_exit_code"
}]
}
}
|