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

Describes the actual schedule of events.

action

object

required

Describes the action to perform when a scheduled event occurs.

state

string

enum

Defaults to SCHEDULE_STATE_ACTIVE

SCHEDULE_STATE_ACTIVE: Scheduled events will occur as normal.
SCHEDULE_STATE_PAUSED: Scheduled events will not occur until the schedule is resumed. Events can still be forced to run on-demand using
RunSchedule with force=true.

Allowed:

Response

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A successful response.