REST template execution parameters

You use execution parameters to create the input process script in the Pre Processing form of the activity designer.

For descriptions of the REST web service command fields, see Configure the REST execution command.
Note: You must use the executionParam. prefix with all variables in this table.
Table 1. REST template execution parameters
Name Variable Type Usage
Web service message web_service_message Reference The sys_id of the corresponding web service message.
Web service message function web_service_message_function Reference The sys_id of the REST message function.
Web service endpoint web_service_endpoint String URL of the REST endpoint.
Parameters parameters Array of JavaScript objects Array of JavaScript objects, expressed with the executionParam. prefix. For instructions on creating arrays using this parameter see Create a JavaScript array in a REST template.
Use mid server use_mid_server Boolean Selects whether or not to use the MID Server. A value of true uses the MID Server, and a value of false does not use the MID Server.
MidCapabilities midCapabilities String (comma separated) List of references to required MID Server capabilities.
Time out time-out String Allowable time out duration, expressed in seconds.
ValueCapabilities valueCapabilities Array of hashmap Capability values used to select the MID Server. For more information, see Scripted value matching for MID Servers. Use this example to customize the MID Server selection if there are additional capabilities that are assigned by value:
var valueCapability = {'NEW_MID_CAPABIILTY':'NEW_MID_CAPABILITY_VALUE'}; executionParam.valueCapabilities.push(valueCapability);
Auth Type auth-type Boolean Type of credentials to use. The choices are:
  • basic_auth_pick_credentials
  • use_existing_credentials
Credentials credentials Reference Contains the credentials to use for this REST message when the auth_type selected is basic_auth_pick_credentials.