Skip to main content
POST
Retrieve data for multiple completed VaR report runs.

Authorizations

Authorization
string
header
required

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

Body

The body containing ReportIds, a list of opaque run identifiers, and ReturnRawData, which defaults to false.

Report-run identifiers and output-shape choice for retrieving multiple results.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.Reports.ApiGetReportsDataByIdRequest, Derivitec.Web.Core
report_ids
string[] | null

Opaque identifiers of the report runs whose result data is requested.

return_raw_data
boolean

Whether to return the raw result representation instead of formatted report data.

Response

Returns available report data and any per-run messages; the envelope is unsuccessful when no requested report succeeds.

VaR result data returned for the selected report runs.

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

VaR result entries returned for the selected report runs.