| timeframe_id |
string |
|
[optional] |
| timeframe_parent_id |
string |
|
[optional] [readonly] |
| ordinal_order |
float |
|
[optional] [readonly] |
| timeframe_specific_dates_begin_date |
string |
Start date of the specific date period - format: YYYYMMDD |
|
| timeframe_specific_dates_begin_time |
string |
Start time of the specific date period - format: hhmm (24 hour) |
|
| timeframe_specific_dates_end_date |
string |
End date of the specific date period - format: YYYYMMDD |
|
| timeframe_specific_dates_end_time |
string |
End time of the specific date period - format: hhmm (24 hour) |
|
| timeframe_recurrence_type |
string |
```doesNotRecur```: no recurrence ```monthly-on-last-day```: every month on the last day of the month ```monthly-on-first-last```: monthly on the first or last ordinal weekday, e.g.: the first Friday, the last Thursday - note: this will produce potentially unexpected behavior if used with a date that is not the first or last occurrence of that particular weekday ```monthly-on-ordinal-weekday```: can be used for any ordinal weekday that is NOT the first or last occurrence of that weekday in the given month e.g. the third Friday, the second Monday ```monthly-date```: every month on the same day, e.g.: the 14th day, the 29th day - note: if there are months in which the “day” does not occur, the date will not be active during that month, e.g.: the 31st day of February ```yearly-on-selected-dates```: every year on the exact month and day, e.g.: April 30th, September 4th ```annual-month-day```: functionally identical to ```yearly-on-selected-dates``` ```yearly-first```: every year on the first ordinal weekday of the exact month, e.g.: the first Monday of every June, the first Friday of every August - note: this will produce potentially unexpected behavior if used with a date that is not the first occurrence of that particular weekday ```yearly-last```: every year on the last ordinal weekday of the exact month, e.g.: the last Friday of every July, the last Tuesday of every November - note: this will produce potentially unexpected behavior if used with a date that is not the last occurrence of that particular weekday ```custom```: if this option is selected the fields ```timeframe-recurrence-custom-interval```, ```timeframe-recurrence-custom-interval-option```, and ```timeframe-recurrence-custom-interval-count``` must be set correctly to produce any behavior |
|
| timeframe_recurrence_custom_interval |
string |
Must be combined with the field ```timeframe-recurrence-custom-interval-count``` ```days```: recur every ```timeframe-recurrence-custom-interval-count``` days ```weeks```: recur every ```timeframe-recurrence-custom-interval-count``` weeks ```months```: recur every ```timeframe-recurrence-custom-interval-count``` months ```years```: recur every ```timeframe-recurrence-custom-interval-count``` years |
|
| timeframe_recurrence_custom_interval_count |
string |
Specifies the recurrence count based on the period specified in ```timeframe-recurrence-custom-interval-count``` e.g. 'every 6 days' or 'every 3 months' If the field ```timeframe-recurrence-custom-interval-count``` is set to ```months``` this field determines the count in combination with the option set in ```timeframe-recurrence-custom-interval-option```, if ```timeframe-recurrence-custom-interval``` is set to ```years``` the count is fixed to a value of 1 and will recur every year according to the option set in ```timeframe-recurrence-custom-interval-option``` |
|
| timeframe_recurrence_custom_interval_option |
string |
If ```timeframe-recurrence-custom-interval``` is set to ```days``` or ```weeks``` this field is not used. This field is for ```months``` and ```years``` only. For ```timeframe-recurrence-custom-interval``` of ```months```: ```monthly-same-day```: recur on the same day of the month, e.g.: the 14th day, the 29th day - note: if there are months in which the “day” does not occur, the date will not be active during that month, e.g.: the 31st day of February ```monthly-ordinal-weekday```: recur on the same ordinal weekday e.g. the third Friday, the second Monday ```monthly-first-last-weekday```: recur on the first or last instance of the selected weekday in the month, e.g.: the first Wednesday, the last Tuesday - note: this will produce potentially unexpected behavior if used with a date that is not the first or last occurrence of that particular weekday ```monthly-on-last-day```: recur on the last day of the month - note: this will produce potentially unexpected behavior if used with a date that is not the last day of the month For ```timeframe-recurrence-custom-interval``` of ```years```: ```yearly-same-day```: recur on the same day of the same month, e.g.: the 10th of May, the 20th of October ```yearly-ordinal-weekday```: recur on the same ordinal weekday of the same month, e.g.: the second Tuesday of April, the third Thursday of November ```yearly-first-last-weekday```: recur on the first or last weekday of the same month, e.g.: the third Wednesday of August, the first Tuesday of December - note: this will produce potentially unexpected behavior if used with a date that is not the first or last occurrence of that particular weekday |
|
| timeframe_recurrence_end_option |
string |
```never```: recurrence will continue indefinitely ```onADate```: recurrence will end on a date, specified in ```timeframe-recurrence-end-date``` |
|
| timeframe_recurrence_end_date |
string |
End date of the recurrence - format: YYYYMMDD |
|
| timeframe_expiry_datetime |
string |
|
[optional] [readonly] |
| domain |
string |
|
[optional] [readonly] |
| timeframe_recurrence_rrule |
string |
The RRULE string, if recurrence is configured |
[optional] [readonly] |
| timeframe_next_observance_datetime |
float[] |
List of the upcoming occurrences of the specific date if recurrence is configured, formatted as epoch timestamp in seconds |
[optional] |
| timeframe_is_v1 |
bool |
Will be set to ```true``` if the specific date is part of a timeframe created before v44.1 |
[optional] [readonly] |