Skip to main content
POST
Request an asynchronous report Excel export.

Authorizations

Authorization
string
header
required

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

Body

The body containing the opaque ReportId, optional PortfolioType, IncludePivotTable (default false), optional Prefilter, RequestId, restriction and row-filter identifiers, and ReportType.

Report-run, format, and filter selections for requesting an Excel export.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.Reports.ApiExportReportAsExcelRequest, Derivitec.Web.Core
report_id
string | null

Opaque identifier of the report run to retrieve or query. The value must not be null or empty.

portfolio_type
enum<string> | null

Portfolio category used to resolve the requested portfolio. It may be omitted when the portfolio name resolves unambiguously.

Available options:
derivitec,
enfusion,
orchestrade,
liquidity_book,
maia,
fund_studio,
not_set
include_pivot_table
boolean

Whether the exported workbook should include the report pivot table.

prefilter
object

Base selection criterion for a named report-data field.

request_id
string | null

Client-generated identifier for the export request; it is not a report-run identifier.

report_type
enum<string>

Report category that selects the applicable result or metadata shape.

Available options:
risk,
var,
pnl,
time_series
legacy_view_state
object

The grid state a current-view export must reproduce. Null means "export the default view".

Response

Returns a notification acknowledging that the report Excel export was requested.

Asynchronous acknowledgement for a requested report export.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.Reports.ApiExportReportAsExcelResponse, 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.

notification
object

User-facing record of a request's notification lifecycle and read state.