JOC API

/job_chain/p

POST

job chain (permanent part)

Parameters in the POST body schema

Name	Type	Description	Example	Default
`jobschedulerId`	required, string	JobScheduler Master ID	scheduler
`compact`	optional, boolean	Response has a compact version if this parameter is true		false
`jobChain`	required, string	Specifies the job chain by its path	/sos/reporting/Inventory

Request

Name

Description

Example

Type

Constraints

Default

Headers

X-Access-Token*

Request requires authentication!

550e8400-e29b-11d4-a716-446655440000

string

access_token*

Request requires authentication! This header is deprecated. Please use X-Access-Token

550e8400-e29b-11d4-a716-446655440000

string

Body

application/json

model | example

{
    "title": "jobChainFilter",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.jobChain.JobChainFilter",
    "type": "object",
    "required": [
        "jobschedulerId",
        "jobChain"
    ],
    "properties": {
        "jobschedulerId": {
            "type": "string",
            "pattern": "^[^/\\<>?:\"|*]*$",
            "maxLength": 100
        },
        "jobChain": {
            "description": "absolute path based on live folder of a JobScheduler object.",
            "type": "string",
            "pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
            "maxLength": 255
        },
        "compact": {
            "description": "controls if the object view is compact or detailed",
            "type": "boolean",
            "default": false
        },
        "compactView": {
            "type": "boolean",
            "default": false
        },
        "maxOrders": {
            "type": "integer",
            "minimum": 0
        }
    }
}

TODO

TODO

Responses

Code	Description	Body
200	Each job chain can have a compact or detailed response. It depends on the parameter `compact`. Required fields are surveyDate path name numOfNodes The compact view has the following optional fields title maxOrders distributed processClass fileWatchingProcessClass The detailed view has the following required fields in addition to the compact view nodes endNodes configurationDate The detailed view has the following optional fields in addition to the compact view fileOrderSources	application/json model \| example { "title": "job chain with delivery date (permanent part)", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.jobChain.JobChainP200", "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.JobChainP", "type": "object", "oneOf": [{ "description": "compact=true then ONLY required fields are responded and optional title, maxOrders, distributed, processClass, fileWatchingProcessClass", "required": [ "surveyDate", "path", "name", "numOfNodes" ] }, { "description": "parameter compact=false or unset, all other fields are optional", "required": [ "surveyDate", "path", "name", "numOfNodes", "nodes" ] }], "properties": { "surveyDate": { "description": "Date of the inventory data. 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" }, "title": { "type": "string" }, "maxOrders": { "type": "integer", "minimum": 0 }, "distributed": { "type": "boolean" }, "processClass": { "type": "string" }, "fileWatchingProcessClass": { "type": "string" }, "numOfNodes": { "type": "integer", "minimum": 0 }, "nodes": { "type": "array", "minItems": 1, "items": { "javaType": "com.sos.joc.model.jobChain.JobChainNodeP", "type": "object", "oneOf": [{ "description": "job chain node object with assigned a job", "required": [ "name", "nextNode", "errorNode", "job", "level" ] }, { "description": "job chain node object with assigned a job chain", "required": [ "name", "nextNode", "errorNode", "jobChain" ] }], "properties": { "name": { "type": "string" }, "nextNode": { "type": "string" }, "errorNode": { "type": "string" }, "job": { "javaType": "com.sos.joc.model.jobChain.JobChainNodeJobP", "type": "object", "required": [ "path" ], "properties": { "path": { "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 }, "documentation": { "description": "absolute path based on live folder of a JobScheduler object.", "type": "string", "pattern": "^(/\|(/[^/\\<>?:\"\|]+)+)$", "maxLength": 255 } } }, "jobChain": { "description": "job chain object is included in nestedJobChains collection", "javaType": "com.sos.joc.model.jobChain.JobChainNodeJobChainP", "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 } } }, "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" }, "onError": { "description": "possible values are 'suspend', 'setback' or it isn't set", "type": "string" }, "delay": { "type": "integer", "minimum": 0 }, "remove": { "description": "for file order sink", "type": "boolean" }, "move": { "description": "for file order sink, a directory path is expected", "type": "string" } } } }, "fileOrderSources": { "type": "array", "items": { "javaType": "com.sos.joc.model.jobChain.FileWatchingNodeP", "type": "object", "required": [ "directory", "regex" ], "properties": { "directory": { "type": "string" }, "nextNode": { "type": "string" }, "regex": { "type": "string" } } } }, "endNodes": { "description": "real end nodes or file sink nodes", "type": "array", "items": { "javaType": "com.sos.joc.model.jobChain.EndNode", "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" } } } }, "configurationDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "documentation": { "description": "absolute path based on live folder of a JobScheduler object.", "type": "string", "pattern": "^(/\|(/[^/\\<>?:\"\|]+)+)$", "maxLength": 255 } } }, "nestedJobChains": { "type": "array", "items": { "javaType": "com.sos.joc.model.jobChain.JobChainP", "type": "object", "oneOf": [{ "description": "compact=true then ONLY required fields are responded and optional title, maxOrders, distributed, processClass, fileWatchingProcessClass", "required": [ "surveyDate", "path", "name", "numOfNodes" ] }, { "description": "parameter compact=false or unset, all other fields are optional", "required": [ "surveyDate", "path", "name", "numOfNodes", "nodes" ] }], "properties": { "surveyDate": { "description": "Date of the inventory data. 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" }, "title": { "type": "string" }, "maxOrders": { "type": "integer", "minimum": 0 }, "distributed": { "type": "boolean" }, "processClass": { "type": "string" }, "fileWatchingProcessClass": { "type": "string" }, "numOfNodes": { "type": "integer", "minimum": 0 }, "nodes": { "type": "array", "minItems": 1, "items": { "javaType": "com.sos.joc.model.jobChain.JobChainNodeP", "type": "object", "oneOf": [{ "description": "job chain node object with assigned a job", "required": [ "name", "nextNode", "errorNode", "job", "level" ] }, { "description": "job chain node object with assigned a job chain", "required": [ "name", "nextNode", "errorNode", "jobChain" ] }], "properties": { "name": { "type": "string" }, "nextNode": { "type": "string" }, "errorNode": { "type": "string" }, "job": { "javaType": "com.sos.joc.model.jobChain.JobChainNodeJobP", "type": "object", "required": [ "path" ], "properties": { "path": { "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 }, "documentation": { "description": "absolute path based on live folder of a JobScheduler object.", "type": "string", "pattern": "^(/\|(/[^/\\<>?:\"\|]+)+)$", "maxLength": 255 } } }, "jobChain": { "description": "job chain object is included in nestedJobChains collection", "javaType": "com.sos.joc.model.jobChain.JobChainNodeJobChainP", "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 } } }, "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" }, "onError": { "description": "possible values are 'suspend', 'setback' or it isn't set", "type": "string" }, "delay": { "type": "integer", "minimum": 0 }, "remove": { "description": "for file order sink", "type": "boolean" }, "move": { "description": "for file order sink, a directory path is expected", "type": "string" } } } }, "fileOrderSources": { "type": "array", "items": { "javaType": "com.sos.joc.model.jobChain.FileWatchingNodeP", "type": "object", "required": [ "directory", "regex" ], "properties": { "directory": { "type": "string" }, "nextNode": { "type": "string" }, "regex": { "type": "string" } } } }, "endNodes": { "description": "real end nodes or file sink nodes", "type": "array", "items": { "javaType": "com.sos.joc.model.jobChain.EndNode", "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" } } } }, "configurationDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "documentation": { "description": "absolute path based on live folder of a JobScheduler object.", "type": "string", "pattern": "^(/\|(/[^/\\<>?:\"\|]+)+)$", "maxLength": 255 } } } } } } { "jobChain": { "path": "/examples/56_NestedJobChains/JobChainB", "name": "JobChainB", "numOfNodes": 4, "configurationDate": "2016-09-23T11:13:48Z", "title": "JobChainB", "endNodes": [{ "name": "Success" }, { "name": "Error" }], "nodes": [{ "nextNode": "2", "name": "1", "job": { "jobChains": [ "/examples/56_NestedJobChains/JobChainB" ], "name": "JobB100", "isOrderJob": true, "maxTasks": 1, "configurationDate": "2016-09-23T11:13:48Z", "title": "Shell Job", "usedInJobChains": 1, "path": "/examples/56_NestedJobChains/JobB100", "surveyDate": "2016-09-23T11:13:48Z", "estimatedDuration": 2 }, "errorNode": "Error" }, { "nextNode": "3", "name": "2", "job": { "jobChains": [ "/examples/56_NestedJobChains/JobChainB" ], "name": "JobB200", "isOrderJob": true, "maxTasks": 1, "configurationDate": "2016-09-23T11:13:48Z", "title": "Shell Job", "usedInJobChains": 1, "path": "/examples/56_NestedJobChains/JobB200", "surveyDate": "2016-09-23T11:13:48Z", "estimatedDuration": 2 }, "errorNode": "Error" }, { "nextNode": "4", "name": "3", "job": { "jobChains": [ "/examples/56_NestedJobChains/JobChainB" ], "name": "JobB300", "isOrderJob": true, "maxTasks": 1, "configurationDate": "2016-09-23T11:13:48Z", "title": "Shell Job", "usedInJobChains": 1, "path": "/examples/56_NestedJobChains/JobB300", "surveyDate": "2016-09-23T11:13:48Z", "estimatedDuration": 2 }, "errorNode": "Error" }, { "nextNode": "Success", "name": "4", "job": { "jobChains": [ "/examples/56_NestedJobChains/JobChainB" ], "name": "JobB400", "isOrderJob": true, "maxTasks": 1, "configurationDate": "2016-09-23T11:13:48Z", "title": "Shell Job", "usedInJobChains": 1, "path": "/examples/56_NestedJobChains/JobB400", "surveyDate": "2016-09-23T11:13:48Z", "estimatedDuration": 2 }, "errorNode": "Error" }], "surveyDate": "2016-09-23T11:13:48Z" }, "deliveryDate": "2016-09-23T11:13:47Z" } { "jobChain": { "path": "/examples/56_NestedJobChains/JobChainB", "name": "JobChainB", "numOfNodes": 4, "configurationDate": "2016-09-23T11:13:48Z", "title": "JobChainB", "endNodes": [{ "name": "Success" }, { "name": "Error" }], "nodes": [{ "nextNode": "2", "name": "1", "job": { "jobChains": [ "/examples/56_NestedJobChains/JobChainB" ], "name": "JobB100", "isOrderJob": true, "maxTasks": 1, "configurationDate": "2016-09-23T11:13:48Z", "title": "Shell Job", "usedInJobChains": 1, "path": "/examples/56_NestedJobChains/JobB100", "surveyDate": "2016-09-23T11:13:48Z", "estimatedDuration": 2 }, "errorNode": "Error" }, { "nextNode": "3", "name": "2", "job": { "jobChains": [ "/examples/56_NestedJobChains/JobChainB" ], "name": "JobB200", "isOrderJob": true, "maxTasks": 1, "configurationDate": "2016-09-23T11:13:48Z", "title": "Shell Job", "usedInJobChains": 1, "path": "/examples/56_NestedJobChains/JobB200", "surveyDate": "2016-09-23T11:13:48Z", "estimatedDuration": 2 }, "errorNode": "Error" }, { "nextNode": "4", "name": "3", "job": { "jobChains": [ "/examples/56_NestedJobChains/JobChainB" ], "name": "JobB300", "isOrderJob": true, "maxTasks": 1, "configurationDate": "2016-09-23T11:13:48Z", "title": "Shell Job", "usedInJobChains": 1, "path": "/examples/56_NestedJobChains/JobB300", "surveyDate": "2016-09-23T11:13:48Z", "estimatedDuration": 2 }, "errorNode": "Error" }, { "nextNode": "Success", "name": "4", "job": { "jobChains": [ "/examples/56_NestedJobChains/JobChainB" ], "name": "JobB400", "isOrderJob": true, "maxTasks": 1, "configurationDate": "2016-09-23T11:13:48Z", "title": "Shell Job", "usedInJobChains": 1, "path": "/examples/56_NestedJobChains/JobB400", "surveyDate": "2016-09-23T11:13:48Z", "estimatedDuration": 2 }, "errorNode": "Error" }], "surveyDate": "2016-09-23T11:13:48Z" }, "deliveryDate": "2016-09-23T11:13:47Z" }
401	Unauthorized!	application/json model \| example { "title": "security", "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "required": [ "isAuthenticated" ], "properties": { "user": { "type": "string" }, "accessToken": { "type": "string" }, "message": { "type": "string" }, "hasRole": { "type": "boolean", "default": false }, "isAuthenticated": { "type": "boolean" }, "isPermitted": { "type": "boolean", "default": false }, "sessionTimeout": { "type": "integer", "default": 1800 }, "enableTouch": { "type": "boolean", "default": true } } } { "user": "root", "message": "Oops!", "hasRole": false, "isAuthenticated": false, "isPermitted": false } { "user": "root", "message": "Oops!", "hasRole": false, "isAuthenticated": false, "isPermitted": false }
403	Forbidden! The user doesn't have sufficient permissions for 'p'	application/json model \| example { "title": "security", "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "required": [ "isAuthenticated" ], "properties": { "user": { "type": "string" }, "accessToken": { "type": "string" }, "message": { "type": "string" }, "hasRole": { "type": "boolean", "default": false }, "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 ...", "hasRole": false, "isAuthenticated": true, "isPermitted": false } { "user": "root", "message": "You don't have sufficient permissions for ...", "hasRole": false, "isAuthenticated": true, "isPermitted": false }
420	'p' 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": "Date time. Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ", "type": "string", "format": "date-time" }, "surveyDate": { "description": "is also required for permanent or volatile requests", "type": "string", "format": "date-time" }, "error": { "javaType": "com.sos.joc.model.common.Err", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "pattern": "^[^<>]*$", "maxLength": 255 }, "message": { "type": "string" } } } } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "p failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "p failed!" } }
440	Login Timeout! The client's session has expired and must log in again.	application/json model \| example { "title": "security", "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "required": [ "isAuthenticated" ], "properties": { "user": { "type": "string" }, "accessToken": { "type": "string" }, "message": { "type": "string" }, "hasRole": { "type": "boolean", "default": false }, "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", "hasRole": false, "isAuthenticated": false, "isPermitted": false } { "user": "root", "message": "Session has expired. Please log in again", "hasRole": false, "isAuthenticated": false, "isPermitted": false }