Configure Request

In this step, you must provide information about the API resource and enter the query parameters using key/value pairs.

Method

Select the HTTP verb or HTTP method to be used for the REST call here.

You can choose from the following methods:

  • GET

  • POST

  • PATCH

  • PUT

  • DELETE

Diagram

Specify here whether the REST call should use an HTTP or HTTPS connection.

HTTPS If you select HTTPS as the connection type, please note the following:

A valid certificate must be stored in the Intrexx certificate store.

OR

The "Verify hostname" option on the "General" tab must be disabled, and the "Trust all certificates" option on the "General" tab must be enabled. If this is not the case, the REST call is aborted.

HTTP If you select HTTP as the connection type, a warning will be logged because login credentials, keys, etc., will be stored in plain text or will be insufficiently obfuscated.

Port (optional)

Enter the API port on the host system here.

If you do not enter a value, the following default values will be used:

  • Port 443 (for HTTPS)

  • Port 80 (for HTTP)

Hostname

Enter the API's hostname here. Enter the hostname without including "http://" or "https://" and without specifying any path or query parameters.

Path

Enter the path to the desired API resource here.

Download file name (optional)

Enter a file name here in case the REST call triggers a file download.

After downloading, the file is saved under the name specified here in a temporary directory that exists for the duration of the process and is then deleted. The directory can be accessed via the Groovy object ` g_dirWorkflowTmp `. In the processing context object of the REST call, the absolute path is available as a string at <aliasDesCalls>.body.file.

If you do not specify a filename, the REST call searches the Content-Disposition header of the response and checks whether a filename is specified there, if applicable. If no filename is found, the name "download" is used by default.

Query Parameters

Step-by-Step

To add query parameters, follow these steps:

  1. Open the REST call action.

  2. Go to the "Request" tab.

  3. Click the " " icon.

    The "Add Query Parameter" dialog box appears.

  4. Enter a key and a value. You can enter the value manually, retrieve it from the resource mapping, or use a combination of both.

  5. Click "OK."

    The added query parameter is displayed.

The query parameters are included in the generated REST call after the path, separated by a "?" appended separately, with "=" used to connect the key and value, and "&" used to separate the pairs.

Your Next Step

Configure Body