Developer Activities

Last updated Dec 11, 2024

SOAP Request

UiPath.Web.Activities.Design.SoapClientWithBodyFactory

Description

Enables you to perform HTTP requests to a specified web API which uses the SOAP protocol. When first dragging this activity to the Designer panel, the SOAP Request Wizard window is displayed. The wizard provides an easy way of building requests and previewing server responses. Once you close the wizard, you cannot reopen it.

All the fields present in this window are also available in the Properties panel. As a result, you can still edit your preferences after closing the wizard.

Project compatibility

Windows - Legacy

Note:

SOAP requests are only supported by Windows - Legacy projects. If you must execute SOAP requests in Windows or Cross-Platform projects, try these solutions instead:

Use a Windows Legacy for your entire process.
Use a Windows Legacy process just for the SOAP Request part, and invoke it from a Windows process via input/output arguments
Use the Invoke code activity.
Use Coded Workflows (available starting with Studio 2023.10).
Use the HTTP Request activity to create your own request that matches the SOAP definition. Make sure to use the proper headers and include the correct XML in your request body.

The SOAP Request Wizard

Service Description - The WSDL schema location.
Ellipsis menu - Enables you to browse your hard drive for a .wsdl file.
Get - Fetches information from the provided .wsdl file, and displays the available parameters in the table.
Contract - The name of the contract which describes the methods exposed by the SOAP service.
Method - A list of all the supported methods. Changing the method also changes the parameters displayed in the table.

Parameters Table

Name - The name of all the supported parameters.
Type - The type of each supported parameter. In some cases, hovering over the Type displays further information, such as whether or not the parameter is optional.
Value - Enables you to add a value for each parameter, so you can make the desired request.

Authentication - A dropdown list that enables you to select the type of authentication used by the web service. The following options are available:
- None - the default option. Indicates that the web service does not use any kind of authorization.
- Simple - Indicated that the service uses simple authentication. If this method is selected, the Username and Password fields are displayed, which enables you to input your credentials.
- Windows - Indicates that the service uses Windows authentication.
- Client Certificate - Indicates that the service uses Client Certificates for authorization. If selected, the Client Certificate field is displayed, which enables you to browse your local drive for your certificate.
Invoke - Enables you to perform the request with the specified options.
Response - Displays a preview of the web server's response.

Properties

Client CertificateAuthentication

Client Certificate - Indicates that the service uses Client Certificates for authorization and enables you to browse your local drive for your certificate.
ClientCertificatePassword - The password for the client certificate. This field supports String variables.
SecureClientCertificatePassword - The password for the client certificate, in the form of a Secure String variable.

Common

ContinueOnError - Specifies if the automation should continue even when the activity throws an error. This field only supports Boolean values (True, False). The default value is False. As a result, if the field is blank and an error is thrown, the execution of the project stops. If the value is set to True, the execution of the project continues regardless of any error.

Note: If this activity is included in Try Catch and the value of the ContinueOnError property is True, no error is caught when the project is executed.
DisplayName - The display name of the activity.

Input

Contract Name - The name of the contract which describes the methods exposed by the SOAP service. This property supports strings and string variables.
EndPoint - The WSDL schema location. By default, the http://www.webservicex.com/globalweather.asmx?wsdl URL is provided, for testing purposes. This property supports strings and string variables, and corresponds to the Service Description field, in the SOAP Request Wizard window.
Method - Method name called by the client.
Parameters - The parameters for the specified method. Select the Ellipsis button to display the Parameters window, in which you can add the desired parameters.

Misc

Private - If selected, the values of variables and arguments are no longer logged at Verbose level.

Output

Headers - The response received from the SOAP request.
Result - The web server's response, as a String variable.

Simple Authentication

Username - Indicates that the web service uses simple authentication and enables you to input your username. Adding a password is also required. This property supports strings and string variables.
Password - Indicates that the web service uses simple authentication and enables you to input your password. Adding a username is also required. This property supports Strings and String variables.
SecurePassword - Indicates that the web service uses secure authentication and enables you to input your secure string password. Adding a username is also required. This property supports Secure String variables.