JOC API

Version 2.6.5

Download RAML
JOC API
/schedule/runtime
POST

Runtime periods of a Schedule


Parameters in the POST body schema

Name Type Description Example Default
dateFrom optional, string The value has to have the format YYYY-MM-DD
Returns dates younger than this date.
A calendar "from" attribute further limits results.
2021-01-01
dateTo optional, string The value has to have the format YYYY-MM-DD
Returns dates older than this date.
A calendar "to" attribute further limits results.
2021-12-31
timeZone optional, string See here the list for available time zones. Europe/Berlin Etc/UTC
calendars optional, array Collection of WorkingDaysCalendar objects (Calendar path, restrictions and period)
[{
    "calendarPath": "/test/eachFriday",
    "includes": {
        "monthdays": [{
            "weeklyDays": [{
                "day": 5,
                "weekOfMonth": 1
            }]
        }]
    },
    "periods": [{
        "singleStart": "00:00:00",
        "whenHoliday": "SUPPRESS"
    }]
}]
nonWorkingDayCalendars optional, array Collection of NonWorkingDayCalendars objects (Calendar path)
[{
    "calendarPath": "/test/holidays1"
}]