Table of Contents |
---|
...
...
...
...
...
...
...
...
The Generic Extract REST API allows for the execution of multiple extracts, both standard EagleML extracts and Data Services extracts with one HTTP POST request and
...
returns the extracted data in a ZIP file.
All parameters supported by the Generic Extractor are supported in the REST request.
Execute a Test Request Using the Swagger UI
You can use the Swagger user interface to execute a test REST request.
To execute a test REST request
...
:
Open the browser (Chrome) to point to the mc2/swagger-ui.html endpoint:
Code Block https://eagle-web-server/mc2/swagger-ui.html
...
2. Select Generic Extractor from the dropdown list in the right top corner
...
:
...
3. Click on eaglegenericextractrestapi, then click on POST and Try It Out:
4. In the Example Value Model, add
...
...
Sample Generic Extractor POST Body
Code Block |
---|
...
|
...
| |
{
"extractParameters": [
{
"name": "ebs:default:outputformat",
"value": "EagleJSON"
},
{
"name": "ebs:default:invalidatecache",
"value": "Y"
}
],
"extracts": [
{
"name": "ebs:genericentity",
"extractParameters": [
{
"name": "maxrows",
"value": "5"
}
]
},
{
"name": "ebs:interfaces",
"extractParameters": [
{
"name": "maxrows",
"value": "10"
}
]
}
]
} |
Then click Execute:
...
5. Click Execute.
The result
...
is a ZIP file with two extracts as show below:
...
When you download the zip, you
...
see two files
...
:
...
...
Run Data Services Extracts Using EQL REST API
To run data services extracts using EQL REST API:
The EQL REST API Swagger is available at:
Code Block language js http://eagle-web-server/eagle/v2/eql/api-doc
The EQL interface allows for the execution of
...
a custom or core Eagle Data Services interface.
...
You can execute a request from the EQL REST API
...
using the MC2 Swagger UI at:
Code Block http://eagle-web-server/mc2/swagger-ui.html
...
Select EQL from the dropdown
...
list:
...
...
Click eql-rest, then click POST
...
and Try it
...
Out>.
...
In the Example Value Model enter the following:
Sample EQL REST API post body to execute EDS interface (example using core EDS interface genericentity)
Code Block language js
...
...
{ "FeedType" : "genericentity" , "emlObjectType": "Entity", "outputformat": "EagleJSON", "filters": { "maxrows" : "5" }, "SaveSQLQuery": "Y", "invalidatecache": "Y" }
...
Click Execute
...
.
...
The result
...
is shown in the Response Body box below:
Sample POST body to execute a user defined EDS interface:
{
"FeedType" : "wh_position_smf_ratings",
"outputformat": "EagleJSON",
"filters": {
"effectivedate" : "2019-06-09",
"entityId" :
...
"ASTL1900"
}
}