REST

The Qlik REST Connector enables Qlik Sense and QlikView to efficiently load data into Qlik apps from a REST data source. Many web-based data sources expose data through a REST API. The Qlik REST Connector is a generic connector, that is, it is not tailored to a specific REST data source.

There are variations in the way the REST API is implemented by different data sources that use it. Users must learn the requirements of each data source. The Qlik REST Connector provides connection options to accommodate those varied requirements. To help understand how to use those options, documentation for the REST Connector includes use cases that illustrate how to load data from different REST sources.

Setting up selected REST sources for data loading

Using pagination with selected REST sources

To access data, the user must have authorization with current access credentials to the data source. Once a connection to a REST data source has been created, data can be selected from tables available to the user’s account and then loaded into an app where it can be used in visualizations.

What's new in this version

For a complete history of changes through all versions, see Version history.

1.7

In Version 1.7, two new properties have been added to the connection dialog:

  • Add 'Expect: 100-continue' header for posting to servers that use the 100 (Continue) initial response.
  • Check response type during Test connection checks the response type returned by the server in addition to validating the connection properties and checking connectivity to the server.

Qlik Sense compatibility

Starting from version 1.1, the Qlik REST Connector is built into Qlik Sense. This means that when you install Qlik Sense, the REST connector is immediately available in Data Manager and Data load editor.

Connector version Qlik Sense versions
1.7 September 2018, June 2018
1.4 April 2018
1.3 February 2018
1.2 November 2017
1.1 September 2017, June 2017, 3.2, 3.1, 3.0
1.0 2.2, 2.1, 2.0

QlikView compatibility

The Qlik REST Connector is installed separately for QlikView.

Connector version QlikView versions
1.7 November 2017, 12.10
1.4 November 2017, 12.10
1.3 November 2017, 12.10
1.2 November 2017, 12.10
1.1 -
1.0 12.00, 11.20

Supported REST data types

The REST Connector supports the following data types:

  • JSON data
  • XML data
  • CSV files

Supported REST authentication methods

The REST Connector supports the following authentication methods:

  • Windows authentication
  • Basic and Digest authentication schema
  • X509 certificates

The REST Connector does not support OAuth schema authentication.

Version history

1.4

In Version 1.4, The REST Connector can receive compressed data and decompress it. This improves transfer time.

1.3

Version 1.3 contains bug fixes only.

1.2

New security properties

The Qlik REST Connector has new security properties in the connection dialog. Existing connections must be modified to conform to the requirements of the new properties.

Response headers

The Qlik REST Connector supports the ability to include HTTP headers in the response object. Starting with the version 1.2, loading of the headers does not happen by default. It must be explicitly allowed. Existing connections that load the response headers must be reconfigured with the Allow response headers parameter.

1.1

Version 1.1 of the REST Connector provides a new pagination option called Next page that returns data based on page sizes specified by the user.

Version 1.1 is also integrated into Qlik Sense and does not have to be installed separately.

The REST Connector can be excluded from installation when Qlik Sense is installed in silent mode.

1.0

Version 1.0 was the first release of the Qlik REST Connector. In version 1.0, the Qlik REST Connector was installed separately for both Qlik Sense and QlikView.