/calendars
POST
Sends collection of calendar items
Parameters in the POST body schema
Name | Type | Description | Example | Default |
---|---|---|---|---|
jobschedulerId |
required, string | JobScheduler Master ID | scheduler | |
compact |
optional, boolean | Response has a compact version if this parameter is true | false | |
regex |
optional, string | Regular expression to filter the collection | .* | |
folders |
optional, string | 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