Help files

Invoke Web Service Action
Description:

This action invokes a web service by sending data through HTTP and retrieving the response from the web service.

Invoke_New_PR_1a.PNG
Invoke_New_PR_2a.PNG
Properties:

URL:

First choose http or https format, then enter the remainder of the web address.

Method:

Choose the HTTP method you want to use to invoke the web service.

Accept:

Specify the acceptable content type for the response of the web service.

Content Type:

Specify the content type of the request that will be sent to the web service.

Custom Headers:

Specify any custom headers to be included in the request that will be sent to the web service.

Request Body:

Specify the body of the request that will be sent to the web service.

Return Data:

Specify how the Web Service response will be stored. You can either store it into a variable or (if the Web Service will return a file) store it into a file by choosing Save to Disk.

File Name:

Choose whether you want to keep the original name of the downloaded file, as provided by the Web Service, or you want to specify a new name. In the first case you will need to provide just the destination folder where the file will be saved. In the second case you will need to provide the full path of the downloaded file (destination folder plus the new file name).

Destination File Path:

Enter or choose a file path, or a previously defined variable, to specify the full path (folder plus filename) where the file returned by the Web Service will be stored.

Destination Folder:

Enter or choose a local folder, or a previously defined variable containing a folder, to specify the folder where the file returned by the Web Service will be saved.

Store Headers Into:

Enter a name to be the variable that will store the HTTP Headers of the response.

Store Web Service Response into:

Enter a name to be the variable that will store the Web Service response.

Store Downloaded File into:

Enter a name to be the variable that will store the file object.

Advanced Tab

Connection Timeout:

Specify the time (in seconds) that the agent should wait for a connection to be established with the server, before giving up.

Follow Redirection:

Choose whether you want to allow the web server to redirect you to another web service.

Clear Cookies:

Choose whether you want to clear all cookies created by similar actions during this Process before this action. Note that WinAutomation does not interact with existing cookies, and that old cookies are not used or affected by the Process, and no new cookies are made by the Process. Therefore this only applies to cookies created by other Actions in this Process.

Fail on Error Status:

Choose whether you want the responses of the invoked web service that denote errors to be processed as if they were normal responses (suppressing all exceptions) or whether you would like them to result in the related exceptions displayed in the Exception Handling Tab)

Encode Request Body:

Specify whether the body of the request should be URL-encoded before invoking.

Accept Untrusted Certificates:

Choose whether the server should accept untrusted certificates.

HTTP Authentication:

Specify whether or not the web server requires authentication. This property refers to HTTP authentication (that is, when the browser displays a pop-up window asking for user name and password).

User Name:

Enter the User Name for the web server here.

Enter Password:

If you choose 'directly', the password entered in the Password field will be hidden. If you choose 'as variable' it will expect you to enter a variable and treat the '%' as an indicator of a variable, not part of the password.

Password:

Enter the Password here. You may enter either a text, or a variable containing the password depending on the selection of the previous property (Enter Password).