Overview of the runExtract REST API
Use the runExtract REST API to run user-defined queries and extract definitions from an external application or integration.
-
Use a synchronous request to run a user-defined query and return the query output immediately.
-
Use an asynchronous request to run a user-defined query or submit an existing extract definition as an extract job. The API returns a request ID that you can use to monitor the job and retrieve the output.
Endpoint
POST /fscmRestApi/scm/redwood/11.13.18.05/runExtractRequest Attributes
| Attribute | Required | Description |
|---|---|---|
| Type | Yes | Specify ORA_SYNC for a synchronous user-defined query or ORA_ASYNC for an asynchronous request. |
| UserDefinedQueryName | Conditional | Name of the user-defined query. Required for synchronous requests and optional for asynchronous requests. |
| ExtractDefinitionName | Conditional | Name of an existing extract definition. Use this attribute for an asynchronous request that runs an extract definition. |
| Parameters | No | Parameter names and values for the user-defined query. Applicable to synchronous requests and asynchronous requests that specify UserDefinedQueryName. |
| CallbackFlag | No | Specify Y to send a callback for an asynchronous user-defined query request. The default value is N. |
| OutputFormat | No | Output format for an asynchronous request that specifies UserDefinedQueryName. Valid values are CSV and JSON. The default value is CSV. |
Response Attributes
| Attribute | Description |
|---|---|
| Type | Execution mode specified in the request. |
| ExecutionId | Identifier of the API execution. |
| ExtractDefinitionName | Name of the extract definition, when applicable. |
| UserDefinedQueryName | Name of the user-defined query, when applicable. |
| CallbackFlag | Callback setting for an asynchronous user-defined query request. |
| OutputFormat | Output format for an asynchronous user-defined query request. |
| Parameters | Parameter values specified in the request. |
| RequestId | Identifier of the submitted extract job. Returned for a successful asynchronous request. |
| Status | Status of the request: Success or Failure. |
For an asynchronous user-defined query request with CallbackFlag set
to Y, configure a callback workflow agent before you run the
request. For more information, see Configure a Callback Workflow
Agent.
Use the Monitoring tab to review synchronous executions and asynchronous extract jobs. For more information, see Monitor Extract Activity.