Skip to main content
POST
Retrieve formatted data 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 ReportId; optional PortfolioType and RowFilter; and optional DataTableQuery.Filter and DataTableQuery.Columns to narrow returned rows and columns.

Selectors and optional formatting query for retrieving one report run.

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

Optional filter and column selection for formatted report data.

Response

Returns the formatted risk report data, or an unsuccessful envelope when report information is unavailable.

Formatted result data returned for one report run.

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

data
object

Formatted risk data for a report run.