Attribute | Description | Allowed Values / Examples |
---|
Name | Specify a name for the alias. | any string |
Standard |
---|
protocol | Multiexcerpt |
---|
| Transport protocol. |
| one of: ldap, ldaps, file, ftp, ftps, sftp, gopher, http (default), https, telnet |
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 | Multiexcerpt |
---|
| HTTP path for the SOAP request. |
|
|
host | Multiexcerpt |
---|
| Host name. Default is "localhost" if no value is specified. |
| a valid hostname (default: localhost) |
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, patch, head, options, delete
|
Advanced |
user | Username/password. |
|
followRedirects | Multiexcerpt |
---|
MultiExcerptName | followRedirects |
---|
| The maximum number of redirects to follow. |
| any positive integer or 0 |
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 | 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 |
requestHttpHeaderRoles | Multiexcerpt |
---|
MultiExcerptName | requestHttpHeaderRoles |
---|
| In the context of HTTP based adapters (URL, REST), enable automatic header generation for the listed headers. These definitions overwrite the default behavior, and X-Transaction-Id, X-Request-Id, X-Sender-Host and/or X-Sender-Service will be substituted by this definition. |
requestHttpHeaderRoles can hold a list of definitions in format <http header name>:<role> , that will automatically be generated for each adapter call on this alias. <role> can be one of the listed allowed values (one list entry per line). Refer to HTTP Header Support > Overwriting the Standard HTTP Headers for more details on header roles. | 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. |
digestAlgorithm
| Multiexcerpt |
---|
MultiExcerptName | digestAlgorithm |
---|
| 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 (default). |
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. |
Proxy |
proxyURL | Multiexcerpt |
---|
| URL of the proxy server. |
|
|
proxyUser | Multiexcerpt |
---|
MultiExcerptName | proxyUser |
---|
| Proxy user. |
|
|
proxyType | Multiexcerpt |
---|
MultiExcerptName | proxyType |
---|
| Type of the proxy |
| one of: HTTP , SOCKS5 |
SSL |
sslCAInfo | Multiexcerpt |
---|
MultiExcerptName | sslCAInfo |
---|
| Name of the file containing additional certificates for the connection verification (e.g. additional root CAs). |
|
|
sslCertificateFile | Multiexcerpt |
---|
MultiExcerptName | sslCertificateFile |
---|
| Name of the file that contains the client certificate. |
|
|
sslPrivateKeyFile | Multiexcerpt |
---|
MultiExcerptName | sslPrivateKeyFile |
---|
| Name of the file that contains the private key. |
|
|
sslPrivateKeyPassword | Multiexcerpt |
---|
MultiExcerptName | sslPrivateKeyPassword |
---|
| Password for the private key. |
|
|
sslCertificateType | Multiexcerpt |
---|
MultiExcerptName | sslCertificateType |
---|
| Type of the certificate. |
| one of: PEM (default), DER |
sslVerifyHost | Multiexcerpt |
---|
MultiExcerptName | sslVerifyHost |
---|
| Whether to verify the host information form the SSL connection. |
| On | Verification on. |
Off | Verification off (default). |
Existence | Limit verification to the mere existence of the host. |
sslVerifyPeer | Multiexcerpt |
---|
MultiExcerptName | sslVerifyPeer |
---|
| Whether to verify the peer information from the SSL connection. |
| On | Verification on (default). |
Off | Verification off. |
sslPrivateKeyType | Multiexcerpt |
---|
MultiExcerptName | sslPrivateKeyType |
---|
| Type of the private key. |
| one of: PEM (default), DER |