Advanced REST Client
Description
Advanced REST Client is a step in the Utility Plugin for Process Studio Workflows. The REST Client workflow step enables you to consume RESTful services by making REST calls. It is an extension of the step ‘REST Client’ with more features as follows:
- Authenticated Proxy Support
- Option to ignore SSL certificate validation
- Request Timeout
- Form-data request body along with file upload by providing file path
- Ability to read HTTP Response headers
- Ability to test REST API
Limitations: Process Studio variables, parameters, and field names must never be same as the Parameter Key, irrespective of case (upper case or lower case).Configurations
| No. | Field Name | Description |
|---|---|---|
| 1 | 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. |
| 2 | HTTP Method | Specify the HTTP method with which the step will interact with a resource. Available HTTP methods are: GET, PUT, DELETE, POST, HEAD, OPTIONS, or PATCH. |
| 3 | URL | Specify the path to a REST client resource (HTTP URL). |
| Settings Tab: | Enter basic connection information for accessing a resource. | |
| General: | ||
| 1 | Request timeout in seconds | The time to establish the connection with the remote host. |
| SSL Configuration: | Provide authentication details for accessing a resource that requires SSL certificate authentication. | |
| 1 | Ignore SSL certificate verification | Enable this checkbox to ignore SSL certificate verification while making HTTPS connection. (This strategy ignores certificate checking, making it insecure and only to be used where it makes sense!!) |
| 2 | Trust store file | Specify trust store file path in case of HTTPS connection. |
| 3 | Browse | Click Browse button to select trust store file from local machine. |
| 4 | Trust store password | Specify trust store password in case of HTTPS connection |
| Proxy Configuration: | ||
| 1 | Use System Proxy | Enable checkbox to allow REST client to use the Process Studio's default proxy configurations. In case of AE agent, it will use agent's proxy configurations. |
| 2 | Proxy Type | Select Proxy server type (HTTP/HTTPS) |
| 3 | Proxy Host | Specify the name/IP of a proxy host, if proxy authentication is required |
| 4 | Proxy Port | Specify the port number of a proxy host, if proxy authentication is required |
| 5 | Proxy Username | In case of authenticated proxy server, provide username |
| 6 | Proxy Password | In case of authenticated proxy server, provide password |
| 7 | Proxy Exceptions (Non- Proxy Hosts) | Specify the Proxy Exceptions, that is, non-proxy hosts. The Proxy Exceptions (Non-Proxy Hosts) can hold semicolon- separated hostnames, IP addresses, and domain names that must not be accessed through the proxy server. When a client requests access to a resource, the proxy server checks the hostname or IP address against the semicolon separated non- proxy hosts. If there is a match, the proxy server forwards the request directly to the target server without going through the proxy. For example, if the Proxy Exceptions (Non-Proxy Hosts) set to "localhost;127.0.0.1;*.mydomain.com", then requests to the localhost, 127.0.0.1 and any server under the mydomain.com domain will be accessed directly without going through the proxy server. It will be considered when the “Use System Proxy” checkbox is unchecked and proxy details (at least Proxy Host and Proxy Port) are provided into the plugin. |
| Parameters Tab: | This tab contains table with three columns to provide request (URL) parameters | |
| 1 | Parameter Key | Specify the Request parameter keys to set value. |
| 2 | Parameter Value | Specify the Request parameter keys values. |
| 3 | Description | Specify a description for the parameter. |
| Authorization Tab: | Enter authorization details for a resource in the Authorization tab. | |
| HTTP Authorization: | ||
| 1 | Type | Select Request Authentication (No Authentication, Basic Authentication, Bearer Token, and OAuth 2.0). |
| 2 | Username | In case of Basic Authentication provide username |
| 3 | Password | In case of Basic Authentication provide password |
| Headers(0) Tab: | This tab contains table with four columns to provide request headers | |
| 1 | Header Key | Specify request header key |
| 2 | Header Value | Specify request header value |
| 3 | Header Value Field | Define the content of any HTTP headers using an existing field. Populate the list of fields by clicking the Get fields button. |
| 4 | Description | Specify a description for header |
| Request Body Tab: | Request Body tab has a group of radio buttons as follows: | |
| Request Body: | ||
| 1 | none | In case where request does not have a request body |
| 2 | raw | Specify raw Request Body as Text, HTML, XML, JSON or XML. You could insert fields in the raw body from the navigator by double clicking the field. Else, use template support in request body to substitute fields and environment variables/parameters in appropriate placeholders (?{fieldname}, ${environment variable}). |
| 3 | form-data | Enter Request body in tabular format in a form. Use form-data to send non-ASCII text or large binary data. |
| 4 | x-www-form-urlencoded | Enter Request body in tabular format in a form. Use x-www- form-urlencoded to send simple text/ASCII data. |
| 5 | read from file | In case where request body to be read from a file. |
| 6 | read from field | In case where request body text to be read from a field. |
| 7 | binary | In case where request body is to be read from a file. |
| 8 | GraphQL (Beta) | Specify GraphQL to execute the GraphQL query schema. Query: Specify a GraphQL query to read or fetch values or a mutation to write or post values. E.g. Query: students id fullName GraphQL Variables: GraphQL variables help to factor dynamic values out of the query and pass them as a separate dictionary. You could insert fields in the Query and GraphQL Variables from the navigator by double-clicking the field. Else, use template support in the request body to substitute fields and environment variables/parameters in appropriate placeholders Note: Please make sure, when substituting (field or environment variable) a string value we have to explicitly enclose that value in double quotes (""). Limitation: Subscription query are not supported by ARC GraphQL. |
| Form-data: | This tab contains table with five columns: | |
| 1 | Key Type | Select form-data parameter key type (Text/File) from the dropdown list. |
| 2 | Key | Specify form-data parameter key. |
| 3 | Value | Specify form-data parameter value. |
| 4 | Value Field | Select a field containing form-data parameter. |
| 5 | Description | Specify a description for form-data parameter String. |
| x-www-form-urlencoded: | This tab contains table with three columns: | |
| 1 | Key | Specify a parameter key. |
| 2 | Value | Specify a parameter value. |
| 3 | Description | Specify a description for parameter. |
| Read from file: | This tab contains table with five columns: | |
| 1 | Content type for request body | Select content-type for request body dropdown. |
| 2 | File Path | Specify request body file path. |
| 3 | View Request Body Contents | Click this button to view request body file contents |
| Read from field: | This tab contains table with five columns: | |
| 1 | Content type for request body | Select content-type for request body from dropdown |
| 2 | Field name | Specify request body raw text to be read from a field. |
| HTTP Response Tab: | This tab has Output fields. | |
| 1 | Response Status | Specify the output field to hold the HTTP Response status (e.g 200 OK). The default field name is ArcRespStatus. |
| 2 | Response Time (milliseconds) | Specify the output field to hold the HTTP Response time in milliseconds. The default field name is ArcRespTime. |
| 3 | Response Headers (JSON) | Specify the output field to hold the HTTP Response headers in the JSON format. The default field name is ArcResponseHeaders. |
| 4 | Response Cookies (JSON) | Specify field name to set HTTP Response Cookies in JSON format. The default field name is ArcRespCookies. |
| 5 | Response Body | Specify the output field to hold the HTTP Response body text if any. The default field name is ArcRespBody. |
| 6 | Output File | Specify the output field to hold the file path for file received in the HTTP Response. The default field name is ArcRespOutputFile. |
| 7 | Add File to Result | Check this option to add HTTP Response output file to workflow result. |