Create a package through Package

post

{scheme}://{host}:{port}/api/Package/Create

Create an ATRS package with PackageName, FolderPath, Schedule, Reports and delivery destinations. Set DataDriven to true and provide DataDriver for a data-driven package. JSON drivers use DataDriverType 1 and ValuesJson; SQL drivers use type 0 with ConString and Query. Include both destination arrays, using [] for an unused type. This operation has different validation from PackageSchedule/Create. See Create and Manage Report Packages.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

An ATRS package containing Tableau reports, recurrence, delivery destinations and an optional data driver. Use PackageName for the name and Reports for the Tableau members.

UniqueId

int64

PackageName

string

FolderPath

string

DataDriven

boolean

Schedule

object

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

EmailDestinations

array of objects

EmailDestinations

DiskDestinations

array of objects

DiskDestinations

Reports

array of objects

Tableau report members. Each member has its own view, output format and parameters.

Reports

DataDriver

object

Data source for a data-driven package. Supply it when DataDriven is true.

MultiThreaded

boolean

ThreadCount

int32

GroupByEmail

boolean

Package email-grouping setting for data-driven output.

Description

string

Keywords

string

MergePDFFiles

boolean

MergedPDFFileName

string

MergeExcelFiles

boolean

MergedExcelFileName

string

Responses

200Successful request.

500The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.