Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 17 Next »

REST API Overrides and Supporting OLAP Reports

OLAP REST API exposes sets of endpoints in GET and POST method. AdhocReport is the endpoint that allows the user to run the OLAP reports by overriding the mentioned parameters. Both POST and GET methods support the adhocReport endpoint. 


Payload parameters supported in the POST method are not all supported in the GET method. For more information on the POST vs GET methods of adhoReport, refer to OLAP REST API POST vs GET (ADD LINK). Mandatory parameters are Report name, Entity ID, Begin effective Date, and End effective Date.  Other overrides like benchmark, currency conversion, grouping rules, report rules, field rules, field, date type, and security filter critieria are optional. Optional payload parameters supported in various OLAP reports are described in the following table. 



Overrides applicable in OLAP REST API
#Report TypesBenchmarkCurrencyGrouping RulesReport and Field Rule
1Cash ActivityNoYesNoYes
2Cash BalanceNoYesNoYes
3Composite AnalysisYesYesNoYes
4Composite MonitorNoNoNoNo
5Entity and ClientYesYesNoYes
6Ledger ActivityNoYesNoYes
7Lot Level PositionsNoYesNoYes
8Lot Level ReconciliationNoNoNoNo
9Net Asset ValueNoNoNoNo
10Performance AnalysisYesYesYesYes
11Positions ReconciliationNoNoNoNo
12Positions ReportYesYesNoYes
13Security ReportNoNoNoYes
14Trade ReconciliationNoNoNoNo
15TradesNoYesNoYes

Note: Currency Conversion override on portfolios and benchmarks has different features. For more information on various features and details, see "OLAP REST API Interfaces’


  • No labels