Run an Extract Definition Asynchronously

Use an asynchronous request to submit an existing extract definition as an extract job.

1. Identify the extract definition that you want to run.
2. Submit a POST request to the runExtract endpoint.

Request Example

{
  "ExtractDefinitionName": "SalesExtract",
  "Type": "ORA_ASYNC"
}

Response Example

{
  "Type": "ORA_ASYNC",
  "ExecutionId": "300100679988223",
  "ExtractDefinitionName": "SalesExtract",
  "UserDefinedQueryName": null,
  "CallbackFlag": null,
  "OutputFormat": null,
  "Parameters": null,
  "RequestId": "135315",
  "Status": "Success",
  "Result": null
}

The response includes a RequestId after the extract job is submitted successfully. Use the request ID to monitor the job and retrieve the extract output.

For this request pattern, don't send UserDefinedQueryName, CallbackFlag, OutputFormat, or Parameters. The API ignores these attributes.

Considerations

The ExtractDefinitionName must identify a valid extract definition.

If parameter values must differ from the values configured for an existing extract definition, an active schedule cannot exist for that extract definition. Otherwise, the API returns an error.