REST Client
Description
REST Client calls RESTful web services using standard HTTP methods (GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS) and returns the response as fields in the data stream. Use this step when your workflow needs to interact with REST APIs — for example, retrieving data from a cloud service, submitting records to a web application, or triggering a remote action. It supports multiple authentication types, custom headers, query parameters, and dynamic URL construction from input fields. For additional features like authenticated proxies and GraphQL, use the Advanced REST Client step instead.
Configurations
| Field Name | Description |
|---|---|
| General Tab: Enter basic connection information for accessing a resource. | |
| Step name | Specify the name of the step as it appears in the workflow workspace. This name has to be unique in a single workflow. |
| URL | Specify the path to a REST client resource. (Representational State Transfer (REST) is a key design idiom that embraces a stateless client-server architecture in which the web services are viewed as resources and can be identified by their URLs). |
| Accept URL from field | Enable checkbox to accept path to a resource from a field. |
| URL field name | Choose a field which defines the path to a resource |
| HTTP method | Choose how the step interacts with a resource---options are either GET, PUT, DELETE, POST, HEAD, or OPTIONS |
| Get Method from field | Enable checkbox to GET method from a field. |
| Method fieldname | Specify the field from which the GET method is defined. |
| Body field | Choose a field from the dropdown list that contains the request body for POST, PUT,and DELETE methods |
| Application type | Choose what type of application a resource is---options are either TEXT PLAIN, XML, JSON, OCTET STREAM, XHTML, FORM URLENCODED, ATOM XML, SVG XML, or TEXT XML |
| Result fieldname | Specify the name of the result output field |
| HTTP status code fieldname | Specify the name of the HTTP status code field |
| Response time (milliseconds) fieldname | Specify the name of the response time field |
| Authentication Tab: | Enter authentication details for a resource in the Authentication tab. |
| HTTP Login | Specify the username required to access a resource |
| HTTP Password | Specify the password associated with the provided HTTP Login user name |
| Preemptive | Enable checkbox to send the authentication credentials before a server gives an unauthorized response |
| Proxy Host | Specify the name of a proxy host, if proxy authentication is required |
| Proxy Port | Specify the port number of a proxy host, if proxy authentication is required |
| SSL Tab: Provide authentication details for accessing a resource that requires SSL certificate authentication | |
| Truststore file | Specify the location of a truststore file |
| Truststore password | Specify the password associated with the provided truststore file |
| Headers Tab: | |
| Field | Define the content of any HTTP headers using an existing field. Populate the list of fields by clicking the Get fields button. |
| Name | Provide a name |
| Parameters Tab: | |
| Parameter | Choose the parameters to set value. |
| Parameter | Provide parameter values for POST, PUT, and DELETE requests. GET parameters should be part of the URL directly. |
| Matrix Parameters Tab: | |
| Parameter | Choose the parameter to set value. |
| Parameter | Provide parameter values for POST, PUT, and DELETE requests. GET parameters should be part of the URL directly. |