Attribute
(Name of Setting) | Description | Allowed Values |
|---|
Protocol
(protocol) | Specify here the protocol through which the REST service is accessible. | http, https |
Port
(port) | Specify here the port through which the REST service is accessible. | a valid port |
Host
(host) | Specify here the host running the REST service. | a valid host |
Base Path
(basePath) | Specify here the base path of the REST service. | Info |
|---|
Please note that the base path differs whether you want to access a Designer service from the outside of PAS or from the inside. When you trigger Designer services within the platform, use the part of the path starting with /rest/.... |
| a valid path, e.g . /support |
Ignore Http Errors
(ignoreHttpErrors) | Specify here whether you want the REST adapter to throw an exception upon receiving an HTTP error code >= 400. | true | Do not throw an exception upon receiving an HTTP error code >= 400 (default). |
| false | Throw an exception upon receiving an HTTP error code >= 400. |
Additional Request Headers
(additionalHeaders) | This attribute can contain a list of additional headers in form of name/value pairs. | Valid format is: <name>:<value>, e.g. API-Key:acme . Separate multiple headers with a comma. |
HTTP Header Role Definitions for Requests
(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> |
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 present header <request header name> to the called service under the name of <http header name>.
This is equivalent to renaming a header. |
Digest Algorithm
(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. |
Accepted Count of Redirects to Follow
(followRedirects) | Specify here the maximum number of redirects to follow. Default value is 0 (no redirects). | any integer, 0 (default) |
cURL Options
(options) | Specify native cURL options as listed in 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 attributes
|
|
Json Keep Null Values
(jsonKeepNulls) | When jsonKeepNulls is true, attributes of the REST parameter having NULL values will be provided with the REST call, otherwise they will be left out completely (see also chapter NULL Values). | true | Render attributes with NULL values to the REST call. |
| false | Leave out attributes with NULL values in the REST call (default). |
Json Compact Format
(jsonCompact) | When jsonCompact is true, the JSON composer will generate compact JSON, otherwise it will generate pretty JSON. | true | Generate compact JSON (default). |
| false | Generate pretty JSON. |
User
(user) | Specify credentials here, if the called REST service needs basic authentication. | Valid format is <user>/<password>, e.g. david.stringer/pAsWoRd456 |
| Proxy Settings (if the called REST service is accessed via a proxy) |
Proxy URL
(proxyURL) | Specify the URL of the proxy server. | See CURLOPT_PROXY. |
Proxy User
(proxyUser) | Specify the proxy credentials. | See CURLOPT_PROXYUSERPWD, format is <user>/<password>, e.g. david.stringer/pAsWoRd456 |
Proxy Type
(proxyType) | Specify the proxy type. | See CURLOPT_PROXYTYPE. |
| SSL Settings (if the called REST service uses SSL) |
SSL CA Info
(sslCAInfo) | Specify a file name containing additional certificates for the connection verification (e.g. additional root CAs). | See CURLOPT_CAINFO. |
SSL Certificate File
(sslCertificateFile) | Specify a fle name containing the client certificate. | See CURLOPT_SSLCERT. |
SSL Certificate Type
(sslCertificateType) | Specify the type of the certificate. | See CURLOPT_SSLCERTTYPE. |
SSL Private Key File
(sslPrivateKeyFile) | Specify a file name containing the private key. | See CURLOPT_SSLKEY. |
SSL Private Key Password
(sslPrivateKeyPassword) | Specify the password for the private key. | See CURLOPT_KEYPASSWD. |
SSL Private Key Type
(sslPrivateKeyType) | Specify the type of the key. | See CURLOPT_SSLKEYTYPE. |
SSL Verify Host
(sslVerifyHost) | Specify whether to verify the host information form the SSL connection. | See CURLOPT_SSL_VERIFYHOST. |
SSL Verify Peer
(sslVerifyPeer) | Specify whether to verify the peer information from the SSL connection. | See CURLOPT_SSL_VERIFYPEER. |