REST API Overrides and Supporting OLAP Reports
OLAP REST API exposes set 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 method supports 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 method of adhocReport, see the page ‘OLAP REST API POST Vs. GET
Mandatory parameters are Report name, Entity ID, Begin effective Date, and End effective Date. Other overrides like benchmark, Currency conversion, Grouping rule, Report rule, field rule, fields, date
type and security filter criteria are optional.
Optional payload parameters supported in various OLAP reports.
Overrides applicable in OLAP REST API | |||||
---|---|---|---|---|---|
# | Report Types | Benchmark | Currency | Grouping Rules | Report and Field Rule |
1 | Cash Activity | No | Yes | No | Yes |
2 | Cash Balance | No | Yes | No | Yes |
3 | Composite Analysis | Yes | Yes | No | Yes |
4 | Composite Monitor | No | No | No | No |
5 | Entity and Client | Yes | Yes | No | Yes |
6 | Ledger Activity | No | Yes | No | Yes |
7 | Lot Level Positions | No | Yes | No | Yes |
8 | Lot Level Reconciliation | No | No | No | No |
9 | Net Asset Value | No | No | No | No |
10 | Performance Analysis | Yes | Yes | Yes | Yes |
11 | Positions Reconciliation | No | No | No | No |
12 | Positions Report | Yes | Yes | No | Yes |
13 | Security Report | No | No | No | Yes |
14 | Trade Reconciliation | No | No | No | No |
15 | Trades | No | Yes | No | Yes |
Note: Currency Conversion override on portfolios and benchmarks has different features. For more information on various features and details, see "OLAP REST API Interfaces’