Web Request

Executes a Web Request. Use this Connector to access a web page or interact with a REST service (where no specialized connector is available).

Revision History

1.0.0.22 Added support for Host and User-Agent headers.
1.0.0.23 Fixed issue where TrustedCertificateSubject wasn't applied correctly
1.0.0.24 Fixed bug where node times out
1.0.0.25 Added an error when Connection provided a Password but no Username
1.0.0.26 Enhanced error message as we're often seeing Password Managers auto-fill Passwords into the Password field
1.0.0.27 Added BaseUrl to the Connection.
1.0.0.29 Added connection testing. Does a GET on the BaseURL with credentials provided
1.0.0.30 Added support to pass in the date header
1.0.0.34 Added support for NTLM
1.0.0.35 Changed handling of TrustedCertificateSubject so that valid certificates are always trusted in addition to those with the specified subject

Properties

Connection

Type: Connection Input

BaseUrl
Type: String
Use this to save a BaseUrl for the connection, which can, of course, be different for each of your Flowgear environments, Dev, Production, etc. When implemented, then the Url on the Node properties must be specified as a path which is relative to this BaseUrl.

Username
Type: String
The username provided for authentication. Authentication is based on 'Basic Auth' and the node will include the username and password as Basic Authorization to the Request Header.

Password
Type: String
The password provided for authentication.

ReturnHttpFailureResponses
Type: Boolean
When True, the Web Request node will consume any web request errors and return a success state (and follow execution) with a Status Code property output. The Status Code property can then be used to validate and check the web request response. All
other failures (non web request related) will return an error state.

SessionKey
Type: String
An identifier that links multiple Web Request Nodes on the same workflow by sharing the same Cookie Jar.

TrustedCertificateSubject
Type: String
When supplied, forces a certificate to be trusted if part of its subject matches the text supplied in this property. For example, providing the text www.example.com will allow the site www.domain.com to be trusted if it serves a certificate containing the subject www.example.com. Without this setting, the error Could not establish trust relationship for the SSL/TLS secure channel will be thrown if there is a mismatch between a certificate and the domain being accessed.

DecompressionType
Type: String
Enums: None, Deflate, GZip
The decompression type to be applied on the response returned by the server.

CertificateBase64
Type: String
The Base64 encoded string of the certificate supplied by the destination server.

Base64Password
Type: String
The password to validate the Base64 encoded certificate.

UseNTLM
Type: Boolean
When True, the Web Request will set the AuthenticationLevel to MutualAuthRequested. Usually when this is used, a SessionKey should also be used.

Url

Type: String Input
The URL for the request. As of v1.0.0.27, the Connection has a BaseUrl, which, if used, has the effect that this Url property must be specified as a path which is relative to the BaseUrl in the Connection.

Headers

Type: Multiline Text Input
An optional location for custom HTTP headers, passed in the form: {header}:{value}

SOAPAction: GetCustomerAccept: text/xml

ContentType

Type: List Input
Specifies the value to set for the Content-Type Property.
None - Specifies that not Content-Type header should be sent.
Application_Json - Specifies that application/json should be set for the Content-Type header
Application_Xml - Specifies that application/xmlshould be set for the Content-Type header
Text_Html - Specifies that text/htmlshould be set for the Content-Type header
Text_Json - Specifies that text/json should be set for the Content-Type header
Text_Plain - Specifies that text/plain should be set for the Content-Type header
Text_Xml - Specifies that text/xml should be set for the Content-Type header

Method

Type: List Input
The HTTP Method to use use for the request. Note that PostData can only be provided for methods POST and PUT .
GET
POST
HEAD
PUT
DELETE
TRACE
OPTIONS
CONNECT
PATCH

UserAgent

Type: String Input
The value that will be sent for the HTTP User-Agent Header. Use this header to emulate a specific browser.

PostData

Type: Multiline Text Input
The request payload. This property is only valid when Method is POST or PUT.

ReturnBodyAs

Type: List Input
Indicates how the response should be processed to the ResponseBody Property
Text - Indicates that the response should be presented as a string
Binary - Indicates that the response should be converted to a byte array (byte)

StatusCode

Type: String Input
The HTTP Status code that was returned by the server.

ResponseHeaders

Type: Multiline Text Output
Contains all headers that were returned by the server.

ResponseBody

Type: Multiline Text Output
The Response body that was returned by the server.

Remarks

Use this Connector to invoke a web page or service.

Where multiple steps are required for the integration, share the session by selecting the same Connection on each Web Request Node and ensuring that a SessionKey has been captured into the Connection.