InvokeRESTService

This activity is both an outbound and inbound REST request which means that it is used to make a request to the REST service and also accept the reply returned by the service.

Settings

Field Description
Method Select an operation for the request, such as GET, POST, PUT, or DELETE.
Uri An absolute path to the REST service that you want to invoke, for example, http://acme.com or https://acme.com. If you enter an absolute path beginning with https:// the Use certificate for verification section appears. Select:

If your connection requires an SSL certificate select True, otherwise select False. To add a certificate click Browse under Server Certificate and browse to the certificate location on your machine.

Request Type The Request content type of the REST service. This field is applicable and visible only in the POST and PUT activities. The following content-type are supported:
  • text/plain
  • application/json
  • application/x-www-form-urlencoded
Response Type The Response content type of the REST service. The following content-types are supported:
  • text/plain
  • application/json
  • other

Input Settings

Field Description
Request Schema Enter a request schema here. This field is visible only if you selected the POST or PUT method in the Settings tab.
Query Params Query parameters to be appended to the path. To add the query parameters, click the button and press Enter to save your changes.

parameterName: Name of the query parameter.

type: The data type of the query parameter. Supported types are string, number, or boolean.

required: Set to True if query parameter is a required configuration. The trigger will report an error if no value(s) are provided to the required query parameter.

Request Headers Header values for the InvokeRESTService activity. To add the header parameters, click the button and press Enter to save your changes.

parameterName: Name of the header parameter.

type: The data type of the header parameter. Supported types are string, number, or boolean.

required: Set to True if header parameter is a required configuration. The trigger will report an error if no value(s) are provided to the required header parameter.

Input

Field Description
queryParams Provide a value to the query parameters configured on the Input Settings section. This field is visible only if you selected the POST or PUT method in the Settings tab.
pathParams Provide a value to path parameters defined as part of URL in the Settings tab. This field is visible only if you selected the POST or PUT method in the Settings tab.
headers Header values for the activity. These values can be manually entered or mapped to the output of the trigger or any preceding activity.
body Request Schema values for the activity. These values can be manually entered or mapped to the output of the trigger or any preceding activity. This field is visible only if you selected the POST or PUT method in the Settings tab.

Output Settings

Field Description
Response Schema The schema for the reply that the server sends.
Response Headers The header parameters for the reply.

Output

The Output tab displays the headers and response body configured for both the request and the response in a tree format.

Related reference