Web Service Task Properties

Owned by Stonebranch (Deactivated)
Jul 05, 2023
4 min read

Task Properties: Web Service Task

Property

UI Field Name

Description

Specifications

Required

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.

formData

Form Data

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

Format:
 

<formData>
	<formField>
		<name>field1</name>
		<value>value1</value>
	</formField>
	<formField>
		<name>field2</name>
		<value>value2</value>
	</formField>
</formData>

N

httpAuth

HTTP Authentication

HTTP authentication scheme to use.

Valid values:

  • As String = None, As Value = 0
  • As String = Basic, As Value = 1

Default is None (0).

N

httpHeaders

HTTP Headers

HTTP headers.

Format:
 

<httpHeaders>
	<httpHeader>
		<name>header1</name>
		<value>val1</value>
	</httpHeader>
	<httpHeader>
		<name>header2</name>
		<value>val2</value>
	</httpHeader>
</httpHeaders>

N

httpMethod

HTTP Method

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

Valid values:

  • As String = GET, As Value = 1
  • As String = POST, As Value = 2
  • As String = PUT, As Value = 3
  • As String = PATCH, As Value = 4
  • As String = DELETE, As Value = 5

Default is GET (1).

N

httpPayloadType

HTTP Payload Type

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

Valid values:

  • As String = Raw, As Value = 1
  • As String = Form Data, As Value = 2

Default is Raw (1).

N

httpVersion

HTTP Version

Version of the HTTP protocol to use.

Valid values:

  • As String = 1.0, As Value = 1
  • As String = 1.1, As Value = 2

Default is 1.1 (2).

N

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

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

outputConditionOperator

Operator

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

Valid values:

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

Default is = (1).

N

outputConditionStrategy

Strategy

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

Valid values:

  • As String = Match Any, As Value = 1
  • As String = Match All, As Value = 2
  • As String = Match None, As Value = 3
  • As String = Count, As Value = 4

Default is Match Any (1).

N

outputConditionValue

Value

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


N

outputPathExpression

Path Expression

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


N

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:

  • As String = Text, As Value = 1
  • As String = XML, As Value = 2
  • As String = JSON, As Value = 3

Default is Text (1).

N

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

payloadScript

Payload Script

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


Y
(if payloadSource
= Script.

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:

  • As String = Form, As Value = 1
  • As String = Script, As Value = 2

Default is Form (1).

N

protocol

Protocol

Protocol to use for the operation.

Valid values:

  • As String = HTTP, As Value = 1
  • As String = SOAP, As Value = 2

Default is HTTP (1).

N

responseProcessingType

Response Processing

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

Valid values:

  • As String = Default Success Status Code Range, As Value = 1
  • As String = Success Status Code Range, As Value = 2
  • As String = Failure Status Code Range, As Value = 3
  • As String = Success Output Contains, As Value = 4
  • As String = Failure Output Contains, As Value = 5

Default is Default Success Status Code Range (1).

N

soapPayloadType

SOAP Payload Type

If protocol = SOAP; Type of SOAP Payload.

Valid values:

  • As String = Body, As Value = 1
  • As String = Envelope, As Value = 2

Default is Body (1).

N

soapResponseOutput

SOAP Response Output

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

Valid values:

  • As String = Body/First Element, As Value = 1
  • As String = Body, As Value = 2
  • As String = Envelope, As Value = 3

Default is Body/First Element (1).

N

soapVersion

SOAP Version

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

Valid values:

  • As String = 1.1, As Value = 1
  • As String = 1.2, As Value = 2

Default is 1.2 (2).

N

statusCodeRange

Status Codes

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

Format: 200-299,503.

N

timeout

Timeout

Number of seconds to wait for the request to complete.


N

url

URL

URL of the target service, excluding any urlParameters.


Y

urlParameters

URL Query Parameters

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

Format:
 

<urlParameters>
      <urlParameter>
            <name>param1</name>
            <value>value1</value>
      </urlParameter>
      <urlParameter>
            <name>param2</name>
            <value>value2</value>
      </urlParameter>
</urlParameters>

N