{{item.notificationType}}:

UrlDownload

execute and receive data by HTTP-Requests , execute and upload data by HTTP-Requests

This step accesses an URL and downloads the content. The result is String value.

View manual

Inputs

Name Type Description Required Values
host STRING This is the URL to be downloaded. (e.g. http://api.somewebservice.com/GetStock, http://www.mywebsite.com/products.csv or ftp://username:password@ftp.myserver.com/folder/file.csv). Supported Protocols are http://, https://, ftp://. If the protocol is ommitted it will be replaced by http:// by default. Yes
method STRING The HTTP Method (GET, POST, HEAD, PUT, PATCH, DELETE). Yes
  • GET (Default)
  • POST
  • HEAD
  • PUT
  • PATCH
  • DELETE
username STRING If the URL is protected with HTTP BASIC AUTH, this is the username. No
password STRING The HTTP BASIC AUTH password. No
errorStatusCodes STRING A comma separated list of http status codes for which flow stops excecution, e.g. 403,404,500. Leave empty for all status codes greater than 300. No
filename STRING Can be used to construct the filenames of the reponse files. Always enter a filename and extension (e.g. myfile.txt). If empty a default filename will be constructed. No Default: ${autoFilename}
fileToUpload FILE Optional: Directly sent this file in request body. This is similar to a Upload-form on a website. No
fileParameterName STRING Optional: The name of the HTTP-request-parameter under which the file is uploaded. (Default if empty: 'upfile') No
bodyContentType STRING Optional: The content type of the requestBody. No
  • application/octet-stream
  • application/xhtml+xml; charset=ISO-8859-1
  • application/json; charset=UTF-8
  • application/xml; charset=ISO-8859-1
  • text/html; charset=ISO-8859-1
  • text/plain; charset=ISO-8859-1
  • text/xml; charset=ISO-8859-1
  • application/x-www-form-urlencoded; charset=ISO-8859-1
  • multipart/form-data; charset=ISO-8859-1
  • text/csv; charset=UTF-8
requestHeaders STRING Optional: Additional HTTP request headers added to the HTTP-Request as key=value pairs (one pair per line). No
timeoutInSeconds STRING Optional: HTTP Connection and read-(socket) timeout in seconds. Default: 60s. If the target host takes longer to respond than the timeoutInSeconds, then the step will fail with an error. No Default: 60
sslCertificates STRING Expert Setting for https-urls: Under normal circumstances, URLs which have only a self-signed SSL certificate will result in an error. You can prevent the error by setting this to 'Trust self-signed SSL Certificates'. But this can be a security risk, because malicious sites can abuse this to steal sensitive information. Only use this, if you know what you are doing!!! No
  • Do not trust self-signed SSL Certificates (default) (Default)
  • Trust self-signed SSL Certificates (Security Warning)
responseEncoding STRING Only use this option if outputtype is set to string and reponse header does not contain a valid charset. No
  • [AUTO-DETECT] (Default)
  • UTF-8
  • UTF-16
  • ISO-8859-1
  • ISO-8859-2
  • ISO-8859-4
  • ISO-8859-5
  • ISO-8859-15
  • cp1252 (Windows-1252, ANSI)
  • MacCentralEurope
  • US-ASCII
  • KOI8-R
outputtype STRING The type of the output of the step. (Note: String is deprecated and should only be used for debugging during development. It may be removed in the future without further warning.) No
  • file (Default)
  • string

Outputs

Name Type Description
file FILE The downloaded file (only if outputtype 'file' is selected).
urlcontent STRING The downloaded content as STRING (only if outputtype 'string' is selected). Note: This output is DEPRECATED and should only be used for debugging during development. It may be removed in the future without further warning.
statusCode STRING The HTTP Status code of the response.
statusText STRING The HTTP Status text of the response.
responseTimeInMillis NUMBER The response time.
responseSize NUMBER The size of the response in bytes.
responseHeaders STRING The HTTP-Response headers.
requestBody STRING The HTTP-requestbody which was sent.

Need help or project support?

If you need help during setup of this step or a project then reach out to our certified partners. Find Partners

More steps steps in Klick-Tipp


Name Version Description Use-Case
UrlDownload
UrlDownload
- This step accesses an URL and downloads the content. The result is String value.
execute and receive data by HTTP-Requests , execute and upload data by HTTP-Requests
SpreadsheetUrlDownload
SpreadsheetUrlDownload
- This step can download content from multiple URLs based on a SPREADSHEET or SPREADSHEET list. Use it to connect to various kinds of Webservice APIs.
execute and receive data by HTTP-Requests , execute and upload data by HTTP-Requests