SendWebServiceRequestAction Class Reference

Sends an HTTP request to a web service (REST or SOAP). More...

Inherits IntegrationAction.

Properties
DataTarget	Source [get, set]
	Specifies the source of the data source to send. The source can be string or template values, a file, or a set of web request variables in WebUrlDataTarget. Example: More...
string	URL [get, set]
	Specifies the URL of the web server that you want to send the request to. More...
WebRequestMethod	Method [get, set]
	Specifies the HTTP request method, as follows: More...
string	ContentType [get, set]
	Specifies the content type for the POST and PUT methods, as follows: More...
HttpAuthentication	Authentication [get, set]
	Specifies the HTTP authentication method, as follows: More...
string	UserName [get, set]
	Specifies the user name. Used when the value of Authentication is SpecifiedUser. More...
EncryptedString	Password [get, set]
	Specifies the password. Used when the value of Authentication is SpecifiedUser. More...
string	Domain [get, set]
	Specifies the domain of the user name. Used when the value of Authentication is SpecifiedUser. More...
bool	WrapContentAsSOAPMessage [get, set]
	Specifies whether to wrap POST or PUT content in the SOAP body tag. The default value is false. More...
int	SendTimeout [get, set]
	Specifies the amount of time, in milliseconds, to wait for a response before timing out. More...
SerializableStringDictionary	Headers [get, set]
	Specifies a dictionary of HTTP header properties and values to be sent with the web request. More...
int	RetryCount [get, set]
	Specifies the number of times to resend the request in case of an error. The default value is 1. More...
string	SuccessfulStatusCodes [get, set]
	Specifies the status codes that are considered to be successful. The default value is 200-206,300,305-307. More...
string	HTTPRequestResponseVariable [get, set]
	Specifies the name of the variable to save the response to. The default value is "Response". More...
CommonActionProperties
Describes the common action properties for Actions and ActionGroups.
string	Name [get, set]
	Specifies the name. This property cannot be empty and must be unique in the YAML script. More...
string	Description [get, set]
	Specifies the description. The default value is "". More...
ActionRunType	RunType [get, set]
	Runs the action by using one of the following types: More...
bool	IgnoreErrors [get, set]
	Specifies whether to ignore errors and continue with the next action. Valid only for Action and ActionGroup. The default value is false. More...
int	FailureRetries [get, set]
	Specifies the number of times that the action is retried if it fails. Available only for Action. The default value is 0. More...
int	RetryInterval [get, set]
	Specifies the interval, in milliseconds, that elapses when a failed action is retried. Valid only when the value of FailureRetries is greater than 0. Available only for Action. The default value is 10000. More...

Detailed Description

Sends an HTTP request to a web service (REST or SOAP).

For common action properties, see IntegrationAction.
Example:

Actions:
- SendWebServiceRequestAction:
    Source: '%EventData%'
    Method: GET
    ContentType: application/octet-stream
    Authentication: SpecifiedUser
    UserName: user1
    Domain: workspace
    Password: mypassword1234
    Headers: 
      H1: 111
      H2: 222 
    SuccessfulStatusCodes: 200 - 206,300,303
    Name: Send Web Service Request
    # And more common action properties
    ... 

Property Documentation

Source

DataTarget Source

getset

Specifies the source of the data source to send. The source can be string or template values, a file, or a set of web request variables in WebUrlDataTarget.
Example:

Source: %EventData%

Example:

Source: 
  File: C:\MySecretFolder\Data.txt      

Example:

Source:
  Variables:
    variable1: 111
    variable2: 222

URL

string URL

getset

Specifies the URL of the web server that you want to send the request to.

Method

WebRequestMethod Method

getset

Specifies the HTTP request method, as follows:

• GET
• HEAD
• POST (default)
• PUT
• DELETE

ContentType

string ContentType

getset

Specifies the content type for the POST and PUT methods, as follows:

• application/json
• text/xml
• application/octet-stream
• application/soap+xml
• application/x-www-form-urlencoded (default)
• text/plain

Authentication

HttpAuthentication Authentication

getset

Specifies the HTTP authentication method, as follows:

• Anonymous (default)
• CurrentUser
• SpecifiedUser

UserName

string UserName

getset

Specifies the user name. Used when the value of Authentication is SpecifiedUser.

Password

EncryptedString Password

getset

Specifies the password. Used when the value of Authentication is SpecifiedUser.

Domain

string Domain

getset

Specifies the domain of the user name. Used when the value of Authentication is SpecifiedUser.

WrapContentAsSOAPMessage

bool WrapContentAsSOAPMessage

getset

Specifies whether to wrap POST or PUT content in the SOAP body tag. The default value is false.

SendTimeout

int SendTimeout

getset

Specifies the amount of time, in milliseconds, to wait for a response before timing out.

Headers

SerializableStringDictionary Headers

getset

Specifies a dictionary of HTTP header properties and values to be sent with the web request.

RetryCount

int RetryCount

getset

Specifies the number of times to resend the request in case of an error. The default value is 1.

SuccessfulStatusCodes

string SuccessfulStatusCodes

getset

Specifies the status codes that are considered to be successful. The default value is 200-206,300,305-307.

HTTPRequestResponseVariable

string HTTPRequestResponseVariable

getset

Specifies the name of the variable to save the response to. The default value is "Response".

Name

string Name

getsetinherited

Specifies the name. This property cannot be empty and must be unique in the YAML script.

Description

string Description

getsetinherited

Specifies the description. The default value is "".

RunType

ActionRunType RunType

getsetinherited

Runs the action by using one of the following types:

• Always (default)
• Never

IgnoreErrors

bool IgnoreErrors

getsetinherited

Specifies whether to ignore errors and continue with the next action. Valid only for Action and ActionGroup. The default value is false.

FailureRetries

int FailureRetries

getsetinherited

Specifies the number of times that the action is retried if it fails. Available only for Action. The default value is 0.

RetryInterval

int RetryInterval

getsetinherited

Specifies the interval, in milliseconds, that elapses when a failed action is retried. Valid only when the value of FailureRetries is greater than 0. Available only for Action. The default value is 10000.

---

The documentation for this class was generated from the following file:

• SendWebServiceRequestAction.Properties.cs