Run Data Services Extracts Using REST Requests

On This Page:

The Data Services can be executed using EQL and Generic Extractor REST APIs.

This page shows examples on how to run Data Services extracts using the MC2 Swagger UI.

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:

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:

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

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

Click on eaglegenericextractrestapi, then POST and Try It Out:

In the Example Value Model add:

{
  "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:

When you download the zip, you will see two files there:

Run Data Services Extracts Using EQL REST API

The EQL REST API Swagger is available at:

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.

A request from the EQL REST API can be executed using the MC2 Swagger UI at

http://eagle-web-server/mc2/swagger-ui.html

In the dropdown select EQL:

Click on eql-rest, then POST, then Try it Out

In the Example Value Model enter:

{
            "FeedType" : "genericentity" ,
            "emlObjectType": "Entity",
            "outputformat": "EagleJSON",
            "filters": {
                "maxrows" : "5"
            },
            "SaveSQLQuery": "Y",
            "invalidatecache": "Y"
}

Then click Execute:

The result will be shown in the Response Body box below: