update

patch

https://api-examples.tamr.cloud/api/v1beta1/schedules/{schedule.scheduleId}

Update a Schedule. This is a patch operation, so only the fields specified in the request are updated.

Path Params

schedule.scheduleId

string

required

Unique ID of the schedule, generated by the service on creation.

Body Params

Required. The updated schedule.

displayName

string

required

Required. Display name of the Schedule, defined by the user.

description

string

Optional. Description of the Schedule, defined by the user.

timetable

object

required

Required. Describes the actual schedule of events.

action

object

required

Required. Describes the action to perform when the Schedule's events occur.

state

string

enum

Defaults to SCHEDULE_STATE_ACTIVE

Optional. Whether the schedule is active or paused. While paused, scheduled events are skipped, but can still be
forced to occur with RunSchedule. Default is active.

Allowed:

Response

200A successful response.