External API Call – Parameters

This screen configures each parameter that will be populated and passed by the API call to the REST API web service. Parameter settings must match the specifications of the called REST API.

Parameter Setting Description
IntegrationProcessDetail API call's code (see Code).
ParameterType
  • Query – Parameter is appended to the API call's path.
  • Body – Parameter is passed in the HTTP request body.
  • Formdata – Parameter is passed using the multipart/form-data media type.
isMandatory Parameter is mandatory.
isEnumList Check if the Body type parameters are passed in the HTTP request in enumeration format (a single line JSON such as {firstName: "John", lastName: "Doe"}).
Name Parameter name.
IsAuthentificationUser Applicable for all non-Body parameters with isEnumList not checked.
IMPORTANT!
Do not set user-id static parameters in this screen. See httpAuthenticationType for details on how to configure authentication credentials.
IsAuthentificationPassword Applicable for all non-Body parameters with isEnumList not checked.
IMPORTANT!
Do not set password static parameters in this screen. See httpAuthenticationType for details on how to configure authentication credentials.