REST Connector

Properties   Config Settings  

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

Remarks

The REST connector 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 connector 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 Connector, 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 connector will be used as the body of the submitted message. In the case of the Send Connector the response message is only returned when the connector 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 connector 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 Connector

When sending a POST or PUT request the message payload 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 Message Payload Variable:

The default Content-Type value for the Message Payload 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 Message Payload 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 connector 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 connector 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 Connector with short descriptions. Click on the links for further details.

AttachedFile	A file to include in the POST data.
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.
LogFile	The file to write logging information to at runtime.
LogMode	What information gets logged during component execution.
LogType	How information gets logged during component execution.
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.
TransferredHeaders	The full set of headers as received from the server.
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 Connector 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	Tells the component whether or not to use the system security libraries or an internal implementation.

AttachedFile Property (REST Connector)

A file to include in the POST data.

Data Type

String

Default Value

""

Remarks

This property optionally specifies a file that will be sent as request parameter. This is only applicable when HTTPMethod is set to POST or PUT.

When set ContentType may be set to specify the Content-Type header for this parameter.

This property is not available in the Receiver.

Authorization Property (REST Connector)

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 connector can be extended with other security schemes in addition to the authorization schemes already implemented by the connector.

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 Connector)

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 connector 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 Connector)

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 payload. This is used to associate a filename with the data obtained from the message payload.

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

This is only applicable to the Send Connector.

This is not applicable if PostData is set.

This property is not available in the Receiver.

ContentType Property (REST Connector)

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 is applicable to both the Send and Receive Connector when PostData is set and defines the Content-Type header (not a form variable level Content-Type).

Cookies Property (REST Connector)

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

Firewall Property (REST Connector)

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 connector will attempt to connect.

FollowRedirects Property (REST Connector)

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 connector 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 connector 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 Connector)

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 Connector)

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 connector will attempt to connect.

HTTPVersion Property (REST Connector)

The HTTP version to use.

Data Type

String

Default Value

"1.1"

Remarks

This property specifies the HTTP version used by the connector. 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 connector 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.

LogFile Property (REST Connector)

The file to write logging information to at runtime.

Data Type

String

Default Value

""

Remarks

To write logging information to a file instead of using the connector's logging API, set this property to a valid file on disk and set the LogType property to "File".

LogMode Property (REST Connector)

What information gets logged during component execution.

Data Type

Enumeration

Possible Values

Verbose (0)
Info (1)
Warning (2)
Error (3)
Fatal (4)

Default Value

3

Remarks

This property controls what information the connector logs. The possible values have the following affect on the connector's behavior:

LogType Property (REST Connector)

How information gets logged during component execution.

Data Type

Enumeration

Possible Values

None (0)
Console (1)
File (2)

Default Value

1

Remarks

This property controls where the connector will log the information. The possible values have the following affect on the connector's behavior:

OAuthAuthorization Property (REST Connector)

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 Connector)

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

Data Type

String

Default Value

""

Remarks

The connector 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 connector, 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 Connector)

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 connector. 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 Connector)

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.

PostData Property (REST Connector)

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 connector 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 Connector)

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 connector 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.

ResponseXPath Property (REST Connector)

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 connector 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 Connector)

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 connector license.

SSLAcceptServerCert Property (REST Connector)

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 connector 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 connector 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.

Note: You may also set the Accept Any field to Yes without opening the certificate selection dialog to force the connector 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 connector to report the server's credentials to Location.

SSLCert Property (REST Connector)

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.

StatusCode Property (REST Connector)

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 an attribute on the outgoing message.

This property is read-only.

StatusLine Property (REST Connector)

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 an attribute on the outgoing message. For instance: HTTP/1.1 200 OK .

This property is read-only.

TempPath Property (REST Connector)

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 connector can store any data before the connector processes it. If TempPath is empty, the connector will receive all data to memory. If set, the connector will generate and write all inbound data to a temporary file in the specified directory.

Once the file is submitted, the connector will handle closing the file stream and deleting the temporary file. However, if the connector 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. Note: by default, this property is empty and the connector 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 Connector)

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 connector will wait for the operation to complete before returning control.

If Timeout expires, and the operation is not yet complete, the connector 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 connector may be changed to absolute timeouts, i.e. the connector 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).

TransferredHeaders Property (REST Connector)

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.

URL Property (REST Connector)

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 Connector)

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

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

OAuthAuthorizationParam Type

This type holds details of the OAuth authorization.

Remarks

This type holds details of the OAuth authorization.

Fields

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

Config Settings (REST Connector)

The connector 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 connector, access to these internal properties is provided through the Other property.

REST Config Settings

SSL Config Settings

General Config Settings