Export - Provide the downloadable stream for the requested report

Provide the downloadable stream for the requested report

POST/downloadFile

Authorization

Bearer

Query parameters

Header parameters

Body

application/jsontext/jsonapplication/*+json

reportId*string (uuid)

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.

exportId*string

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.

Response

200400401404405500

Indicate Successfull completion of the export process

Body

text/plainapplication/jsontext/json

canTimeoutboolean

readTimeoutinteger (int32)

writeTimeoutinteger (int32)

canReadboolean

canSeekboolean

canWriteboolean

capacityinteger (int32)

lengthinteger (int64)

positioninteger (int64)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/downloadFile', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "exportId": "text",
      "reportId": "123e4567-e89b-12d3-a456-426614174000"
    }),
});
const data = await response.json();

Response

200401404500

{
  "canTimeout": false,
  "readTimeout": 0,
  "writeTimeout": 0,
  "canRead": false,
  "canSeek": false,
  "canWrite": false,
  "capacity": 0,
  "length": 0,
  "position": 0
}