Retrieve the table definition of a report run whose data is not held in Druid.

curl --request POST \
  --url https://api.riskportal.activeviam.com/api/ReportQuery/LegacyTableDefinition \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "$type": "Derivitec.Web.Core.LegacyReportQuery.ApiGetLegacyTableDefinitionRequest, Derivitec.Web.Core",
  "report_id": "<string>",
  "table_view_definition_id": "<string>"
}
'

import requests

url = "https://api.riskportal.activeviam.com/api/ReportQuery/LegacyTableDefinition"

payload = {
    "$type": "Derivitec.Web.Core.LegacyReportQuery.ApiGetLegacyTableDefinitionRequest, Derivitec.Web.Core",
    "report_id": "<string>",
    "table_view_definition_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.LegacyReportQuery.ApiGetLegacyTableDefinitionRequest, Derivitec.Web.Core',
    report_id: '<string>',
    table_view_definition_id: '<string>'
  })
};

fetch('https://api.riskportal.activeviam.com/api/ReportQuery/LegacyTableDefinition', 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/ReportQuery/LegacyTableDefinition",
  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.LegacyReportQuery.ApiGetLegacyTableDefinitionRequest, Derivitec.Web.Core',
    'report_id' => '<string>',
    'table_view_definition_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/ReportQuery/LegacyTableDefinition"

	payload := strings.NewReader("{\n  \"$type\": \"Derivitec.Web.Core.LegacyReportQuery.ApiGetLegacyTableDefinitionRequest, Derivitec.Web.Core\",\n  \"report_id\": \"<string>\",\n  \"table_view_definition_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/ReportQuery/LegacyTableDefinition")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"$type\": \"Derivitec.Web.Core.LegacyReportQuery.ApiGetLegacyTableDefinitionRequest, Derivitec.Web.Core\",\n  \"report_id\": \"<string>\",\n  \"table_view_definition_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.riskportal.activeviam.com/api/ReportQuery/LegacyTableDefinition")

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.LegacyReportQuery.ApiGetLegacyTableDefinitionRequest, Derivitec.Web.Core\",\n  \"report_id\": \"<string>\",\n  \"table_view_definition_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "$type": "Derivitec.Web.Core.LegacyReportQuery.ApiGetLegacyTableDefinitionResponse, Derivitec.Web.Core",
  "is_success": true,
  "error_messages": [
    "<string>"
  ],
  "report_id": "<string>",
  "report_name": "<string>",
  "reporting_currency": "<string>",
  "tabs": [
    {
      "$type": "Derivitec.Web.Core.LegacyReportQuery.LegacyTableTabWire, Derivitec.Web.Core",
      "table_id": "<string>",
      "title": "<string>",
      "columns": [
        {
          "$type": "Derivitec.Web.Core.LegacyReportQuery.LegacyTableColumnWire, Derivitec.Web.Core",
          "key": "<string>",
          "display_name": "<string>",
          "tool_tip": "<string>",
          "data_type": "string",
          "renderer_role": "plain_text",
          "width": 123,
          "visible": true,
          "filterable": true,
          "chartable": true,
          "supported_operators": [
            "is_equal_to"
          ],
          "multiplier": 123,
          "decimals": 123,
          "format": "<string>",
          "is_error_flag": true,
          "is_error_message": true
        }
      ],
      "pivots": [
        {
          "$type": "Derivitec.Web.Core.LegacyReportQuery.LegacyTablePivotWire, Derivitec.Web.Core",
          "key": "<string>",
          "display_name": "<string>",
          "active": true,
          "link_kind": "none"
        }
      ],
      "initial_expansion_depth": 123,
      "max_expansion_depth": 123
    }
  ],
  "active_tab_index": 123,
  "available_table_views": [
    {
      "$type": "Derivitec.Web.Core.LegacyReportQuery.LegacyTableViewOption, Derivitec.Web.Core",
      "id": "<string>",
      "display_name": "<string>"
    }
  ],
  "selected_table_view_id": "<string>",
  "can_export_raw": true,
  "can_export_current_view": true,
  "export_prohibited_reason": "<string>"
}

Retrieve the table definition of a report run whose data is not held in Druid.

Returns the tabs of an accessible report run, each carrying its column and pivot metadata and the depth its pivots open to, for a run stored outside Druid. It returns no row values. An unavailable or restricted run returns an unsuccessful response envelope. Report restriction and caller fields are server-managed, and the definition describes only what the caller is authorized to see.

POST

api

ReportQuery

LegacyTableDefinition

Retrieve the table definition of a report run whose data is not held in Druid.

curl --request POST \
  --url https://api.riskportal.activeviam.com/api/ReportQuery/LegacyTableDefinition \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "$type": "Derivitec.Web.Core.LegacyReportQuery.ApiGetLegacyTableDefinitionRequest, Derivitec.Web.Core",
  "report_id": "<string>",
  "table_view_definition_id": "<string>"
}
'

import requests

url = "https://api.riskportal.activeviam.com/api/ReportQuery/LegacyTableDefinition"

payload = {
    "$type": "Derivitec.Web.Core.LegacyReportQuery.ApiGetLegacyTableDefinitionRequest, Derivitec.Web.Core",
    "report_id": "<string>",
    "table_view_definition_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.LegacyReportQuery.ApiGetLegacyTableDefinitionRequest, Derivitec.Web.Core',
    report_id: '<string>',
    table_view_definition_id: '<string>'
  })
};

fetch('https://api.riskportal.activeviam.com/api/ReportQuery/LegacyTableDefinition', 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/ReportQuery/LegacyTableDefinition",
  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.LegacyReportQuery.ApiGetLegacyTableDefinitionRequest, Derivitec.Web.Core',
    'report_id' => '<string>',
    'table_view_definition_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/ReportQuery/LegacyTableDefinition"

	payload := strings.NewReader("{\n  \"$type\": \"Derivitec.Web.Core.LegacyReportQuery.ApiGetLegacyTableDefinitionRequest, Derivitec.Web.Core\",\n  \"report_id\": \"<string>\",\n  \"table_view_definition_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/ReportQuery/LegacyTableDefinition")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"$type\": \"Derivitec.Web.Core.LegacyReportQuery.ApiGetLegacyTableDefinitionRequest, Derivitec.Web.Core\",\n  \"report_id\": \"<string>\",\n  \"table_view_definition_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.riskportal.activeviam.com/api/ReportQuery/LegacyTableDefinition")

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.LegacyReportQuery.ApiGetLegacyTableDefinitionRequest, Derivitec.Web.Core\",\n  \"report_id\": \"<string>\",\n  \"table_view_definition_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "$type": "Derivitec.Web.Core.LegacyReportQuery.ApiGetLegacyTableDefinitionResponse, Derivitec.Web.Core",
  "is_success": true,
  "error_messages": [
    "<string>"
  ],
  "report_id": "<string>",
  "report_name": "<string>",
  "reporting_currency": "<string>",
  "tabs": [
    {
      "$type": "Derivitec.Web.Core.LegacyReportQuery.LegacyTableTabWire, Derivitec.Web.Core",
      "table_id": "<string>",
      "title": "<string>",
      "columns": [
        {
          "$type": "Derivitec.Web.Core.LegacyReportQuery.LegacyTableColumnWire, Derivitec.Web.Core",
          "key": "<string>",
          "display_name": "<string>",
          "tool_tip": "<string>",
          "data_type": "string",
          "renderer_role": "plain_text",
          "width": 123,
          "visible": true,
          "filterable": true,
          "chartable": true,
          "supported_operators": [
            "is_equal_to"
          ],
          "multiplier": 123,
          "decimals": 123,
          "format": "<string>",
          "is_error_flag": true,
          "is_error_message": true
        }
      ],
      "pivots": [
        {
          "$type": "Derivitec.Web.Core.LegacyReportQuery.LegacyTablePivotWire, Derivitec.Web.Core",
          "key": "<string>",
          "display_name": "<string>",
          "active": true,
          "link_kind": "none"
        }
      ],
      "initial_expansion_depth": 123,
      "max_expansion_depth": 123
    }
  ],
  "active_tab_index": 123,
  "available_table_views": [
    {
      "$type": "Derivitec.Web.Core.LegacyReportQuery.LegacyTableViewOption, Derivitec.Web.Core",
      "id": "<string>",
      "display_name": "<string>"
    }
  ],
  "selected_table_view_id": "<string>",
  "can_export_raw": true,
  "can_export_current_view": true,
  "export_prohibited_reason": "<string>"
}

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 report-run ReportId and an optional TableViewDefinitionId selecting a saved table view. Report restriction and caller fields are server-managed. Which columns are filterable or sortable, and the units of their values, are described by the response rather than assumed by the caller.

Asks for the authorized table definition of a report run whose data is not held in Druid. The server derives the available table views; the caller never supplies column definitions.

$type

enum<string>

required

Available options:

Derivitec.Web.Core.LegacyReportQuery.ApiGetLegacyTableDefinitionRequest, 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

table_view_definition_id

string | null

Named table view to apply. Null selects the user's default.

report_type

enum<string>

The report category that selects the applicable metadata shape. Server-managed.

Available options:

risk,

var,

pnl,

time_series

Response

Returns the report's tabs with their column and pivot metadata, or an unsuccessful envelope when the run is unavailable, restricted, or not stored outside Druid.

The authorized table definition of a non-Druid Risk report.

$type

enum<string>

required

Available options:

Derivitec.Web.Core.LegacyReportQuery.ApiGetLegacyTableDefinitionResponse, 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.

report_id

string | null

Report id.

report_name

string | null

Report name.

reporting_currency

string | null

Reporting currency, which the client needs for the FX cross self-link exclusion.

tabs

object[] | null

Ordered table tabs.

Show child attributes

active_tab_index

integer<int32>

Index of the tab that starts active.

available_table_views

object[] | null

Named table views the user may select.

Show child attributes

selected_table_view_id

string | null

Currently selected named table view.

can_export_raw

boolean

Whether the raw dump export is allowed.

can_export_current_view

boolean

Whether the current-view export is allowed.

export_prohibited_reason

string | null

Why export is prohibited, when it is.

Introduction

Release and upgrades

User guide

Admin user guide

APIs Endpoints

Retrieve the table definition of a report run whose data is not held in Druid.

Authorizations

Body

Response