JOC API

/order/variables

POST

Gets variables that were returned by the jobs before specified position

Parameters in the POST body schema

Name	Type	Description	Example
`controllerId`	required, string	Controller ID	myController
`orderId`	required; string	The id of an order in the format #yyyy-mm-dd#Pnnnnnnnnnn-name	#2020-12-15#P0000000002-myFirstOrder
`position`	optional, array or string	The position can also be specified by the label of the instruction.	[2, "then", 0]

Request

Name

Description

Example

Type

Constraints

Default

Headers

X-Access-Token*

Request requires authentication!

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.OrderVariablesFilter",
    "type": "object",
    "required": [
        "controllerId",
        "orderId"
    ],
    "properties": {
        "controllerId": {
            "type": "string",
            "pattern": "^[^/\\<>?:\"|*]*$",
            "maxLength": 100,
            "minLength": 1
        },
        "orderId": {
            "type": "string",
            "pattern": "^[^<>]*$",
            "maxLength": 255,
            "minLength": 1
        },
        "position": {
            "anyOf": [{
                "description": "Actually, each even item is a string, each odd item is an integer",
                "type": "array",
                "minItems": 1,
                "items": {
                    "anyOf": [{
                        "type": "integer"
                    }, {
                        "type": "string"
                    }]
                }
            }, {
                "type": "string",
                "pattern": "^[^<>]*$",
                "maxLength": 255,
                "minLength": 1
            }]
        }
    }
}

{ "controllerId": "standalone", "orderId": "#2021-07-07#T5668412865-test", "position": [1] }

{
    "controllerId": "standalone",
    "orderId": "#2021-07-07#T5668412865-test",
    "position": [1]
}

Responses

Code	Description	Body
200	`variables`: It contains a merge of the returned values of all previous jobs `variablesNotSettable`: true or false It is true if the requested `position` is at the beginning of the Order's scope In this case a resume of the Order is only possible without setting any variables For example: The first position of the Workflow for a "main" Order or the first position of a branch in a fork for a "child" Order	application/json model \| example { "title": "available positions for a resume", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.order.OrdersPositions", "type": "object", "required": [ "deliveryDate" ], "properties": { "deliveryDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "surveyDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "workflowId": { "javaType": "com.sos.controller.model.workflow.WorkflowId", "type": "object", "required": [ "path" ], "properties": { "path": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "versionId": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 } }, "additionalProperties": false }, "positions": { "type": "array", "uniqueItems": true, "items": { "type": "object", "javaType": "com.sos.joc.model.order.Position", "properties": { "position": { "description": "Actually, each even item is a string, each odd item is an integer", "type": "array", "minItems": 1, "items": { "anyOf": [{ "type": "integer" }, { "type": "string" }] } }, "positionString": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "type": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "label": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 } }, "additionalProperties": false } }, "blockPositions": { "type": "array", "uniqueItems": true, "items": { "type": "object", "javaType": "com.sos.joc.model.order.Position", "properties": { "position": { "description": "Actually, each even item is a string, each odd item is an integer", "type": "array", "minItems": 1, "items": { "anyOf": [{ "type": "integer" }, { "type": "string" }] } }, "positionString": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "type": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "label": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 } }, "additionalProperties": false } } }, "additionalProperties": false } { "deliveryDate": "2021-07-08T17:10:33.938+0000", "surveyDate": "2021-07-07T14:35:33.961+0000", "workflowId": { "path": "/test/w1", "versionId": "dc6f31f8-9e7e-48ba-947a-f86e0f970055" }, "variables": { "hello": "world", "returnCode": 0 }, "variablesNotSettable": false } { "deliveryDate": "2021-07-08T17:10:33.938+0000", "surveyDate": "2021-07-07T14:35:33.961+0000", "workflowId": { "path": "/test/w1", "versionId": "dc6f31f8-9e7e-48ba-947a-f86e0f970055" }, "variables": { "hello": "world", "returnCode": 0 }, "variablesNotSettable": false }
401	Unauthorized!	application/json model \| example { "title": "authentication", "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "required": [ "isAuthenticated" ], "properties": { "user": { "type": "string" }, "accessToken": { "type": "string" }, "message": { "type": "string" }, "role": { "type": "string" }, "isAuthenticated": { "type": "boolean" }, "isPermitted": { "type": "boolean", "default": false }, "sessionTimeout": { "type": "integer", "default": 1800 }, "enableTouch": { "type": "boolean", "default": true } } } { "user": "root", "message": "Oops!", "isAuthenticated": false, "isPermitted": false } { "user": "root", "message": "Oops!", "isAuthenticated": false, "isPermitted": false }
403	Forbidden! The user doesn't have sufficient permissions for 'variables'	application/json model \| example { "title": "authentication", "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "required": [ "isAuthenticated" ], "properties": { "user": { "type": "string" }, "accessToken": { "type": "string" }, "message": { "type": "string" }, "role": { "type": "string" }, "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 ...", "role": "all", "isAuthenticated": true, "isPermitted": false } { "user": "root", "message": "You don't have sufficient permissions for ...", "role": "all", "isAuthenticated": true, "isPermitted": false }
420	'variables' 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": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "surveyDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "error": { "javaType": "com.sos.joc.model.common.Err", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "variables failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "variables failed!" } }
440	Login Timeout! The client's session has expired and must log in again.	application/json model \| example { "title": "authentication", "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "required": [ "isAuthenticated" ], "properties": { "user": { "type": "string" }, "accessToken": { "type": "string" }, "message": { "type": "string" }, "role": { "type": "string" }, "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", "role": "all", "isAuthenticated": false, "isPermitted": false } { "user": "root", "message": "Session has expired. Please log in again", "role": "all", "isAuthenticated": false, "isPermitted": false }