Versions Compared

Old Version 26

changes.mady.by.user Pamela Totas

Saved on

compared with

New Version 27

changes.mady.by.user Pamela Totas

Saved on

Key

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

...

  • 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.

...

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

...

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"
  }
]

...

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

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.

...

GET METHOD:

Sample Request URL:

https://o171-q001-ww01.eagleinvsys.com/eagle/report/v1/adhocReport?reportName=JSON_Structural_change&entityId= MTHREN10, MTHREN9&beginDate=19800302&endDate=19800302&fields= 7377, 7373, 11429, 11779, 11780&outputFormat=JSON

Postman Reference:

Both GET and POST method API request for ADHOC submit with overrides will return the same response, provided with same data as query string or JSON.

...