StatPro Revolution Web API


The Portfolio Comments Resource


Overview

The Portfolio Comments resource represents the set of comments made by users on a particular portfolio for a particular type portfolio comment. Currently only two types of portfolio comment are supported in the API, Compliance Backtesting and Compliance Validation comments.

See annotated representations below for further details of the results output by this resource.


Media types

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

application/vnd.statpro.revolution.api.portfolio-comments+json

application/vnd.statpro.revolution.api.portfolio-comments+xml

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

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

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


Related resources

The Portfolio Comments resource always links to the Service and Porfolios resources (and to itself). To access these resources use the link relations:-

  • self
  • service
  • portfolios-query

The self link relation identifies the link to the current Portfolio Comments resource.

The service link relation identifies the Service resource link.

The portfolios-query link relation identifies the link that allows a new query for portfolios to be made.


Update history

  • Initial Version - June 2017

Annotated Representation (JSON)

Legend

{
  "portfolioComments": {
    "links": {
      "service": {
        "rel": "service",
        "href": "...",
        "type": "application/vnd.statpro.revolution.api.service+json"
      },
      "portfoliosQuery": {
        "rel": "portfolios-query",
        "href": "...?$filter={filter}&$orderby={orderby}&$skip={skip}&$top={top}&includePublishedPortfolios=false&portfolioClassifierCode=",
        "type": "application/vnd.statpro.revolution.api.portfolios+json"
      },
      "self": {
        "rel": "self",
        "href": "...",
        "type": "application/vnd.statpro.revolution.api.portfolio-comments+json"
      }
    },
    "portfolioCommentType": "complianceBacktesting",
    "comments": [
      {
        "applicationDate": "2017-05-12",
        "dateStamp": "2017-05-12T12:00:00Z",
        "commentOwner": "Admin Account",
        "comment": "Return manually overridden."
      },
      {
        "applicationDate": "2017-05-12",
        "dateStamp": "2017-05-12T11:00:00Z",
        "commentOwner": "Admin Account",
        "comment": "VaR manually overridden."
      }
    ]
  }
}


Annotated Representation (XML)

Legend

<?xml version="1.0" encoding="utf-8"?>
<portfolioComments xmlns="http://statpro.com/2012/Revolution">
  <link rel="service"
        href="..."
        type="application/vnd.statpro.revolution.api.service+xml" />
  <link rel="portfolios-query"
        href="...?$filter={filter}&amp;$orderby={orderby}&amp;$skip={skip}&amp;$top={top}&amp;includePublishedPortfolios=false&amp;portfolioClassifierCode="
        type="application/vnd.statpro.revolution.api.portfolios+xml" />
  <link rel="self"
        href="..."
        type="application/vnd.statpro.revolution.api.portfolio-comments+xml" />
  <portfolioCommentType>complianceBacktesting</portfolioCommentType>
  <comments>
    <comment>
      <applicationDate>2017-05-12</applicationDate>
      <dateStamp>2017-05-12T12:00:00Z</dateStamp>
      <commentOwner>Admin Account</commentOwner>
      <comment>Return manually overridden.</comment>
    </comment>
    <comment>
      <applicationDate>2017-05-12</applicationDate>
      <dateStamp>2017-05-12T11:00:00Z</dateStamp>
      <commentOwner>Admin Account</commentOwner>
      <comment>VaR manually overridden.</comment>
    </comment>
  </comments>
</portfolioComments>


Last updated: June 2017


To Top