Skip to main content
POST
Request an Excel export of report errors and warnings.

Authorizations

Authorization
string
header
required

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

Body

The body containing the required opaque risk report-run ReportId and a non-empty client-generated RequestId that identifies this export request. The two identifiers belong to different namespaces. Row restrictions, portfolio type, market-data environment, and caller fields are server-managed.

Report-run and request identifiers for requesting an Excel export of report errors and warnings.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.ReportQuery.ApiExportReportErrorsToExcelRequest, 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
request_id
string | null

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

Response

Returns a Requested export acknowledgement carrying the supplied request identifier, or an unsuccessful envelope for restricted access; no file content or download URL is returned.

Asynchronous acknowledgement for an Excel export request covering report errors and warnings.

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