Home Schema Example JSON Schema

Recurring Frequencies

Type: array

An array of RecurringFrequency objects. This is used for any kronos task schedules.

No Additional Items

Each item of this array must be:

Recurring Frequency

Type: object

Recurring frequency objects describe complex recurring logic that are usually not supported by cron.
This design is probably a super set of CRON.

No Additional Properties

Every

Type: integer

Event recurs in multiples of every units. Defaults to 1.

Value must be greater or equal to 1

Unit

Type: enum (of string)

The unit of measurement for every. Defaults to day.

Must be one of:

  • "minute"
  • "hour"
  • "day"
  • "week"
  • "month"
  • "year"

Count

Type: integer

The number of times for this recurring frequency before it ends. Count is based on the start_on. Defaults to repeat infinitely.

Value must be greater or equal to 1

Minute of Hour

Type: integer

For unit = hour, this is the minute of the hour for the event to recur. Required for unit = hour. Defaults to 0.

Value must be greater or equal to 0 and lesser or equal to 59

Time of Day

Type: stringFormat: time

For unit is one of {day, week, month, year}, this is the time of the day for the event to recur. Required for unit in {day, week, month, year}. Defaults to 09:00.

Day of Week

Type: enum (of string)

For unit = week, this is the day of the week for the event to recur. Required for unit = week. Defaults to mon.

Must be one of:

  • "mon"
  • "tue"
  • "wed"
  • "thu"
  • "fri"
  • "sat"
  • "sun"

Day of Month

Type: integer

For unit = month, this is the day of the month for the event to recur. For certain days that do not occur every month (e.g., 31), it will fallback to the last day of the month (e.g., Feb 28). Required for unit = month. Defaults to 1.

Value must be greater or equal to 1 and lesser or equal to 31

Day of Year

Type: string

For unit = year, this is the day of the year for the event to recur. For certain days that do not occur every month (e.g., 02/29), it will fallback to the closest equivalent (e.g., 02/28). Required for unit = year. Defaults to 1/1.

Must match regular expression: ^(01|02|03|04|05|06|07|08|09|10|11|12)\/(01|02|03|04|05|06|07|08|09|10|11|12|13|14|15|16|17|18|19|20|21|22|23|24|25|26|27|28|29|30|31)$

Start From Trigger

Type: boolean

If true, the event will start from the trigger time. If false, the event will start from the next recurring time. Defaults to false.