JOC API

/daily_plan/orders/generate

POST

Generates orders for a given daily plan

Parameters in the POST body schema

Name	Type	Description	Example	Default
`controllerId`	required, string	Controller ID	myController
`selector`	optional	Describes, for what schedules the orders should be generated for the given daily plan. All selectors will be combined with "or". The elements in the lists schedulePaths, folders, workflowPaths will be combined with "or" The schedules for what orders are to be generated can be selected with: schedulePaths folders workflowPaths
`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]	Generate orders for the given daily plan based on all of the given schedules in schedulePaths.	["/path/mySchedule"]
`folders`	optional; array[folder]	Generate orders for the given daily plan based on the schedules located in the given folders. Depending on the value for "recursive" also in one of the subfolders recursively.	[{ "folder": "/sos", "recursive": true }]	If no selector is specified then "folder":"/", "recursive":true
`workflowPaths`	optional; array[string]	Generate orders for the given daily plan based on the schedules that are assigned to one of the given workflows in workflowPaths.	[/path/to/workflow]
`controllerIds`	optional; array[string]	When empty, the schedules will be returned for those Controller Ids that have a deployed workflow for the given schedules (from the selector). When not empty, the orders will be returned for those Controller Ids that have a deployed workflow for the given schedules (from the selector) and that are included in the list controllerIds.	["myControllerId"]
`overwrite`	optional, boolean	if true, overwrite existing orders (same workflow, same start time, same schedule name). Any variables will be overwritten. if false, existing orders will not be overwritten.		false
`withSubmit`	optional, boolean	if true, the orders will be submitted to the Controller. if false, the order will be planned and not submitted to the Controller		false
`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 Selector",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.dailyplan.DailyPlanOrderSelector",
    "type": "object",
    "description": "To generate orders for the daily plan",
    "properties": {
        "controllerId": {
            "type": "string",
            "pattern": "^[^/\\<>?:\"|*]*$",
            "maxLength": 100
        },
        "dailyPlanDate": {
            "description": "ISO date YYYY-MM-DD",
            "type": "string",
            "format": "date"
        },
        "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
        },
        "controllerIds": {
            "type": "array",
            "items": {
                "type": "string",
                "pattern": "^[^/\\<>?:\"|*]*$",
                "maxLength": 100
            }
        },
        "selector": {
            "javaType": "com.sos.joc.model.dailyplan.DailyPlanOrderSelectorDef",
            "type": "object",
            "description": "Define the selector to generate orders for the daily plan",
            "properties": {
                "folders": {
                    "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
                    }
                }
            }
        },
        "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		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" } } }
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 'generate'	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	'generate' 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": "generate failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "generate 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 }