StartAsynchronousExport operation

This operation makes the Application Studio service to start the export job and return the ID of the job immediately. You can use it for long exports, which have time-out issues when exported synchronously. You must retrieve the result of asynchronous export after the export is finished, otherwise it is discarded after half an hour.

Request

Method URL
GET /BI/api/rest/IonApi/BookExport/v1/StartAsynchronousExport
Parameter Status Type Value
appName Required String A unique name of the application with the report book to export.
bookName Required String A unique name of the report book to export.
outputFormat Required Enum

pdf [0]

xlsx [1]

xlsx value [2]

pptx [3]

image [4]

Export output format.

usePageLayout Optional Boolean The default is TRUE. Use only for pptx or image export.
imageFormat Optional Enum

png [0]

jpg [1]

The default is png. Use only for image export.
string exportProfile Optional String An export profile name. To export in the default way, leave empty.

Result

A jobId parameter, a GUID of an export job.