RecurrenceTemplate Object

Fields

The fields in this section list which values can be retrieved when querying RecurrenceTemplate records.

calendar (Calendar)

Select a calendar to skip occurrences of the recurrence during off-hours and holidays.

day ([Int!])

Required when frequency is daily, ignored in all other cases. List of days of the week, e.g. 1,2,3,4,5.

  • 0: Sunday
  • 1: Monday
  • 2: Tuesday
  • 3: Wednesday
  • 4: Thursday
  • 5: Friday
  • 6: Saturday
dayOfMonth ([Int!])

Required when frequency is monthly and day_of_week is false, ignored in all other cases. List of days of the month, e.g. 11,21,-1.

  • 1: Day one
  • 2: Day two
  • 3: Day three
  • ...
  • 30: Day thirty
  • 31: Day thirty-one
  • -1: Last day of month
dayOfWeek (Boolean)

Indicates whether or not the dayOfWeekIndex and dayOfWeekDay values should be considered. Can only be set to true when frequency is monthly or yearly.

dayOfWeekDay (DayNames)

Required when dayOfWeek is true, ignored in all other cases.

dayOfWeekIndex (RecurrenceDayOfWeekIndex)

Required when dayOfWeek is true, ignored in all other cases.

disabled (Boolean)

Whether recurrency should be temporarily disabled.

frequency (RecurrenceFrequency)

The frequency of the recurrency.

interval (Int)

The interval of the Frequency, e.g. every 2nd week or every 10th day.

monthOfYear ([Int!])

Required when frequency is yearly, ignored in all other cases. List of months of the year, e.g. 3,6,9,12.

  • 1: January
  • 2: February
  • 3: March
  • 4: April
  • 5: May
  • 6: June
  • 7: July
  • 8: August
  • 9: September
  • 10: October
  • 11: November
  • 12: December
timeOfDay (ISO8601Time)

The time of day to start the scheduled occurrence.

timeZone (TimeZone)

The time zone for the timeOfDay field.