This documentation supports the 22.1 version of BMC Helix Digital Workplace Basic and BMC Helix Digital Workplace Advanced. Icons distinguish capabilities available only for the Advanced and External license levels. For more information, see License-types-and-features.

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.

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:

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 

Tip

Import the ServiceExport.zipas a service for an example with the Render Template input parameters.

Render Template output parameters

Generate JWT Input parameters 

Generate JWT output parameters

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*