StatPro Revolution Web API


The Portfolio Reporting Tags Resource


Overview

The Portfolio Reporting Tags resource represents a non-paged collection of reporting tags accessible within the identifier user's tenancy.

Portfolio Reporting Tags are optionally associated to a portfolio and can be used to label certain portfolios as having certain characteristics. This is typically used in circumstances where there are complex reporting requirements and so multiple alternative settings portfolios might get created to help fulfil them. This resource identifies the distinct reporting tags associated with all portfolios within the authenticated user's tenancy. The reporting tags associated with each portfolio are available from the the Portfolios and Portfolio Reporting Components resources.

A single portfolio reporting tag is made up of a reporting tag group and a reporting tag name. The group can optionally be specified to group different alternative settings portfolios into different groups. For example, if the reporting requires the same set of alternative settings portfolios but calculated in different currencies, then multiple groups might be created for each required currency. If no reporting tag group is specified, then a default value of 'Default' will be used.


Media types

The Portfolio Reporting Tags resource is exposed via XML and JSON representations, which have the following media type names:-

application/vnd.statpro.revolution.api.portfolio-reporting-tags+json

application/vnd.statpro.revolution.api.portfolio-reporting-tags+xml

When a response is received from the web service with status 200 (= OK), the fact that the response contains a Portfolio Reporting Tags resource representation is indicated by the presence of one of these two response headers:-

Content-Type: application/vnd.statpro.revolution.api.portfolio-reporting-tags+json; charset=utf-8

Content-Type: application/vnd.statpro.revolution.api.portfolio-reporting-tags+xml; charset=utf-8


Related resources

The Portfolio Reporting Tags resource links to the Service resource. It also links to itself. To do so, its resource representations use link relations:-

  • service
  • self

The service link relation identifies the Service resource link.

All related resources are accessed using the HTTP GET method.


Update history

  • Initial Version - February 2015

Annotated Representation (JSON)

Legend

{
  "service": {
    "links": {
      "service": {
        "rel": "service",
        "href": "...",
        "type": "application/vnd.statpro.revolution.api.service+json"
      },
      "self": {
        "rel": "self",
        "href": "...",
        "type": "application/vnd.statpro.revolution.api.portfolio-reporting-tags+json"
      }
    },
    "reportingTags": [
      {
        "group": "InUSD",
        "name": "Top-Down Single Level by Asset Class"
      },
      {
        "group": "InUSD",
        "name": "Top-Down Multi Level by Asset Class and Sector"
      },
      {
        "group": "InEUR",
        "name": "Top-Down Single Level by Asset Class"
      },
      {
        "group": "InEUR",
        "name": "Top-Down Multi Level by Asset Class and Sector"
      }
    ]
  }
}


Annotated Representation (XML)

Legend

<?xml version="1.0" encoding="utf-8"?>
<portfolioReportingTags xmlns="http://statpro.com/2012/Revolution">
  <link rel="service"
        href="..."
        type="application/vnd.statpro.revolution.api.service+xml" />
  <link rel="self"
        href="..."
        type="application/vnd.statpro.revolution.api.portfolio-reporting-tags+xml" />
  <reportingTag>
    <group>InUSD</group>
    <name>Top-Down Single Level by Asset Class</name>
  </reportingTag>
  <reportingTag>
    <group>InUSD</group>
    <name>Top-Down Multi Level by Asset Class and Sector</name>
  </reportingTag>
  <reportingTag>
    <group>InEUR</group>
    <name>Top-Down Single Level by Asset Class</name>
  </reportingTag>
  <reportingTag>
    <group>InEUR</group>
    <name>Top-Down Multi Level by Asset Class and Sector</name>
  </reportingTag>
</portfolioReportingTags>


Last updated: February 2015


To Top