JOC API

/calendars/used

POST

Sends compact collection of calendar items with objects which use it

Parameters in the POST body schema

Name	Type	Description	Example
`jobschedulerId`	required, string	JobScheduler Master ID	scheduler
`regex`	optional, string	Regular expression to filter the collection	.*
`folders`	optional, array	collection of folder objects	[{ "folder": "/sos", "recursive": true }]
`type`	optional, String	Calendar type to filter the collection. Possible values are WORKING_DAYS and NON_WORKING_DAYS
`categories`	optional, array	Categories of a calendar.	[ "myCategory", "myCategory2" ]
`calendars`	optional, array	Filtered response by a collection of calendars specified by its calendar path. Some other parameters such as `calendarIds`, `folders`, `regex`, `type` and `categories` are ignored if this parameter is defined.	[ "/sos/myCalendar", "/sos/myCalendar2" ]
`calendarIds`	optional, array	Filtered response by a collection of calendars specified by its calendar id. Some other parameters such as `folders`, `regex`, `type` and `categories` are ignored if this parameter is defined.	[ 4711, 4712 ]

Request

Name

Description

Example

Type

Constraints

Default

Headers

X-Access-Token*

Request requires authentication!

550e8400-e29b-11d4-a716-446655440000

string

access_token*

Request requires authentication! This header is deprecated. Please use X-Access-Token

550e8400-e29b-11d4-a716-446655440000

string

Body

application/json

model | example

{
    "title": "calendars filter",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.calendar.CalendarsFilter",
    "type": "object",
    "required": [
        "jobschedulerId"
    ],
    "properties": {
        "jobschedulerId": {
            "type": "string",
            "pattern": "^[^/\\<>?:\"|*]*$",
            "maxLength": 100
        },
        "calendarIds": {
            "type": "array",
            "items": {
                "type": "number",
                "format": "utc-millisec",
                "minimum": 0
            }
        },
        "calendars": {
            "type": "array",
            "items": {
                "description": "absolute path based on live folder of a JobScheduler object.",
                "type": "string",
                "pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
                "maxLength": 255
            }
        },
        "compact": {
            "description": "controls if the object view is compact or detailed",
            "type": "boolean",
            "default": false
        },
        "type": {
            "type": "string",
            "pattern": "^[^<>]*$",
            "maxLength": 255
        },
        "categories": {
            "type": "array",
            "items": {
                "type": "string",
                "pattern": "^[^<>]*$",
                "maxLength": 255
            }
        },
        "regex": {
            "description": "regular expression to filter JobScheduler objects by matching the path",
            "type": "string",
            "pattern": "^((?!<script( |>)|<svg/on).)*$"
        },
        "folders": {
            "type": "array",
            "items": {
                "javaType": "com.sos.joc.model.common.Folder",
                "type": "object",
                "required": [
                    "folder"
                ],
                "properties": {
                    "folder": {
                        "description": "absolute path based on live folder of a JobScheduler object.",
                        "type": "string",
                        "pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
                        "maxLength": 255
                    },
                    "recursive": {
                        "type": "boolean",
                        "default": true
                    }
                }
            }
        },
        "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	Each calendar can have a compact or detailed response. It depends on the parameter `compact`. Fix required fields are id path name type category title to from The detailed view has the following field in addition to the compact view includes excludes	application/json model \| example { "title": "calendars", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.calendar.Calendars", "type": "object", "required": [ "deliveryDate", "calendars" ], "properties": { "deliveryDate": { "description": "Date time. Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ", "type": "string", "format": "date-time" }, "calendars": { "type": "array", "items": { "javaType": "com.sos.joc.model.calendar.Calendar", "type": "object", "properties": { "id": { "type": "number", "format": "utc-millisec", "minimum": 0 }, "path": { "description": "absolute path based on live folder of a JobScheduler object.", "type": "string", "pattern": "^(/\|(/[^/\\<>?:\"\|]+)+)$", "maxLength": 255 }, "name": { "type": "string", "pattern": "^[^/\\<>?:\"\|]$", "maxLength": 255 }, "basedOn": { "description": "absolute path based on live folder of a JobScheduler object.", "type": "string", "pattern": "^(/\|(/[^/\\<>?:\"\|]+)+)$", "maxLength": 255 }, "documentation": { "description": "absolute path based on live folder of a JobScheduler object.", "type": "string", "pattern": "^(/\|(/[^/\\<>?:\"\|]+)+)$", "maxLength": 255 }, "type": { "javaType": "com.sos.joc.model.calendar.CalendarType", "type": "string", "enum": [ "WORKING_DAYS", "NON_WORKING_DAYS", "JOB", "ORDER", "SCHEDULE" ], "default": "WORKING_DAYS" }, "category": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "title": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "from": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "to": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "periods": { "type": "array", "items": { "javaType": "com.sos.joc.model.calendar.Period", "type": "object", "properties": { "singleStart": { "type": "string", "pattern": "^[0-9:]$" }, "begin": { "type": "string", "pattern": "^[0-9:]$" }, "end": { "type": "string", "pattern": "^[0-9:]$" }, "repeat": { "type": "string", "pattern": "^[0-9:]$" }, "absoluteRepeat": { "type": "string", "pattern": "^[0-9:]$" }, "whenHoliday": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 } } } }, "includes": { "javaType": "com.sos.joc.model.calendar.Frequencies", "type": "object", "properties": { "dates": { "type": "array", "items": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" } }, "weekdays": { "type": "array", "items": { "javaType": "com.sos.joc.model.calendar.WeekDays", "type": "object", "required": [ "days" ], "properties": { "from": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "to": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "days": { "type": "array", "items": { "description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday, 7=Sunday (again)", "type": "integer", "minimum": 0, "maximum": 7 } } } } }, "monthdays": { "type": "array", "items": { "javaType": "com.sos.joc.model.calendar.MonthDays", "type": "object", "properties": { "from": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "to": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "days": { "type": "array", "items": { "description": "digit from 1-31", "type": "integer", "minimum": 1, "maximum": 31 } }, "weeklyDays": { "type": "array", "items": { "javaType": "com.sos.joc.model.calendar.WeeklyDay", "type": "object", "properties": { "day": { "description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday, 7=Sunday (again)", "type": "integer", "minimum": 0, "maximum": 7 }, "weekOfMonth": { "type": "integer", "minimum": 1, "maximum": 5 } } } } } } }, "ultimos": { "type": "array", "items": { "javaType": "com.sos.joc.model.calendar.MonthDays", "type": "object", "properties": { "from": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "to": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "days": { "type": "array", "items": { "description": "digit from 1-31", "type": "integer", "minimum": 1, "maximum": 31 } }, "weeklyDays": { "type": "array", "items": { "javaType": "com.sos.joc.model.calendar.WeeklyDay", "type": "object", "properties": { "day": { "description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday, 7=Sunday (again)", "type": "integer", "minimum": 0, "maximum": 7 }, "weekOfMonth": { "type": "integer", "minimum": 1, "maximum": 5 } } } } } } }, "months": { "type": "array", "items": { "javaType": "com.sos.joc.model.calendar.Months", "type": "object", "required": [ "months" ], "properties": { "months": { "type": "array", "items": { "type": "integer", "minimum": 1, "maximum": 12 } }, "from": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "to": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "weekdays": { "type": "array", "items": { "javaType": "com.sos.joc.model.calendar.WeekDays", "type": "object", "required": [ "days" ], "properties": { "from": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "to": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "days": { "type": "array", "items": { "description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday, 7=Sunday (again)", "type": "integer", "minimum": 0, "maximum": 7 } } } } }, "monthdays": { "type": "array", "items": { "javaType": "com.sos.joc.model.calendar.MonthDays", "type": "object", "properties": { "from": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "to": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "days": { "type": "array", "items": { "description": "digit from 1-31", "type": "integer", "minimum": 1, "maximum": 31 } }, "weeklyDays": { "type": "array", "items": { "javaType": "com.sos.joc.model.calendar.WeeklyDay", "type": "object", "properties": { "day": { "description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday, 7=Sunday (again)", "type": "integer", "minimum": 0, "maximum": 7 }, "weekOfMonth": { "type": "integer", "minimum": 1, "maximum": 5 } } } } } } }, "ultimos": { "type": "array", "items": { "javaType": "com.sos.joc.model.calendar.MonthDays", "type": "object", "properties": { "from": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "to": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "days": { "type": "array", "items": { "description": "digit from 1-31", "type": "integer", "minimum": 1, "maximum": 31 } }, "weeklyDays": { "type": "array", "items": { "javaType": "com.sos.joc.model.calendar.WeeklyDay", "type": "object", "properties": { "day": { "description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday, 7=Sunday (again)", "type": "integer", "minimum": 0, "maximum": 7 }, "weekOfMonth": { "type": "integer", "minimum": 1, "maximum": 5 } } } } } } } } } }, "holidays": { "type": "array", "items": { "javaType": "com.sos.joc.model.calendar.Holidays", "type": "object", "properties": { "nationalCalendar": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "dates": { "type": "array", "items": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" } } } } }, "repetitions": { "type": "array", "items": { "javaType": "com.sos.joc.model.calendar.Repetition", "type": "object", "required": [ "repetition" ], "properties": { "from": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "to": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "repetition": { "javaType": "com.sos.joc.model.calendar.RepetitionText", "type": "string", "enum": [ "DAILY", "WEEKLY", "MONTHLY", "YEARLY" ] }, "step": { "type": "integer", "minimum": 1, "default": 1 } } } } } }, "excludes": { "javaType": "com.sos.joc.model.calendar.Frequencies", "type": "object", "properties": { "dates": { "type": "array", "items": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" } }, "weekdays": { "type": "array", "items": { "javaType": "com.sos.joc.model.calendar.WeekDays", "type": "object", "required": [ "days" ], "properties": { "from": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "to": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "days": { "type": "array", "items": { "description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday, 7=Sunday (again)", "type": "integer", "minimum": 0, "maximum": 7 } } } } }, "monthdays": { "type": "array", "items": { "javaType": "com.sos.joc.model.calendar.MonthDays", "type": "object", "properties": { "from": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "to": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "days": { "type": "array", "items": { "description": "digit from 1-31", "type": "integer", "minimum": 1, "maximum": 31 } }, "weeklyDays": { "type": "array", "items": { "javaType": "com.sos.joc.model.calendar.WeeklyDay", "type": "object", "properties": { "day": { "description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday, 7=Sunday (again)", "type": "integer", "minimum": 0, "maximum": 7 }, "weekOfMonth": { "type": "integer", "minimum": 1, "maximum": 5 } } } } } } }, "ultimos": { "type": "array", "items": { "javaType": "com.sos.joc.model.calendar.MonthDays", "type": "object", "properties": { "from": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "to": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "days": { "type": "array", "items": { "description": "digit from 1-31", "type": "integer", "minimum": 1, "maximum": 31 } }, "weeklyDays": { "type": "array", "items": { "javaType": "com.sos.joc.model.calendar.WeeklyDay", "type": "object", "properties": { "day": { "description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday, 7=Sunday (again)", "type": "integer", "minimum": 0, "maximum": 7 }, "weekOfMonth": { "type": "integer", "minimum": 1, "maximum": 5 } } } } } } }, "months": { "type": "array", "items": { "javaType": "com.sos.joc.model.calendar.Months", "type": "object", "required": [ "months" ], "properties": { "months": { "type": "array", "items": { "type": "integer", "minimum": 1, "maximum": 12 } }, "from": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "to": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "weekdays": { "type": "array", "items": { "javaType": "com.sos.joc.model.calendar.WeekDays", "type": "object", "required": [ "days" ], "properties": { "from": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "to": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "days": { "type": "array", "items": { "description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday, 7=Sunday (again)", "type": "integer", "minimum": 0, "maximum": 7 } } } } }, "monthdays": { "type": "array", "items": { "javaType": "com.sos.joc.model.calendar.MonthDays", "type": "object", "properties": { "from": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "to": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "days": { "type": "array", "items": { "description": "digit from 1-31", "type": "integer", "minimum": 1, "maximum": 31 } }, "weeklyDays": { "type": "array", "items": { "javaType": "com.sos.joc.model.calendar.WeeklyDay", "type": "object", "properties": { "day": { "description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday, 7=Sunday (again)", "type": "integer", "minimum": 0, "maximum": 7 }, "weekOfMonth": { "type": "integer", "minimum": 1, "maximum": 5 } } } } } } }, "ultimos": { "type": "array", "items": { "javaType": "com.sos.joc.model.calendar.MonthDays", "type": "object", "properties": { "from": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "to": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "days": { "type": "array", "items": { "description": "digit from 1-31", "type": "integer", "minimum": 1, "maximum": 31 } }, "weeklyDays": { "type": "array", "items": { "javaType": "com.sos.joc.model.calendar.WeeklyDay", "type": "object", "properties": { "day": { "description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday, 7=Sunday (again)", "type": "integer", "minimum": 0, "maximum": 7 }, "weekOfMonth": { "type": "integer", "minimum": 1, "maximum": 5 } } } } } } } } } }, "holidays": { "type": "array", "items": { "javaType": "com.sos.joc.model.calendar.Holidays", "type": "object", "properties": { "nationalCalendar": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "dates": { "type": "array", "items": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" } } } } }, "repetitions": { "type": "array", "items": { "javaType": "com.sos.joc.model.calendar.Repetition", "type": "object", "required": [ "repetition" ], "properties": { "from": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "to": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "repetition": { "javaType": "com.sos.joc.model.calendar.RepetitionText", "type": "string", "enum": [ "DAILY", "WEEKLY", "MONTHLY", "YEARLY" ] }, "step": { "type": "integer", "minimum": 1, "default": 1 } } } } } }, "usedBy": { "javaType": "com.sos.joc.model.calendar.UsedBy", "type": "object", "properties": { "deliveryDate": { "description": "Date time. Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ", "type": "string", "format": "date-time" }, "jobs": { "type": "array", "items": { "description": "absolute path based on live folder of a JobScheduler object.", "type": "string", "pattern": "^(/\|(/[^/\\<>?:\"\|]+)+)$", "maxLength": 255 } }, "orders": { "type": "array", "items": { "description": "absolute path based on live folder of a JobScheduler object.", "type": "string", "pattern": "^(/\|(/[^/\\<>?:\"\|]+)+)$", "maxLength": 255 } }, "jobstreams": { "type": "array", "items": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 } }, "schedules": { "type": "array", "items": { "description": "absolute path based on live folder of a JobScheduler object.", "type": "string", "pattern": "^(/\|(/[^/\\<>?:\"\|*]+)+)$", "maxLength": 255 } } } } } } } } }
401	Unauthorized!	application/json model \| example { "title": "security", "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "required": [ "isAuthenticated" ], "properties": { "user": { "type": "string" }, "accessToken": { "type": "string" }, "message": { "type": "string" }, "hasRole": { "type": "boolean", "default": false }, "isAuthenticated": { "type": "boolean" }, "isPermitted": { "type": "boolean", "default": false }, "sessionTimeout": { "type": "integer", "default": 1800 }, "enableTouch": { "type": "boolean", "default": true } } } { "user": "root", "message": "Oops!", "hasRole": false, "isAuthenticated": false, "isPermitted": false } { "user": "root", "message": "Oops!", "hasRole": false, "isAuthenticated": false, "isPermitted": false }
403	Forbidden! The user doesn't have sufficient permissions for 'used'	application/json model \| example { "title": "security", "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "required": [ "isAuthenticated" ], "properties": { "user": { "type": "string" }, "accessToken": { "type": "string" }, "message": { "type": "string" }, "hasRole": { "type": "boolean", "default": false }, "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 ...", "hasRole": false, "isAuthenticated": true, "isPermitted": false } { "user": "root", "message": "You don't have sufficient permissions for ...", "hasRole": false, "isAuthenticated": true, "isPermitted": false }
420	'used' 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": "Date time. Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ", "type": "string", "format": "date-time" }, "surveyDate": { "description": "is also required for permanent or volatile requests", "type": "string", "format": "date-time" }, "error": { "javaType": "com.sos.joc.model.common.Err", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "pattern": "^[^<>]*$", "maxLength": 255 }, "message": { "type": "string" } } } } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "used failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "used failed!" } }
440	Login Timeout! The client's session has expired and must log in again.	application/json model \| example { "title": "security", "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "required": [ "isAuthenticated" ], "properties": { "user": { "type": "string" }, "accessToken": { "type": "string" }, "message": { "type": "string" }, "hasRole": { "type": "boolean", "default": false }, "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", "hasRole": false, "isAuthenticated": false, "isPermitted": false } { "user": "root", "message": "Session has expired. Please log in again", "hasRole": false, "isAuthenticated": false, "isPermitted": false }