Page Comparison

...

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 REST API.

Features	BASE URL’s
Report Profiles	https://o171-q001-ww01.eagleinvsys.com/eagle/report/v1/reportProfiles
Benchmark Definitions	https://o171-q001-ww01.eagleinvsys.com/eagle/report/v1/benchmarkDefinitions
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}

Details on individual GET Endpoints

...

This gives the profile names of all types of Performance Calculations, OLAP Reports and Advance reports.

Resource path: /eagle/report/v1/reportProfiles
Examples:
Web Browser	https://o171-q001-ww01.eagleinvsys.com/eagle/report/v1/reportProfiles
Curl	curl -u user:password “https://o171-q001-ww01.eagleinvsys.com/eagle/report/v1/reportProfiles”
Sample response: [ { "instance": 257, "profileName": "13F Report", "reportType": "Advanced Reporting ", "updateUser": "BASELINE ADMIN", "updateDate": 1398830400000 } ]

fields: A GET request to return a list of fields.

This includes all types of like Regular fields, Advance fields, Special fields, Performance fields etc.

Resource path: /eagle/report/v1/fields
Examples:
Web Browser	https://o171-q001-ww01.eagleinvsys.com/eagle/report/v1/fields
Curl	curl -u user:password “https://o171-q001-ww01.eagleinvsys.com/eagle/report/v1/fields”
Sample response: [ { "id": 139, "description": "i Settlement Date", "indicator": "T", "type": "Date", "updateSource": "REGFA", "updateDate": 1268884800000 } ]

fieldsByIndicator: A GET request to return the list of report fields by field indicator.

Fields of all types are assigned with an indicator respective to the database it belongs to and those are fetched with a filter mentioned in this endpoint.

Resource path: /eagle/report/v1/fieldsByIndicator/{fieldIndicator}
Examples:
Web Browser	https://o171-q001-ww01.eagleinvsys.com/eagle/report/v1/fieldsByIndicator/H
Curl	curl -u user:password “https://o171-q001-ww01.eagleinvsys.com/eagle/report/v1/fieldsByIndicator/H”
Sample response: [ { "id": 143, "description": "i Book Value (lot)", "indicator": "H", "type": "Numeric", "updateSource": "REGFA", "updateDate": 1268884800000 } ]

entities: A GET request to return a list of report entities.

This includes all types of entities like Portfolios, Performance composites, Reporting Composites, Entity List etc.

Resource path: /eagle/report/v1/entities
Examples:
Web Browser	https://o171-q001-ww01.eagleinvsys.com/eagle/report/v1/entities
Curl	curl -u user:password “https://o171-q001-ww01.eagleinvsys.com/eagle/report/v1/entities”
Sample response: [ { "id":"23980", "name":"JKAUMC9", "type":"COMP" }, { "id":"10120", "name":"ALLGIPS ", "type":"LIST" } ]

entityById: A GET request to return an entity based on its Id.

This is to filter a specific entity using an 8-digit entity id.

Resource path: /eagle/report/v1/entity/{entity id}
Examples:
Web Browser	https://o171-q001-ww01.eagleinvsys.com/eagle/report/v1/entity/LTTEST02
Curl	curl -u user:password “https://o171-q001-ww01.eagleinvsys.com/eagle/report/v1/entity/LTTEST02”
Sample response: [ { "id": "LTTEST02", "name": "LTTEST02", "type": "PORT" } ] For another Entity [ { "id": "JKAUMC1", "name": "JKAUMC1 Entity Name", "type": "ACOM" } ]

entitiesByEntityNameLike: A GET request to return a list of entities that contain the specified value in the Entity name. This is to apply filters on the Entity name to query the list of Entities matching with the entity name filter.

Resource path: /eagle/report/v1/entitiesByEntityNameLike/{entity name}
Examples:
Web Browser	https://o171-q001-ww01.eagleinvsys.com/eagle/report/v1/entitiesByEntityNameLike/JKA
Curl	curl -u user:password “https://o171-q001-ww01.eagleinvsys.com/eagle/report/v1/entitiesByEntityNameLike/JKA”
Sample response: [ { "id": "JKOPTST2", "name": "COPYJKACOM23 ", "type": "ACOM" }, { "id": "JKACOM36", "name": "Copy of JKACOM3 ", "type": "ACOM" } ]

entitiesByType: A GET request to return a list of entities by entity type.

This includes all types of entities like Portfolios, Performance composites, Reporting Composites, Entity List, Custom index etc. This endpoint is used to filter the entities by entity type.

Resource path: /eagle/report/v1/entitiesByType/{entity type}
Examples:
Web Browser	https://o171-q001-ww01.eagleinvsys.com/eagle/report/v1/entitiesByType/COMP
Curl	curl -u user:password “https://o171-q001-ww01.eagleinvsys.com/eagle/report/v1/entitiesByType/COMP”
Sample response: [ { "id": "JKTXC34", "name": "JK DQM VOL CMP34", "type": "COMP" }, { "id": "JKTXC35", "name": "JK DQM VOL CMP35", "type": "COMP" } ]

POST method of REST Endpoint

...

URL : https://o171-q001-ww01.eagleinvsys.com/eagle/report/v1/adhocReport

Payload:

{ 
"reportName": "string", 
"entityId": "string", 
"beginDate": "YYYYMMDD",
"endDate": "YYYYMMDD", 
"fields": "string",
"outputFormat": "JSON/ JSON2/ CSV/ TSV/ XLS/ ERX"
"benchmarkToPortfolio": true/false,
"constituentsAndBenchmarkToComposite": true/false,
"firstAlternateCurrency": "string",
"secondAlternateCurrrency": "string",
"fetchPriorFXRates": "number",
"benchmarkOverride": {
"Comparison Index 4":"string",
"Comparison Index 5": "string",
"IsEntities": true/false
},
}

GET

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

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.

...

Versions Compared

Old Version 14

New Version 15

Key