Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

MC2 exposes a set of REST Endpoints. The REST endpoints are exposed directly on the Application Server on basePort + 207. The basePort is calculated based on the information from eagle/cfg/system.xml (or eagle/estar/tpe/cfg/system.xml on older systems).

For example if system.xml has the following data:

system.xml
<?xml version="1.0" encoding="UTF-8"?>
<system version="1.1">
  <servers baseport="20000" server_type="1" starversion="**Eagle Version 13.1**">
...
    <server ignorewsdb="1" name="extractservice" offset="220" type="extractservice"/>

The basePort will be 20000 + 220 = 20220 and the REST API port will be 20427.

The page with the list of available Swagger definitions can be accessed at

http://appserverhostname:20427/eagle/v2/api-doc

The above link will return a JSON document with the list of all available APIs grouped by resources.

To retrieve the full SWAGGER definition you can use:

http://appserverhostname:20427/eagle/v2/api-doc/all

Also, for example to retrieve the SWAGGER for Warehouse group only you can use:

http://appserverhostname:20427/eagle/v2/api-doc/warehouse

In 2017R2 and later we exposed the REST API thru the regular Eagle Web Server using the Eagle supported authentication.

After 2017R2 you can execute the above requests directly on the web server using either a Web Browser or a command line tool, like curl:

https://webserver/eagle/v2/api-doc


Executing Extract Service REST Requests

To execute an extract you can use the SWAGGER definition to see all resource endpoints and parameters supported to build the URL. You can use either a Web Browser or a command line tool, like curl, to execute REST requests.

For example to retrieve an extract with one entity in JSON you can use:

http://appserverhostname:20427/eagle/v2/entities?maxrows=1

or in 2017R2

http://webserver/eagle/v2/entities?maxrows=1


To retrieve the result in EagleML the output format can be specified as:

http://appserverhostname:20427/eagle/v2/entities?maxrows=1&outputformat=eagleml

To retrieve the extract compressed the output format can have +gzip appended:

http://appserverhostname:20427/eagle/v2/entities?maxrows=1&outputformat=eagleml+gzip

or

http://appserverhostname:20427/eagle/v2/entities?maxrows=1&outputformat=json+gzip

Please refer to wiki or SWAGGER for all supported resources and filters.


  • No labels