REST Adapter

Properties   Config Settings  

The REST component provides a simple, ligthweight and fast way to communicate with RESTful web server.

Remarks

The REST adapter implements a highly configurable HTTP client that is capable of sending and receiving data to and from web servers. Support includes issuing simple GET requests as well as defining custom form and file parameters to be POSTed to server. URL defines the location to which the request is made.

The adapter supports HTTP 1.0, 1.1, and 2.0 which can be configured in the HTTPVersion property.

The HTTPMethod property defines the HTTP method to use. Possible values are:

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

Getting Data From the Server

In the REST Send Adapter, if HTTPMethod is set to GET the request is issued to the server specified by URL. Additional custom headers may be specified in the request by setting OtherHeaders.

The response received by the adapter will be used as the body of the submitted BizTalk message. In the case of the Send Adapter the response message is only returned when the adapter is configured in a solicit response port (recommended). The HTTP headers of the response are available via the TransferredHeaders context property of the message.

Sending Data To the Server

When HTTPMethod is set to POST or PUT data will be sent to the server. The RequestParams property specifies one or more parameters to add to the POST or PUT request. This property is only applicable when the HTTPMethod property is set to POST or PUT.

To specify additional parameters set this property to one or more name value pairs. Set one pair on each line. For instance: name1=value1 name2=value2

The adapter will format a request with parameters slightly differently depending on whether the request is made by the Send or Receive adapter.

Note: To have complete control over the data being sent set PostData instead.

Send Adapter

When sending a POST or PUT request the BizTalk message body will always be used as the last parameter regardless of the values specified in RequestParams. If no values are set here then a request will be made with only one parameter which is the content of the message. Several examples and additional details follow.

Basic Example:

Setting the RequestParams to a value of: name1=value1 name2=value2

Will result in a HTTP request like this: POST / HTTP/1.1 Host: www.nsoftware.com Accept-Encoding: gzip, deflate User-Agent: IPWorks HTTP Component - www.nsoftware.com Connection: close Content-Type: multipart/form-data; boundary="boundaryV+iTxA==" Content-Length: 335 --boundaryV+iTxA== Content-Disposition: form-data; name="name1" Content-Type: text/plain value1 --boundaryV+iTxA== Content-Disposition: form-data; name="name2" Content-Type: text/plain value2 --boundaryV+iTxA== Content-Disposition: form-data Content-Type: application/octet-stream message body --boundaryV+iTxA==--

Notice that the default "Content-Type" for the individual request parameters is "text/plain", and the default "Content-Type" for the message form variable is "application/octet-stream" and has no defined name attribute. See the following examples for further details.

Custom Request Parameter Content-Type Values:

When sending requests the RequestParams may optionally include a custom Content-Type value. The syntax is:

[ContentType]name=value

For instance setting RequestParams to a value of: [text/html]name1=value1 [my/type]name2=value2 name3=value3 Will result in a HTTP request like: POST / HTTP/1.1 Host: www.nsoftware.com Accept-Encoding: gzip, deflate User-Agent: IPWorks HTTP Component - www.nsoftware.com Connection: close Content-Type: multipart/form-data; boundary="boundaryQDNEUw==" Content-Length: 439 --boundaryQDNEUw== Content-Disposition: form-data; name="name1" Content-Type: text/html value1 --boundaryQDNEUw== Content-Disposition: form-data; name="name2" Content-Type: my/type value2 --boundaryQDNEUw== Content-Disposition: form-data; name="name3" Content-Type: text/plain value3 --boundaryQDNEUw== Content-Disposition: form-data Content-Type: application/octet-stream message body --boundaryQDNEUw==--

Note the updated Content-Type header values for the "name1" and "name2" parameters.

Custom Content-Type and Name Values for the BizTalk Message Variable:

The default Content-Type value for the BizTalk Message form variable is "application/octet-stream" and no "name" attribute is defined in the Content-Disposition header. These can be explicitly defined in the ContentType and ContentFileName properties. These properties are applicable to the BizTalk Message form variable even if RequestParams is not set. For instance setting:

• ContentType to "text/html"
• ContentFileName to "myfile.txt"

And leaving RequestParams unspecified (no parameters) will result in a HTTP request like:

POST / HTTP/1.1 Host: www.nsoftware.com Accept-Encoding: gzip, deflate User-Agent: IPWorks HTTP Component - www.nsoftware.com Connection: close Content-Type: multipart/form-data; boundary="boundaryVAJHkA==" Content-Length: 142 --boundaryVAJHkA== Content-Disposition: form-data; name="myfile.txt" Content-Type: text/html message body --boundaryVAJHkA==--

Parsing the Response

The ResponseXPath property may be set to traverse elements within the JSON document. This property implements a subset of the XML XPath specification, allowing you to point to specific elements in the XML document. When this property is set, the adapter will parse the response and return the value at the specified location.

For example, let's say the response data from the original request is below.

{ "bag": { "name": "fanny-pack", "items": ["camera", "wallet"], "description": "A hip new design by nsoftware" } }

The ResponseXPath property supports both XPath notation and JSONPath notation. For simplicitly, only the XPath notation is shown below. For more information and examples on notation schemes please see "Getting Started with JSON".

If you would like to return the value of element "name" from the operation, then set ResponseXPath to /json/bag/name/. Likewise, if you would like to return the value of the first element of the "items" array, then we can set ResponseXPath to /json/bag/items/[0]/ and the output will be camera.

Additional Settings

In addition to the basic operation as discussed above the adapter supports a variety of other settings that control authentication, proxy settings, and other behavior. Some of additional features include:

• Authentication (NTLM, Kerberos, Digest, Basic) via the AuthScheme, User, and Password properties.
• Full Proxy/Firewall support using the HTTPProxy and Firewall properties.
• CustomRequestMethod provides support for custom HTTP methods.
• Specify redirect behavior with FollowRedirects.
• Add cookies to the request via Cookies.
• Configurable UserAgent.
• And many more!

Sender Property List

---

The following is the full list of the properties of the sender Adapter with short descriptions. Click on the links for further details.

Authorization	The Authorization string to be sent to the server.
AuthScheme	The authorization scheme to be used when server authorization is to be performed.
ContentFileName	Defines the filename of the content.
ContentType	Defines the Content-Type header in the request.
Cookies	The cookies to be sent in the HTTP request.
Firewall	A set of properties related to firewall access.
FollowRedirects	Determines what happens when the server issues a redirect.
HTTPMethod	The HTTP method used for the request.
HTTPProxy	A set of properties related to proxy access.
HTTPVersion	The HTTP version to use.
MaxPersistentConnections	The maximum number of simultaneous persistent connections when sending.
MaxThreads	The maximum number of threads that the component may consume.
MaxTransmissionBatchSize	The maximum number of messages that can be sent in a single batch.
OAuthAuthorization	OAuth Authorization Information.
Other	Defines a set of configuration settings to be used by the component.
OtherHeaders	Other headers as determined by the user.
Password	A password if authentication is to be used.
PostData	The data to be posted to the server.
RequestParams	Parameters to add to the POST or PUT request.
ResponseXPath	This property may be set to traverse elements within the JSON document.
RuntimeLicense	Specifies the component runtime license key.
SSLAcceptServerCert	Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCert	The certificate to use for client authentication during the SSL handshake.
StatusCode	The response status code of the last server response.
StatusLine	The first line of the last server response.
Timeout	A timeout for the component.
TransferredData	The body of the HTTP response.
TransferredHeaders	The full set of headers as received from the server.
TransmitBatchMode	How the transmitter processes batches.
TransportLog	Tells the component where and how to report information about its operations.
URI	The Uniform Resource Identifier (URI) of the send port or receive location.
URL	The URL to which the request is made.
User	A user name if authentication is to be used.

Config Settings

---

The following is a list of config settings for the Adapter with short descriptions. Click on the links for further details.

Accept	A list of acceptable MIME types for the request.
AcceptEncoding	Used to tell the server which types of content encodings the client supports.
AddBodyAsMessageProperty	This setting causes the adapter to include the response body as a property on the message.
AllowHTTPCompression	This property enables HTTP compression for receiving data.
AllowHTTPFallback	Specifies whether HTTP/2 connections can fall back to HTTP/1.1.
ChunkSize	Specifies the chunk size in bytes when using chunked encoding.
CustomRequestMethod	Specifies the HTTP method to be used.
EncodeURL	If set to true the URL will be encoded by the component.
IfModifiedSince	A date determining the maximum age of the desired document.
KerberosSPN	The Service Principal Name for the Kerberos Domain Controller.
LogDebugData	Whether to log debug data.
MaxRedirectAttempts	Limits the number of redirects that are followed in a request.
Pragma	A browser/server specific header line (optional).
Range	The byte-range to be sent to the server.
Referer	Referer URL/document (optional).
ResponseBodyAlwaysAvailable	Whether the response body is always available.
SubmitErrorAsMessage	Whether errors are submitted as BizTalk messages.
TransferredDataLimit	The maximum of data to be transferred.
UseChunkedEncoding	Enables or Disables HTTP chunked encoding for transfers.
UserAgent	Information about the user agent (browser).
ReuseSSLSession	Determines if the SSL session is reused.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuites	The cipher suite to be used in an SSL negotiation.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
SSLIncludeCertChain	Whether the entire certificate chain is included in the SSLServerAuthentication event.
SSLSecurityFlags	Flags that control certificate verification.
TLS12SignatureAlgorithms	Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroups	The supported groups for ECC.
TLS13KeyShareGroups	The groups for which to pregenerate key shares.
TLS13SignatureAlgorithms	The allowed certificate signature algorithms.
TLS13SupportedGroups	The supported groups for (EC)DHE key exchange.
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
LocalHost	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
TcpNoDelay	Whether or not to delay when sending packets.
UseInternalSecurityAPI	Whether or not to use the system security libraries or an internal implementation.

REST Transmitter

Setting the REST Adapter Configuration Properties for a Dynamic Send Port

A dynamic send port does not provide any transport configuration options in BizTalk Explorer because it is expected that these properties will be provided with the context properties associated with the message. These properties can be set in a custom pipeline or in an orchestration. To set message configuration properties in an orchestration you can do the following:

• Add a Construct Message shape to your orchestration.
• Configure the Construct Message shape to construct a new message. (for example Message_2)
• Add a Message Assignment shape to the Construct Message shape.
• Add code to the Message Assignment shape to initialize the message that you constructed and to set the appropriate configuration properties for the message.

Configuring the REST Send Port with the BizTalk Server Administration Console

To configure the send port by using the BizTalk Server Administration console, use the following procedure:

To configure variables for a REST send port:

1. In the BizTalk Server Administration console, create a new send port or double-click an existing send port to modify it. For more information, see How to Create a Send Port. Configure all of the send port options and specify nsoftware.REST 2024 for the Type option in the Transport section of the General tab.
2. On the General tab, in the Transport section, click the Configure button next to Type.
3. In the nsoftware.REST 2024 Transport Properties dialog box, use the following properties to:

   
   

   Authorization	The Authorization string to be sent to the server. Type: xs:string    Default Value: ""
   AuthScheme	The authorization scheme to be used when server authorization is to be performed. Type: xs:int    Default Value: 0
   ContentFileName	Defines the filename of the content. Type: xs:string    Default Value: ""
   ContentType	Defines the Content-Type header in the request. Type: xs:string    Default Value: ""
   Cookies	The cookies to be sent in the HTTP request. Type: xs:string    Default Value: ""
   Firewall	A set of properties related to firewall access. Type: Firewall    Default Value: null
   FollowRedirects	Determines what happens when the server issues a redirect. Type: xs:int    Default Value: 0
   HTTPMethod	The HTTP method used for the request. Type: xs:int    Default Value: 1
   HTTPProxy	A set of properties related to proxy access. Type: Proxy    Default Value: null
   HTTPVersion	The HTTP version to use. Type: xs:string    Default Value: "1.1"
   MaxPersistentConnections	The maximum number of simultaneous persistent connections when sending. Type: xs:int    Default Value: 1
   MaxThreads	The maximum number of threads that the component may consume. Type: xs:int    Default Value: 20
   MaxTransmissionBatchSize	The maximum number of messages that can be sent in a single batch. Type: xs:int    Default Value: 1
   OAuthAuthorization	OAuth Authorization Information. Type: OAuthAuthorizationParam    Default Value: null
   Other	Defines a set of configuration settings to be used by the component. Type: xs:string    Default Value: ""
   OtherHeaders	Other headers as determined by the user. Type: xs:string    Default Value: ""
   Password	A password if authentication is to be used. Type: baf:Password    Default Value: ""
   PostData	The data to be posted to the server. Type: xs:string    Default Value: ""
   RequestParams	Parameters to add to the POST or PUT request. Type: xs:string    Default Value: ""
   ResponseXPath	This property may be set to traverse elements within the JSON document. Type: xs:string    Default Value: ""
   RuntimeLicense	Specifies the component runtime license key. Type: xs:string    Default Value: ""
   SSLAcceptServerCert	Instructs the component to unconditionally accept the server certificate that matches the supplied certificate. Type: Certificate    Default Value: null
   SSLCert	The certificate to use for client authentication during the SSL handshake. Type: Certificate    Default Value: null NOTE: The digital id must have a private key associated with it.
   StatusCode	The response status code of the last server response. Type: xs:string    Default Value: ""
   StatusLine	The first line of the last server response. Type: xs:string    Default Value: ""
   Timeout	A timeout for the component. Type: xs:int    Default Value: 60
   TransferredData	The body of the HTTP response. Type: xs:string    Default Value: ""
   TransferredHeaders	The full set of headers as received from the server. Type: xs:string    Default Value: ""
   TransmitBatchMode	How the transmitter processes batches. Type: xs:int    Default Value: 0
   TransportLog	Tells the component where and how to report information about its operations. Type: Log    Default Value: null
   URI	The Uniform Resource Identifier (URI) of the send port or receive location. Type: xs:string    Default Value: ""
   URL	The URL to which the request is made. Type: xs:string    Default Value: "" NOTE: This property must be specified.
   User	A user name if authentication is to be used. Type: xs:string    Default Value: ""

4. Click OK and OK again to save settings.

Authorization Property (REST Adapter)

The Authorization string to be sent to the server.

Data Type

String

Default Value

""

Remarks

If the Authorization property contains a non-empty string, an Authorization HTTP request header is added to the request. This header conveys Authorization information to the server.

A common use for this property is to specify OAuth authorization string.

This property is provided so that the HTTP adapter can be extended with other security schemes in addition to the authorization schemes already implemented by the adapter.

The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

AuthScheme Property (REST Adapter)

The authorization scheme to be used when server authorization is to be performed.

Data Type

Enumeration

Possible Values

Basic (0)
Digest (1)
Proprietary (2)
None (3)
Ntlm (4)
Negotiate (5)
OAuth (6)

Default Value

0

Remarks

This property specifies the type of authentication to perform. Possible values are:

• Basic
• Digest
• Proprietary
• None
• NTLM
• Negotiate
• OAuth

In most cases this setting is only applicable if User and Password is set.

This property is also applicable without setting User and Password if the AuthScheme is set to NTLM or Negotiate. In that case the current user credentials will be used.

AuthScheme should be set to authNone (3) when no authentication is to be performed (or do not set HTTPUser and HTTPPassword).

By default, AuthScheme is authBasic (0), and if the HTTPUser and HTTPPassword properties are set, the adapter will attempt basic authentication. If AuthScheme is set to authDigest (1) or authNtlm (4), digest or NTLM authentication will be attempted instead.

If AuthScheme is set to authProprietary (2) then the authorization token must be supplied through the HTTPAuthorization configuration. Note that, if you set the HTTPAuthorization config, the AuthScheme will be set automatically to authProprietary (2) by the control.

If AuthScheme is set to authOAuth (6) then the authorization string must be supplied through Authorization property.

ContentFileName Property (REST Adapter)

Defines the filename of the content.

Data Type

String

Default Value

""

Remarks

This property optionally sets the "name" attribute of the "Content-Disposition" header for the form variable corresponding to the message body. This is used to associate a filename with the data obtained from the message body.

This is only applicable when HTTPMethod is set to POST or PUT.

This is only applicable to the Send Adapter.

This is not applicable if PostData is set.

This property is not available in the Receiver.

ContentType Property (REST Adapter)

Defines the Content-Type header in the request.

Data Type

String

Default Value

""

Remarks

This property optionally defines the Content-Type header sent in the request.

This property is applicable when using the Send Adapter to define the "Content-Type" header of the form variable for the BizTalk message body. See RequestParams for details about the HTTP request structure.

This is applicable to both the Send and Receive Adapter when PostData is set and defines the Content-Type header (not a form variable level Content-Type).

Cookies Property (REST Adapter)

The cookies to be sent in the HTTP request.

Data Type

String

Default Value

""

Remarks

This property specifies the cookies (if any) to be sent in the HTTP request. Specify one name/value pair per line. For instance setting this property to: CookieName1=CookieValue1 CookieName2=CookieValue2

Will result in the HTTP header:

Cookie: CookieName1=CookieValue1; CookieName2=CookieValue2

ErrorThreshold Property (REST Adapter)

The maximum number of errors before the component shuts down.

Data Type

Integer

Default Value

5

Remarks

This property limits the number of errors that the adapter can incur before it shuts down and stops processing messages.

If set to 0 the adapter will never shutdown.

Note that if the operation completes successfully the current error count will be reset.

This property may be configured on the adapter's static handler property page in the BizTalk Server administration console.

This property is not available in the Sender.

Firewall Property (REST Adapter)

A set of properties related to firewall access.

Data Type

Firewall

Remarks

This is a Firewall type property which contains fields describing the firewall through which the adapter will attempt to connect.

FollowRedirects Property (REST Adapter)

Determines what happens when the server issues a redirect.

Data Type

Enumeration

Possible Values

Never (0)
Always (1)
Same Scheme (2)

Default Value

0

Remarks

Normally, the adapter returns an error if the server responds with an "Object Moved" message. If FollowRedirects is set to frAlways (1) the new URL for the object is retrieved automatically every time.

If FollowRedirects is set to frSameScheme (2), the new URL is retrieved automatically only if the URL scheme is the same, otherwise the adapter generate a runtime error.

Furthermore, if either the new URL server and port are different than the existing one, HTTPUser and HTTPPassword are also reset to empty, unless FollowRedirects is set to frAlways (1), in which case the same credentials are used to connect to the new server.

The default value is frNever (0). In this case, redirects are never followed, and a runtime error is generated instead.

HTTPMethod Property (REST Adapter)

The HTTP method used for the request.

Data Type

Enumeration

Possible Values

DELETE (0)
GET (1)
POST (2)
PUT (3)
PATCH (4)

Default Value

1

Remarks

This property specifies the HTTP method to use when making a request to the server. Possible values are:

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

When set to POST or PUT see RequestParams and PostData for details about sending data to the server.

To specify a different HTTP method set CustomRequestMethod.

HTTPProxy Property (REST Adapter)

A set of properties related to proxy access.

Data Type

Proxy

Remarks

This is a Proxy type property which contains fields describing the proxy through which the adapter will attempt to connect.

HTTPVersion Property (REST Adapter)

The HTTP version to use.

Data Type

String

Default Value

"1.1"

Remarks

This property specifies the HTTP version used by the adapter. Possible values are:

• "1.0"
• "1.1" (default)
• "2.0"

When using HTTP/2 ("2.0") additional details apply. Please see notes below for details.

HTTP/2 Notes

When using HTTP/2 only secure (TLS/SSL) connections are currently supported. Attempting to use a plaintext URL with HTTP/2 will result in an error.

If the server does not support HTTP/2 the adapter will automatically use HTTP/1.1 instead. This is done in order to provide compatibility without the need for any additional settings. The AllowHTTPFallback setting controls whether this behavior is allowed (default) or disallowed.

HTTP/2 is supported on all versions of Windows. If the Windows version is prior to Windows 8.1/Windows Server 2012 R2 the internal security implementation will be used. If the Windows version is Window 8.1/Windows Server 2012 R2 or later the system security libraries will be used by default.

The HTTPVersion context property will be set on the BizTalk message to indicate which HTTP version was used.

MaxBatchSize Property (REST Adapter)

The maximum size, in MB, of the current batch (0 indicates no limit).

Data Type

Integer

Default Value

0

Remarks

This property limits the maximum amount of data the adapter can store before finalizing and processing the current batch to the number of bytes indicated.

Note: the default value, "0" indicates that there is no limit on the size of the batch. This value is not recommended for production environments as it may result in extremely large batches being held in memory before the adapter moves the data to the next stage of processing.

This property may be configured on the adapter's static handler property page in the BizTalk Server administration console.

This property is not available in the Sender.

MaxFileCount Property (REST Adapter)

The maximum number of files in the current batch (0 indicates no limit).

Data Type

Integer

Default Value

10

Remarks

This property places a limit on the number of files that can be transmitted in a single batch.

This property may be configured on the adapter's static handler property page in the BizTalk Server administration console.

This property is not available in the Sender.

MaxFileSize Property (REST Adapter)

The maximum size, in MB, of a file in the current batch (0 indicates no limit).

Data Type

Integer

Default Value

0

Remarks

This property limits the maximum size of any file in the current transmission batch to the number of bytes indicated.

Note: the default value, "0" indicates that there is no limit on the size of the batch. This value is not recommended for production environments as it may result in extremely large batches being held in memory before the adapter moves the data to the next stage of processing.

This property may be configured on the adapter's static handler property page in the BizTalk Server administration console.

This property is not available in the Sender.

MaxPersistentConnections Property (REST Adapter)

The maximum number of simultaneous persistent connections when sending.

Data Type

Integer

Default Value

1

Remarks

This setting specifies the maximum number of simultaneous persistent connections when sending.

The default value is 1, which limits the adapter to using one persistent connection for the adapter at any one time. This means when ConnectionLifetime is set to Persisted the send adapter will first check to see if an existing connection is present before transmitting data. In the case where a connection exists but another instance of the send port is using the connection the adapter will wait for the connection to become free. A value of 1 effectively serializes all communication for the send port through one persistent connection.

By setting a value greater than 1 a pool of persistent connections can be created. This allows multiple simultaneous persistent connections to be used. When the send adapter is active it will check to see if there are any existing connections. In the case where a connection exists but is being used by another instance of the send port it will attempt to create a new persistent connection. If creating a new persistent connection would exceed the limit specified in this setting the adapter will instead wait for a connection to become free. Setting this to a value greater than 1 allows multiple simultaneous connections to be made while still taking advantage of persistent connections to reduce the overhead of re-connecting.

Note: This only applies to the send adapter.

The default value is 1.

This property can only be configured through the adapter's static handler property page in the BizTalk Server administration console.

This property is not available in the Receiver.

MaxThreads Property (REST Adapter)

The maximum number of threads that the component may consume.

Data Type

Integer

Default Value

20

Remarks

This property limits the number of concurrent threads that the adapter may consume while completing its work.

This property can only be configured through the adapter's static handler property page in the BizTalk Server administration console.

MaxTransmissionBatchSize Property (REST Adapter)

The maximum number of messages that can be sent in a single batch.

Data Type

Integer

Default Value

1

Remarks

This property controls the maximum size of an outbound message batch.

Note: be careful when modifying this property as it directly effects the efficiency of the transmit adapter. Setting MaxTransmissionBatchSize to a low value in an environment that requires transmission of large quantities of data will result in the adapter accumulating several small batches. If TransmitBatchMode is set to Parallel, this will result in the adapter transmitting many small batches at once and can put a heavy load on the processor.

Conversely, if TransmitBatchMode is set to Serial, setting MaxTransmissionBatchSize to a large value may result in long transmission delays as the adapter will wait on existing work to complete before accepting new messages from the BizTalk Message Engine. This is especially true when the adapter is transmitting large data.

This property can only be configured through the adapter's static handler property page in the BizTalk Server administration console.

This property is not available in the Receiver.

OAuthAuthorization Property (REST Adapter)

OAuth Authorization Information.

Data Type

OAuthAuthorizationParam

Remarks

This property holds details about the OAuth authorization. This includes the following fields:

• AuthorizationScopes
• AuthorizationString
• CacheLocation
• CallbackURL
• ClientId
• ClientSecret
• ExpiresIn
• RefreshToken
• ServerAuthURL
• ServerTokenURL
• ServiceProvider
• TimeStamp

Other Property (REST Adapter)

Defines a set of configuration settings to be used by the component.

Data Type

String

Default Value

""

Remarks

The adapter accepts one or more configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the adapter, access to these internal properties is provided through the Other property.

The Other property may be set to one or more configuration settings (name/value pairs). Set one setting per line. For example: configname1=value1 configname2=value2

OtherHeaders Property (REST Adapter)

Other headers as determined by the user.

Data Type

String

Default Value

""

Remarks

This property optionally specifies headers to be included in addition to the headers generated by the adapter. The headers specified should be valid HTTP headers following the format:

Header: Value

To specify multiple headers enter one header per line. For instance setting:

X-Header1: Value1 X-Header2: Value2

Will result in a request with the following headers:

GET / HTTP/1.1 Host: www.nsoftware.com Accept-Encoding: gzip, deflate User-Agent: IPWorks HTTP Component - www.nsoftware.com Connection: close X-Header1: Value1 X-Header2: Value2

Password Property (REST Adapter)

A password if authentication is to be used.

Data Type

Password

Default Value

""

Remarks

If HTTP Basic Authentication is used to authenticate the user, User and Password are Base64-encoded.

If HTTP Digest Authentication is used to, the User and Password properties are used to respond to the HTTP Digest Authentication challenge from the server.

PollingInterval Property (REST Adapter)

The amount of time, in seconds, between download attempts.

Data Type

Integer

Default Value

60

Remarks

The adapter will wait for the number of seconds indicated before attempting another download.

This property is not available in the Sender.

PostData Property (REST Adapter)

The data to be posted to the server.

Data Type

String

Default Value

""

Remarks

This property optionally specifies the raw data to be posted to the server.

If set, this property defines the entire HTTP body to be sent to the server. This is only applicable when the HTTPMethod is set to POST or PUT.

In the HTTP Sender, the %MessageBody% macro can be used to include the contents of the incoming BizTalk message in the PostData property. The adapter replaces this macro with the full BizTalk message body at runtime.

ContentType may be set to define a Content-Type header. No Content-Type header is set by default when PostData is set.

If specified both RequestParams and ContentFileName properties are ignored.

RequestParams Property (REST Adapter)

Parameters to add to the POST or PUT request.

Data Type

String

Default Value

""

Remarks

The RequestParams property specifies one or more parameters to add to the POST or PUT request. This property is only applicable when the HTTPMethod property is set to POST or PUT.

To specify additional parameters set this property to one or more name value pairs. Set one pair on each line. For instance: name1=value1 name2=value2

The adapter will format a request with parameters slightly differently depending on whether the request is made by the Send or Receive adapter.

Note: To have complete control over the data being sent set PostData instead.

RequeueEndpoints Property (REST Adapter)

Whether to requeue receive endpoints if the polling interval has not been reached.

Data Type

Boolean

Default Value

false

Remarks

This setting controls whether receive endpoints are requeued for later processing if the polling interval has not yet been reached. When this setting is set to No (default) each thread will block until the polling interval for the corresponding receive location is reached. If there exist more active receive locations than MaxThreads it is possible for some threads to block the execution of others since they may be waiting for a polling interval.

When this setting is set to Yes if the polling interval has not been reached the thread will not block until the polling interval is reached, and instead the endpoint will be requeued to be processed later. This lets subsequent endpoints in the queue to be processed.

If MaxThreads is set to a low value and there are a larger number of receive locations setting this to Yes will help assure that polling intervals are respected and receive locations poll in a timely manner.

The default value is No.

This property can only be configured through the adapter's static handler property page in the BizTalk Server administration console.

This property is not available in the Sender.

ResponseXPath Property (REST Adapter)

This property may be set to traverse elements within the JSON document.

Data Type

String

Default Value

""

Remarks

Parsing the Response

The ResponseXPath property may be set to traverse elements within the JSON document. This property implements a subset of the XML XPath specification, allowing you to point to specific elements in the XML document. When this property is set, the adapter will parse the response and return the value at the specified location.

For example, let's say the response data from the original request is below.

{ "bag": { "name": "fanny-pack", "items": ["camera", "wallet"], "description": "A hip new design by nsoftware" } }

The ResponseXPath property supports both XPath notation and JSONPath notation. For simplicitly, only the XPath notation is shown below. For more information and examples on notation schemes please see "Getting Started with JSON".

If you would like to return the value of element "name" from the operation, then set ResponseXPath to /json/bag/name/. Likewise, if you would like to return the value of the first element of the "items" array, then we can set ResponseXPath to /json/bag/items/[0]/ and the output will be camera.

RuntimeLicense Property (REST Adapter)

Specifies the component runtime license key.

Data Type

String

Default Value

""

Remarks

You can use the RuntimeLicense property to set the runtime key for the adapter license.

This property may be configured on the adapter's static handler property page in the BizTalk Server administration console.

SSLAcceptServerCert Property (REST Adapter)

Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.

Data Type

Certificate

Remarks

If it finds any issues with the certificate presented by the server, the adapter will normally terminate the connection with an error. You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

This property is used to set a Public Key Certificate.

Ordinarily, the system will attempt to locate the public key in trusted certificate stores in the system registry. If a match is found, the certificate is trusted, and the process proceeds without error. If the certificate is not trusted, the adapter will report an error.

You may explicitly set a public key, either to accept a key that is not installed on the system, or to ensure that a specific key is presented. Public key certificates may be loaded from the machine registry or from file. If you click on the ellipses, a certificate selection dialog will open. To select a public key from the system registry, select the System Store tab or the User Store tab, and highlight the appropriate registry store. The list of available certificates will be shown below.

Alternatively, you may specify a public key on file. Select the PEM or Certificate File tabs to load a public key from file. You can use the browse button to examine the file system for the certificate that you wish to use. Public keys typically are stored in .CER, .DER, or .PEM files, but other formats may be used. You can click on the Open button to examine the contents of the certificate. Or, if you have a certificate stored in memory, you can write the contents of the certificate into the text box provided. Note that if you are loading a certificate from memory, the certificate must be Base-64 encoded, or the string representation of the certificate may become corrupted and uninterpretable.

Regardless of how you selected the certificate, once you hit the OK button, the adapter will attempt to verify that certificate selection. If successful, the subject of the certificate will be displayed in the property field. If the adapter was not able to verify the selection, a dialog box will appear instead detailing the verification error.

Note: You may also set the Accept Any field to Yes without opening the certificate selection dialog to force the adapter to unilaterally authenticate any server during the security handshake. It is strongly recommended that you use this only for testing purposes. Set the LogMode to Info to cause the adapter to report the server's credentials to Location.

SSLCert Property (REST Adapter)

The certificate to use for client authentication during the SSL handshake.

Data Type

Certificate

Remarks

This property is used to assign a specific certificate for SSL client authentication.

This field is used to set a Private Key Certificate.

Private key certificates may be loaded from the registry, from files in PKCS#12 format, or from a PEM file format. If you click on the ellipses, a certificate selection dialog will open. To select a private key from the system registry, select the System Store tab or the User Store tab, and highlight the appropriate registry store. The list of certificates which have private keys will be shown below.

To select a private key certificate from a file in PKCS#12 format, select the PFX Store tab. The browse button can be used to examine the file system for PKCS#12 (.pfx or .p12) certificates. If you wish to examine the certificate, provide the password in the field provided and click on the Open button to examine the file store for certificates present. To load a certificate from PEM files, select the PEM tab. Like the PFX file selection, you can specify the password and click the Open button to examine the certificates in the PEM store, or you may paste any PEM data stored in memory.

Regardless of how you selected the certificate, once you hit the OK button, the adapter will attempt to verify that certificate selection. If successful, the subject of the certificate will be displayed in the property field. If the adapter was not able to verify the selection, a dialog box will appear instead detailing the verification error.

StatusCode Property (REST Adapter)

The response status code of the last server response.

Data Type

String

Default Value

""

Remarks

This property holds the status code of the server response, such as 200. This indicates the status of the request. This is set as a context property on the BizTalk Message.

This property is read-only.

StatusLine Property (REST Adapter)

The first line of the last server response.

Data Type

String

Default Value

""

Remarks

This property holds the first line of the server response. This indicates the status of the request. This is set as a context property on the BizTalk Message.For instance: HTTP/1.1 200 OK .

This property is read-only.

TempPath Property (REST Adapter)

A temporary local directory where data can be stored before the component processes it.

Data Type

String

Default Value

""

Remarks

This property indicates a temporary directory where the adapter can store any data before the adapter processes it. If TempPath is empty, the adapter will receive all data to memory. If set, the adapter will generate and write all inbound data to a temporary file in the specified directory.

Once the file is submitted, the adapter will handle closing the file stream and deleting the temporary file. However, if the adapter is shut down during a transfer some temporary files may be left in the directory. To ensure optimal performance, server administrators should check the directory regularly and remove old or extraneous files.

This property accepts the "%TEMP%" macro, which will be replaced with the default system temporary directory at runtime. Note: by default, this property is empty and the adapter will use memory streams to store all inbound data before submitting it. It is recommended that you use a temporary directory when downloading large batches or batches containing large files to alleviate potential increased memory requirements.

This property is not available in the Sender.

Timeout Property (REST Adapter)

A timeout for the component.

Data Type

Integer

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion, or an error condition is encountered.

If Timeout is set to a positive value, the adapter will wait for the operation to complete before returning control.

If Timeout expires, and the operation is not yet complete, the adapter fails with an error.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when data is successfully sent or received.

Optionally, the behavior of the adapter may be changed to absolute timeouts, i.e. the adapter will wait for a maximum of Timeout seconds since the beginning of the operation, without extending the timeout period during communications.

This behavior is controlled by the AbsoluteTimeout configuration setting.

The default value for the Timeout property is 60 (seconds).

TransferredData Property (REST Adapter)

The body of the HTTP response.

Data Type

String

Default Value

""

Remarks

This property holds the body of the HTTP response. This is only populated if AddBodyAsMessageProperty is enabled.

This property is not available in the Receiver.

TransferredHeaders Property (REST Adapter)

The full set of headers as received from the server.

Data Type

String

Default Value

""

Remarks

This property holds the HTTP headers as received from the server. This may be queried after an operation completes to inspect the response headers.

This property is read-only.

TransmitBatchMode Property (REST Adapter)

How the transmitter processes batches.

Data Type

Enumeration

Possible Values

Parallel (0)
Serial (1)

Default Value

0

Remarks

This property controls how the transmitter processes message batches:

This property can only be configured through the adapter's static handler property page in the BizTalk Server administration console.

This property is not available in the Receiver.

TransportLog Property (REST Adapter)

Tells the component where and how to report information about its operations.

Data Type

Log

Remarks

This is a Log type property which contains fields describing how and where the adapter will record information about its execution.

This property may be configured on the adapter's static handler property page in the BizTalk Server administration console.

URI Property (REST Adapter)

The Uniform Resource Identifier (URI) of the send port or receive location.

Data Type

String

Default Value

""

Remarks

This property specifies a URI for the send port or receive location. Setting this property is optional.

By default the adapter will automatically generate a URI. You may choose to specify your own value here to be used in place of the generated URI.

If this value is specified it must begin with the correct prefix, as seen in the default value.

URL Property (REST Adapter)

The URL to which the request is made.

Data Type

String

Default Value

""

Remarks

This property specifies the URL to which the request is made. TLS/SSL will be used if and only if the URL scheme is "https".

User Property (REST Adapter)

A user name if authentication is to be used.

Data Type

String

Default Value

""

Remarks

If HTTP Basic Authentication is used to authenticate the user, User and Password are Base64-encoded.

If HTTP Digest Authentication is used to, the User and HTTPPassword properties are used to respond to the HTTP Digest Authentication challenge from the server.

Certificate Type

The digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

Constructors

Constructors are only relevant when configuring adapters in orchestrations.

public Certificate();

public Certificate(string certificateFile);

public Certificate(byte[] certificateData);

public Certificate(CertStoreTypes certStoreType, string store, string storePassword, string subject);

public Certificate(CertStoreTypes certStoreType, string store, string storePassword, byte[] encoded);

public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, string subject);

public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, byte[] encoded);

Firewall Type

The firewall the component will connect through.

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall such as the firewall Host and the FirewallType.

Fields

Constructors

Constructors are only relevant when configuring adapters in orchestrations.

public Firewall();

Log Type

A log where the component will record information about its operations.

Remarks

This describes how and where the adapter will record information describing its execution.

Fields

Constructors

Constructors are only relevant when configuring adapters in orchestrations.

public Log();

public Log(LogTypes logType, string location, LogModes logMode);

OAuthAuthorizationParam Type

This type holds details of the OAuth authorization.

Remarks

This type holds details of the OAuth authorization.

Fields

Constructors

Constructors are only relevant when configuring adapters in orchestrations.

public OAuthAuthorizationParam();

Proxy Type

The proxy the component will connect to.

Remarks

When connecting through a proxy, this type is used to specify different properties of the proxy such as the Server and the AuthScheme.

Fields

Constructors

Constructors are only relevant when configuring adapters in orchestrations.

public Proxy();

public Proxy(string server, int port);

public Proxy(string server, int port, string user, string password);

Config Settings (REST Adapter)

The adapter accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the adapter, access to these internal properties is provided through the Other property.

REST Config Settings

SSL Config Settings

General Config Settings

Supported Macros

The adapter also supports the following Macros. These values are not case sensitive and would be supplied to a property in the form %MacroName%.