Versions Compared

Old Version 22

changes.mady.by.user Pamela Totas

Saved on

compared with

New Version 23

changes.mady.by.user Pamela Totas

Saved on

Key

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

...

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

...

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

...

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

...

POST Method of REST Endpoint

‘adhocReport’ 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.

...

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 Below are details of the input parameter and its values in the POST request payload and GET Request URL String of ‘adhocReport’ the 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 or multiple entity 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 or multiple field 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.


...