REST connector
The REST connector enables you to add calls to RESTful web services inside a process workflow. You can then process the response through a parameterized template, which can be used as the body of an HTTP request in later steps in a workflow.
Required license
Configuration parameters
You can configure the default settings for the REST connector as described in Configuring-service-connectors. The following table describes the parameter required to create a connection:
Parameter | Example | Description |
|---|---|---|
Default Base URL | The base URL to enable workflow actions to use relative URLs. A base URL enables the workflow action to target the endpoint by relative URL: /method. The workflow action can override the base URL by specifying the full URL to an endpoint: http://server2-example.com /method | |
Connect Timeout | 30000 | Time in milliseconds that the connector waits for a response before cancelling the connection attempt. Default value—30000 ms |
Read Timeout | 30000 | Time in milliseconds that the connector waits for a response before cancelling the read attempt. Default value—30000 ms |
(Version 23.3.04 and later) Parameters to enable two-way SSL support
You can configure a two-way Secure Sockets Layer (SSL) support for the REST connector. The two-way SSL is a security protocol that ensures both parties involved in communication (server and client) authenticate each other by using SSL certificates.
Before version 23.3.04, the REST connector used a one-way Secure Sockets Layer (SSL) over the HTTPS protocol, verifying only the server. When the target server enforced trusted client restriction or two-way SSL, the REST connector failed to connect. Two-way SSL support resolves the issue by validating the server and client, and protecting data through encryption. It establishes trust by confirming identities and ensures compliance with security standards.
You can continue using the one-way SSL for the REST connector. If you want to introduce two-way SSL support, create another REST connection. Previously created connections don't need to be changed.
Parameter | Example | Description |
|---|---|---|
Store Type | PKCS12 | Enter the store type you use. Only the PKCS12 store type is supported. |
Trust Store Location | client-truststore.jks | Upload the client trust store certificate from your local machine. The certificate must have the .jks extension. Other extensions are not supported. |
Key Store Location | client-keystore.jks | Upload the client key store certificate from your local machine. The certificate must have the .jks extension. Other extensions are not supported. |
Key Store Secret | secret | Enter your key store secret value. |
Trust Store Secret | 123 | Enter your trust store secret value. |
The following image shows these parameters:
Workflow actions available through the REST connector
The following table provides an overview of all REST connector actions:
Action | Description | Input parameters | Output parameters |
|---|---|---|---|
Send HTTP Request | Sends an HTTP request to a RESTful web service. | ||
Render Template | Processes parameterized template, inserts passed arguments into the template’s parameters, and returns the rendered template as a string. Template argument values are processed before they are inserted into the template so that special characters are escaped by the rules specified in the Template Type parameter. | ||
Generate JWT | Generates a signed or unsigned JSON web token. |
Input and output parameters for actions
Send HTTP Request input parameters
Send HTTP Request output parameters
Render Template input parameters
Render Template output parameters
Generate JWT Input parameters
Generate JWT output parameters