Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 9 Next »

The Generic Extract Rest API provides an interface that enables you to perform a generic extract.

  • The rest API base path is http://host:port/eagle/v2/generic/extract 
  • The rest API definition is http://host:port/eagle/v2/generic/extract/api-doc

For details about host and port, see REST Endpoints.

Execute Generic Extract Request

To generate an extract request:

  1. To generate an extract, send a POST request to http://host:port/eagle/v2/generic/extract.                      
  2.  Set query parameters in JSON format as a request body as shown below.


Request Body Example
curl -X POST -d @requestBody.json "http://host:port/eagle/v2/generic/extract"
requstBody.json content:

{
  "extractParameters": [
    {
      "name":"maxrows",
      "value":"1"
    },{
      "name":"OutputFormat",
      "value":"JSON"
    }
  ],
  "extracts": [
    {
      "name":"ENTITYEXTRACT"
    },
    {
      "name":"SMFEXTRACT"
    }
  ]
}

In response, you receive a ZIP archive with the extract files in TSR or JSON format in the event that no data was extracted or errors occurred.

  • No labels