Retrieve VaR run information by run identifier.
curl --request POST \
--url https://api.riskportal.activeviam.com/api/VarReport/GetReportInfoById \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json-patch+json' \
--data '
{
"$type": "Derivitec.Web.Core.Reports.ApiGetVarReportInfoByIdRequest, Derivitec.Web.Core",
"confidence_level": 0.99,
"row_query": {
"$type": "Derivitec.Web.Core.Filters.Filter, Derivitec.Web.Core",
"field": "<string>",
"type": "<string>"
},
"row_restriction_filter": {
"$type": "Derivitec.Web.Core.Filters.Filter, Derivitec.Web.Core",
"field": "<string>",
"type": "<string>"
},
"report_id": "<string>"
}
'import requests
url = "https://api.riskportal.activeviam.com/api/VarReport/GetReportInfoById"
payload = {
"$type": "Derivitec.Web.Core.Reports.ApiGetVarReportInfoByIdRequest, Derivitec.Web.Core",
"confidence_level": 0.99,
"row_query": {
"$type": "Derivitec.Web.Core.Filters.Filter, Derivitec.Web.Core",
"field": "<string>",
"type": "<string>"
},
"row_restriction_filter": {
"$type": "Derivitec.Web.Core.Filters.Filter, Derivitec.Web.Core",
"field": "<string>",
"type": "<string>"
},
"report_id": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json-patch+json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json-patch+json'},
body: JSON.stringify({
$type: 'Derivitec.Web.Core.Reports.ApiGetVarReportInfoByIdRequest, Derivitec.Web.Core',
confidence_level: 0.99,
row_query: {
$type: 'Derivitec.Web.Core.Filters.Filter, Derivitec.Web.Core',
field: '<string>',
type: '<string>'
},
row_restriction_filter: {
$type: 'Derivitec.Web.Core.Filters.Filter, Derivitec.Web.Core',
field: '<string>',
type: '<string>'
},
report_id: '<string>'
})
};
fetch('https://api.riskportal.activeviam.com/api/VarReport/GetReportInfoById', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.riskportal.activeviam.com/api/VarReport/GetReportInfoById",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'$type' => 'Derivitec.Web.Core.Reports.ApiGetVarReportInfoByIdRequest, Derivitec.Web.Core',
'confidence_level' => 0.99,
'row_query' => [
'$type' => 'Derivitec.Web.Core.Filters.Filter, Derivitec.Web.Core',
'field' => '<string>',
'type' => '<string>'
],
'row_restriction_filter' => [
'$type' => 'Derivitec.Web.Core.Filters.Filter, Derivitec.Web.Core',
'field' => '<string>',
'type' => '<string>'
],
'report_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json-patch+json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.riskportal.activeviam.com/api/VarReport/GetReportInfoById"
payload := strings.NewReader("{\n \"$type\": \"Derivitec.Web.Core.Reports.ApiGetVarReportInfoByIdRequest, Derivitec.Web.Core\",\n \"confidence_level\": 0.99,\n \"row_query\": {\n \"$type\": \"Derivitec.Web.Core.Filters.Filter, Derivitec.Web.Core\",\n \"field\": \"<string>\",\n \"type\": \"<string>\"\n },\n \"row_restriction_filter\": {\n \"$type\": \"Derivitec.Web.Core.Filters.Filter, Derivitec.Web.Core\",\n \"field\": \"<string>\",\n \"type\": \"<string>\"\n },\n \"report_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json-patch+json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.riskportal.activeviam.com/api/VarReport/GetReportInfoById")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json-patch+json")
.body("{\n \"$type\": \"Derivitec.Web.Core.Reports.ApiGetVarReportInfoByIdRequest, Derivitec.Web.Core\",\n \"confidence_level\": 0.99,\n \"row_query\": {\n \"$type\": \"Derivitec.Web.Core.Filters.Filter, Derivitec.Web.Core\",\n \"field\": \"<string>\",\n \"type\": \"<string>\"\n },\n \"row_restriction_filter\": {\n \"$type\": \"Derivitec.Web.Core.Filters.Filter, Derivitec.Web.Core\",\n \"field\": \"<string>\",\n \"type\": \"<string>\"\n },\n \"report_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.riskportal.activeviam.com/api/VarReport/GetReportInfoById")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n \"$type\": \"Derivitec.Web.Core.Reports.ApiGetVarReportInfoByIdRequest, Derivitec.Web.Core\",\n \"confidence_level\": 0.99,\n \"row_query\": {\n \"$type\": \"Derivitec.Web.Core.Filters.Filter, Derivitec.Web.Core\",\n \"field\": \"<string>\",\n \"type\": \"<string>\"\n },\n \"row_restriction_filter\": {\n \"$type\": \"Derivitec.Web.Core.Filters.Filter, Derivitec.Web.Core\",\n \"field\": \"<string>\",\n \"type\": \"<string>\"\n },\n \"report_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"$type": "Derivitec.Web.Core.Reports.ApiGetVarReportInfoByIdResponse, Derivitec.Web.Core",
"is_success": true,
"error_messages": [
"<string>"
],
"report_info": {
"$type": "Derivitec.Web.Core.Reports.VarReportInfo, Derivitec.Web.Core",
"confidence_level": 123,
"first_observation_date": "2023-11-07T05:31:56Z",
"historical_start_date_rule": "<string>",
"id": "<string>",
"mkt_data_date": "2023-11-07T05:31:56Z",
"portfolio_id": 123,
"portfolio_name": "<string>",
"pricing_date": "2023-11-07T05:31:56Z",
"real_time_mkt_data": true,
"reporting_currency": "<string>",
"report_name": "<string>",
"report_definition_id": "<string>",
"status": "none",
"status_message": "<string>",
"time_stamp": "2023-11-07T05:31:56Z",
"var_horizon": 123,
"portfolio_type": "derivitec",
"market_data_provider_ids": [
"<string>"
],
"market_data_environment_names": [
"<string>"
],
"weighting_var_definition": {
"$type": "Derivitec.Web.Core.Reports.WeightingVarDefinition, Derivitec.Web.Core",
"active": true,
"window_length": 123,
"decay_period": 123,
"scheme": "exponentially_weighted"
},
"last_observation_date": "2023-11-07T05:31:56Z",
"historical_end_date_rule": "<string>",
"portfolio_date_time": "2023-11-07T05:31:56Z"
}
}Retrieve VaR run information by run identifier.
Looks up VaR run information using ReportId. Caller, organisation, access, and effective restriction
context are server-managed; unavailable metadata is reported through the response envelope.
POST
/
api
/
VarReport
/
GetReportInfoById
Retrieve VaR run information by run identifier.
curl --request POST \
--url https://api.riskportal.activeviam.com/api/VarReport/GetReportInfoById \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json-patch+json' \
--data '
{
"$type": "Derivitec.Web.Core.Reports.ApiGetVarReportInfoByIdRequest, Derivitec.Web.Core",
"confidence_level": 0.99,
"row_query": {
"$type": "Derivitec.Web.Core.Filters.Filter, Derivitec.Web.Core",
"field": "<string>",
"type": "<string>"
},
"row_restriction_filter": {
"$type": "Derivitec.Web.Core.Filters.Filter, Derivitec.Web.Core",
"field": "<string>",
"type": "<string>"
},
"report_id": "<string>"
}
'import requests
url = "https://api.riskportal.activeviam.com/api/VarReport/GetReportInfoById"
payload = {
"$type": "Derivitec.Web.Core.Reports.ApiGetVarReportInfoByIdRequest, Derivitec.Web.Core",
"confidence_level": 0.99,
"row_query": {
"$type": "Derivitec.Web.Core.Filters.Filter, Derivitec.Web.Core",
"field": "<string>",
"type": "<string>"
},
"row_restriction_filter": {
"$type": "Derivitec.Web.Core.Filters.Filter, Derivitec.Web.Core",
"field": "<string>",
"type": "<string>"
},
"report_id": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json-patch+json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json-patch+json'},
body: JSON.stringify({
$type: 'Derivitec.Web.Core.Reports.ApiGetVarReportInfoByIdRequest, Derivitec.Web.Core',
confidence_level: 0.99,
row_query: {
$type: 'Derivitec.Web.Core.Filters.Filter, Derivitec.Web.Core',
field: '<string>',
type: '<string>'
},
row_restriction_filter: {
$type: 'Derivitec.Web.Core.Filters.Filter, Derivitec.Web.Core',
field: '<string>',
type: '<string>'
},
report_id: '<string>'
})
};
fetch('https://api.riskportal.activeviam.com/api/VarReport/GetReportInfoById', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.riskportal.activeviam.com/api/VarReport/GetReportInfoById",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'$type' => 'Derivitec.Web.Core.Reports.ApiGetVarReportInfoByIdRequest, Derivitec.Web.Core',
'confidence_level' => 0.99,
'row_query' => [
'$type' => 'Derivitec.Web.Core.Filters.Filter, Derivitec.Web.Core',
'field' => '<string>',
'type' => '<string>'
],
'row_restriction_filter' => [
'$type' => 'Derivitec.Web.Core.Filters.Filter, Derivitec.Web.Core',
'field' => '<string>',
'type' => '<string>'
],
'report_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json-patch+json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.riskportal.activeviam.com/api/VarReport/GetReportInfoById"
payload := strings.NewReader("{\n \"$type\": \"Derivitec.Web.Core.Reports.ApiGetVarReportInfoByIdRequest, Derivitec.Web.Core\",\n \"confidence_level\": 0.99,\n \"row_query\": {\n \"$type\": \"Derivitec.Web.Core.Filters.Filter, Derivitec.Web.Core\",\n \"field\": \"<string>\",\n \"type\": \"<string>\"\n },\n \"row_restriction_filter\": {\n \"$type\": \"Derivitec.Web.Core.Filters.Filter, Derivitec.Web.Core\",\n \"field\": \"<string>\",\n \"type\": \"<string>\"\n },\n \"report_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json-patch+json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.riskportal.activeviam.com/api/VarReport/GetReportInfoById")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json-patch+json")
.body("{\n \"$type\": \"Derivitec.Web.Core.Reports.ApiGetVarReportInfoByIdRequest, Derivitec.Web.Core\",\n \"confidence_level\": 0.99,\n \"row_query\": {\n \"$type\": \"Derivitec.Web.Core.Filters.Filter, Derivitec.Web.Core\",\n \"field\": \"<string>\",\n \"type\": \"<string>\"\n },\n \"row_restriction_filter\": {\n \"$type\": \"Derivitec.Web.Core.Filters.Filter, Derivitec.Web.Core\",\n \"field\": \"<string>\",\n \"type\": \"<string>\"\n },\n \"report_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.riskportal.activeviam.com/api/VarReport/GetReportInfoById")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n \"$type\": \"Derivitec.Web.Core.Reports.ApiGetVarReportInfoByIdRequest, Derivitec.Web.Core\",\n \"confidence_level\": 0.99,\n \"row_query\": {\n \"$type\": \"Derivitec.Web.Core.Filters.Filter, Derivitec.Web.Core\",\n \"field\": \"<string>\",\n \"type\": \"<string>\"\n },\n \"row_restriction_filter\": {\n \"$type\": \"Derivitec.Web.Core.Filters.Filter, Derivitec.Web.Core\",\n \"field\": \"<string>\",\n \"type\": \"<string>\"\n },\n \"report_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"$type": "Derivitec.Web.Core.Reports.ApiGetVarReportInfoByIdResponse, Derivitec.Web.Core",
"is_success": true,
"error_messages": [
"<string>"
],
"report_info": {
"$type": "Derivitec.Web.Core.Reports.VarReportInfo, Derivitec.Web.Core",
"confidence_level": 123,
"first_observation_date": "2023-11-07T05:31:56Z",
"historical_start_date_rule": "<string>",
"id": "<string>",
"mkt_data_date": "2023-11-07T05:31:56Z",
"portfolio_id": 123,
"portfolio_name": "<string>",
"pricing_date": "2023-11-07T05:31:56Z",
"real_time_mkt_data": true,
"reporting_currency": "<string>",
"report_name": "<string>",
"report_definition_id": "<string>",
"status": "none",
"status_message": "<string>",
"time_stamp": "2023-11-07T05:31:56Z",
"var_horizon": 123,
"portfolio_type": "derivitec",
"market_data_provider_ids": [
"<string>"
],
"market_data_environment_names": [
"<string>"
],
"weighting_var_definition": {
"$type": "Derivitec.Web.Core.Reports.WeightingVarDefinition, Derivitec.Web.Core",
"active": true,
"window_length": 123,
"decay_period": 123,
"scheme": "exponentially_weighted"
},
"last_observation_date": "2023-11-07T05:31:56Z",
"historical_end_date_rule": "<string>",
"portfolio_date_time": "2023-11-07T05:31:56Z"
}
}Authorizations
oauth2apikey
OAuth2 access-token requested from AWS Cognito and provided as a Auth Bearer header
Body
application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
The body containing the opaque ReportId; it may also carry optional PortfolioType, ConfidenceLevel, RowQuery, and WeightingVarDefinition, while the run identifier determines this lookup.
Selector for retrieving one VaR report-run summary by run identifier.
Available options:
Derivitec.Web.Core.Reports.ApiGetVarReportInfoByIdRequest, Derivitec.Web.Core Optional VaR confidence-level override expressed as a decimal fraction; null retains the report's configured level.
Example:
0.99
Base selection criterion for a named report-data field.
- Option 1
- Option 2
- Option 3
- Option 4
Show child attributes
Show child attributes
Configuration used to select VaR weighting behaviour.
Show child attributes
Show child attributes
Base selection criterion for a named report-data field.
- Option 1
- Option 2
- Option 3
- Option 4
Show child attributes
Show child attributes
Nested filter group that combines child criteria with a logical operator.
Show child attributes
Show child attributes
Optional named overrides used when querying or exporting a historical VaR report.
Show child attributes
Show child attributes
Opaque identifier of the report run to retrieve or query. The value must not be null or empty.
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 information for the identified VaR report run, or an unsuccessful response envelope when it is unavailable.
Response envelope containing one VaR report-run summary.
Available options:
Derivitec.Web.Core.Reports.ApiGetVarReportInfoByIdResponse, Derivitec.Web.Core Whether the operation completed successfully. The default is true; error outcomes set it to false.
Example:
true
Messages explaining operation-level failures. The collection is empty by default.
Summary of a VaR report run.
Show child attributes
Show child attributes
Was this page helpful?