Skip to main content
POST
Retrieve completed VaR report data by run identifier.

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 for the completed VaR report run.

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 completed VaR report data, or an unsuccessful response envelope with validation or availability messages.

VaR result data, statistics, status, portfolio context, and market-data diagnostics.

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

market_data_error_summary
object

Market-data failures grouped by the affected data category.

portfolio_date_time
string<date-time>

Portfolio snapshot date and time used or recorded for the report; no time-zone convention is established here.

portfolio_id
integer<int32>

Opaque identifier of the portfolio associated with the report run.

portfolio_name
string | null

Portfolio name associated with the report run or saved launcher item.

portfolio_var_statistics
object

Reports value-at-risk statistics for a portfolio, tradable, scenario, or aggregation group.

report_id
string | null

Opaque identifier of the report run.

reporting_currency
string | null

Currency used to express monetary report values; the code format is not constrained here.

report_name
string | null

Name of the report definition associated with the run, schedule, restriction, or launcher item.

scenario_portfolio_var_statistics
object[] | null

Scenario portfolio-level VaR statistics returned with the report.

scenarios
object[] | null

Scenario definitions represented in the VaR result.

Names and describes a scenario supplied to a risk calculation.

status
enum<string>

Lifecycle state recorded for the report run or scheduled item.

Available options:
none,
succeeded,
failed,
running,
warning
status_message
string | null

Human-readable diagnostic associated with the recorded report or schedule state.

time_stamp
string<date-time>

Timestamp recorded for the report run; no time-zone convention is established by this contract.

tradable_var_statistics
object[] | null

Tradable-level VaR statistics returned with the report.

user_time_zone_id
string | null

Time-zone identifier associated with presentation of report timestamps; accepted identifier formats are not defined here.

position_infos
object[] | null

Position information returned with VaR report data.