/public/flexschedulerule/:id

Retrieve the information for a flexscheduleRule entity

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Season dates

A schedule either repeats for the same season every year or runs between fixed dates. repeatsYearly tells you which, and decides which date fields are present.

FieldDescription
repeatsYearlytrue when the schedule runs for the same season every year (the app's start and end dates with yearly repeat). false otherwise.
annualStartMonth, annualStartDayOnly when repeatsYearly is true: the month (1 to 12) and day the season starts each year.
annualEndMonth, annualEndDayOnly when repeatsYearly is true: the month (1 to 12) and day the season ends each year.
startDateOnly when repeatsYearly is false: the schedule's start date, in epoch milliseconds.
endDateOnly when repeatsYearly is false and the schedule has an end date: the end date, in epoch milliseconds.
startMonth, startDay, startYearOnly when repeatsYearly is false: the start date as numbers.

A schedule that repeats yearly has no startDate, endDate, startMonth, startDay or startYear.

Path Params
string
required

FlexScheduleRule's unique id

Response

Language
LoadingLoading…
Response
Choose an example:
application/json