...
URL: https://o171-q001-ww01.eagleinvsys.com/eagle/report/v1/adhocReport? reportName=******&entityId=****,****&beginDate= YYYYMMDD &endDate= YYYYMMDD &fields= 7377,7373,11429,11779,11780&outputFormat=JSON JSON/ JSON2/ CSV/ TSV/ XLS/ ERX |
Below are For details of the regarding input parameter parameters and its their values in the POST request payload and GET Request request URL String string of the adhocReport endpoint to extract and OLAP report data.
...
Input Parameter
...
Description
...
reportName
...
Name of the Report. As the name indicates, report name should be provided in string format.
...
entityId
...
Single entity ID or multiple entity IDs with comma (,) or tilde (~) as separator should be provided in string format.
...
beginDate
...
Beginning date of the report should be provided in this particular format (YYYYMMDD).
...
endDate
...
End Date of the report should be provided in this particular format (YYYYMMDD).
...
fields
...
- Single field ID or multiple field IDs with comma (,) or tilde (~) as separator should be provided in string format.
- Fields related to entity or security characteristic should be given along with calculation or other performance fields.
...
outputFormat
...
- Provide any one output format from the list JSON, JSON2, CSV, TSV, XLS, ERX to receive response in that particular format.
- Any format apart from these given options will get you response in JSON2 format (default).
...
"benchmarkOverride":
{
"Comparison Index 4":"<Entity ID>",
"Comparison Index 5": "<Entity ID>",
"IsEntities": true
}
...
- For another entity to override as benchmark to replace already configured benchmark. Provide another entity Id as benchmark.
- Provide a boolean value true in 'IsEntities' flag for another entity override.
- Either another entity or another benchmark assignment is allowed.
...
"benchmarkOverride":
{
"Comparison Index 5": "Primary Comparison Index",
"IsEntities": false
}
...
, refer to OLAP REST API – POST VS GET Method.
| Info |
|---|
Note Mandatory/Required parameters: reportName, beginDate, endDate, outputFormat Optional parameters: fields, entities. If not given or given as empty string will submit and generate report with all fields and entities mapped with that respective report profile |
...