Create a saved PnL launcher item.

curl --request POST \
  --url https://api.riskportal.activeviam.com/api/ReportLauncher/PnlReportLauncherItemCreate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "$type": "Derivitec.Web.Core.ReportLauncher.ApiPnlReportLauncherItemCreateRequest, Derivitec.Web.Core",
  "report_name": "Daily risk overview",
  "reporting_currency": "USD",
  "market_data_environment_names": [
    "<string>"
  ],
  "portfolio_name": "Example portfolio"
}
'

import requests

url = "https://api.riskportal.activeviam.com/api/ReportLauncher/PnlReportLauncherItemCreate"

payload = {
    "$type": "Derivitec.Web.Core.ReportLauncher.ApiPnlReportLauncherItemCreateRequest, Derivitec.Web.Core",
    "report_name": "Daily risk overview",
    "reporting_currency": "USD",
    "market_data_environment_names": ["<string>"],
    "portfolio_name": "Example portfolio"
}
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.ReportLauncher.ApiPnlReportLauncherItemCreateRequest, Derivitec.Web.Core',
    report_name: 'Daily risk overview',
    reporting_currency: 'USD',
    market_data_environment_names: ['<string>'],
    portfolio_name: 'Example portfolio'
  })
};

fetch('https://api.riskportal.activeviam.com/api/ReportLauncher/PnlReportLauncherItemCreate', 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/ReportLauncher/PnlReportLauncherItemCreate",
  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.ReportLauncher.ApiPnlReportLauncherItemCreateRequest, Derivitec.Web.Core',
    'report_name' => 'Daily risk overview',
    'reporting_currency' => 'USD',
    'market_data_environment_names' => [
        '<string>'
    ],
    'portfolio_name' => 'Example portfolio'
  ]),
  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/ReportLauncher/PnlReportLauncherItemCreate"

	payload := strings.NewReader("{\n  \"$type\": \"Derivitec.Web.Core.ReportLauncher.ApiPnlReportLauncherItemCreateRequest, Derivitec.Web.Core\",\n  \"report_name\": \"Daily risk overview\",\n  \"reporting_currency\": \"USD\",\n  \"market_data_environment_names\": [\n    \"<string>\"\n  ],\n  \"portfolio_name\": \"Example portfolio\"\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/ReportLauncher/PnlReportLauncherItemCreate")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"$type\": \"Derivitec.Web.Core.ReportLauncher.ApiPnlReportLauncherItemCreateRequest, Derivitec.Web.Core\",\n  \"report_name\": \"Daily risk overview\",\n  \"reporting_currency\": \"USD\",\n  \"market_data_environment_names\": [\n    \"<string>\"\n  ],\n  \"portfolio_name\": \"Example portfolio\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.riskportal.activeviam.com/api/ReportLauncher/PnlReportLauncherItemCreate")

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.ReportLauncher.ApiPnlReportLauncherItemCreateRequest, Derivitec.Web.Core\",\n  \"report_name\": \"Daily risk overview\",\n  \"reporting_currency\": \"USD\",\n  \"market_data_environment_names\": [\n    \"<string>\"\n  ],\n  \"portfolio_name\": \"Example portfolio\"\n}"

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

{
  "$type": "Derivitec.Web.Core.ApiBaseResponse, Derivitec.Web.Core",
  "is_success": true,
  "error_messages": []
}

POST

api

ReportLauncher

PnlReportLauncherItemCreate

Create a saved PnL launcher item.

curl --request POST \
  --url https://api.riskportal.activeviam.com/api/ReportLauncher/PnlReportLauncherItemCreate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "$type": "Derivitec.Web.Core.ReportLauncher.ApiPnlReportLauncherItemCreateRequest, Derivitec.Web.Core",
  "report_name": "Daily risk overview",
  "reporting_currency": "USD",
  "market_data_environment_names": [
    "<string>"
  ],
  "portfolio_name": "Example portfolio"
}
'

import requests

url = "https://api.riskportal.activeviam.com/api/ReportLauncher/PnlReportLauncherItemCreate"

payload = {
    "$type": "Derivitec.Web.Core.ReportLauncher.ApiPnlReportLauncherItemCreateRequest, Derivitec.Web.Core",
    "report_name": "Daily risk overview",
    "reporting_currency": "USD",
    "market_data_environment_names": ["<string>"],
    "portfolio_name": "Example portfolio"
}
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.ReportLauncher.ApiPnlReportLauncherItemCreateRequest, Derivitec.Web.Core',
    report_name: 'Daily risk overview',
    reporting_currency: 'USD',
    market_data_environment_names: ['<string>'],
    portfolio_name: 'Example portfolio'
  })
};

fetch('https://api.riskportal.activeviam.com/api/ReportLauncher/PnlReportLauncherItemCreate', 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/ReportLauncher/PnlReportLauncherItemCreate",
  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.ReportLauncher.ApiPnlReportLauncherItemCreateRequest, Derivitec.Web.Core',
    'report_name' => 'Daily risk overview',
    'reporting_currency' => 'USD',
    'market_data_environment_names' => [
        '<string>'
    ],
    'portfolio_name' => 'Example portfolio'
  ]),
  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/ReportLauncher/PnlReportLauncherItemCreate"

	payload := strings.NewReader("{\n  \"$type\": \"Derivitec.Web.Core.ReportLauncher.ApiPnlReportLauncherItemCreateRequest, Derivitec.Web.Core\",\n  \"report_name\": \"Daily risk overview\",\n  \"reporting_currency\": \"USD\",\n  \"market_data_environment_names\": [\n    \"<string>\"\n  ],\n  \"portfolio_name\": \"Example portfolio\"\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/ReportLauncher/PnlReportLauncherItemCreate")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"$type\": \"Derivitec.Web.Core.ReportLauncher.ApiPnlReportLauncherItemCreateRequest, Derivitec.Web.Core\",\n  \"report_name\": \"Daily risk overview\",\n  \"reporting_currency\": \"USD\",\n  \"market_data_environment_names\": [\n    \"<string>\"\n  ],\n  \"portfolio_name\": \"Example portfolio\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.riskportal.activeviam.com/api/ReportLauncher/PnlReportLauncherItemCreate")

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.ReportLauncher.ApiPnlReportLauncherItemCreateRequest, Derivitec.Web.Core\",\n  \"report_name\": \"Daily risk overview\",\n  \"reporting_currency\": \"USD\",\n  \"market_data_environment_names\": [\n    \"<string>\"\n  ],\n  \"portfolio_name\": \"Example portfolio\"\n}"

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

{
  "$type": "Derivitec.Web.Core.ApiBaseResponse, Derivitec.Web.Core",
  "is_success": true,
  "error_messages": []
}

Authorizations

Authorization

string

header

required

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

Body

The body containing Item with its client-supplied saved-item Id, accessible ReportName and PortfolioName, optional PortfolioType, reporting currency, market-data environment names, real-time and run-date flags, optional run linkage, InitialDate, FinalDate, and optional LookbackPeriod. Caller, organisation, and internal report, portfolio, and provider identifiers are server-managed.

Payload for creating a saved P&L report launcher item.

$type

enum<string>

required

Available options:

Derivitec.Web.Core.ReportLauncher.ApiPnlReportLauncherItemCreateRequest, Derivitec.Web.Core

report_name

string | null

Organisation-scoped name of the report definition to use. The value must not be null or empty.

Example:

"Daily risk overview"

reporting_currency

string | null

Currency in which report values are expressed. When null, the service uses the caller's configured reporting currency or USD.

Example:

"USD"

market_data_environment_names

string[] | null

Names of market-data environments to use for the report. The list is empty by default.

portfolio_name

string | null

Name of the portfolio to select. The value must not be null or empty.

Example:

"Example portfolio"

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

item

object

P&L-specific saved report-launcher item.

Show child attributes

Response

Returns whether the PnL launcher item was saved and any validation or access errors in the response envelope.

Common operation outcome containing a success indicator and any error messages.

$type

enum<string>

required

Available options:

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

Introduction

Release and upgrades

User guide

Admin user guide

APIs Endpoints

Create a saved PnL launcher item.

Authorizations

Body

Response