REST HTTP Request

This REST tool issues an HTTP REST request to the specified URL. This tool supports GET, POST, PUT, PATCH, and DELETE calls.

This tool:

• Expects the certificate file to exist in a specific directory: I3\IC\Certificates\REST. Create the I3\IC\Certificates\REST directory if it does not exist. The I3\IC\Certificates\REST directory is not created by default.
  
  Use the CertTrustU.exe to install a client certificate. The certificate must be in PEM format. For more information, see PureConnect Security Features Technical Reference in the PureConnect Documentation Library.

• Expects to receive a URL with special characters already URL encoded. The tool does not automatically URL encode special characters. For example, to URL encode Ñ, use %C3%B1.

• Supports many concurrent requests.

• Does not use Windows Certificate store to check for validity of the certificate and utilizes openssl to do the verification.

To obtain more information on any failure, check logs of Interaction Processor or the response body and headers for failure information.

For more information, refer to the Interaction Designer REST APIs Developer's Guide in the PureConnect Documentation Library.

Inputs

URL

The URL of the request. You must URL encode any special characters in the URL. For example, to URL encode Ñ, use %C3%B1.

Proxy Uri

(Optional) String URI of the HTTP proxy to use for REST calls. This parameter supports the use of a forward proxy to retrieve content from the origin (API) server. This parameter must include the protocol used. For example: http://env4-revproxy1.ininlab or http://192.168.1.10.

HTTP Method

The HTTP method to execute. HTTP methods include GET, POST, PUT, PATCH, and DELETE.

Additional HTTP Headers

(Optional) Additional HTTP headers to include in the REST call other than content type and authorization with a  bearer token.

Bearer Token

(Optional) The bearer token string to add to the HTTP header.

Content Type

The content type to add to the header of the REST call. If this parameter contains an empty string, the default (application/json) is used.

Raw Request Body

The body of the request to send with the REST call.

Request Timeout [s]

Maximum time in seconds to wait for request to be sent and response received before terminating the REST call request. Default: 20 seconds.

Client SSL Certificate

(Optional) The name of a certificate in the \I3\IC\Certificates\REST directory on the PureConnect server to use for Client Authentication. The certificate must be in PEM format and contain the unencrypted private key.

Ignore Unknown SSL Certificate Authority

This parameter applies only if the URL protocol is HTTPS. Check this parameter to accept certificate even if certificate authority is unknown.

Ignore Wrong SSL Certificate Usage

This parameter applies only if the URL protocol is HTTPS. Check this parameter to accept malformed certificates.

Ignore SSL Certificate Name Mismatch

This parameter applies only if the URL protocol is HTTPS. Check this parameter to accept a certificate even if the name does not match the visited host.

Ignore Invalid SSL Certificate Date (expired certificate)

This parameter applies only if the URL protocol is HTTPS. Check this parameter to accept a certificate even if it has expired.

Outputs

Status Code

The API server response status code.

Status Text

The API server response status text.

Response Headers

The API server response headers.

Response Body

The API server response body.

Exit Paths

Success

This path is taken if the operation is successful.

Unknown Host

This path is taken if an invalid or unknown hostname is used (for example, DNS lookup failed).

Timeout

This path is taken if the request timed out.

Connection Failure

This path is taken if a valid HTTP or HTTPS session was not established. For example, a failure to establish a HTTPS connection due to the absence of a client certificate when the Client SSL Certificate parameter is true.

Failure

This path is taken for any failure other than unknown host, timeout, or connection failure.