JOC API

/order/p

POST

order (permanent part)

Parameters in the POST body schema

Name	Type	Description	Example	Default
`jobschedulerId`	required, string	JobScheduler Master ID	scheduler
`jobChain`	required, string	Path of a job chain	/sos/reporting/Inventory
`orderId`	required; string	The id of an order	inventory
`compact`	optional, boolean	Response has a compact version if this parameter is true		false

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": "order filter",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.order.OrderFilter",
    "type": "object",
    "required": [
        "jobschedulerId",
        "jobChain",
        "orderId"
    ],
    "properties": {
        "jobschedulerId": {
            "type": "string",
            "pattern": "^[^/\\<>?:\"|*]*$",
            "maxLength": 100
        },
        "jobChain": {
            "description": "absolute path based on live folder of a JobScheduler object.",
            "type": "string",
            "pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
            "maxLength": 255
        },
        "orderId": {
            "type": "string",
            "pattern": "^[^<>]*$",
            "maxLength": 255
        },
        "compact": {
            "description": "controls if the object view is compact or detailed",
            "type": "boolean",
            "default": false
        },
        "suppressNotExistException": {
            "description": "controls if an exception raises when Object doesn't exist",
            "type": "boolean",
            "default": true
        }
    }
}

{ "jobschedulerId": "scheduler", "compact": true, "jobChain": "/test/foo/bar1", "orderId": "order1" }

{
    "jobschedulerId": "scheduler",
    "compact": true,
    "jobChain": "/test/foo/bar1",
    "orderId": "order1"
}

Responses

Code	Description	Body
200	Each order can have a compact or detailed response. It depends on the parameter `compact`. Note that no ad hoc or file order is permanent! Required fields are surveyDate path orderId jobChain estimatedDuration The compact view has the following optional fields title The detailed view has the following optional fields in addition to the compact view initialState (name of the start node) endState (name of the end node) priority params configurationDate	application/json model \| example { "title": "order with delivray date (permanent part)", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.order.OrderP200", "type": "object", "required": [ "deliveryDate", "order" ], "properties": { "deliveryDate": { "description": "Date time. 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.OrderP", "type": "object", "description": "compact=true then ONLY surveyDate, path, id, jobChain and _type are responded, title is optional", "required": [ "surveyDate", "path", "orderId", "jobChain", "estimatedDuration" ], "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 }, "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 }, "_type": { "javaType": "com.sos.joc.model.order.OrderType", "type": "string", "description": "the type of the order", "enum": [ "PERMANENT", "AD_HOC", "FILE_ORDER" ] }, "title": { "type": "string" }, "initialState": { "description": "the name of the start node", "type": "string" }, "endState": { "description": "the name of the end node", "type": "string" }, "estimatedDuration": { "type": "integer", "minimum": 0 }, "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 } } } } } { "deliveryDate": "2016-09-23T11:13:41Z", "order": { "estimatedDuration": 2, "params": [{ "value": "3", "name": "order_param_exit_code" }], "_type": "permanent", "configurationDate": "2016-09-23T11:13:44Z", "jobChain": "/examples/37_JobChainExitCodeHandling/01_JobChainA", "path": "/examples/37_JobChainExitCodeHandling/01_JobChainA,ExitCode_3", "title": "Exit Code 3 : Skip Node 400", "surveyDate": "2016-09-23T11:13:44Z", "orderId": "ExitCode_3" } } { "deliveryDate": "2016-09-23T11:13:41Z", "order": { "estimatedDuration": 2, "params": [{ "value": "3", "name": "order_param_exit_code" }], "_type": "permanent", "configurationDate": "2016-09-23T11:13:44Z", "jobChain": "/examples/37_JobChainExitCodeHandling/01_JobChainA", "path": "/examples/37_JobChainExitCodeHandling/01_JobChainA,ExitCode_3", "title": "Exit Code 3 : Skip Node 400", "surveyDate": "2016-09-23T11:13:44Z", "orderId": "ExitCode_3" } }
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 }