On This Page:
| Table of Contents |
|---|
Application Server REST Endpoints
MC2 exposes a set of REST Endpoints. The REST endpoints are exposed directly on the Application Server on baseport + 207. For more information about calculating the REST endpoint port number, see Calculating MC2 Endpoints Port Numbers.
The baseport is 20000 + 220 = 20220 and the REST API port is 20427. You can access the page with the list of available Swagger definitions at http://appserverhostname:20427/eagle/v2/api-doc. This link provides a JSON document with the list of all available APIs grouped by resources. A full extract SWAGGER definition is located at http://appserverhostname:20427/eagle/v2/extract/api-doc. In addition, you can access the SWAGGER for a Warehouse group that you can use at:
http://xn--http-4b7a//appserverhostname:20427/eagle/v2/extract/api-doc.
Web Server REST Endpoints
After 2017R2, you can execute the requests listed above directly from the Eagle Web Server. After providing Eagle supported authentication credentials, you can access the web server using a web browser or a command-line tool, such as curl, to gain access. https://webserver/eagle/v2/api-doc.
Swagger UI REST Endpoint
The Swagger UI can be used to navigate the exposed REST endpoints and execute sample requests. The Swagger UI REST Endpoint is exposed on 2017R2 and later environments at https://webserver/mc2/swagger-ui.html.
Execute 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, such as curl, to execute REST requests.
...
The Eagle Extract Service REST requests return different results depending on the Force Empty Extract File parameter setting as described in Force Empty Extract File Generation.
Eagle Data Services REST Requests
You can execute the Eagle Data Services extracts through the EQL endpoint http://webserver/eagle/v2/eql/api-doc
...