We assume that you have already learned what is described in:

If you want to find the right Reader for your purposes, see Readers Comparison.

Short Summary

RESTConnector sends HTTP requests to a web server and receives responses

Component Same input metadata Sorted inputs Inputs Outputs Each to all outputs1) Java CTL

1) Component sends each data record to all connected output ports.


RESTConnector sends HTTP requests to a web server and receives responses. Request is written in a file or in the graph itself or it is received through a single input port. The response can be sent to an output port, stored to a specified file or stored to a temporary file. Path to the file can then be sent to a specified output port.



Port typeNumberRequiredDescriptionMetadata
Input0noFor setting various attributes of the componentAny
Output0NoFor response content, response file path, status code, component attributes...Any
Output1NoFor error detailsAny

RESTConnector Attributes

AttributeReqDescriptionPossible values
Authentication method
Specify the API authentication method.None | Basic HTTP
UsernameNOSpecify username for HTTP basic authentication 
PasswordNOSpecify password for HTTP basic authentication 
Request URLYESSpecifies the request URL 
Request methodYESSpecifies the request method.GET (default) | POST
Request bodyNOSpecifies the API call payload. It is mandatory for POST requests.JSON object
Request handling functionsYESSpecifies the handling functions. You can use it for pagination in responses etc. 
Request handling functions URLNOSpecifies the URL of request handling functions code 
CharsetNORequest charsetUTF-8 (default)
Delay between requests (sec)NOSpecifies the time delay between each HTTP request in secondsDefault is 0
Max. retry attemptsNOMaximum attempts on HTTP requestDefault is 5
Paused between retriesNOPaused between each HTTP request1,2,4,8,..sec
Max. pages limitNOLimit of pages for API call.10000 (Default)