Versions Compared

Old Version 2

changes.mady.by.user IT Stonebranch

Saved on

compared with

New Version Current

changes.mady.by.user Stonebranch

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Anchor
Task Properties - Web Service Task
Task Properties - Web Service Task
Task Properties: Web Service Task

Property

UI Field Name

Description

Specifications

Required

Anchor
autoCleanup - WEB
autoCleanup - WEB
autoCleanup

Auto Cleanup

Specification for whether or not to enable the auto clean-up of Web Service response output upon task instance completion or, if the task instance is within a workflow, when the top-level workflow instance completes.

Boolean; Valid values: true / false. Default is false.

Anchor
formData - WEB
formData - WEB
formData

Form Data

If httpPayloadType = Form Data; Any parameters to be encoded and added to the message body.

Format:
 

Panel
Html bobswift<pre> &lt;formData&gt; &lt;formField&gt; &lt;name&gt;field1&lt;/name&gt; &lt;value&gt;value1&lt;/value&gt; &lt;/formField&gt; &lt;formField&gt; &lt;name&gt;field2&lt;/name&gt; &lt;value&gt;value2&lt;/value&gt; &lt;/formField&gt; &lt;/formData&gt; </pre>
<formData>
	<formField>
		<name>field1</name>
		<value>value1</value>
	</formField>
	<formField>
		<name>field2</name>
		<value>value2</value>
	</formField>
</formData>


N

Anchor
httpAuth - WEB
httpAuth - WEB
httpAuth

HTTP Authentication

HTTP authentication scheme to use.

Valid values:

Html bobswift<ul> <li>
  • As
  • String
  • =
  • None,
  • As
  • Value
  • =
  • 0
<li>
  • As
  • String
  • =
  • Basic,
  • As
  • Value
  • =
  • 1
</ul>

Default is None (0).

N

Anchor
httpHeaders - WEB
httpHeaders - WEB
httpHeaders

HTTP Headers

HTTP headers.

Format:
 

Panel
Html bobswift<pre> &lt;httpHeaders&gt; &lt;httpHeader&gt; &lt;name&gt;header1&lt;/name&gt; &lt;value&gt;val1&lt;/value&gt; &lt;/httpHeader&gt; &lt;httpHeader&gt; &lt;name&gt;header2&lt;/name&gt; &lt;value&gt;val2&lt;/value&gt; &lt;/httpHeader&gt; &lt;/httpHeaders&gt; </pre>
<httpHeaders>
	<httpHeader>
		<name>header1</name>
		<value>val1</value>
	</httpHeader>
	<httpHeader>
		<name>header2</name>
		<value>val2</value>
	</httpHeader>
</httpHeaders>


N

Anchor
httpMethod - WEB
httpMethod - WEB
httpMethod

HTTP Method

If protocol = HTTP; Type of HTTP request method to use.

Valid values:

html-bobswift

<ul> <li>
  • As
  • String
  • =
  • GET,
  • As
  • Value
  • =
  • 1
<li>
  • As
  • String
  • =
  • POST,
  • As
  • Value
  • =
  • 2
<li>
  • As
  • String
  • =
  • PUT,
  • As
  • Value
  • =
  • 3
<li>
  • As
  • String
  • =
  • PATCH,
  • As
  • Value
  • =
  • 4
<li>
  • As
  • String
  • =
  • DELETE,
  • As
  • Value
  • =
  • 5
</ul>

Default is GET (1).

N

Anchor
httpPayloadType - WEB
httpPayloadType - WEB
httpPayloadType

HTTP Payload Type

If protocol = HTTP and httpMethod = POST, PUT, or PATCH; Type of HTTP payload.

Valid values:

html-bobswift

<ul> <li>
  • As
  • String
  • =
  • Raw,
  • As
  • Value
  • =
  • 1
<li>
  • As
  • String
  • =
  • Form
  • Data,
  • As
  • Value
  • =
  • 2
</ul>

Default is Raw (1).

N

Anchor
httpVersion - WEB
httpVersion - WEB
httpVersion

HTTP Version

Version of the HTTP protocol to use.

Valid values:

html-bobswift

<ul> <li>
  • As
  • String
  • =
  • 1.0,
  • As
  • Value
  • =
  • 1
<li>
  • As
  • String
  • =
  • 1.1,
  • As
  • Value
  • =
  • 2
</ul>

Default is 1.1 (2).

N

Anchor
insecure - WEB
insecure - WEB
insecure

Insecure

Specification for whether or not to allow the Web Service task to use a TLS/SSL connection that is considered to be insecure.

Boolean; Valid values: true / false. Default is false.

N

Anchor
mimeType - WEB
mimeType - WEB
mimeType

MIME Type

If protocol = HTTP; MIME type of the message body.

If httpPayloadType = Form Data, mimeType is set to
Application/x-www-form-urlencoded.

N

Anchor
outputConditionOperator - WEB
outputConditionOperator - WEB
outputConditionOperator

Operator

If responseProcessingType = Success Output Contains or Failure Output Contains; Condition operator to evaluate in combination with outputConditionValue.

Valid values:

html-bobswift

<ul> <li>
  • As
  • String
  • =
  • =,
  • As
  • Value
  • =
  • 1
<li>
  • As
  • String
  • =
  • !=,
  • As
  • Value
  • =
  • 2
<li>
  • As
  • String
  • =
  • >,
  • As
  • Value
  • =
  • 3
<li>
  • As
  • String
  • =
  • >=,
  • As
  • Value
  • =
  • 4
<li>
  • As
  • String
  • =
  • <,
  • As
  • Value
  • =
  • 5
<li>
  • As
  • String
  • =
  • <=,
  • As
  • Value
  • =
  • 6
<li>
  • As
  • String
  • =
  • regex,
  • As
  • Value
  • =
  • 7
</ul>

Default is = (1).

N

Anchor
outputConditionStrategy - WEB
outputConditionStrategy - WEB
outputConditionStrategy

Strategy

If outputType = XML or JSON; Strategy to take when applying outputConditionOperator and outputConditionValue against outputPathExpression matches.

Valid values:

html-bobswift

<ul> <li>
  • As
  • String
  • =
  • Match
  • Any,
  • As
  • Value
  • =
  • 1
<li>
  • As
  • String
  • =
  • Match
  • All,
  • As
  • Value
  • =
  • 2
<li>
  • As
  • String
  • =
  • Match
  • None,
  • As
  • Value
  • =
  • 3
<li>
  • As
  • String
  • =
  • Count,
  • As
  • Value
  • =
  • 4
</ul><ul> <li>

Default is Match Any (1).

N

Anchor
outputConditionValue - WEB
outputConditionValue - WEB
outputConditionValue

Value

If responseProcessingType = Success Output Contains or Failure Output Contains; Condition value to evaluate in combination with the outputConditionOperator.


N

Anchor
outputPathExpression - WEB
outputPathExpression - WEB
outputPathExpression

Path Expression

If outputType = XML or JSON; Expression to be used when evaluating the response output.


N

Anchor
outputType - WEB
outputType - WEB
outputType

Output Type

If responseProcessingType = Success Status Code Range or Failure Status Code Range; Output type that the Response Processing mechanism should assume when evaluating the output. If the expected output is XML or JSON, it is valid to specify Text. However, when specifying XML or JSON, the output must be XML or JSON, respectively; otherwise, the parsing will fail and the path expression evaluation will return no matches.

Valid values:

Html bobswift
  • As
  • String
  • =
  • Text,
  • As
  • Value
  • =
  • 1
<li>
  • As
  • String
  • =
  • XML,
  • As
  • Value
  • =
  • 2
<li>
  • As
  • String
  • =
  • JSON,
  • As
  • Value
  • =
  • 3
</ul><ul> <li>

Default is Text (1).

N

Anchor
payload - WEB
payload - WEB
payload

Payload

If protocol = HTTP, httpMethod = is POST, PUT, or PATCH, httpPayloadType is Raw, and payloadSource = Form, or if protocol = SOAP and payloadSource = Form; Request payload.


N

Anchor
payloadScript - WEB
payloadScript - WEB
payloadScript

Payload Script

If payloadSource = Script; Script that contains the content of the request payload.


Y
(if payloadSource
= Script.

Anchor
payloadSource - WEB
payloadSource - WEB
payloadSource

Payload Source

If protocol = HTTP, httpMethod = is POST, PUT, or PATCH, and httpPayloadType is Raw, or if protocol = SOAP; Specification for whether the payload is defined in payload or in payloadScript.

Valid values:

Html bobswift
  • As
  • String
  • =
  • Form,
  • As
  • Value
  • =
  • 1
<li>
  • As
  • String
  • =
  • Script,
  • As
  • Value
  • =
  • 2
</ul><ul> <li>

Default is Form (1).

N

Anchor
protocol - WEB
protocol - WEB
protocol

Protocol

Protocol to use for the operation.

Valid values:

Html bobswift
  • As
  • String
  • =
  • HTTP,
  • As
  • Value
  • =
  • 1
<li>
  • As
  • String
  • =
  • SOAP,
  • As
  • Value
  • =
  • 2
</ul><ul> <li>

Default is HTTP (1).

N

Anchor
responseProcessingType - WEB
responseProcessingType - WEB
responseProcessingType

Response Processing

Specification for how to process the response in order to determine success or failure.

Valid values:

Html bobswift
  • As
  • String
  • =
  • Default
  • Success
  • Status
  • Code
  • Range,
  • As
  • Value
  • =
  • 1
<li>
  • As
  • String
  • =
  • Success
  • Status
  • Code
  • Range,
  • As
  • Value
  • =
  • 2
<li>
  • As
  • String
  • =
  • Failure
  • Status
  • Code
  • Range,
  • As
  • Value
  • =
  • 3
<li>
  • As
  • String
  • =
  • Success
  • Output
  • Contains,
  • As
  • Value
  • =
  • 4
<li>
  • As
  • String
  • =
  • Failure
  • Output
  • Contains,
  • As
  • Value
  • =
  • 5
</ul><ul> <li>

Default is Default Success Status Code Range (1).

N

Anchor
soapPayloadType - WEB
soapPayloadType - WEB
soapPayloadType

SOAP Payload Type

If protocol = SOAP; Type of SOAP Payload.

Valid values:

Html bobswift
  • As
  • String
  • =
  • Body,
  • As
  • Value
  • =
  • 1
<li>
  • As
  • String
  • =
  • Envelope,
  • As
  • Value
  • =
  • 2
</ul><ul> <li>

Default is Body (1).

N

Anchor
soapResponseOutput - WEB
soapResponseOutput - WEB
soapResponseOutput

SOAP Response Output

If protocol = SOAP; Element of the SOAP response to be captured as output.

Valid values:

Html bobswift
  • As
  • String
  • =
  • Body/First
  • Element,
  • As
  • Value
  • =
  • 1
<li>
  • As
  • String
  • =
  • Body,
  • As
  • Value
  • =
  • 2
<li>
  • As
  • String
  • =
  • Envelope,
  • As
  • Value
  • =
  • 3
</ul>

Default is Body/First Element (1).

N

Anchor
soapVersion - WEB
soapVersion - WEB
soapVersion

SOAP Version

If protocol = SOAP; Version of the SOAP protocol to use.

Valid values:

Html bobswift<ul> <li>
  • As
  • String
  • =
  • 1.1,
  • As
  • Value
  • =
  • 1
<li>
  • As
  • String
  • =
  • 1.2,
  • As
  • Value
  • =
  • 2
</ul>

Default is 1.2 (2).

N

Anchor
statusCodeRange - WEB
statusCodeRange - WEB
statusCodeRange

Status Codes

If responseProcessingType = Success Status Code Range or Failure Status Code Range; Qualifying status codes.

Format: 200-299,503.

N

Anchor
timeout - WEB
timeout - WEB
timeout

Timeout

Number of seconds to wait for the request to complete.


N

Anchor
url - WEB
url - WEB
url

URL

URL of the target service, excluding any urlParameters.


Y

Anchor
urlParameters - WEB
urlParameters - WEB
urlParameters

URL Query Parameters

If protocol = HTTP; Any query parameters to be encoded as a query string and appended to the URL.

Format:
 

Panel
Html bobswift<pre> &lt;urlParameters&gt;
<urlParameters>
&lt;urlParameter&gt;
<urlParameter>
&lt;name&gt;param1&lt;/name&gt;
<name>param1</name>
&lt;value&gt;value1&lt;/value&gt;
<value>value1</value>
&lt;/urlParameter&gt;
</urlParameter>
&lt;urlParameter&gt;
<urlParameter>
&lt;name&gt;param2&lt;/name&gt;
<name>param2</name>
&lt;value&gt;value2&lt;/value&gt;
<value>value2</value>
&lt;/urlParameter&gt; &lt;/urlParameters&gt;
</urlParameter>
</
pre>
urlParameters>


N