Modify a Schedule Pattern (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.
Name | Description | Required |
---|---|---|
freq_type | Indicates how often the schedule is run. Valid values are:
| Yes |
freq_interval | The meaning of this parameter changes based on the value of the freq_type parameter:
| 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:
| Yes |
freq_relative_interval | The meaning of this parameter changes based on the value of the freq_type parameter:
| 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.
- application/x-www-form-urlencoded
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
- 200
OK
- application/json
- Schema
- Example (from schema)
Schema
- errorMessage string
- errorCode integer
{
"errorMessage": "string",
"errorCode": 0
}