Skip to main content

Modify a Schedule Pattern (Deprecated)​

Select

SaaS
Customer Managed

deprecated

This endpoint has been deprecated and may be removed in future versions of the API.

This operation modifies the schedule pattern for a schedule policy.

More Details

Name

Description

Required

freq_type

Indicates how often the schedule is run.

Valid values are:

  • 1, One time

  • 4, Daily

  • 8, Weekly

  • 16, Monthly

  • 32, Monthly relative

  • 64, Yearly

  • 128, Yearly relative

  • 1024, Automatic schedule

Yes

freq_interval

The meaning of this parameter changes based on the value of the freq_type parameter:

  • If freq_type equals 1 (one time) or 1024 (automatic schedule), freq_interval is not used and is set to 0.

  • If freq_type equals 4 (daily), freq_interval is the number of days the schedule should repeat. For example, the parameters to run a schedule daily every 17 days are freq_type="4" and freq_interval="17".

  • If freq_type equals 8 (weekly), freq_interval is the sum of the bit form values assigned to the days of the week. The bit form values are:

    • Sunday = 1

    • Monday = 2

    • Tuesday = 4

    • Wednesday = 8

    • Thursday = 16

    • Friday = 32

    • Saturday = 64

      For example, the parameters to run a schedule weekly on Monday and Saturday are freq_type="8" and freq_interval="66" and the parameters to run a schedule weekly on Sunday, Monday, Tuesday, Wednesday, and Thursday are freq_type="8" and freq_interval="31".

  • If freq_type equals 16 (monthly), freq_interval is the day of the month the schedule runs. For example, the parameters to run a schedule monthly on the thirteenth of every month are freq_type="16" and freq_interval="13".

  • If freq_type equals 32 (monthly relative), freq_interval is the day of the week the schedule runs. Valid values are:

    • 1, for Sunday

    • 2, for Monday

    • 3, for Tuesday

    • 4, for Wednesday

    • 5, for Thursday

    • 6, for Friday

    • 7, for Saturday

    • 8, for any day

    • 9, for a weekday

    • 10, for a weekend day

  • If freq_type equals 64 (yearly) or 128 (yearly relative), freq_interval is the day of the month the schedule runs.

Yes

active_start_date

The start date of the schedule specified in UNIX timestamp format. The timestamp is always the beginning of the day (00:00 hours) for the specified date.

Yes

active_start_time

The start time of the schedule specified in seconds.

Yes

freq_recurrence_factor

The meaning of this parameter changes based on the value of the freq_type parameter:

  • If freq_type equals Yearly or Yearly_Relative, freq_recurrence_factor is the month the schedule runs. For example, the parameters to run a yearly schedule every July are freq_type="Yearly" and freq_recurrence_factor="7".

  • If freq_type equals Daily, Weekly, Monthly or Monthly_Relative, freq_recurrence_factor is set to 1.

  • If freq_type equals One_Time or Automatic_Schedule, freq_recurrence_factor is set to 0.

Yes

freq_relative_interval

The meaning of this parameter changes based on the value of the freq_type parameter:

  • If freq_type equals Monthly_Relative or Yearly_Relative, freq_relative_interval is the ordinal numbers indicating when the schedule runs. Use with the freq_interval parameter. Valid values are:

    • 1, if the exception occurs on the first n

    • 2, if the exception occurs on the second n

    • 3, if the exception occurs on the third n

    • 4, if the exception occurs on the fourth n

    • 5, if the exception occurs on the last n

  • If freq_type equals any other value,  freq_recurrence_factor is set to 0.

Yes

freq_subday_interval

The time interval to repeat the schedule.

No

active_end_date

The end date of the schedule specified in the UNIX timestamp format. The timestamp is always the beginning of the day (00:00 hours) for the specified date.

No

active_end_time

The end time of the schedule specified in seconds.

No

active_end_occurence

The number of times you want to repeat the schedule.

No

timezoneId

The ID of the time zone to associate with the schedule. For a list of valid values, see Time Zone IDs and Names.

Yes

calendarId

The code for the calendar, for example, 1.

Yes

Path Parameters
  • taskId string required
  • subtaskId string required

    The system-generated ID assigned to the subtask. If the subtask ID is not known, use the GET Schedule Policy Properties API to retrieve it.

Request Body
  • freq_type integer required

    Indicates how often the schedule is run. 1 -> One Time 4 -> Daily 8 -> Weekly 16 -> Monthly 32 -> Monthly relative 64 -> Yearly 128 -> Yearly relative 1024 Automatic schedule

  • active_start_date integer required

    The start date of the schedule specified in UNIX timestamp format. The timestamp is always the beginning of the day (00:00 hours) for the specified date.

  • active_start_time integer
  • active_end_date integer
  • active_end_time integer
  • freq_interval integer
  • freq_recurrence_factor integer
  • freq_relative_interval integer
  • freq_subday_interval integer
  • timezoneId integer
  • calendarId integer
  • active_end_occurence integer
Responses

OK

Schema
  • errorMessage string
  • errorCode integer
Loading...