JOC API

/daily_plan/projections/dates

POST

Gets the start times of date range of the daily plan projections

Parameters in the POST body schema

Name	Type	Description	Example	Default
	Following elements filter the projections. All filter elements will be combined with "and". The elements in the lists schedulePaths, scheduleFolders, workflowPaths, workflowFolders and controllerIds will be combined with "or".
`dateFrom`	optional, string	The value has to have the format YYYY-MM-DD	2023-01-01
`dateTo`	optional, string	The value has to have the format YYYY-MM-DD	2023-12-31
`schedulePaths`	optional, array[string]	Filters all projections that have been calculated with one of the given schedules in schedulePaths.	["/path/mySchedule"]
`scheduleFolders`	optional, array[object]	Filters all projections that have been calculated 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 projections that have been calculated with one of the given workflows in workflowsPaths.	["/path/to/workflow"]
`workflowFolders`	optional, array[object]	Filters all projections that have been calculated with 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 }]
`withoutStartTime`	optional, boolean	If true, the workflows that have a start time for a day are considered. With false it is the other way round		false
`controllerIds`	optional, array[string]	Filters orders that have been generated for the Controller IDs that are in the list controllerIds	["myControllerId"]

Request

Name

Description

Example

Type

Constraints

Default

Headers

Accept-Encoding

If 'gzip' -> Content-Encoding of response is 'gzip'; recommended because of big response

gzip

string?

X-Access-Token*

Request requires authentication!

550e8400-e29b-11d4-a716-446655440000

string

Body

application/json

model | example

{
    "title": "daily plan projections request",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.dailyplan.projections.ProjectionsRequest",
    "type": "object",
    "properties": {
        "dateFrom": {
            "description": "ISO date YYYY-MM-DD",
            "type": "string",
            "format": "date"
        },
        "dateTo": {
            "description": "ISO date YYYY-MM-DD",
            "type": "string",
            "format": "date"
        },
        "controllerIds": {
            "type": "array",
            "items": {
                "type": "string",
                "pattern": "^[^/\\<>?:\"|*]*$",
                "maxLength": 100
            }
        },
        "schedulePaths": {
            "type": "array",
            "items": {
                "type": "string",
                "pattern": "^[^<>]*$",
                "maxLength": 255
            }
        },
        "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
            }
        },
        "workflowPaths": {
            "type": "array",
            "items": {
                "type": "string",
                "pattern": "^[^<>]*$",
                "maxLength": 255
            }
        },
        "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
            }
        },
        "withoutStartTime": {
            "type": "boolean",
            "default": false
        }
    },
    "additionalProperties": false
}

Responses

Code	Description	Body
200		application/json model \| example { "title": "daily plan projections response", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.dailyplan.projections.ProjectionsCalendarResponse", "type": "object", "description": "meta only for ./dates API", "required": [ "deliveryDate", "surveyDate" ], "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" }, "years": { "javaType": "com.sos.joc.model.dailyplan.projections.items.year.YearsItem", "type": "object", "additionalProperties": { "javaType": "com.sos.joc.model.dailyplan.projections.items.year.MonthsItem", "type": "object", "additionalProperties": { "javaType": "com.sos.joc.model.dailyplan.projections.items.year.MonthItem", "type": "object", "additionalProperties": { "javaType": "com.sos.joc.model.dailyplan.projections.items.year.DateItem", "type": "object", "description": "numOfPeriods and numOfNonPeriods are in the ./calendar response, periods and nonPeriods are in the ./dates response", "properties": { "planned": { "type": "boolean" }, "numOfPeriods": { "type": "integer", "minimum": 0 }, "numOfNonPeriods": { "type": "integer", "minimum": 0 }, "periods": { "type": "array", "items": { "javaType": "com.sos.joc.model.dailyplan.projections.items.year.DatePeriodItem", "type": "object", "required": [ "schedule" ], "properties": { "schedule": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "period": { "javaType": "com.sos.inventory.model.calendar.Period", "type": "object", "properties": { "singleStart": { "type": "string", "pattern": "^([0-1][0-9]\|2[0-4])(:[0-5][0-9]){1,2}$" }, "begin": { "type": "string", "pattern": "^([0-1][0-9]\|2[0-4])(:[0-5][0-9]){1,2}$" }, "end": { "type": "string", "pattern": "^([0-1][0-9]\|2[0-4])(:[0-5][0-9]){1,2}$" }, "repeat": { "type": "string", "pattern": "^([0-1][0-9]\|2[0-4])(:[0-5][0-9]){1,2}$" }, "whenHoliday": { "javaType": "com.sos.inventory.model.calendar.WhenHolidayType", "description": "default: SUPPRESS", "type": "string", "enum": [ "SUPPRESS", "IGNORE", "PREVIOUSNONWORKINGDAY", "NEXTNONWORKINGDAY" ] } } } } } }, "nonPeriods": { "type": "array", "items": { "javaType": "com.sos.joc.model.dailyplan.projections.items.year.DatePeriodItem", "type": "object", "required": [ "schedule" ], "properties": { "schedule": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "period": { "javaType": "com.sos.inventory.model.calendar.Period", "type": "object", "properties": { "singleStart": { "type": "string", "pattern": "^([0-1][0-9]\|2[0-4])(:[0-5][0-9]){1,2}$" }, "begin": { "type": "string", "pattern": "^([0-1][0-9]\|2[0-4])(:[0-5][0-9]){1,2}$" }, "end": { "type": "string", "pattern": "^([0-1][0-9]\|2[0-4])(:[0-5][0-9]){1,2}$" }, "repeat": { "type": "string", "pattern": "^([0-1][0-9]\|2[0-4])(:[0-5][0-9]){1,2}$" }, "whenHoliday": { "javaType": "com.sos.inventory.model.calendar.WhenHolidayType", "description": "default: SUPPRESS", "type": "string", "enum": [ "SUPPRESS", "IGNORE", "PREVIOUSNONWORKINGDAY", "NEXTNONWORKINGDAY" ] } } } } } } }, "additionalProperties": false } } } }, "meta": { "javaType": "com.sos.joc.model.dailyplan.projections.items.meta.MetaItem", "type": "object", "additionalProperties": { "javaType": "com.sos.joc.model.dailyplan.projections.items.meta.ControllerInfoItem", "type": "object", "additionalProperties": { "javaType": "com.sos.joc.model.dailyplan.projections.items.meta.ScheduleInfoItem", "type": "object", "required": [ "totalOrders", "workflows" ], "properties": { "totalOrders": { "type": "number", "format": "utc-millisec", "minimum": 0 }, "workflows": { "javaType": "com.sos.joc.model.dailyplan.projections.items.meta.WorkflowsItem", "type": "object", "additionalProperties": { "javaType": "com.sos.joc.model.dailyplan.projections.items.meta.WorkflowItem", "type": "object", "properties": { "avg": { "type": "number", "format": "utc-millisec", "minimum": 0 } }, "additionalProperties": false } }, "workflowPaths": { "description": "this property is only used for a shorter response of ./projections/day API", "type": "array", "uniqueItems": true, "items": { "description": "absolute path of an object.", "type": "string", "pattern": "^(/\|(/[^/\\\\<>?:\"\|*]+)+)$", "maxLength": 255, "minLength": 1 } } }, "additionalProperties": false } } } }, "additionalProperties": 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 'dates'	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	'dates' 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": "dates failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "dates 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 }