{{item.notificationType}}:

SpreadsheetUrlDownload

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

This step can do multiple HTTP Calls based on a SPREADSHEET or SPREADSHEET list. Use it to connect to various kinds of webservices/APIs. Supports single calls and batch processing of multiple rows.

View manual

Why Synesty?

  • Central middleware for all integrations, connectors and automation of business processes
  • No coding required - just Drag&Drop and configuration
  • Professional support with quick responses
Sign up for FREE Request a demo

Inputs

Name Type Description Required Values
input SPREADSHEET SPREADSHEET containing all the data to make the request. Yes
host STRING This is the URL which will be called (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://. The protocol is mandatory. FTP is only supported for batchSize=1. Yes
method STRING The HTTP Method (GET, POST, PUT, HEAD, PATCH, DELETE). Yes
  • GET (Default)
  • POST
  • HEAD
  • PUT
  • PATCH
  • DELETE
requestBody STRING Optional: Directly sent the HTTP request body. This can be useful when talking to XML or JSON webservices where you can insert the full XML Request in this textfield. Only possible with POST, PUT, PATCH or DELETE method. If batchSize = 1 then all fields of the row are available as Freemarker variables (e.g. ${somecol1!}). If batchSize > 1 then all rows of a single batch will be available as a Freemarker variable called ${rows}. When bodyContentType=multipart/form-data then you can send form parameters like &param1=value1&param2=value2 (if your URL/host does not have any parameters then your first parameter must not have the & character. It is also possible to add each parameter on a new line. Make sure each parameter/value is on a single line. For multi-line values consider the Freemarker <#compress> function to remove linebreaks. No
limit STRING Limit the number or rows used from the input SPREADSHEET. Use low values for testing. No
batchSize STRING Specify batchSize > 1 to make one call per N rows defined by batchSize. This is often useful to access APIs which allow you to send e.g. 25 items per call. Example: Assume you have 12 rows in your input Spreadsheet: If batchSize=1, then it will do 12 requests (one request per row). If batchSize=5 then it will do 3 requests (1st, 2nd request: 5 rows, 3rd request: 2 rows). If you use batchSize>1 then you can access all rows and their values of the batch in the requestBody. For batchSize=1 you access all columns of each row in the requestBody. 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
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 execution, 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 response files. Always enter a filename and extension (e.g. myfile.txt). If empty a default filename will be constructed. No
outputMode STRING Use this to specify the output behavior. (File List - one file per response. Add responseContent column - The response will also be part of the result spreadsheet. Only use this when needed if File Lis ist not enough. Add response content with Base64 encoded String to output spreadsheet - The output in the responseContent column will be a BASE64 encoded String.) No
  • File List (Default)
  • Add response content to output spreadsheet.
  • Add response content with Base64 encoded String to output spreadsheet.
encoding STRING The encoding of the response (Default: UTF-8). Only used for output mode 'Add responseContent column' Yes
  • UTF-8 (Default)
  • 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
outputSourceColumns STRING Specify the columns from the source SPREADSHEET which should be added to the output SPREADSHEET. No
headerContentType STRING The HTTP header content type 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
  • text/csv; charset=UTF-8
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
rateLimitPerSecond STRING Rate Limit allows you to limit the number of calls per second, e.g. 2 calls/s (=120 calls/minute). Or 0.5 calls/s means 2 seconds delay after each call. Default: Empty = No limit. No
numErrorsToStopFlow STRING Optional: Specifies the number of errors or timeouts which can happen before the flow will abort with an ERROR. Default: 3. It is recommended to leave this value small. If you experience slow responding hosts, try to decrease the batchSize first. No
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)

Outputs

Name Type Description
requests SPREADSHEET A SPREADSHEET containing the URL, requestBody and the HTTP-Status code of each request.
output FILELIST A FILELIST containing the content of each request.

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