Export - Provides a downloadable stream for a report

PreviousExport - Initiates the export process of a report NextExport - Provides a downloadable report with a specified filename

Last updated 2 months ago

Provides a downloadable stream for the requested report.

post

/downloadFile

Authorizations

Query parameters

versionstring

The requested API version

Header parameters

embedfast-user-idstring

Optional User Id

Body

reportIdstring uuidrequired

A public property of type Guid (a unique identifier) that has both a getter and a setter method, which allows for getting and setting the value of the ReportId property.

exportIdstringrequired

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the ExportId property.

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/downloadFile' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"reportId":"123e4567-e89b-12d3-a456-426614174000","exportId":"text"}'

200

400

401

404

405

500

{
  "canTimeout": true,
  "readTimeout": 1,
  "writeTimeout": 1,
  "canRead": true,
  "canSeek": true,
  "canWrite": true,
  "capacity": 1,
  "length": 1,
  "position": 1
}

Success: Successfull completion of the export process.