Request an Excel export of a report view.

curl --request POST \
  --url https://api.riskportal.activeviam.com/api/ReportQuery/ExportToExcel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "$type": "Derivitec.Web.Core.ReportQuery.ApiExportPivotToExcelRequest, Derivitec.Web.Core",
  "time_positions_loaded": "2023-11-07T05:31:56Z",
  "report_id": "<string>",
  "request_id": "<string>",
  "export_columns": [
    "<string>"
  ],
  "pivot_depth": 123,
  "pinned_columns": [
    "<string>"
  ],
  "prefilter": {
    "$type": "Derivitec.Web.Core.Filters.Filter, Derivitec.Web.Core",
    "field": "<string>",
    "type": "<string>"
  }
}
'

import requests

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

payload = {
    "$type": "Derivitec.Web.Core.ReportQuery.ApiExportPivotToExcelRequest, Derivitec.Web.Core",
    "time_positions_loaded": "2023-11-07T05:31:56Z",
    "report_id": "<string>",
    "request_id": "<string>",
    "export_columns": ["<string>"],
    "pivot_depth": 123,
    "pinned_columns": ["<string>"],
    "prefilter": {
        "$type": "Derivitec.Web.Core.Filters.Filter, Derivitec.Web.Core",
        "field": "<string>",
        "type": "<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.ReportQuery.ApiExportPivotToExcelRequest, Derivitec.Web.Core',
    time_positions_loaded: '2023-11-07T05:31:56Z',
    report_id: '<string>',
    request_id: '<string>',
    export_columns: ['<string>'],
    pivot_depth: 123,
    pinned_columns: ['<string>'],
    prefilter: {
      $type: 'Derivitec.Web.Core.Filters.Filter, Derivitec.Web.Core',
      field: '<string>',
      type: '<string>'
    }
  })
};

fetch('https://api.riskportal.activeviam.com/api/ReportQuery/ExportToExcel', 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/ExportToExcel",
  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.ReportQuery.ApiExportPivotToExcelRequest, Derivitec.Web.Core',
    'time_positions_loaded' => '2023-11-07T05:31:56Z',
    'report_id' => '<string>',
    'request_id' => '<string>',
    'export_columns' => [
        '<string>'
    ],
    'pivot_depth' => 123,
    'pinned_columns' => [
        '<string>'
    ],
    'prefilter' => [
        '$type' => 'Derivitec.Web.Core.Filters.Filter, Derivitec.Web.Core',
        'field' => '<string>',
        'type' => '<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/ExportToExcel"

	payload := strings.NewReader("{\n  \"$type\": \"Derivitec.Web.Core.ReportQuery.ApiExportPivotToExcelRequest, Derivitec.Web.Core\",\n  \"time_positions_loaded\": \"2023-11-07T05:31:56Z\",\n  \"report_id\": \"<string>\",\n  \"request_id\": \"<string>\",\n  \"export_columns\": [\n    \"<string>\"\n  ],\n  \"pivot_depth\": 123,\n  \"pinned_columns\": [\n    \"<string>\"\n  ],\n  \"prefilter\": {\n    \"$type\": \"Derivitec.Web.Core.Filters.Filter, Derivitec.Web.Core\",\n    \"field\": \"<string>\",\n    \"type\": \"<string>\"\n  }\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/ExportToExcel")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"$type\": \"Derivitec.Web.Core.ReportQuery.ApiExportPivotToExcelRequest, Derivitec.Web.Core\",\n  \"time_positions_loaded\": \"2023-11-07T05:31:56Z\",\n  \"report_id\": \"<string>\",\n  \"request_id\": \"<string>\",\n  \"export_columns\": [\n    \"<string>\"\n  ],\n  \"pivot_depth\": 123,\n  \"pinned_columns\": [\n    \"<string>\"\n  ],\n  \"prefilter\": {\n    \"$type\": \"Derivitec.Web.Core.Filters.Filter, Derivitec.Web.Core\",\n    \"field\": \"<string>\",\n    \"type\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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.ReportQuery.ApiExportPivotToExcelRequest, Derivitec.Web.Core\",\n  \"time_positions_loaded\": \"2023-11-07T05:31:56Z\",\n  \"report_id\": \"<string>\",\n  \"request_id\": \"<string>\",\n  \"export_columns\": [\n    \"<string>\"\n  ],\n  \"pivot_depth\": 123,\n  \"pinned_columns\": [\n    \"<string>\"\n  ],\n  \"prefilter\": {\n    \"$type\": \"Derivitec.Web.Core.Filters.Filter, Derivitec.Web.Core\",\n    \"field\": \"<string>\",\n    \"type\": \"<string>\"\n  }\n}"

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

{
  "$type": "Derivitec.Web.Core.ReportQuery.ApiExportPivotToExcelResponse, Derivitec.Web.Core",
  "is_success": true,
  "error_messages": [
    "<string>"
  ],
  "notification": {
    "$type": "Derivitec.Web.Core.Notifications.ExportPivotToExcelNotification, Derivitec.Web.Core",
    "title": "<string>",
    "user_id": "<string>",
    "organisation_id": "<string>",
    "request_id": "<string>",
    "is_marked_as_read": true,
    "timestamp": "2023-11-07T05:31:56Z",
    "status": "none",
    "status_message": "<string>",
    "report_id": "<string>"
  }
}

POST

api

ReportQuery

ExportToExcel

Request an Excel export of a report view.

curl --request POST \
  --url https://api.riskportal.activeviam.com/api/ReportQuery/ExportToExcel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "$type": "Derivitec.Web.Core.ReportQuery.ApiExportPivotToExcelRequest, Derivitec.Web.Core",
  "time_positions_loaded": "2023-11-07T05:31:56Z",
  "report_id": "<string>",
  "request_id": "<string>",
  "export_columns": [
    "<string>"
  ],
  "pivot_depth": 123,
  "pinned_columns": [
    "<string>"
  ],
  "prefilter": {
    "$type": "Derivitec.Web.Core.Filters.Filter, Derivitec.Web.Core",
    "field": "<string>",
    "type": "<string>"
  }
}
'

import requests

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

payload = {
    "$type": "Derivitec.Web.Core.ReportQuery.ApiExportPivotToExcelRequest, Derivitec.Web.Core",
    "time_positions_loaded": "2023-11-07T05:31:56Z",
    "report_id": "<string>",
    "request_id": "<string>",
    "export_columns": ["<string>"],
    "pivot_depth": 123,
    "pinned_columns": ["<string>"],
    "prefilter": {
        "$type": "Derivitec.Web.Core.Filters.Filter, Derivitec.Web.Core",
        "field": "<string>",
        "type": "<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.ReportQuery.ApiExportPivotToExcelRequest, Derivitec.Web.Core',
    time_positions_loaded: '2023-11-07T05:31:56Z',
    report_id: '<string>',
    request_id: '<string>',
    export_columns: ['<string>'],
    pivot_depth: 123,
    pinned_columns: ['<string>'],
    prefilter: {
      $type: 'Derivitec.Web.Core.Filters.Filter, Derivitec.Web.Core',
      field: '<string>',
      type: '<string>'
    }
  })
};

fetch('https://api.riskportal.activeviam.com/api/ReportQuery/ExportToExcel', 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/ExportToExcel",
  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.ReportQuery.ApiExportPivotToExcelRequest, Derivitec.Web.Core',
    'time_positions_loaded' => '2023-11-07T05:31:56Z',
    'report_id' => '<string>',
    'request_id' => '<string>',
    'export_columns' => [
        '<string>'
    ],
    'pivot_depth' => 123,
    'pinned_columns' => [
        '<string>'
    ],
    'prefilter' => [
        '$type' => 'Derivitec.Web.Core.Filters.Filter, Derivitec.Web.Core',
        'field' => '<string>',
        'type' => '<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/ExportToExcel"

	payload := strings.NewReader("{\n  \"$type\": \"Derivitec.Web.Core.ReportQuery.ApiExportPivotToExcelRequest, Derivitec.Web.Core\",\n  \"time_positions_loaded\": \"2023-11-07T05:31:56Z\",\n  \"report_id\": \"<string>\",\n  \"request_id\": \"<string>\",\n  \"export_columns\": [\n    \"<string>\"\n  ],\n  \"pivot_depth\": 123,\n  \"pinned_columns\": [\n    \"<string>\"\n  ],\n  \"prefilter\": {\n    \"$type\": \"Derivitec.Web.Core.Filters.Filter, Derivitec.Web.Core\",\n    \"field\": \"<string>\",\n    \"type\": \"<string>\"\n  }\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/ExportToExcel")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"$type\": \"Derivitec.Web.Core.ReportQuery.ApiExportPivotToExcelRequest, Derivitec.Web.Core\",\n  \"time_positions_loaded\": \"2023-11-07T05:31:56Z\",\n  \"report_id\": \"<string>\",\n  \"request_id\": \"<string>\",\n  \"export_columns\": [\n    \"<string>\"\n  ],\n  \"pivot_depth\": 123,\n  \"pinned_columns\": [\n    \"<string>\"\n  ],\n  \"prefilter\": {\n    \"$type\": \"Derivitec.Web.Core.Filters.Filter, Derivitec.Web.Core\",\n    \"field\": \"<string>\",\n    \"type\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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.ReportQuery.ApiExportPivotToExcelRequest, Derivitec.Web.Core\",\n  \"time_positions_loaded\": \"2023-11-07T05:31:56Z\",\n  \"report_id\": \"<string>\",\n  \"request_id\": \"<string>\",\n  \"export_columns\": [\n    \"<string>\"\n  ],\n  \"pivot_depth\": 123,\n  \"pinned_columns\": [\n    \"<string>\"\n  ],\n  \"prefilter\": {\n    \"$type\": \"Derivitec.Web.Core.Filters.Filter, Derivitec.Web.Core\",\n    \"field\": \"<string>\",\n    \"type\": \"<string>\"\n  }\n}"

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

{
  "$type": "Derivitec.Web.Core.ReportQuery.ApiExportPivotToExcelResponse, Derivitec.Web.Core",
  "is_success": true,
  "error_messages": [
    "<string>"
  ],
  "notification": {
    "$type": "Derivitec.Web.Core.Notifications.ExportPivotToExcelNotification, Derivitec.Web.Core",
    "title": "<string>",
    "user_id": "<string>",
    "organisation_id": "<string>",
    "request_id": "<string>",
    "is_marked_as_read": true,
    "timestamp": "2023-11-07T05:31:56Z",
    "status": "none",
    "status_message": "<string>",
    "report_id": "<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, a non-empty client-generated RequestId that identifies this export request, grid query, export and pinned columns, optional PivotDepth, optional Prefilter, and optional result-version TimePositionsLoaded timestamp. The export-request identifier is not a report-run identifier. Report restriction, report type, portfolio type, market-data environment, and caller fields are server-managed.

Grid, column, and filter selections for requesting an Excel export of a pivoted report view.

$type

enum<string>

required

Available options:

Derivitec.Web.Core.ReportQuery.ApiExportPivotToExcelRequest, Derivitec.Web.Core

time_positions_loaded

string<date-time>

Timestamp identifying the loaded-position result version to query.

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

request_id

string | null

Client-generated identifier for the export request; it is not a report-run identifier.

export_columns

string[] | null

Columns selected for the requested export.

grid_query

object

Client grid query for selecting, grouping, filtering, and sorting report rows.

Show child attributes

pivot_depth

integer<int32> | null

Optional pivot depth selected for the export.

pinned_columns

string[] | null

Pinned columns included in the requested export.

report_type

enum<string>

Report category that selects the applicable result or metadata shape.

Available options:

risk,

var,

pnl,

time_series

prefilter

object

Base selection criterion for a named report-data field.

Option 1
Option 2
Option 3
Option 4

Show child attributes

Response

Returns a Requested export acknowledgement carrying the supplied request identifier, or an unsuccessful envelope when the export is unavailable; no file content or download URL is returned.

Asynchronous acknowledgement for an Excel export request covering a pivoted report view.

$type

enum<string>

required

Available options:

Derivitec.Web.Core.ReportQuery.ApiExportPivotToExcelResponse, 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.

notification

object

User-facing record of a request's notification lifecycle and read state.

Show child attributes

Introduction

Release and upgrades

User guide

Admin user guide

APIs Endpoints

Request an Excel export of a report view.

Authorizations

Body

Response