Update attributes of an existing schedule. Only fields supplied in the request are changed; omitted fields keep their current values. A schedule in the completed state cannot be updated.
POST /revisions/:id/data (Command: update_schedule)
Request Body
| Parameter | Type | Required | Description |
|---|
engine | string | Yes | Must be scheduler_blobhub. |
command | string | Yes | Must be update_schedule. |
schedule_id | string | Yes | Id of the schedule to update. |
enabled | boolean | No | New enabled flag. |
repeat | string | No | Either one_time or recurring_cron. |
cron_expression | string | No | Six-field AWS cron expression. Must be set when repeat is recurring_cron. |
invocation_time | string | No | ISO 8601 datetime. Must be set when repeat is one_time. |
timezone | string | No | IANA timezone name. |
start_date | string | No | ISO 8601 UTC datetime. |
end_date | string | No | ISO 8601 UTC datetime. |
invocation_target_type | string | No | Must be workflow. |
invocation_target | object | No | Replacement invocation target object. |
If repeat is changed to recurring_cron, cron_expression must be supplied in the same request. If changed to one_time, invocation_time must be supplied. invocation_time follows the same naive-datetime format as on create.
Response
| Parameter | Type | Description |
|---|
schedule | object | The updated schedule object. |
Example
{
"engine": "scheduler_blobhub",
"command": "update_schedule",
"schedule_id": "sched-001",
"enabled": false,
"timezone": "Europe/London"
}
