Export - Provides a downloadable stream for a report

Provides a downloadable stream for the requested report.

post

Authorizations

Bearer

Query parameters

versionstringOptional

The requested API version

Default: 1.0

Header parameters

embedfast-user-idstringOptional

Optional User Id

Body

application/jsontext/jsonapplication/*+json

Class for export status request parameters.

reportIdstring · uuidOptional

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.

exportIdstring · min: 1Required

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.

paginatedAssetIdstring · uuid | nullableOptional

Gets or sets the unique identifier for the paginated asset. Required in case of Paginated visual export (type 2) MAQ.BIHub.API.Model.ExportMethod

Responses

200

Success: Successfull completion of the export process.

text/plainapplication/jsontext/json

400

Bad Request: The request could not be processed due to invalid syntax or missing/incorrect parameters.

text/plainapplication/jsontext/json

401

Unauthorized: Invalid credentials or missing/invalid authentication token.

text/plainapplication/jsontext/json

404

Not Found: The report was not found, the URL is invalid, or the resource has been deleted.

text/plainapplication/jsontext/json

405

Method Not Allowed: User doesn't have enough access to perform this operation.

500

Internal Server Error: An unexpected error occurred or a server timeout.

text/plainapplication/jsontext/json

post

HTTPcURLJavaScriptPython

POST /downloadFile HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 127

{
  "reportId": "123e4567-e89b-12d3-a456-426614174000",
  "exportId": "text",
  "paginatedAssetId": "123e4567-e89b-12d3-a456-426614174000"
}

application/jsontext/jsonapplication/*+json

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