Skip to main content
POST
Retrieve paged VaR group tables.

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 VaR selection fields, TableIndex (default -1), Page (default 1), and PageSize (default -1).

Requests paged group VaR tables for a report.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.VarReportQuery.ApiVarReportQueryGroupVarTablesRequest, Derivitec.Web.Core
confidence_level
number<double> | null

Optional VaR confidence-level override expressed as a decimal fraction; null retains the report's configured level.

Example:

0.99

row_query
object

Base selection criterion for a named report-data field.

weighting_var_definition
object

Configuration used to select VaR weighting behaviour.

row_restriction_filter
object

Base selection criterion for a named report-data field.

full_report_filter
object

Nested filter group that combines child criteria with a logical operator.

report_configuration
object

Optional named overrides used when querying or exporting a historical VaR report.

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
table_index
integer<int32>

Zero-based configured table index to select; -1 requests all tables and is the default.

Example:

-1

page
integer<int32>

One-based page number to return; defaults to 1.

Example:

1

page_size
integer<int32>

Number of rows requested per table; -1 uses each table definition's take_n value and is the default.

Example:

-1

Response

Returns the selected page of one or all available VaR group tables.

Returns paged group VaR tables and their display definitions.

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

price_histories_count
integer<int32>

Number of position price histories used to produce the query result.

group_var_tables
object[] | null

Selected group VaR tables with page metadata and display definitions.