API Docs / Schemas / RecurrenceConfigDto

RecurrenceConfigDto

Configuration for how often a recurring task repeats.

Properties

Name Type Description
everyinteger

Interval value (e.g., 1 for every month, 2 for every 2 months)

Interval value (e.g., 1 for every month, 2 for every 2 months)

unitenum

Day Week Month Year

Day Week Month Year

inMonthsarray of enum

Which months to run in. Only valid when Unit is Year.
Example: ["January", "April", "July", "October"] for quarterly

None January February March April May June July SemiAnnual August September October Quarterly November December AllMonths

Which months to run in. Only valid when Unit is Year.
Example: ["January", "April", "July", "October"] for quarterly

None January February March April May June July SemiAnnual August September October Quarterly November December AllMonths

weekDaysOnlyboolean

If true, skip weekends for daily patterns. Only valid when Unit is Day.

If true, skip weekends for daily patterns. Only valid when Unit is Day.

JSON Example

{
  "every": 0,
  "unit": "Day",
  "inMonths": [
    "None"
  ],
  "weekDaysOnly": false
}

Contained in Schemas