Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space WBRIDGE and version 20.1c

...

Multiexcerpt
MultiExcerptNameurl_parameters

Incoming Parameters

Multiexcerpt
MultiExcerptNameurl_parameters_incoming
NameTypeDirectionRestrictionsDescription
to listed protocol onlyto listed method only
urlstringin

This parameter contains the URL that will be accessed by the adapter. The URL contains protocol, port and path.
contentBlobin
post, put, writeUse this parameter to supply the content to be used by the listed methods.
headerParametersArray of HeaderFieldinhttp, https
Use this parameter to supply additional header information for the URL adapter call in the form of name and value pairs.
methodStringin

This parameter provides the method of the URL adapter call.
authenticationAuthenticationinldap, ftp, ftps, sftp, http, https
This parameter provides an object of type Authentication containing the user and the password.
proxyProxyinldap, ftp, ftps, sftp, http, https
Use this parameter to supply necessary proxy information.
followRedirectsIntegerinhttp, https
Specify here the maximum number of redirects to follow.
sslSSLinhttps, ftps
Use this parameter to supply SSL information.
commandsArray of Stringinftp, ftps

Use this parameter to specify ftp commands. All commands are executed after executing the ftp method. For a list of available ftp commands see RFC 959.

optionsArray of Optioninldap, ftp, ftps, sftp, http, https
Use this parameter to specify cURL options for the URL adapter call.
responseBloboutget, post, put, list, readContains the response content in relation to the used method.
streamSourceStringinftp, ftps, sftp, http, httpspost, putIf you want to use file streaming with streaming method fromFile, supply the streaming source here. Then, content is not used.
streamTargetStringinftp, ftps, sftp, http, httpsget, post, put, listIf you want to use file streaming with streaming method toFile, supply the streaming target here. Then, response is not used.
ignoreHTTPErrorsBooleaninhttp, https
Version
SingleLinefalse
  • Added in Builder 6.0.0.37

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.

Outgoing Parameters

Multiexcerpt
MultiExcerptNameurl_parameters_outgoing
NameTypeDirectionRestrictionsDescription
to listed protocol onlyto listed method only
responseBlobout
get, post, put, list, readContains the response content in relation to the used method.
httpStatusIntegerouthttp, https
Contains the HTTP status code of the response.
httpHeaderParameterArray of HeaderFieldouthttp, https
Note
iconfalse

Deprecated This attribute is deprecated as of Runtime 2020.11. Please use httpHeaderMap (see below) for new implementations as its implementation complies to the HTTP specification.

Contains the HTTP headers of the response.

httpHeaderMapMap of EntryoutMap of Entry
Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNamehttpHeaderMap
PageWithExcerptINTERNAL:_bridge_excerpts

URL Parameter Types

Multiexcerpt
MultiExcerptNameurl_parameter_types
ClassAttributeTypeCURL OptionDescriptionValues/Example
AuthenticationpasswordString
Password needed for authentication.
usernameString
Username needed for authentication.
EntrykeyString
Key of the map entry.
valueArray of Any

List of values of the map entry. The dynamic type for httpHeaderMap is String.


HeaderFieldnameString
Name of the header field.
valueString
Value of the header field.
OptionnameString
Native cURL option.CURLOPT_CONNECTTIMEOUT
valueString
Value of the cURL option.10
ProxyauthenticationAuthenticationCURLOPT_PROXYUSERPWDProxy user.
typeStringCURLOPT_PROXYTYPEType of the proxy.HTTP, SOCKS5
urlStringCURLOPT_PROXYURL of the proxy server.
SSLcaInfoStringCURLOPT_CAINFOName of the file containing additional certificates for the connection verification (e.g. additional root CAs).
certificateCertificate
Client certificate
keyKey
Private key of client certificate
verifyHostStringCURLOPT_SSL_VERIFYHOST

Whether to verify the host information form the SSL connection.

OnVerification on (default).
OffVerification off.
ExistenceLimit verification to the mere existence of the host.
verifyPeerStringCURLOPT_SSL_VERIFYPEERWhether to verify the peer information from the SSL connection.OnVerification on (default).
OffVerification off.
KeyfileStringCURLOPT_SSLKEYName of the file containing the private key.
passwordStringCURLOPT_KEYPASSWDPassword for the private key.
typeStringCURLOPT_SSLKEYTYPEType of the key.PEM, DER, ENG
CertificatefileStringCURLOPT_SSLCERTName of the file containing the client certificate.
typeStringCURLOPT_SSLCERTTYPEType of the certificate.PEM, DER, P12