Versions Compared

Old Version 17

changes.mady.by.user Pamela Totas

Saved on

compared with

New Version 18

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 endpoints on GET and POST methods of various OLAP endpoints exposed via RESTful web service.

...

This includes all types of like Regular fields, Advance fields, Special fields, Performance  and 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
    }
]

...

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

This is to filter a specific entity using an 8-digit entity idEntity 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"
  }
]

...

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

...