Skip to main content
POST
Retrieve the summary for a risk report run.

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. Row filter, portfolio type, available portfolio types, market-data environment, restriction, and caller fields are server-managed rather than client-selected access controls.

Selector for retrieving one risk report-run summary by run identifier.

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

Response

Returns the risk run summary, including run and portfolio identity, dates, status, reporting currency, and environment names, or an unsuccessful envelope with no summary when unavailable.

Response envelope containing one risk report-run summary.

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

report_info
object

Summary of a risk report run.