JOC API

/job/p

POST

job (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
`job`	required, string	Path of a job	/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": "jobFilter",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.job.JobFilter",
    "type": "object",
    "required": [
        "jobschedulerId",
        "job"
    ],
    "properties": {
        "jobschedulerId": {
            "type": "string",
            "pattern": "^[^/\\<>?:\"|*]*$",
            "maxLength": 100
        },
        "job": {
            "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
        }
    }
}

{ "jobschedulerId": "scheduler", "compact": true, "job": "/sos/housekeeping/scheduler_restart" }

{
    "jobschedulerId": "scheduler",
    "compact": true,
    "job": "/sos/housekeeping/scheduler_restart"
}

Responses

Code	Description	Body
200	Each job can have a compact or detailed response. It depends on the parameter `compact`. Required fields are surveyDate path name isOrderJob usedInJobChains estimatedDuration maxTasks (default:1) hasDescription (default:false) The compact view has the following optional fields processClass title The detailed view has the following required fields in addition to the compact view configurationDate The detailed view has the following optional fields in addition to the compact view params locks jobChains (only for order jobs) A job object as child of a job chain node in the response have only the following required fields path processClass and doesn't have any optional fields	application/json model \| example { "title": "job object with delivery date (permant part)", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.job.JobP200", "type": "object", "properties": { "deliveryDate": { "description": "Date time. Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ", "type": "string", "format": "date-time" }, "job": { "javaType": "com.sos.joc.model.job.JobP", "type": "object", "oneOf": [{ "description": "as child of nodes only path is required and processClass is optional", "required": [ "path" ] }, { "description": "compact=true then ONLY required fields are responded and title, processClass are optional", "required": [ "surveyDate", "path", "name", "isOrderJob", "isShellJob", "usedInJobChains", "estimatedDuration", "maxTasks", "hasDescription" ] }], "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 }, "isOrderJob": { "type": "boolean" }, "isShellJob": { "type": "boolean" }, "name": { "type": "string" }, "title": { "type": "string" }, "estimatedDuration": { "type": "integer", "minimum": 0 }, "processClass": { "description": "absolute path based on live folder of a JobScheduler object.", "type": "string", "pattern": "^(/\|(/[^/\\<>?:\"\|]+)+)$", "maxLength": 255 }, "maxTasks": { "type": "integer", "minimum": 0 }, "criticality": { "type": "string", "default": "normal" }, "locks": { "type": "array", "items": { "javaType": "com.sos.joc.model.job.LockUseP", "type": "object", "required": [ "path" ], "properties": { "path": { "description": "absolute path based on live folder of a JobScheduler object.", "type": "string", "pattern": "^(/\|(/[^/\\<>?:\"\|]+)+)$", "maxLength": 255 } } } }, "usedInJobChains": { "type": "integer", "minimum": 0 }, "jobChains": { "description": "Only relevant for order jobs when called /jobs/p/... or job/p/...", "type": "array", "items": { "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 }, "configurationDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" } } } } } { "deliveryDate": "2016-09-23T11:13:05Z", "job": { "jobChains": [ "/examples/55_JobSchedulerLaunchQueue/01_JQLJobChain1/JobChain100" ], "name": "JobA", "isOrderJob": true, "maxTasks": 1, "configurationDate": "2016-09-23T11:13:14Z", "title": "Simple Shell Job", "usedInJobChains": 1, "path": "/examples/55_JobSchedulerLaunchQueue/01_JQLJobChain1/JobA", "surveyDate": "2016-09-23T11:13:14Z", "estimatedDuration": 2 } } { "deliveryDate": "2016-09-23T11:13:05Z", "job": { "jobChains": [ "/examples/55_JobSchedulerLaunchQueue/01_JQLJobChain1/JobChain100" ], "name": "JobA", "isOrderJob": true, "maxTasks": 1, "configurationDate": "2016-09-23T11:13:14Z", "title": "Simple Shell Job", "usedInJobChains": 1, "path": "/examples/55_JobSchedulerLaunchQueue/01_JQLJobChain1/JobA", "surveyDate": "2016-09-23T11:13:14Z", "estimatedDuration": 2 } }
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 }