The Portfolio Analysis Controller resource represents a controller that allows the caller to trigger actions on a portfolio analysis. Currently only a single action can be performed which is to trigger the calculation of a Custom Time Period Portfolio Analysis resource (and optionally any reporting component alternative settings portfolios linked to the portfolio). This resource requires a simple Xml query to be included in the message body of a POST request. Further details of formulating this query can be found in the Portfolio Analysis Controller link relation.
For further details of what a Custom Time Period Portfolio Analysis represents refer to the resource page.
Calculating results for Custom Time Period Portfolio Analyses is not an action that can return results immediately on-the-fly and so for this reason we have the Portfolio Analysis Controller resource as a trigger mechanism to enqueue the request within the Revolution platform. Upon triggering the calculation of a Custom Time Period Portfolio Analysis this controller resource emits one of the following responses:
In order to understand how to trigger a Custom Time Period Portfolio Analysis using the Portfolio Analysis Controller resource it is necessary to formulate a query which is described in more detail in the Portfolio Analysis Controller link relation.
See the annotated representations below detailing the responses of the Portfolio Analysis Controller in XML and JSON representations of the resource for the 200 (= OK) response.
The Portfolio Analysis Controller resource is exposed via XML and JSON representations, which have the following media type names:- > application/vnd.statpro.revolution.api.portfolio-analysis-controller+xml
When a response is received from the web service with status 200 (= OK), the fact that the response contains a Portfolio Analysis Controller resource representation is indicated by the presence of one of these two response headers:- > Content-Type: application/vnd.statpro.revolution.api.portfolio-analysis-controller+xml; charset=utf-8
Content-Type: application/vnd.statpro.revolution.api.portfolio-analysis-controller+json; charset=utf-8
The Portfolio Analysis Controller resource links to the Custom Time Period Portfolio Analysis resource. To do so, its resource representations use link relations:-
custom-time-period-portfolio-analysis link relation identifies the link that allows the caller to access the resulting triggered custom time period portfolio analysis.
All related resources are accessed using the HTTP GET method.
Last updated: June 2017