Invoke OpenAPI
Overview
The Invoke OpenAPI node sends an HTTP request through a configured OpenAPI service and outputs the JSON response as a DataObject.
Purpose
Use this node when a workflow needs to retrieve or submit data through a REST API described by an OpenAPI specification, or through a manually configured API path on an OpenAPI service.
Configuration
| Field | Description |
|---|---|
| OpenAPI Service | Select an existing OpenAPI service, or click New Configuration to 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. Selecting a path can prefill headers, body type, path parameters, query parameters, and body hints. |
| 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, such as {petId}. |
| Query Parameters | Query string parameters appended to the request URL. |
Outputs
| Output | Data Type | Collection | Description |
|---|---|---|---|
| DataObject | DataObject | False | JSON response body returned by the API. |
Properties
| Property | FlowDataType | Description |
|---|---|---|
| OPEN_API_INFO | JsonNode | OpenAPI info object when available from the service specification. |
| OPEN_API_OPERATION | JsonNode | OpenAPI operation object when available from the selected path. |
| 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 loads the selected OpenAPI service. If the service has an OpenAPI specification, it resolves the selected operation and base URL from the service/specification. Otherwise, it uses the manually selected operation and path. It evaluates expressions in the configured body and request values, builds the HTTP request, sends it asynchronously, validates that the response body is non-empty JSON, stores request and response metadata properties, and emits the response JSON as a DataObject. Non-success HTTP responses fail the node.
Examples
The screenshot below shows a configured node calling the /pet/{petId} path of a Petstore service, with an api_key header and a petId path parameter:
Notes / Limitations
- The response body must be valid JSON. Non-JSON responses fail the node.
- Non-success HTTP responses fail the node with the status code and response JSON.
- The GeneralNode dialog includes a Properties tab and View Output preview when the node is configured.