Schedule Resource

Retrieve, create or delete a schedule for a dataflow, recipe, or connection sync.

Resource URL

1/wave/asset/<assetId>/schedule

Formats

JSON

Available Version

GET (52.0), PUT (40.0), DELETE (43.0)

Available Components

LWC — lightning/analyticsWaveApi getSchedule()
LWC — lightning/analyticsWaveApi updateSchedule()

HTTP Methods

GET PUT DELETE

GET Response Body (ScheduleRepresentation)

Property Name	Type	Description	Filter Group and Version	Available Version
`assetId`	String	The asset ID that this schedule belongs to.	Small, 52.0	52.0
`frequency`	ConnectWaveScheduleFrequencyTypeEnum	Frequency on which this schedule is run. Valid values are: `Daily` (Run once per day) `EventDriven` (Create Event Driven schedule) `Hourly` (Run on one or more hours each day) `Minutely` (Run subhourly each day) `Monthly` (Run on one or more specific numeric days per month) `MonthlyRelative` (Run on one or more relative days for month) `None` (Not scheduled to run) `Weekly` (Run on one or more days each week)	Small, 39.0	39.0
`nextScheduledDate`	Date	Next scheduled time (in UTC) for this schedule	Small, 43.0	43.0
`notificationLevel`	ConnectEmailNotificationLevelEnum	Email notification level of dataflow associated with this schedule. Valid values are: `Always` `Failures` `Never` `Warnings`	Small, 43.0	43.0
`time`	TimeRepresentation	Hour,minute, and timezone in which this schedule is run	Small 39.0	39.0

PUT Request Body (ScheduleInputRepresentation)

Property Name	Type	Description	Required or Optional	Available Version
`ScheduleInputRepresentation`	HourlyScheduleInputRepresentation, DailyScheduleInputRepresentation, WeeklyScheduleInputRepresentation, MonthlyRelativeScheduleInputRepresentation, MonthlySpecificScheduleInputRepresentation	Schedule on which to run the asset.	Required	40.0

The following JSON shows how to create an hourly schedule for an asset.

1{
2  "daysOfWeek" : [
3    "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday"
4  ],
5  "lastHour" : 20,
6  "hourlyInterval" : 3,
7  "time" : {
8    "hour" : 2,
9    "minute" : 30,
10    "timezone" : "America/Los_Angeles"
11  },
12  "frequency" : "hourly"
13}

PUT Response Body

Property Name	Type	Description	Filter Group and Version	Available Version
`assetId`	String	The asset ID that this schedule belongs to.	Small, 52.0	52.0
`frequency`	ConnectWaveScheduleFrequencyTypeEnum	Frequency on which this schedule is run. Valid values are: `Daily` (Run once per day) `EventDriven` (Create Event Driven schedule) `Hourly` (Run on one or more hours each day) `Minutely` (Run subhourly each day) `Monthly` (Run on one or more specific numeric days per month) `MonthlyRelative` (Run on one or more relative days for month) `None` (Not scheduled to run) `Weekly` (Run on one or more days each week)	Small, 39.0	39.0
`nextScheduledDate`	Date	Next scheduled time (in UTC) for this schedule	Small, 43.0	43.0
`notificationLevel`	ConnectEmailNotificationLevelEnum	Email notification level of dataflow associated with this schedule. Valid values are: `Always` `Failures` `Never` `Warnings`	Small, 43.0	43.0
`time`	TimeRepresentation	Hour,minute, and timezone in which this schedule is run	Small 39.0	39.0

Examples: For more examples on about how to schedule dataflows, recipes, and connection syncs, see Schedule Dataflows, Recipes, and Data Syncs

Tableau CRM REST API Developer Guide

Schedule Resource