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 how host and port, see Manage REST Endpoints.
Executing Generic Extract request
...
Execute the Generic Extract Request
After completing the steps outlined in the following procedure, you will receive a ZIP archive with the extract files in TSR or JSON format.
To generate an extract request:
To generate an extract, send a POST request to http://host:port/eagle/v2/generic/
...
Set query parameters in JSON format as a request body as shown below.
...
Request Body Example
| Code Block | ||
|---|---|---|
| ||
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" |
...
} |
...
] |
...
} |
...
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.)