API Reference
  1. ATRS Public REST API
  2. Single schedules

Update a Tableau schedule

post
{scheme}://{host}:{port}/api/SingleSchedule/Update

Update a schedule using UniqueId and the complete intended SingleScheduleModel. Supply ClientRenderingSettings, parameters, recurrence and both complete destination arrays, retaining destination IDs. Omitted destinations can be deleted; use [] for an unused destination type. Supply valid schedule dates, including EndDate. A successful response has no body. Retrieve the schedule to check the saved settings. See Create a Schedule from a Working Template.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Complete Tableau schedule definition. Include Schedule, ClientRenderingSettings, the Tableau resource, and both destination arrays. Supply DataDriver when IsDataDriven is true.

string
required
string
required
int64
string
string
Schedule
object
required

Schedule dates, recurrence and enabled state. ExecutionTime uses local ATRS schedule time.

EmailDestinations
array of objects
EmailDestinations
DiskDestinations
array of objects
DiskDestinations
int64
string
ClientDestinations
array of objects
ClientDestinations
boolean
DataDriver
object

Data-driver settings for a single-report schedule. Package creation uses DataDriverModel.

string
required
string
string
string
string
required
string
RenderingSettings
object

Tableau output settings for package report members. PDF orientation and page size use the numeric enum values shown below.

ClientRenderingSettings
object
required

Client rendering settings for single-report schedules. Package report members use TableauReportSettings.

Parameters
array of objects
Parameters
Responses
200

Operation completed. The response body is empty.

Updated about 16 hours ago

Did this page help you?
Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 16 hours ago

Did this page help you?