Versions Compared

Key

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

You can execute Data Services using EQL and Generic Extractor REST APIs.

Below are examples showing how to run Data Services extracts using the MC2 Swagger UI.

Table of Contents

Run Data Services Extracts using Generic Extractor

One option to run EBS extracts is to use the Generic Extractor REST API. The Swagger for the Generic Extractor REST API can be retrieved from:

Code Block
languagejs
https://eagle-web-server/eagle/v2/generic/extract/api-doc
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 to returns the extracted data in a ZIP file.

All parameters supported by the Generic Extractor are supported in the REST request.

To execute a test REST request you can use the MC2 Swagger UI. Open the browser (Chrome) to point to the mc2/swagger-ui.html endpoint:

Code Block
https://eagle-web-server/mc2/swagger-ui.html

In the dropdown on the right top corner select Generic Extractor:


Click on eaglegenericextractrestapi, then click on POST and Try It Out:


In the Example Value Model add:

Code Block
languagejs
themeDJango
titleSample Generic Extractor POST Body
linenumberstrue
{
  "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:



The result will be 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

The EQL REST API Swagger is available at:

Code Block
languagejs
http://eagle-web-server/eagle/v2/eql/api-doc


The EQL interface allows for the execution of one ad-hoc or pre-defined 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:

Code Block
languagejs
themeDJango
titleSample EQL REST Api POST Body
linenumberstrue
{
            "FeedType" : "genericentity" ,
            "emlObjectType": "Entity",
            "outputformat": "EagleJSON",
            "filters": {
                "maxrows" : "5"
            },
            "SaveSQLQuery": "Y",
            "invalidatecache": "Y"
}

Then click Execute:


The result is shown in the Response Body box below: