REST Message workflow activity

The REST Message activity enables an administrator to override the REST endpoint or supply the variables configured in the REST Message module.

The REST Message activity executes a dead link REST function (POST, PUT, GET, or DELETE) on an endpoint using values defined in the function record.

Note: If you want to use a MID Server to send the REST message, the MID Server must be accessible by the instance and configured to use SSH.

Input variables

Table 1. REST Message activity input variables
Field Description
REST Message Name of the REST message to run. This is a reference field to the REST Message [sys_rest_message] table (System Web Services > Outbound > REST Message).
REST Message Function Function to call that is defined in a REST message function. This is a reference field to the HTTP Method [sys_rest_message_fn] table (System Web Services > Outbound > REST Message).

Available functions are put, post, get, or delete. You can edit functions in the HTTP Methods related list in each REST Message record.

REST Endpoint REST endpoint to use instead of the Endpoint defined in the HTTP Method record. Leave this field blank to use the defined endpoint in the REST Message Function record.
Variables Values to use for variables defined in the HTTP Method record.
Use the following format for the string:
name1=value1, name2=value2, . . .
For example, use name=${nameValue}, id=${idValue} where name and id are function variables. If either the variable name or value contains a comma or equal sign, escape those characters with a backslash.
Use MID Server Check box for using a MID Server to send the REST message. A MID Server might be necessary to reach an endpoint within a firewall or a subnetwork that is not visible from the instance. If this check box is selected, but no MID Server is defined in the MID Server field, the workflow automatically attempts to find a MID Server based on IP range and the REST capability.
MID Server Name of the MID Server to use. This field is available when Use MID Server is selected. The workflow ignores this parameter if the use_midserver parameter is disabled.
Sensor Script The script to execute after the request has been made and a response has been received. You can access the full response body from the activity.output variable.