Versions Compared

Old Version 18

changes.mady.by.user Pamela Totas

Saved on

compared with

New Version 19

changes.mady.by.user Pamela Totas

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

REST API Interfaces describes the endpoints on GET and POST methods of various OLAP endpoints exposed via RESTful web service. Topics CoveredIn this document you will find information on the following topics:

  • GET method of REST Endpoints
  • POST method of REST Endpoints

Base Path: https:// <hostname>//eagle/report/v1/<supported feature>

REST Endpoint output defaults to JSON Format.  In addition, the Endpoints are in camel casing and case sensitive.

GET

...

Method of REST Endpoints

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 Definitionshttps://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

Following are details on individual GET endpoints.

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

...

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

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

...

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 the 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 the name indicates, report name should be provided in string format.

entityId

Single entity Id ID or multiple entity Id’s 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 field ID or multiple field Id’s 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).
constituentsAndBenchmarkToCompositeProvide boolean value either true or false. This flag is applicable only for Composite Analysis report.
benchmartToPortfolioProvide boolean value either true or false. This flag is applicable for OLAP reports such as Performance Analysis, Positions and Entity And Client.
firstAlternateCurrencyProvide 3 letter predefined Currency code. For example, USD / CAD
secondAlternateCurrrencyProvide 3 letter predefined Currency code. For example, USD/CAD 
fetchPriorFXRatesProvide numeric value starting from 1 till 1000.

"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

     }

  • For another benchmark assignment to override. 
  • Provide another assignment name. Benchmark assignment name can be retrieved using 'benchmarkDefinitions' endpoint.
  • Provide a boolean value false in 'IsEntities' flag for another benchmark assignment.
  • Either another entity or another benchmark assignment is allowed.



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

.

 Sample POST Request with Payload:

...