...
GET method of OLAP RESTful web service is used to read/request the data from the Eagle data warehouse. Below are the list of GET Endpoints supported by OLAP RESTAPIREST API.
Features | BASE URL’s |
Report Profiles | https://o171-q001-ww01.eagleinvsys.com/eagle/report/v1/reportProfiles |
Fields | https://o171-q001-ww01.eagleinvsys.com/eagle/report/v1/fields |
Fields By Indicator | https://o171-q001-ww01.eagleinvsys.com/eagle/report/v1/fieldsByIndicator/{FieldIndicator} |
Entities | https://o171-q001-ww01.eagleinvsys.com/eagle/report/v1/entities |
Entity By Id | https://o171-q001-ww01.eagleinvsys.com/eagle/report/v1/entity/ {EntityID} |
Entity By Name | https://o171-q001-ww01.eagleinvsys.com/eagle/report/v1/entitiesByEntityNameLike/{Entitynamelike} |
Entity By Type | https://o171-q001-ww01.eagleinvsys.com/eagle/report/v1/entitiesByType/{EntityType} |
...
URL: https://o171-q001-ww01.eagleinvsys.com/eagle/report/v1/adhocReportadhocReport? reportName=******&entityId=****,****&beginDate= YYYYMMDD &endDate= YYYYMMDD &fields= 7377,7373,11429,11779,11780&outputFormat=JSON JSON/ JSON2/ CSV/ TSV/ XLS/ ERX |
Details of input parameter and its values in POST request payload and GET Request URL String of ‘adhocReport’ endpoint to extract and OLAP report data.
Input Parameter | Description |
reportName | Name of the Report. As name indicates, report name should be provided in string format. |
entityId | Single entity Id or multiple entity Id’s 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 Id’s 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). |
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.
Sample Sample POST Request with Payload:
...