JOC API

/daily_plan/orders

POST

Gets orders from a daily plan interval

Parameters in the POST body schema

Name	Type	Description	Example	Default
	Following elements filter the orders that should be considered. All filter elements will be combined with "and". The elements in the lists schedulePaths, scheduleFolders, workflowPaths, workflowFolders and controllerIds will be combined with "or".
`dailyPlanDateFrom`	required, string	The value has to have the format YYYY-MM-DD The begin of the day range of the daily plan. Depends on the settings for daily plan timezone and daily plan period.	2020-12-31
`dailyPlanDateTo`	optional, string	The value has to have the format YYYY-MM-DD The end of the day range of the daily plan. Depends on the settings for daily plan timezone and daily plan period. If only one day of the daily plan is desired than specify `dailyPlanDateFrom` == `dailyPlanDateTo`	2020-12-31
`schedulePaths`	optional, array[string]	Filters all orders in the given daily plan range that have been generated with one of the given schedules in schedulePaths.	["/path/mySchedule"]
`scheduleFolders`	optional, array[object]	Filters all orders in the given daily plan range 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 }]
`workflowPaths`	optional, array[string]	Filters all orders in the given daily plan range that are assigned to one of the given workflows in workflowPaths.	["/path/to/workflow"]
`workflowFolders`	optional, array[object]	Filters all orders in the given daily plan range 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 }]
`tags`	optional, array[string]	Tags to be assigned to the workflow
`controllerIds`	optional, array[string]	Filters orders that have been generated for the Controller IDs that are in the list controllerIds	["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"]
`late`	optional, boolean	If true filters all orders that are late. Late means that the current time is after the planned time+2 minutes.		false
`states`	optional, array[string]	Filters all orders that have one of the states specified in this list of states. Possible values are: PLANNED SUBMITTED FINISHED	["PLANNED","FINISHED"]
`submissionHistoryIds`	optional, array[integer]	Filters all orders in the given daily plan range 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]

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 Definition",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.dailyplan.DailyPlanOrderFilterDef",
    "type": "object",
    "description": "Define the filter to get orders from the daily plan",
    "required": [
        "dailyPlanDateFrom"
    ],
    "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
            }
        },
        "tags": {
            "type": "array",
            "uniqueItems": true,
            "items": {
                "type": "string",
                "pattern": "^[^<>]*$",
                "maxLength": 255
            }
        },
        "orderIds": {
            "type": "array",
            "items": {
                "type": "string",
                "pattern": "^[^<>]*$",
                "maxLength": 255
            }
        },
        "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"
        },
        "dailyPlanDateFrom": {
            "description": "ISO date YYYY-MM-DD",
            "type": "string",
            "format": "date"
        },
        "dailyPlanDateTo": {
            "description": "ISO date YYYY-MM-DD",
            "type": "string",
            "format": "date"
        },
        "expandCycleOrders": {
            "description": "for internal use only: controls if the cycle order should be expanded in the answer",
            "type": "boolean",
            "default": false
        },
        "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": "Planned Orders", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.dailyplan.PlannedOrders", "type": "object", "required": [ "deliveryDate", "plannedOrderItems" ], "properties": { "deliveryDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "plannedOrderItems": { "type": "array", "items": { "type": "object", "javaType": "com.sos.joc.model.dailyplan.PlannedOrderItem", "required": [ "surveyDate", "workflowPath", "orderId", "plannedStartTime", "expectedEndTime", "startMode" ], "properties": { "controllerId": { "type": "string", "pattern": "^[^/\\<>?:\"\|]$", "maxLength": 100 }, "surveyDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "workflowPath": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "schedulePath": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "orderId": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "cyclicOrder": { "type": "object", "javaType": "com.sos.joc.model.dailyplan.CyclicOrderInfos", "properties": { "count": { "type": "integer", "minimum": 0 }, "firstOrderId": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "lastOrderId": { "type": "string", "pattern": "^[^<>]*$", "maxLength": 255 }, "firstStart": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "lastStart": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" } } }, "plannedStartTime": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "expectedEndTime": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "startTime": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "endTime": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "historyId": { "type": "string" }, "node": { "description": "only for orders", "type": "string" }, "exitCode": { "type": "integer", "minimum": 0 }, "error": { "javaType": "com.sos.joc.model.common.Err", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "startMode": { "description": "0=single_start, 1=start_start_repeat", "type": "integer", "default": 0 }, "period": { "description": "undefined for startMode=0", "required": [ "begin", "end", "repeat" ], "type": "object", "properties": { "begin": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "end": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "repeat": { "type": "number", "format": "utc-millisec", "minimum": 0 } } }, "late": { "type": "boolean" }, "submitted": { "type": "boolean" }, "state": { "javaType": "com.sos.joc.model.dailyplan.DailyPlanOrderState", "type": "object", "required": [ "severity", "_text" ], "properties": { "severity": { "type": "integer" }, "_text": { "javaType": "com.sos.joc.model.dailyplan.DailyPlanOrderStateText", "type": "string", "enum": [ "PLANNED", "SUBMITTED", "FINISHED" ] } } } } } } } }
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 'orders'	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	'orders' 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": "orders failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "orders 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 }