V2NodesOpenAPI REST Request
OpenAPI REST Request
V2

OpenAPI REST Request

Execute template-driven REST operations defined in a cached OpenAPI specification.

Revision History

0.0.0.13 - Preserved the complete Connection URL when resolving relative schema and request paths.
0.0.0.12 - Preserved inherited fields in designer templates when OpenAPI schemas use constraints-only allOf overlays.
0.0.0.11 - Added generic OAuth authentication.
1.0.0.0 - Initial release.
1.0.0.3 - Fixed shared OAuthConnection lock handling.
1.0.0.4 - Fixed error message handling.
0.0.0.9 - Node name correction.

Connection

The Connection stores the service URL, authentication settings, the OpenAPI schema location, and the cached schema used for templates.

Property Type Description
URL String Base URL for the target REST service. The complete path and port are retained.
Authorization Enum Authentication mode: None, Basic, Bearer, or OAuth.
Username String Username used when Authorization is Basic.
Password Masked Password used when Authorization is Basic.
Bearer Token Masked Token used when Authorization is Bearer.
Auth URL String OAuth authorization endpoint used when Authorization is OAuth.
Token URL String OAuth token endpoint used when Authorization is OAuth.
Client ID Masked OAuth client identifier used when Authorization is OAuth.
Secret Key Masked OAuth client secret used when Authorization is OAuth.
Scope String OAuth scopes requested during authentication.
Access Token Masked OAuth access token populated after you connect the account.
Refresh Token Masked OAuth refresh token populated when the provider returns one.
Custom Headers String Additional headers in Key: Value format, one per line.
Authentication Test Path String Relative path used by the Connection test action.
Authentication Test HTTP Method Enum HTTP method used by the Connection test action: GET or OPTIONS.
Open API URL String URL of the OpenAPI document. An absolute value overrides URL; a relative value is appended beneath the complete URL.
Schema String Cached OpenAPI document populated by the Acquire Metadata Connection action.

Setup Notes

  • Set URL to an absolute HTTP or HTTPS URL for the target REST service.
  • Set Open API URL to the OpenAPI document location. Relative values are appended beneath the complete URL, and one leading / does not discard the Connection path.
  • Choose an authentication mode supported by the API. When you use OAuth, provide Auth URL, Token URL, Client ID, Secret Key, and any required Scope, then complete the account authorization step so the Connection can store Access Token and Refresh Token.
  • Add any required custom headers to Custom Headers in Key: Value format, one per line.
  • Do not include an Authorization header in Custom Headers when Authorization is set to Basic, Bearer, or OAuth.
  • Provide a lightweight Authentication Test Path before running the Connection test action.
  • Click Acquire Metadata on the Connection to download, validate, and cache the OpenAPI document used for templates.

Methods

The Node groups OpenAPI operations into query, mutation, and delete methods based on the HTTP verb defined in the cached schema.

Query

Executes a GET operation defined in the OpenAPI document.

Parameter Type Description
Connection Connection Connection containing the service URL, authentication settings, and cached schema.
OperationId String Identifier of the OpenAPI operation to execute. This is populated by the template.
Options Object Additional values used for route, query string, or header parameters required by the operation.
Return Type Description
Response Array Response objects emitted for the items returned by the API.

Mutation

Executes a POST, PUT, or PATCH operation defined in the OpenAPI document.

Parameter Type Description
Connection Connection Connection containing the service URL, authentication settings, and cached schema.
OperationId String Identifier of the OpenAPI operation to execute. This is populated by the template.
Options Object Additional values used for route, query string, or header parameters required by the operation.
Items Array Optional request body item stream. One item sends one JSON object body. Multiple items are serialized into a JSON array.
Return Type Description
Response Array Response objects emitted for the items returned by the API.

Delete

Executes a DELETE operation defined in the OpenAPI document.

Parameter Type Description
Connection Connection Connection containing the service URL, authentication settings, and cached schema.
OperationId String Identifier of the OpenAPI operation to execute. This is populated by the template.
Options Object Additional values used for route, query string, or header parameters required by the operation.
Return Type Description
Response Array Response objects emitted for the items returned by the API.

Usage Notes

  • Templates are generated from the cached Schema, so refresh metadata whenever the upstream API contract changes.
  • If an operation returns a JSON object, the Node emits one Response object.
  • If an operation returns a JSON array, the Node emits one Response object per array element.
  • If an operation returns a primitive value or null, the Node wraps it in a value property.
  • If an OAuth-protected request returns a raw 401, the Node refreshes the access token once and retries the request automatically.

Known Issues

  • OAuth support assumes a standard authorization-code bearer-token flow and does not support PKCE-only public-client providers.