On this Page:

Related Pages:

All URL adapter parameters, that are specified on the <<URLAlias>> in the component diagram, can also be supplied dynamically via action script. Find below a list of all relevant parameters of the URL adapter and their description.

With the URL adapter, it is possible to get and put messages via file transfer protocols: FTP, FTPS and SFTP. These protocols often get confused and mixed up due to the similarity in function and names. Please refer to Using the URL Adapter with the FTP Protocol and Related Protocols for a distinction and more information on the usage with the URL adapter.

<<URLAlias>>

Name	Type	Direction	Restrictions		Description
Name	Type	Direction	to listed protocol only	to listed method only	Description
url	string	in			This parameter contains the URL that will be accessed by the adapter. The URL contains protocol, port and path.
content	Blob	in		post, put, write	Use this parameter to supply the content to be used by the listed methods.
headerParameters	Array of HeaderField	in	http, https		Use this parameter to supply additional header information for the URL adapter call in the form of name and value pairs.
method	String	in			This parameter provides the method of the URL adapter call.
authentication	Authentication	in	ldap, ftp, ftps, sftp, http, https		This parameter provides an object of type Authentication containing the user and the password.
proxy	Proxy	in	ldap, ftp, ftps, sftp, http, https		Use this parameter to supply necessary proxy information.
followRedirects	Integer	in	http, https		Specify here the maximum number of redirects to follow.
ssl	SSL	in	https, ftps		Use this parameter to supply SSL information.
commands	Array of String	in	ftp, 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.
options	Array of Option	in	ldap, ftp, ftps, sftp, http, https		Use this parameter to specify cURL options for the URL adapter call.
response	Blob	out		get, post, put, list, read	Contains the response content in relation to the used method.
streamSource	String	in	ftp, ftps, sftp, http, https	post, put	If you want to use file streaming with streaming method fromFile, supply the streaming source here. Then, content is not used.
streamTarget	String	in	ftp, ftps, sftp, http, https	get, post, put, list	If you want to use file streaming with streaming method toFile, supply the streaming target here. Then, response is not used.
ignoreHTTPErrors	Boolean	in	http, https		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.
httpStatus	Integer	out	http, https		Contains the HTTP status of the response.
httpHeaderParameter	Array of HeaderField	out	http, https		Contains the HTTP header of the response.

URL Parameter Types

CURL Option	Attribute	Type	CURL Option	Description	Values/Example
Authentication	password	String		Password needed for authentication.
Authentication	username	String		Username needed for authentication.
HeaderField	name	String		Name of the header field.
HeaderField	value	String		Value of the header field.
Option	name	String		Native cURL option.	`CURLOPT_CONNECTTIMEOUT`
Option	value	String		Value of the cURL option.	`10`
Proxy	authentication	Authentication	CURLOPT_PROXYUSERPWD	Proxy user.
	type	String	CURLOPT_PROXYTYPE	Type of the proxy.	HTTP, SOCKS5
	url	String	CURLOPT_PROXY	URL of the proxy server.
SSL	caInfo	String	CURLOPT_CAINFO	File name containing additional certificates for the connection verification (e.g. additional root CAs).
	certificate	Certificate		Client certificate
	key	Key		Private key of client certificate
	verifyHost	String	CURLOPT_SSL_VERIFYHOST	Whether to verify the host information form the SSL connection.	On	Verification on.
	verifyHost	String	CURLOPT_SSL_VERIFYHOST		Off	Verification off.
	verifyPeer	String	CURLOPT_SSL_VERIFYPEER	Whether to verify the peer information from the SSL connection.	On	Verification on.
	verifyPeer	String	CURLOPT_SSL_VERIFYPEER		Off	Verification off.
Key	file	String	CURLOPT_SSLKEY	File name containing the private key.
	password	String	CURLOPT_KEYPASSWD	Password for the private key.
	type	String	CURLOPT_SSLKEYTYPE	Type of the key.	PEM, DER, ENG
Certificate	file	String	CURLOPT_SSLCERT	File name containing the client certificate.
Certificate	type	String	CURLOPT_SSLCERTTYPE	Type of the certificate.	PEM, DER, P12

Page tree

URL

<<URLAlias>>

URL Parameter Types