Skip to main content
GET
Retrieve a temporary report Excel export as base64 content.

Authorizations

Authorization
string
header
required

OAuth2 access-token requested from AWS Cognito and provided as a Auth Bearer header

Query Parameters

exportId
string

The optional query-string export identifier returned when the temporary download was created; no format or default is declared.

Response

Returns base64 file content and a file name when available, or error messages when the temporary export cannot be retrieved.

JSON response containing base64-encoded report file content and a suggested file name when available.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.Reports.ApiDownloadExcelResponse, Derivitec.Web.Core
is_success
boolean

Whether the operation completed successfully. The default is true; error outcomes set it to false.

Example:

true

error_messages
string[] | null

Messages explaining operation-level failures. The collection is empty by default.

file
string | null

Base64-encoded report file content when available.

file_name
string | null

Suggested file name when report file content is available.

content_type
string | null

Optional media type for the downloaded file; the current JSON download action does not populate this field.