Skip to main content

PublicScheduleUpdateViewModel

Defines the recurrence settings that can be changed for an existing task.

scheduleFrequencyPublicScheduleUpdateFrequencyrequired

Defines recurrence frequencies that can be assigned when updating an existing task schedule. Once is not a valid update target.

Enum values:

  • Hourly: Executes periodically every configured number of hours.
  • Daily: Executes periodically every configured number of days.
  • Weekly: Executes periodically on selected days of the week.
  • Monthly: Executes periodically on selected days of the month and/or on the last day of the month.
  • RealTime: Executes continuously in Real-Time loops with an optional Start Delay.

Possible values: [Hourly, Daily, Weekly, Monthly, RealTime]

runEveryinteger<int32>nullable

The positive number of hours, days, or months between executions for Hourly, Daily, or Monthly schedules. Hourly values are 1–23, Daily values are 1–6, and Monthly values are 1–12.

scheduleDaysinteger<int32>[]nullable

The weekdays (0 for Sunday through 6 for Saturday) for Weekly schedules or calendar days (1 through 28) for Monthly schedules, with -1 denoting the last day of the month.

realTimeDelayInMinutesinteger<int32>nullable

The optional Start Delay in minutes between Real-Time execution loops (1–59).

PublicScheduleUpdateViewModel
{
  "scheduleFrequency": "Hourly",
  "runEvery": 0,
  "scheduleDays": [
    0
  ],
  "realTimeDelayInMinutes": 0
}