...
...
...
...
...
...
...
...
...
To retrieve the full extract SWAGGER definition you can use:
...
...
...
...
...
Web Server REST Endpoints
| Tip |
|---|
| 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:
...
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
...
...
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.
...
For example, to retrieve an extract with one entity in JSON you can use either a HTTP GET or POST request
...
.
...
In case of a GET request, you can pass filter parameters
...
as a query
...
parameter as shown below:
...
...
With a POST request, you can pass filter parameters
...
within a JSON body
...
with multiple parameters
...
separated by a comma
...
:
POST Request Example
| Code Block | ||
|---|---|---|
| ||
http://appserverhostname:20427/eagle/v2/entities |
...
{ |
...
"maxrows": "1" |
...
} |
or in 2017R2
For 2017R2, this is the format: http://webserver/eagle/v2/entities?maxrows=1
To retrieve the result in EagleML, you can specify the output format
...
as:
...
http://appserverhostname:20427/eagle/v2/entities?maxrows=1&outputformat=eagleml
To retrieve the extract compressed, you can specify the output format
...
by appending +gzip
...
:
...
...
...
For a list of supported endpoints for EagleML extracts and their parameters/swagger files, see REST API Extracts.
The Eagle Extract Service REST requests return different results depending on the Force Empty Extract File parameter setting as described in About 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
or through the Generic Extract REST API http://webserver/eagle/v2/generic/extract/api-doc
See Run Data Services Extracts Using REST Requests for an example of execution.