REST mailbox
The REST mailbox block enables that any REST can be called from a workflow.
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.
|
Variables are specified in the mailbox and/or workflow and sent to the request. The response is stored to variables and/or a file.
|
HINT
For the REST mailbox block to work properly, it is necessary to create and properly configure the mailbox in the menu Settings | Program | Administration Panel | Settings | Documentation | Mailboxes in PANTHEON.
|
Double-clicking the REST mailbox block opens the REST mailbox window, which is divided into two parts for defining the required settings:
In this section, you need to define the general mailbox data to enable data exchange with the web service.
|
Mailbox
|
From the drop-down list, select the mailbox you want to use for data exchange with the web service (must have been created beforehand).
|
|
Operation
|
Identifier for retrieving data used in a workflow, such as method type, URL, etc.
|
|
Data
|
Displays any data from the selected mailbox, e.g. the path to use a variable from the mailbox and from the workflow.
|
|
Resource
|
Enter the URL link for the specific action.
|
|
Request timeout s
|
If needed, enter the request timeout in seconds.
|
2.1 Body
|
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).
|
|
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.
|