Name | Description | Allowed Values / Examples |
---|
Protocol (protocol) | Multiexcerpt |
---|
| Transport protocol. |
| one of: ldap, file, ftp, ftps, sftp, gopher, http (default), https, telnet |
Port (port) | Multiexcerpt |
---|
| Machine port number the service is binding to. This port number can be given at service level only. |
| a valid port number (default: 80) |
Path (path) | Multiexcerpt |
---|
| HTTP path for the SOAP request. |
|
|
Host (host) | Multiexcerpt |
---|
| Host name. Default is "localhost" if no value is specified. |
| a valid hostname (default: localhost) |
Method (method) | Multiexcerpt |
---|
| HTTP method of the URL adapter call. Default is "POST" if no value is specified. |
| one of: get, post (default), read, write, put, list |
Advanced |
Follow Redirects (followRedirects) | Multiexcerpt |
---|
MultiExcerptName | followRedirects |
---|
| The maximum number of redirects to follow. |
| any positive integer or 0 |
Ignore Http Errors (ignoreHttpErrors) | Multiexcerpt |
---|
MultiExcerptName | ignoreHttpErrors |
---|
| If true, HTTP error codes > 300 will not cause an exception in the model. This implies, that the response body is accessible even if HTTP errors occur. The default value is false. |
| true | Ignore HTTP error codes > 300. |
false | Do not ignore HTTP errors (default). |
Options (options) | Multiexcerpt |
---|
| Native cURL options as listed on Setting cURL Options on the URL Adapter . Use one of the following syntax rules: - values separated by
',' in one line - values separated by
' ' in one line - list of tagged values
|
| valid cURL options, e.g. CURLOPT_TIMEOUT=20 |
Request Http Header Roles (requestHttpHeaderRoles) | Multiexcerpt include |
---|
SpaceWithExcerpt | INTERNAL |
---|
MultiExcerptName | request_http_header_roles |
---|
PageWithExcerpt | INTERNAL:_bridge_excerpts |
---|
|
Multiexcerpt include |
---|
SpaceWithExcerpt | INTERNAL |
---|
MultiExcerptName | request_http_header_roles_adapter |
---|
PageWithExcerpt | INTERNAL:_bridge_excerpts |
---|
|
| client_host | Provide the client host in a header <http header name> instead of X-Sender-Host. |
client_service | Provide the client service in a header <http header name> instead of X-Sender-Service. |
correlation_id | Provide the correlation ID in a header <http header name> instead of X-Request-Id. |
transaction_id | Provide the transaction ID in a header <http header name> instead of X-Transaction-Id. |
passthrough | Pass a present header <http header name> to the called service. |
passthrough= <request header name> | Pass an incoming header <request header name> to the called service under the name of <http header name> . This is equivalent to renaming a header. |
Dig est Algorithm (digestAlgorithm)
| Multiexcerpt |
---|
MultiExcerptName | digestAlgorithm |
---|
| Builder 7.12.0 Runtime 2021.1 Generates a HTTP digest header using the specified algorithm. When applied, a digest header is generated using the specified algorithm, and sent with the request . The generated header conforms with RFC3230 and RFC5843. Info |
---|
Only one value is supported (no multi-value header). |
|
| None | No header generated. |
MD5 | Generate header using MD5 algorithm. |
SHA | Generate header using SHA algorithm. |
SHA-1 | Generate header using SHA-1 algorithm. |
SHA-256 | Generate header using SHA-256 algorithm. |
SHA-512 | Generate header using SHA-512 algorithm. |
Authentication |
User (user) | Username/password. |
|
Proxy |
Proxy URL (proxyURL) | Multiexcerpt |
---|
| URL of the proxy server. |
|
|
Proxy User (proxyUser) | Multiexcerpt |
---|
MultiExcerptName | proxyUser |
---|
| Proxy user. |
|
|
Proxy Type (proxyType) | Multiexcerpt |
---|
MultiExcerptName | proxyType |
---|
| Type of the proxy |
| one of: HTTP , SOCKS5
|
SSL |
Ssl CA Info (sslCAInfo) | Multiexcerpt |
---|
MultiExcerptName | sslCAInfo |
---|
| Name of the file containing additional certificates for the connection verification (e.g. additional root CAs). |
|
|
Ssl Certificate File (sslCertificateFile) | Multiexcerpt |
---|
MultiExcerptName | sslCertificateFile |
---|
| Name of the file that contains the client certificate. |
|
|
Ssl Private Key File (sslPrivateKeyFile) | Multiexcerpt |
---|
MultiExcerptName | sslPrivateKeyFile |
---|
| Name of the file that contains the private key. |
|
|
Ssl Private Key Password (sslPrivateKeyPassword) | Multiexcerpt |
---|
MultiExcerptName | sslPrivateKeyPassword |
---|
| Password for the private key. |
|
|
Ssl Certificate Type (sslCertificateType) | Multiexcerpt |
---|
MultiExcerptName | sslCertificateType |
---|
| Type of the certificate. |
| one of: PEM (default), DER, P12
|
Ssl Verify Host (sslVerifyHost) | Multiexcerpt |
---|
MultiExcerptName | sslVerifyHost |
---|
| Whether to verify the host information form the SSL connection. |
| On | Verification on (default). |
Off | Verification off. |
Existence | Limit verification to the mere existence of the host. |
Ssl Verify Peer (sslVerifyPeer) | Multiexcerpt |
---|
MultiExcerptName | sslVerifyPeer |
---|
| Whether to verify the peer information from the SSL connection. |
| On | Verification on (default). |
Off | Verification off. |
Ssl Private Key Type (sslPrivateKeyType) | Multiexcerpt |
---|
MultiExcerptName | sslPrivateKeyType |
---|
| Type of the private key. |
| one of: PEM (default), DER, ENG |