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.

Details on Individual GET Endpoints

Following are details on individual GET endpoints.

 reportProfiles: A GET request to return a list of report profiles.

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

[
    {
        "instance": 257,
        "profileName": "13F Report",
        "reportType": "Advanced Reporting ",
        "updateUser": "BASELINE ADMIN",
        "updateDate": 1398830400000
    }
]

...

Details on Individual GET Endpoints

Following are details on individual GET endpoints.

 reportProfiles: A GET request to return a list of fieldsreport profiles.

This includes gives the profile names of all types of Regular fields, Advance fields, Special fields, and Performance fieldsPerformance Calculations, OLAP Reports and Advanced reports.

[
    {
        "

instance":

 257,
        "

profileName": "

13F Report",
        "

reportType": "

Advanced Reporting ",
        "

updateUser": "

BASELINE ADMIN",
        "updateDate":

 1398830400000
    }
]

fieldsByIndicatorfields: A GET request to return the a 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

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

[
    {
        "id":

 139,
        "description": "

i Settlement Date",
        "indicator": "

T",
        "type": "

Date",
        "updateSource": "REGFA",
        "updateDate": 1268884800000
    }
]

entitiesfieldsByIndicator: A GET request to return a the list of report entitiesfields by field indicator.

This includes all types of entities like Portfolios, Performance composites, Reporting Composites, and Entity List etcFields 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.

[

    {

        "id":

 143,

        "description": "

i Book Value (lot)",

        "indicator": "

H"

,

        "type": "

Numeric",

        "updateSource": "

REGFA",

        "updateDate": 1268884800000
    }
]

entityByIdentities: A GET request to return an entity based on its ID.        This is to filter a specific entity using an 8-digit Entity IDa list of report entities.

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

[
   {

"id":

"

23980",

 "name":

"

JKAUMC9",

"type":

"

COMP"

     },

   {
      "id":

"

10120",

      "name":

"

ALLGIPS ",

      "type":

"

LIST"

     }
]

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

...

an entity based on its ID.        

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

[

   {

       "id":

 "

LTTEST02",

       "name":

 "

LTTEST02",

       "type":

 "

PORT"

   }

]
For another Entity
[
  {   

      "id":

 "

JKAUMC1",

      "name":

 "JKAUMC1 Entity Name",

      "type":

 "ACOM"

  }
]

entitiesByTypeentitiesByEntityNameLike: 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, and Custom index. This endpoint is used to filter the entities by entity typethat contain the specified value in the Entity name. This applies filters on the Entity name to query the list of Entities matching with the entity name filter.

[
  {
        "id": "

JKOPTST2",
        "name": "

COPYJKACOM23 

",
        "type": "

ACOM"
    },

 {
        "id": "

JKACOM36",
        "name": "

Copy 

of 

JKACOM3 

",
        "type": "

ACOM"
    }
]

POST Method of REST Endpoint

adhocReport is a feature supported to extract OLAP report output using both POST and GET method. This runs a PACE report service based on the request payload input parameters in JSON format.

Request Formats:

POST

...

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, and Custom index. This endpoint is used to filter the entities by entity type.

[
 {
        "id": "

JKTXC34",

        "

name": "

JK DQM VOL CMP34",
        "

type": "

COMP"
    },

    {
        "id": "

JKTXC35",
        "

name": "

JK 

DQM 

VOL CMP35",
        "type": "

COMP"

GET

    }
]

entityTypes: A GET request to return a list of default Eagle entity types and custom entity types. This includes all types of default entities like Portfolios, Performance composites, reporting Composites, Entity List, Custom index etc., and user defined custom entity types.

[
     {  
        "entityType": "COMP",
        "type": "Base",
        "basetype": null,
        "updateDate": "2020-03-03 09:33:32",
        "updateUser": "ALOMBARDO"
    }]

performanceDictionaries: A GET request to return a list of performance dictionaries, which  are otherwise called as stored performance models.

[
{
        "dictionaryId": "95271",
        "dictionaryName": "113169PA-Position_Detail_Anl Check",
        "dictionaryLevel": "1",
        "dictionaryLevelDesc": "Entity",
        "fieldAttributeId": "-1"
    }]  

regularDictionaries: A GET request to return a list of regular dictionaries.

[
 {
        "dictionaryId": "188",
        "dictionaryName": "AK DICTIONARY",
        "dictionaryLevel": "1",
        "dictionaryLevelDesc": "VK_Currency",
        "fieldAttributeId": "9334"
     }
]

groupingRuleRange: A GET request to return a list of grouping rule Range fields which are used to construct dynamic grouping.

[

groupingRuleFilter: A GET request to return a list of grouping rule filter fields, which are used to construct dynamic grouping.

[
 {
        "guidelineID": 2,
        "guidelineName": "*M Transaction Type FIL",
        "guidelineDescription": "*M Transaction Type FIL",
        "updateSource": "DCLINTON",
        "updateDate": "2008-07-01 12:00:35",
        "comments": null
    },
  ]

globalAttributionFields: A GET request to return a list of global attribution fields of types Brinson Fachler, Karnosky Singer and Eagle Fixed Income style.

[
    {
        "id": 14533,
        "description": "104102 - Bf",
        "analysisStyle": "Brinson - Fachler",
        "updateSource": "PERFSMOKE",
        "updateDate": "2013-05-10 06:19:01"
    }]

POST Method of REST Endpoint

adhocReport is a feature supported to extract OLAP report output using both POST and GET method. This runs a PACE report service based on the request payload input parameters in JSON format.

Request Formats:

POST

{
"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 
               },
"groupingRuleOverride": {

    "groupModel": [{"simple": "fieldID"},{"range": "aggregationID"},{"perfModel": "dictionaryID"}],
    "calculationAndDisplay": {
        "calculateAttributionAndDisplay": "TOTAL/fieldID/aggregationID/SECURITY",
        "limitResultToLevelAbove": "DoNotLimit/Limit/LimitFetchDisplay/LimitFetchNotDisplay",
        "showBelowAttribution": "true/false",
        "hideBenchmarkOnlySecurities": "true/false"
    },
    "dynamicPerformance": {
       "portfolioLookThrough": true/false,
       "adjustSecurityToMatchParent": true/false,
       "applyFilterToBenchmark": true/false
    },
    "entityHierarchy":"BOTTOMUPBALANCED/TOPDOWNBALANCED/TOPDOWNUNBALANCED",
    "globalAttributionOptions": "Single-globalattributionFieldID"
  },
}

GET

Below are details of the input parameter and its values in the POST request payload and GET Request URL String of the adhocReport endpoint to extract and OLAP report data.

.

 Sample POST Request with Payload:

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

Payload:

...

.

 Sample POST Request with Payload:

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

Payload:

{

"reportName": "AG - GroupingRule Override GRModel1",
"entityId": "MTHREN8",
"beginDate": "20200504",
"endDate": "20200504",
"fields": "1087,1099,3277",
"outputFormat": "JSON, CSV"
"benchmarkToPortfolio": true,
"constituentsAndBenchmarkToComposite": false,
"firstAlternateCurrency": "GBP",
"secondAlternateCurrrency": "AUD",
"fetchPriorFXRates": "4",
"benchmarkOverride": {
               "Comparison Index 4":"Primary Comparison Index",
               "IsEntities": false           
               },
"groupingRuleOverride": {
    "groupModel": [{"simple": "1061"},{"range": "8178"},{"perfModel": "178"}],
    "calculationAndDisplay": {
        "calculateAttributionAndDisplay": "1060",
        "limitResultToLevelAbove": "LimitFetchDisplay",
        "showBelowAttribution": "true",
        "hideBenchmarkOnlySecurities": "true"
    },
    "dynamicPerformance": {
       "portfolioLookThrough": true,
       "adjustSecurityToMatchParent": true,
       "applyFilterToBenchmark": true
    },
    "entityHierarchy":"BOTTOMUPBALANCED",
    "globalAttributionOptions": "14533"
  },

}

GET METHOD:

Sample Request URL:

...