StatPro Revolution Web API


The Portfolio Analysis Bulk Status Resource


Overview

The Portfolio Analysis Bulk Status resource represents a collection of portfolio analyses where each item in the collection gives brief information regarding the status of that portfolio analyses latest calculation. Most of this status information can be obtained from a single portfolio analysis resource, however this resource allows for extracting the status information for a bulk set of portfolio analyses in one go. It is also lighter weight than the portfolio analysis resources as it is optimized for just extracting the key status information. For further details of the status information retrieved refer to the annotations below.

Requests for the Portfolio Analysis Bulk Status resource allows for extracting status information for a specified set of portfolios or all portfolios accessible to the user. Additional query strings exist that can be used to optionally extract specific status fields and to adjust the analysis context (i.e. whether we are considering the default, compliance, awaiting sign-off or signed-off results). For further details of these query strings refer to the documentation for further details of the portfolio-analysis-status-bulk link relation.


Media types

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

application/vnd.statpro.revolution.api.portfolio-analysis-status-bulk+json

application/vnd.statpro.revolution.api.portfolio-analysis-status-bulk+xml

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

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

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


Related resources

The Portfolio Analysis Bulk Status resource links to the Service resource and itself. To do so, its resource representations use link relations:-

  • service
  • self

The service link relation identifies the Service resource link.

The self link relation identifies the Portfolio Analysis Bulk Status resource link, in which the representation is the same as the one that has been currently retrieved (so long as the underlying data on the server hasn't changed).


Update history

  • Initial Version - May 2018

Annotated Representation (JSON)

Legend

{
  "portfolioAnalysisStatuses": {
    "links": {
      "service": {
        "rel": "service",
        "href": "...",
        "type": "application/vnd.statpro.revolution.api.service+json"
      },
      "self": {
        "rel": "self",
        "href": "...",
        "type": "application/vnd.statpro.revolution.api.portfolio-analysis-status-bulk+json"
      }
    },
    "items": [
      {
        "portfolioId": "37f70bab-aede-4de2-802b-003c09128adb",
        "status": "Finished",
        "calculationTrigger": "Batch",
        "statusUpdated": "2018-05-03T22:05:21Z",
        "latestResultsDate": "2018-05-02",
        "defaultAnalysis": {
          "rel": "default-portfolio-analysis",
          "href": "...",
          "type": "application/vnd.statpro.revolution.api.portfolio-analysis+json"
        }
      },
      {
        "portfolioId": "910f28a4-252f-4d12-8a57-04b39dc302be",
        "status": "FinishedWithMessages",
        "calculationTrigger": "Imports",
        "statusUpdated": "2018-05-03T22:10:21Z",
        "latestResultsDate": "2018-05-02",
        "defaultAnalysis": {
          "rel": "default-portfolio-analysis",
          "href": "...",
          "type": "application/vnd.statpro.revolution.api.portfolio-analysis+json"
        }
      },
      {
        "portfolioId": "092e8be8-07b0-4f77-98cf-056da537a534",
        "status": "InProgress",
        "calculationTrigger": "Manual",
        "statusUpdated": "2018-05-03T21:10:21Z",
        "defaultAnalysis": {
          "rel": "default-portfolio-analysis",
          "href": "...",
          "type": "application/vnd.statpro.revolution.api.portfolio-analysis+json"
        }
      }
    ]
  }
}


Annotated Representation (XML)

Legend

<?xml version="1.0" encoding="utf-8"?>
<portfolioAnalysisStatuses 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-analysis-status-bulk+xml" />
  <portfolioAnalysis>
    <portfolioId>37f70bab-aede-4de2-802b-003c09128adb</portfolioId>
    <status>Finished</status>
    <calculationTrigger>Batch</calculationTrigger>
    <statusUpdated>2018-05-03T22:05:21Z</statusUpdated>
    <latestResultsDate>2018-05-02</latestResultsDate>
    <link rel="default-portfolio-analysis"
          href="..."
          type="application/vnd.statpro.revolution.api.portfolio-analysis+xml" />
  </portfolioAnalysis>
  <portfolioAnalysis>
    <portfolioId>910f28a4-252f-4d12-8a57-04b39dc302be</portfolioId>
    <status>FinishedWithMessages</status>
    <calculationTrigger>Imports</calculationTrigger>
    <statusUpdated>2018-05-03T22:10:21Z</statusUpdated>
    <latestResultsDate>2018-05-02</latestResultsDate>
    <link rel="default-portfolio-analysis"
          href="..."
          type="application/vnd.statpro.revolution.api.portfolio-analysis+xml" />
  </portfolioAnalysis>
  <portfolioAnalysis>
    <portfolioId>092e8be8-07b0-4f77-98cf-056da537a534</portfolioId>
    <status>InProgress</status>
    <calculationTrigger>Manual</calculationTrigger>
    <statusUpdated>2018-05-03T21:10:21Z</statusUpdated>
    <link rel="default-portfolio-analysis"
          href="..."
          type="application/vnd.statpro.revolution.api.portfolio-analysis+xml" />
  </portfolioAnalysis>
</portfolioAnalysisStatuses>


Last updated: May 2018


To Top