Recurrences API
A Recurrence record can be aggregated within several record types:
It contains the fields described below.
Fields
- frequency
- Readonly enum, default:
no_repeat— The frequency of the recurrency. -
no_repeat: No Repeatdaily: Dailyweekly: Weeklymonthly: Monthlyyearly: Yearly
- interval
- Required integer, default:
1— The interval of the Frequency, e.g. every 2nd week or every 10th day. - calendar
- Optional reference to Calendar — Select a calendar to skip occurrences of the recurrence during off-hours and holidays.
- disabled
- Optional boolean, default:
false— The Disabled box is checked if the recurrency should be temporarily disabled. - time_of_day
- Required time of day — The time of day to start the Recurrence.
- time_zone
- Required time_zone — The Time zone field is used to select the time zone for the
time_of_dayfield. - start_date
- Required date — The date at which to start the Recurrence.
- end_date
- Optional date — The date at which to end the Recurrence.
- day
- Optional string — Required when
frequencyisdaily, ignored in all other cases. Comma separated list of days of the week, e.g.1,2,3,4,5. -
0: Sunday1: Monday2: Tuesday3: Wednesday4: Thursday5: Friday6: Saturday
- day_of_month
- Optional string — Required when
frequencyismonthlyandday_of_weekisfalse, ignored in all other cases. Comma separated list of days of the month, e.g.11,21,-1. -
1: Day one2: Day two3: Day three- …
30: Day thirty31: Day thirty-one-1: Last day of month
- day_of_week
- Required boolean, default:
false— Indicates whether or not theday_of_week_indexandday_of_week_dayvalues should be considered. Can only be set totruewhenfrequencyismonthlyoryearly. - day_of_week_index
- Optional enum, default:
first— Required whenday_of_weekistrue, ignored in all other cases. -
first: Firstsecond: Secondthird: Thirdfourth: Fourthlast: Last
- day_of_week_day
- Optional string — Required when
day_of_weekistrue, ignored in all other cases. Comma separated list of days of the week, e.g.monday,tuesday,wednesday,thursday,friday. -
monday: Mondaytuesday: Tuesdaywednesday: Wednesdaythursday: Thursdayfriday: Fridaysaturday: Saturdaysunday: Sunday
- month_of_year
- Optional string — Required when
frequencyisyearly, ignored in all other cases. Comma separated list of months of the year, e.g.3,6,9,12. -
1: January2: February3: March4: April5: May6: June7: July8: August9: September10: October11: November12: December
- last_occurrence_at
- Readonly datetime — The time and date at which the last occurrence of the recurrence occurred.
- last_occurrence_object
- Readonly reference to Workflow — The record that was created during the last occurrence.
- last_occurrence_errors
- Readonly string (max 1024) — The validation errors during the last occurrence that prevented the record from being created.
- next_occurrence_at
- Readonly datetime — The time and date at which the next record will be created.
- next_occurrence_errors
- Readonly string — The validation errors that prevented the next occurrence of the recurrence from being scheduled.
- ical
- Readonly string (max 2048) - The ICAL representation of the recurrency (without time_of_day)