RESTful API - Trigger Configuration (Magic xpi 4.14)
Before you use the RESTful API component, a RESTful API service must be configured in the Settings dialog box's Services section.
When you drag the component into the Magic xpi Studio’s trigger area, the Properties pane opens. To configure the trigger, double-click or right-click on the trigger and select Configuration from the context menu to open the RESTful API Trigger Configuration dialog box.
This dialog box contains the following fields:
|
|
|
|
Connection
|
|
Service Name
|
The name of the service will be auto-populated for which the trigger is being created.
|
|
Operation
|
|
Path
|
Select the path where the trigger will receive the REST requests. The path list is populated from the service.
|
|
Operation
|
The operation is populated from the path above.
|
|
Parameters Details
|
|
Parameter Type
|
This table lists all the parameters that are defined in the Paths configuration of the RESTful service.
The parameter can be of type:
-
Path
-
Query
-
Header
-
Cookie
-
Request
-
Response
|
|
Parameter Name
|
The name of the parameter defined for the path selected.
|
|
Parameter Value
|
Here you can assign a variable to each parameter defined for the selected path. Click  (ellipsis button) to open the Environment Variable List and assign a variable to each parameter.
|
|
Output
|
|
Response Body
|
Click (ellipsis button) to open the Environment Variables List and assign a variable for the response body. This response will be sent back to the user on successful completion of the flow.
|
|
If response parameters are defined in the triggers parameter section, then Response body field should be kept blank.
|
|
|
Response Headers
|
These are the response headers sent back to user on the execution of the request.
Click (ellipsis button) to open the Environment Variables List and assign a variable for the response header.
|
|
Multiple response headers should be separated with semi-colon (;) characters in the same line or each header can be specified in a new line.
The header name and its value should be separated by equal to (=) character.
|
|
|
Response Status
|
This is the response status sent back to user on the execution of the request.
Click (ellipsis button) to open the Environment Variables List and assign a variable for the response status.
|
|
Only numeric response code is supported.
|
|
Since version: 4.14
