REST API Overrides and Supporting OLAP Reports
OLAP The OLAP REST API exposes set sets of endpoints in both the GET and POST method. AdhocReport AdhocReport is the endpoint that endpoint that allows the user to run the OLAP reports by overriding the mentioned parameters. Both POST
...
the GET and POST 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 adhocReport,
...
refer to OLAP REST API – POST
...
...
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 criteria are optional.
...
Optional payload parameters supported in various OLAP reports are described in the following table.
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 |
...
Currency Conversion override on portfolios and benchmarks
...
have different features. For more information on various features and details,
...
refer to OLAP REST API
...