Versions Compared

Key

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

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

...

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

For details about how host and port, see REST Endpoints.Executing

Execute Generic Extract request

In order to get generate an extract you should , send a POST request to the  http://host:port/eagle/v2/generic/extract  and set query parameters in JSON format as a request body as shown below.

Code Block
languagejs
titleRequest 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 willreceive geta ZIP archive with the extract files orin TSR inor JSON format in the event casethat no data was extracted or some errors occurred.