JOC API

/daily_plan/orders/submit

POST

Submits planned orders for a given daily plan

Parameters in the POST body schema

Name	Type	Description	Example
`controllerId`	required, string	Controller ID	myController
`filter`	required	Specify the filters elements to filter the orders that should be considered. Only planned orders will be considered and submitted to the Controller. All filter elements will be combined with "and". The elements in the lists schedulePaths, folders, workflowPaths, states will be combined with "or" The filter elements are dailyPlanDate schedulePaths folders workflowPaths submissionHistoryIds orderIds controllerIds
`dailyPlanDate`	required, string	The value has to have the format YYYY-MM-DD The day of the daily plan. Depends on the settings for daily plan timezone and daily plan period.	2020-12-31
`schedulePaths`	optional; array[string]	Filters all orders in the given daily plan that have been generated with one of the given schedules in schedulePaths.	["/path/mySchedule"]
`scheduleFolders`	optional; array[scheduleFolder]	Filters all orders in the given daily plan that have been generated with a schedule located in one of the given folders. Depending on the value for "recursive" in one of the subfolders recursively too.	[{ "folder": "/sos", "recursive": true }]
`workflowFolders`	optional; array[workflowFolder]	Filters all orders in the given daily plan that have been generated with a schedule assigned to a workflow located in one of the given folders. Depending on the value for "recursive" in one of the subfolders recursively too.	[{ "folder": "/sos", "recursive": true }]
`workflowPaths`	optional; array[string]	Filters all orders in the given daily plan that are assigned to one of the given workflows in workflowPaths.	[/path/to/workflow]
`submissionHistoryIds`	optional,array	Filters all orders in the given daily plan that have been generated by one of the given submissions. To retrieve submissionHistoryIds call /dailyplan/submissions. A submission can be manually executed or the automatically executed by the daily plan service.	[4711]
`controllerIds`	optional; array[string]	Filters orders that have been generated for the Controller IDs that are in the list controllerIds. The orders will be submitted to the Controller for that they have been planned before.	["myControllerId"]
`orderIds`	optional; array[string]	Filters all orders in the given daily plan that have one of the order IDs in the given list of orderIds.	["#2020-09-15#P0000000046-myOrderName"]
`auditLog`	optional, object	Object that contains `comment`, `timeSpent` and `ticketLink`.	{ "comment":"Operational requirement!", "timeSpent":2 }
`comment`	optional, string	Field in `auditLog` to comment this action, e.g. the reason.
`timeSpent`	optional, integer	Field in `auditLog` to enter the time spent in minutes.	5
`ticketLink`	optional, string	Field in `auditLog` to enter a link to a corresponding ticket.

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": "Daily Plan  Order Filter",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.dailyplan.DailyPlanOrderFilter",
    "type": "object",
    "description": "To get orders from the daily plan",
    "required": [
        "controllerId",
        "filter"
    ],
    "properties": {
        "controllerId": {
            "type": "string",
            "pattern": "^[^/\\<>?:\"|*]*$",
            "maxLength": 100
        },
        "overwrite": {
            "description": "controls if the order should be overwritten",
            "type": "boolean",
            "default": false
        },
        "withSubmit": {
            "description": "controls if the order should be submitted to the controller",
            "type": "boolean",
            "default": true
        },
        "expandCycleOrders": {
            "description": "controls if the cycle order should be expanded in the answer",
            "type": "boolean",
            "default": false
        },
        "filter": {
            "javaType": "com.sos.joc.model.dailyplan.DailyPlanOrderFilterDef",
            "type": "object",
            "description": "Define the filter To get orders from the daily plan",
            "properties": {
                "submissionHistoryIds": {
                    "type": "array",
                    "items": {
                        "type": "number",
                        "format": "utc-millisec",
                        "minimum": 0
                    }
                },
                "scheduleFolders": {
                    "type": "array",
                    "items": {
                        "type": "object",
                        "javaType": "com.sos.joc.model.common.Folder",
                        "required": [
                            "folder"
                        ],
                        "properties": {
                            "folder": {
                                "description": "absolute path of an object.",
                                "type": "string",
                                "pattern": "^(/|(/[^/\\\\<>?:\"|*]+)+)$",
                                "maxLength": 255,
                                "minLength": 1
                            },
                            "recursive": {
                                "type": "boolean",
                                "default": true
                            }
                        },
                        "additionalProperties": false
                    }
                },
                "workflowFolders": {
                    "type": "array",
                    "items": {
                        "type": "object",
                        "javaType": "com.sos.joc.model.common.Folder",
                        "required": [
                            "folder"
                        ],
                        "properties": {
                            "folder": {
                                "description": "absolute path of an object.",
                                "type": "string",
                                "pattern": "^(/|(/[^/\\\\<>?:\"|*]+)+)$",
                                "maxLength": 255,
                                "minLength": 1
                            },
                            "recursive": {
                                "type": "boolean",
                                "default": true
                            }
                        },
                        "additionalProperties": false
                    }
                },
                "schedulePaths": {
                    "type": "array",
                    "items": {
                        "type": "string",
                        "pattern": "^[^<>]*$",
                        "maxLength": 255
                    }
                },
                "workflowPaths": {
                    "type": "array",
                    "items": {
                        "type": "string",
                        "pattern": "^[^<>]*$",
                        "maxLength": 255
                    }
                },
                "orderIds": {
                    "type": "array",
                    "items": {
                        "type": "string"
                    }
                },
                "controllerIds": {
                    "type": "array",
                    "items": {
                        "type": "string",
                        "pattern": "^[^/\\<>?:\"|*]*$",
                        "maxLength": 100
                    }
                },
                "states": {
                    "type": "array",
                    "items": {
                        "javaType": "com.sos.joc.model.dailyplan.DailyPlanOrderStateText",
                        "type": "string",
                        "enum": [
                            "PLANNED",
                            "SUBMITTED",
                            "FINISHED"
                        ]
                    }
                },
                "late": {
                    "type": "boolean"
                },
                "dailyPlanDate": {
                    "description": "ISO date YYYY-MM-DD",
                    "type": "string",
                    "format": "date"
                },
                "schedulesFolder": {
                    "description": "absolute path of an object.",
                    "type": "string",
                    "pattern": "^(/|(/[^/\\\\<>?:\"|*]+)+)$",
                    "maxLength": 255,
                    "minLength": 1
                }
            }
        },
        "auditLog": {
            "javaType": "com.sos.joc.model.audit.AuditParams",
            "type": "object",
            "properties": {
                "comment": {
                    "type": "string",
                    "pattern": "^[^<>]*$",
                    "maxLength": 255
                },
                "timeSpent": {
                    "type": "integer",
                    "minimum": 0
                },
                "ticketLink": {
                    "type": "string",
                    "pattern": "^[^<>]*$",
                    "maxLength": 255
                }
            }
        }
    }
}

Responses

Code	Description	Body
200	Confirm submit successfully	application/json model \| example { "title": "ok answer", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.common.Ok", "type": "object", "required": [ "deliveryDate", "ok" ], "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" }, "ok": { "type": "boolean" } } } { "deliveryDate": "2016-05-05T21:13:35Z", "ok": true } { "deliveryDate": "2016-05-05T21:13:35Z", "ok": true }
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 'submit'	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	'submit' 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": "submit failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "submit 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 }