The Compliance Portfolio Analysis resource represents the compliance analysis of one of the identified user’s portfolios. The portfolio in question may be owned by the user, or may be owned by another user and shared to the identified user. The resource contains basic information about the portfolio, compliance analysis information and information about the calculation (or execution) of that analysis. If the analysis has finished being calculated, then the resource exposes a further link to a resource that contains the compliance analysis’s total results data.
A compliance portfolio analysis’s status is important. It indicates whether the calculation of the analysis is in progress, has finished, has failed, or whether no results are available. If the analysis is in progress then it will become either finished or failed at some point in the future. Re-request the resource periodically (say once every three seconds) to determine its final status.
If a compliance portfolio analysis has finished (with or without messages), then analysis results are available, and returned representations will include a link to the Compliance Total Results resource that contains the total level compliance results.
If a compliance portfolio analysis has failed, then no analysis results are available. Instead the returned representation will include one or more error messages detailing why the compliance analysis failed.
If a compliance portfolio analysis’s status indicates that no results are available, then no results can be calculated given the current state of the portfolio and/or its compliance analysis. It may be that the portfolio has been recently created, and currently has no holdings. Alternatively, previous results may have expired and been removed from the system. In this case the user hasn’t logged in to the Revolution desktop website for a while, and will need to do so in order to trigger a recalculation of his/her compliance portfolio analyses. (Note that the Web API is not able to trigger analysis recalculations.)
The Compliance Portfolio Analysis resource is exposed via XML and JSON representations, which have the following media type names:- > application/vnd.statpro.revolution.api.compliance-portfolio-analysis+json
When a response is received from the web service with status 200 (= OK), the fact that the response contains a Compliance Portfolio Analysis resource representation is indicated by the presence of one of these two response headers:- > Content-Type: application/vnd.statpro.revolution.api.compliance-portfolio-analysis+json; charset=utf-8
Content-Type: application/vnd.statpro.revolution.api.compliance-portfolio-analysis+xml; charset=utf-8
The Compliance Portfolio Analysis resource always links to the Service and Porfolios resources (and to itself). If the compliance portfolio analysis has finished then analysis results are available, and the resource will also link to the Compliance Total Results resource. To do so, its resource representations use link relations:-
self link relation identifies the link to the current Compliance Portfolio Analysis resource. Use this link to poll for availability of results (or calculation failure) if the current status indicates that the analysis is in-progress.
service link relation identifies the Service resource link.
portfolios-query link relation identifies the link that allows a new query for portfolios to be made.
compliance-backtesting-history link relation identifies the Compliance Backtesting History resource link.
compliance-validation-history link relation identifies the Compliance Validation History resource link.
compliance-total-results link relation identifies the link that allows a client application to extract the total level compliance results for the portfolio.
All related resources are accessed using the HTTP GET method.
Please refer to Portfolio Analysis - Processing Messages.
categoriesare now available for the
errorscollections - Oct 2018
statusUpdatedis now available - May 2018
investmentStrategyare now available - August 2017.
stressTestMaximumThresholdare now available under the
commitmentLeverageMonitoringsection - June 2017.
Last updated: Oct 2018