JOC API

/calendars

POST

Gets released calendars

Parameters in the POST body schema

Name	Type	Description	Example	Default
`calendarPaths`	optional, array[string]	Filters response by a collection of calendars specified by its calendar path. The parameters `folders`, `regex` and `type` are ignored if this parameter is defined.	[ "/sos/myCalendar", "/sos/myCalendar2" ]
`compact`	optional, boolean	A compact response is returned if this parameter is true		false
`regex`	optional, string	Regular expression to filter the collection	.*
`folders`	optional, array[object]	Limits the result to a collection of folders	[{ "folder": "/sos", "recursive": true }]
`type`	optional, string	Calendar type to filter the collection. Possible values are WORKINGDAYSCALENDAR and NONWORKINGDAYSCALENDAR

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": "calendars filter",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.calendar.CalendarsFilter",
    "type": "object",
    "properties": {
        "calendarPaths": {
            "type": "array",
            "items": {
                "type": "string",
                "pattern": "^[^<>]*$",
                "maxLength": 255
            }
        },
        "compact": {
            "description": "controls if the object's data is compact or detailed",
            "type": "boolean",
            "default": false
        },
        "type": {
            "javaType": "com.sos.inventory.model.calendar.CalendarType",
            "type": "string",
            "enum": [
                "WORKINGDAYSCALENDAR",
                "NONWORKINGDAYSCALENDAR"
            ]
        },
        "regex": {
            "description": "regular expression to filter Controller objects by matching the path",
            "type": "string"
        },
        "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
            }
        },
        "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	Response contains only valid calendars Each calendar can have a compact or detailed response. It depends on the parameter `compact`. Compact required fields are id path name type Compact optional fields are 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": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "calendars": { "type": "array", "items": { "javaType": "com.sos.inventory.model.calendar.Calendar", "type": "object", "javaInterfaces": [ "com.sos.joc.model.common.IConfigurationObject", "com.sos.joc.model.common.ICalendarObject", "com.sos.joc.model.common.IReleaseObject", "com.sos.inventory.model.common.IInventoryObject" ], "required": [ "includes" ], "properties": { "id": { "type": "number", "format": "utc-millisec", "minimum": 0 }, "path": { "description": "absolute path of an object.", "type": "string", "pattern": "^(/\|(/[^/\\<>?:\"\|]+)+)$", "maxLength": 255, "minLength": 1 }, "name": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "version": { "description": "inventory repository version", "type": "string", "pattern": "[0-9]+\\.[0-9]+\\.[0-9]+", "default": "1.0.0", "maxLength": 10 }, "documentationName": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "type": { "javaType": "com.sos.inventory.model.calendar.CalendarType", "type": "string", "enum": [ "WORKINGDAYSCALENDAR", "NONWORKINGDAYSCALENDAR" ] }, "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" }, "includes": { "javaType": "com.sos.inventory.model.calendar.Frequencies", "type": "object", "anyOf": [{ "required": [ "dates" ] }, { "required": [ "weekdays" ] }, { "required": [ "monthdays" ] }, { "required": [ "ultimos" ] }, { "required": [ "months" ] }, { "required": [ "holidays" ] }, { "required": [ "repetitions" ] }], "properties": { "dates": { "type": "array", "minItems": 1, "items": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" } }, "weekdays": { "type": "array", "minItems": 1, "items": { "javaType": "com.sos.inventory.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", "minItems": 1, "items": { "description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday", "type": "integer", "minimum": 0, "maximum": 6 } } } } }, "monthdays": { "type": "array", "minItems": 1, "items": { "javaType": "com.sos.inventory.model.calendar.MonthDays", "type": "object", "anyOf": [{ "required": [ "days" ] }, { "required": [ "weeklyDays" ] }], "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", "minItems": 1, "items": { "description": "digit from 1-31", "type": "integer", "minimum": 1, "maximum": 31 } }, "weeklyDays": { "type": "array", "minItems": 1, "items": { "javaType": "com.sos.inventory.model.calendar.WeeklyDay", "type": "object", "required": [ "day", "weekOfMonth" ], "properties": { "day": { "description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday", "type": "integer", "minimum": 0, "maximum": 6 }, "weekOfMonth": { "type": "integer", "minimum": 1, "maximum": 5 } } } } } } }, "ultimos": { "type": "array", "minItems": 1, "items": { "javaType": "com.sos.inventory.model.calendar.MonthDays", "type": "object", "anyOf": [{ "required": [ "days" ] }, { "required": [ "weeklyDays" ] }], "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", "minItems": 1, "items": { "description": "digit from 1-31", "type": "integer", "minimum": 1, "maximum": 31 } }, "weeklyDays": { "type": "array", "minItems": 1, "items": { "javaType": "com.sos.inventory.model.calendar.WeeklyDay", "type": "object", "required": [ "day", "weekOfMonth" ], "properties": { "day": { "description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday", "type": "integer", "minimum": 0, "maximum": 6 }, "weekOfMonth": { "type": "integer", "minimum": 1, "maximum": 5 } } } } } } }, "months": { "type": "array", "minItems": 1, "items": { "javaType": "com.sos.inventory.model.calendar.Months", "type": "object", "anyOf": [{ "required": [ "months", "weekdays" ] }, { "required": [ "months", "monthdays" ] }, { "required": [ "months", "ultimos" ] }], "properties": { "months": { "type": "array", "minItems": 1, "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", "minItems": 1, "items": { "javaType": "com.sos.inventory.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", "minItems": 1, "items": { "description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday", "type": "integer", "minimum": 0, "maximum": 6 } } } } }, "monthdays": { "type": "array", "minItems": 1, "items": { "javaType": "com.sos.inventory.model.calendar.MonthDays", "type": "object", "anyOf": [{ "required": [ "days" ] }, { "required": [ "weeklyDays" ] }], "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", "minItems": 1, "items": { "description": "digit from 1-31", "type": "integer", "minimum": 1, "maximum": 31 } }, "weeklyDays": { "type": "array", "minItems": 1, "items": { "javaType": "com.sos.inventory.model.calendar.WeeklyDay", "type": "object", "required": [ "day", "weekOfMonth" ], "properties": { "day": { "description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday", "type": "integer", "minimum": 0, "maximum": 6 }, "weekOfMonth": { "type": "integer", "minimum": 1, "maximum": 5 } } } } } } }, "ultimos": { "type": "array", "minItems": 1, "items": { "javaType": "com.sos.inventory.model.calendar.MonthDays", "type": "object", "anyOf": [{ "required": [ "days" ] }, { "required": [ "weeklyDays" ] }], "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", "minItems": 1, "items": { "description": "digit from 1-31", "type": "integer", "minimum": 1, "maximum": 31 } }, "weeklyDays": { "type": "array", "minItems": 1, "items": { "javaType": "com.sos.inventory.model.calendar.WeeklyDay", "type": "object", "required": [ "day", "weekOfMonth" ], "properties": { "day": { "description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday", "type": "integer", "minimum": 0, "maximum": 6 }, "weekOfMonth": { "type": "integer", "minimum": 1, "maximum": 5 } } } } } } } } } }, "holidays": { "type": "array", "minItems": 1, "items": { "javaType": "com.sos.inventory.model.calendar.Holidays", "type": "object", "required": [ "dates" ], "properties": { "nationalCalendar": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "dates": { "type": "array", "minItems": 1, "items": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" } } } } }, "repetitions": { "type": "array", "minItems": 1, "items": { "javaType": "com.sos.inventory.model.calendar.Repetition", "type": "object", "required": [ "repetition", "step" ], "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.inventory.model.calendar.RepetitionText", "type": "string", "enum": [ "DAILY", "WEEKLY", "MONTHLY", "YEARLY" ] }, "step": { "type": "integer", "minimum": 1, "default": 1 } } } } } }, "excludes": { "javaType": "com.sos.inventory.model.calendar.Frequencies", "type": "object", "anyOf": [{ "required": [ "dates" ] }, { "required": [ "weekdays" ] }, { "required": [ "monthdays" ] }, { "required": [ "ultimos" ] }, { "required": [ "months" ] }, { "required": [ "holidays" ] }, { "required": [ "repetitions" ] }], "properties": { "dates": { "type": "array", "minItems": 1, "items": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" } }, "weekdays": { "type": "array", "minItems": 1, "items": { "javaType": "com.sos.inventory.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", "minItems": 1, "items": { "description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday", "type": "integer", "minimum": 0, "maximum": 6 } } } } }, "monthdays": { "type": "array", "minItems": 1, "items": { "javaType": "com.sos.inventory.model.calendar.MonthDays", "type": "object", "anyOf": [{ "required": [ "days" ] }, { "required": [ "weeklyDays" ] }], "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", "minItems": 1, "items": { "description": "digit from 1-31", "type": "integer", "minimum": 1, "maximum": 31 } }, "weeklyDays": { "type": "array", "minItems": 1, "items": { "javaType": "com.sos.inventory.model.calendar.WeeklyDay", "type": "object", "required": [ "day", "weekOfMonth" ], "properties": { "day": { "description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday", "type": "integer", "minimum": 0, "maximum": 6 }, "weekOfMonth": { "type": "integer", "minimum": 1, "maximum": 5 } } } } } } }, "ultimos": { "type": "array", "minItems": 1, "items": { "javaType": "com.sos.inventory.model.calendar.MonthDays", "type": "object", "anyOf": [{ "required": [ "days" ] }, { "required": [ "weeklyDays" ] }], "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", "minItems": 1, "items": { "description": "digit from 1-31", "type": "integer", "minimum": 1, "maximum": 31 } }, "weeklyDays": { "type": "array", "minItems": 1, "items": { "javaType": "com.sos.inventory.model.calendar.WeeklyDay", "type": "object", "required": [ "day", "weekOfMonth" ], "properties": { "day": { "description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday", "type": "integer", "minimum": 0, "maximum": 6 }, "weekOfMonth": { "type": "integer", "minimum": 1, "maximum": 5 } } } } } } }, "months": { "type": "array", "minItems": 1, "items": { "javaType": "com.sos.inventory.model.calendar.Months", "type": "object", "anyOf": [{ "required": [ "months", "weekdays" ] }, { "required": [ "months", "monthdays" ] }, { "required": [ "months", "ultimos" ] }], "properties": { "months": { "type": "array", "minItems": 1, "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", "minItems": 1, "items": { "javaType": "com.sos.inventory.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", "minItems": 1, "items": { "description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday", "type": "integer", "minimum": 0, "maximum": 6 } } } } }, "monthdays": { "type": "array", "minItems": 1, "items": { "javaType": "com.sos.inventory.model.calendar.MonthDays", "type": "object", "anyOf": [{ "required": [ "days" ] }, { "required": [ "weeklyDays" ] }], "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", "minItems": 1, "items": { "description": "digit from 1-31", "type": "integer", "minimum": 1, "maximum": 31 } }, "weeklyDays": { "type": "array", "minItems": 1, "items": { "javaType": "com.sos.inventory.model.calendar.WeeklyDay", "type": "object", "required": [ "day", "weekOfMonth" ], "properties": { "day": { "description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday", "type": "integer", "minimum": 0, "maximum": 6 }, "weekOfMonth": { "type": "integer", "minimum": 1, "maximum": 5 } } } } } } }, "ultimos": { "type": "array", "minItems": 1, "items": { "javaType": "com.sos.inventory.model.calendar.MonthDays", "type": "object", "anyOf": [{ "required": [ "days" ] }, { "required": [ "weeklyDays" ] }], "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", "minItems": 1, "items": { "description": "digit from 1-31", "type": "integer", "minimum": 1, "maximum": 31 } }, "weeklyDays": { "type": "array", "minItems": 1, "items": { "javaType": "com.sos.inventory.model.calendar.WeeklyDay", "type": "object", "required": [ "day", "weekOfMonth" ], "properties": { "day": { "description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday", "type": "integer", "minimum": 0, "maximum": 6 }, "weekOfMonth": { "type": "integer", "minimum": 1, "maximum": 5 } } } } } } } } } }, "holidays": { "type": "array", "minItems": 1, "items": { "javaType": "com.sos.inventory.model.calendar.Holidays", "type": "object", "required": [ "dates" ], "properties": { "nationalCalendar": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "dates": { "type": "array", "minItems": 1, "items": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" } } } } }, "repetitions": { "type": "array", "minItems": 1, "items": { "javaType": "com.sos.inventory.model.calendar.Repetition", "type": "object", "required": [ "repetition", "step" ], "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.inventory.model.calendar.RepetitionText", "type": "string", "enum": [ "DAILY", "WEEKLY", "MONTHLY", "YEARLY" ] }, "step": { "type": "integer", "minimum": 1, "default": 1 } } } } } } } } } } }
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 'calendars'	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	'calendars' 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": "calendars failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "calendars 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 }