Set General Properties
Step-by-Step
To create a REST call action, follow these steps:
-
Launch the "Processes" module.
-
Open an existing process or create a new one.
-
Use drag-and-drop to drag the "REST Call" action onto the workspace.
-
Double-click the REST call action.
The following sections describe the individual steps in the dialog.
The first step is to define the general properties of the REST call action.
Alias
Enter an alias for the REST call action here.
The alias serves as an identifier for the REST call action. If you use multiple REST call actions within a process, the aliases must be different.
The alias must begin with a lowercase letter and may consist only of alphanumeric characters (case-sensitive), as well as underscores (_) and hyphens (-).
The response to a REST call action can be accessed during a process by specifying the alias.
Title
Enter a descriptive title for the REST call action here.
The title is displayed in the action element in the Process Designer.
Description
The description can be used to convey important information regarding the REST call.
Logging Requests and Responses
If you enable this option, the request will be logged immediately before it is sent, and the response will be logged immediately after it is received. This option is primarily intended for debugging the request and should only be used in development environments. For one thing, the log file can become extremely large, and for another, depending on the API, the logged files may also contain passwords.
Binary response data and very long responses (> 100,000 characters) are not displayed. You can find a corresponding note in the log file (Property: logVerbose).
Parsing JSON
If you enable this option, the response payload will generally be parsed as JSON.
If the payload can be successfully parsed as JSON, the parsed JSON object is appended to the REST call and is then available in the shared state.
If the payload cannot be successfully parsed as JSON, a message is written to the log file (property: parseJson). In this case, no JSON object is available.
Verify Host Names
If you enable this option, the REST API client will check whether it can establish a connection to the correct host. If the host cannot be verified, the connection is rejected and the call fails (Property: hostnameVerification).
Trust all certificates
If you enable this option, an HTTPS connection will be established. However, the certificate is not verified.
Enabling this option is useful in development environments, allowing you to work with self-signed certificates. In general, it may be appropriate in a development environment for the REST API client to trust all certificates (property: trustAllCertificates).
For production use, the certificates can be placed in the portal's certificate store.
Timeout (in seconds)
Here you can specify the time in seconds that the REST API client waits for a response to be returned, or the duration until the REST API client terminates the connection if a response is not received or is interrupted. The default value is set to 30 seconds (Property: timeout).
Your Next Step