REST request
The REST request block allows you to send requests to REST web services.
The block can be accessed from the menu Settings | Documentation | Workflow Design by clicking the panel Design | Input/Output.
 |
HINT
REST (Representational State Transfer) is an architecture for exchanging data between web services.
|
Double-clicking the REST request block opens the REST request window, which is divided into two parts for defining the required settings:
In this section, general information of the request are defined.
|
Method
|
Select the action method from the drop-down list of available methods:
- GET – Get (retrieve) data.
- PUT – Edit (update) data.
- POST – Create new data.
- DELETE – Delete data.
|
HINT
The standard HTTP methods listed above are used to access and modify resources.
|
|
|
Base URL
|
Enter the URL link of the web service.
 |
WARNING
Base URL is a mandatory field.
|
|
|
Resource
|
Enter the URL link for the specific action.
|
|
Request timeout s
|
If needed, enter the request timeout in seconds.
|
In the tab, you need to specify the content of the request.
|
Request content
|
Select the type of method (data format) that you want to send to the web service.
|
|
Response content
|
Select the type of method (data format) that you want to receive from the web service.
|
|
(Input field)
|
Enter the request parameters corresponding to the selected method (e.g. in the JSON format as shown in the image above).
|
In the tab, select the type of authentication (access).
|
Auth type
|
From the drop-down list, select one of the available Auth types:
- No Auth – No authentication.
- API key – Authentication using API key. If selected, the following fields appear:
- Key – Enter the API key obtained from the web service.
- Value – Enter the value of the API key.
- Basic Auth – Authentication using a username and password. If selected, the following fields appear:
- User – Enter the username.
- Password – Enter the password.
- Bearer Token – Authentication using a security token. If selected, the following fields appear:
- Token – Enter the security token.
- Token – Authentication using an access token. If selected, the following fields appear:
- Token – Enter the access token.
|
In the tab, you can customize the request header.
|
Key
|
Enter the name of the key.
|
|
Value
|
Enter the value of the key.
|
There are 3 buttons at the bottom of the window:
|
Reset
|
Returns all field values to default or empty.
|
|
OK
|
Saves information and closes the window.
|
|
Cancel
|
Closes window without saving.
|
|
HINT
For more information on how to use the REST request block, see the chapter REST request in the user manual.
|