JOC API

Version 1.13.1

Download RAML
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 Default
jobschedulerId required, string JobScheduler Master ID scheduler
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
]