Invoke OpenAPI with Input
Overview
The Invoke OpenAPI with Input node sends an HTTP request through a configured OpenAPI service and outputs the JSON response as a DataObject. It includes an input port so the API call can be connected after another node in the workflow.
Purpose
Use this node when an API call should run after, or be connected to, upstream workflow data. The request configuration is the same as Invoke OpenAPI.
Configuration
All configuration options are the same as Invoke OpenAPI:
| Field | Description |
|---|---|
| OpenAPI Service | Select an existing OpenAPI service, or create one inline. See Open API Service. |
| Operation | For services without an uploaded OpenAPI specification, choose the HTTP method manually. |
| Path | For services without an uploaded OpenAPI specification, enter the request path manually. |
| Select Path | For services with an OpenAPI specification, choose the operation path from the service definition. |
| Headers | Optional request headers as key/value pairs. Values can use workflow properties. |
| Body Type | Request body mode: None, Raw (JSON), or Form-Data. |
| Body (JSON) | JSON request body used when Raw (JSON) is selected. |
| Body (Form-Data) | Form-data key/value pairs used when Form-Data is selected. |
| Path Parameters | Values that replace placeholders in the URL path. |
| Query Parameters | Query string parameters appended to the request URL. |
Inputs
| Input | Data Type | Input Type | Description |
|---|---|---|---|
| Input | Any | Multiple | Any Input |
Outputs
| Output | Data Type | Collection | Description |
|---|---|---|---|
| DataObject | DataObject | False | JSON response body returned by the API. |
Properties
| Property | FlowDataType | Description |
|---|---|---|
| OPEN_API_INFO | JsonNode | |
| OPEN_API_OPERATION | JsonNode | |
| REQUEST_URL | String | Request URL |
| REQUEST_METHOD | String | Request Method |
| REQUEST_HEADERS | JsonNode | Request Headers |
| REQUEST_BODY | String | Request Body |
| RESPONSE_CODE | Integer | Response Code |
| RESPONSE_STATUS_TEXT | String | Response Status Text |
| RESPONSE_HEADERS | JsonNode | Response Headers |
Processing Logic
At runtime, the node builds and sends the API request from its configured service, operation/path, headers, body settings, path parameters, and query parameters. It validates that the response body is non-empty JSON, adds request and response metadata properties, and emits the response JSON as a DataObject. Non-success HTTP responses fail the node.
Examples
Connect a file reader, import node, or transformation upstream when the API call should be part of a connected processing chain, then configure the request the same way you would configure Invoke OpenAPI.
Notes / Limitations
- The response body must be valid JSON.
- Non-success HTTP responses fail the node.
- The current processor builds the request body from the configured Body (JSON) or Body (Form-Data) settings.