Data sources

Lists data sources available on the tenant for the creation of analytics data connections.

Endpoints

GET

/v1/data-sources
GET

/v1/data-sources/{dataSourceId}/api-specs
GET

/v1/data-sources/{dataSourceId}/gateways

Gets the list of data sources available on the node.

Facts

Rate limit	Tier 1 (1000 requests per minute)
Categories	externalmanage

Query Parameters

dataSourceIdstring

Filtering on datasourceID, when multiple dataSourceId are set in query, last dataSourceId will be used
detailboolean

Determines if provider detail is returned
includeuiboolean

Determines if UI info is returned

Responses

200

application/json

An array of data source info

application/jsonobject
Show application/json properties
- dataSourcesarray of objects
  Required
  
  List of datasources metadata object
  
  Show dataSources properties
  
  namestring
  Required
  
  Datasource name
  
  uiInfoobject
  
  UI related metadata (only present when 'includeui' is set to true in query)
  
  Show uiInfo properties
  
  iframeboolean
  
  If support iframe
  
  selectUrlstring
  
  Select URL
  
  connectUrlstring
  
  Connect URL
  
  iconRectUrlstring
  
  Icon URL
  
  iconSquareUrlstring
  
  Square icon URL
  
  credentialsUrlstring
  
  Credentials URL
  
  connectorMainUrlstring
  
  Connector main URL
  
  loadModelSupportstring
  
  Indicate if the datasource supports load model
  
  providerstring
  Required
  
  Connector provider
  
  capabilitiesarray of strings
  
  List of capabilities supported by the datasource
  
  dataSourceIdstring
  Required
  
  Unique identifier of datasource
  
  providerNamestring
  Required
  
  Provider name
  
  qriDefinitionobject
  
  Qri definition template
  
  Show qriDefinition properties
  
  itemPartobject
  
  Show itemPart properties
  
  prefixstring
  
  Prefix of the template
  
  templatestring
  Required
  
  Qri template
  
  propertiesarray of strings
  Required
  
  List of properties used in template
  
  pathPartobject
  Required
  
  Show pathPart properties
  
  prefixstring
  
  Prefix of the template
  
  templatestring
  Required
  
  Qri template
  
  propertiesarray of strings
  Required
  
  List of properties used in template
  
  qriPrefixstring
  Required
  
  Qri prefix
  
  connectionPartobject
  Required
  
  Show connectionPart properties
  
  templatestring
  Required
  
  Qri template
  
  propertiesarray of strings
  Required
  
  List of properties used in template
  
  dataLoadUrlOverridestring
  
  Override value of dataload URL (could be null)
  
  dataSourcePropertyNamestring
  
  Datasource property name (could be null)
- lastUpdatedstring
  Required
  
  Time stamp of last updated
- connectorNodesarray of objects
  
  List of connector nodes (only present when query parameter 'detail' is set to true)
  
  Show connectorNodes properties
  
  urlstring
  Required
  
  URL of connector node
  
  statestring
  Required
  
  State of the connector node
  
  contractTypenumber
  Required
  
  Contract type used to communicate with the connector (between 0 and 3)
  
  providerNamestring
  Required
  
  Connector provider name
  
  cachedDataSourcesarray of strings
  
  List of datasource Ids provided by the provider
  
  dataSourcesUpdatedboolean
  Required
  
  Indicates if the datasources is up to date

401

application/json

Unauthorized request (Bad JWT token etc)

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  A service specific error code string
  
  metaobject
  
  Additional metadata associated with the error
  
  titlestring
  Required
  
  Summary of the error
  
  detailstring
  
  Concrete detail about the error

404

application/json

Datasource not found or it is not enabled

application/jsonobject
Show application/json properties
- errorsarray of objects

500

application/json

Internal errors

application/jsonobject
Show application/json properties
- errorsarray of objects

GET /v1/data-sources

curl "https://your-tenant.us.qlikcloud.com/api/v1/data-sources" \
-H "Authorization: Bearer <API-key>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/data-sources',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)

This API is not included yet in qlik-cli

Response

{
  "dataSources": [
    {
      "name": "Qlik® REST Connector",
      "uiInfo": {
        "iframe": true,
        "selectUrl": "/customdata/64/QvRestConnector/web/standalone/select-dialog.html",
        "connectUrl": "/customdata/64/QvRestConnector/web/standalone/connect-dialog.html",
        "iconRectUrl": "/customdata/64/QvRestConnector/web/Icons/rest.png",
        "iconSquareUrl": "/customdata/64/QvRestConnector/web/Icons/rest-square.png",
        "credentialsUrl": "/customdata/64/QvRestConnector/web/standalone/credentials-dialog.html",
        "connectorMainUrl": "/customdata/64/QvRestConnector/web/connector-main-iframe.js",
        "loadModelSupport": "false"
      },
      "provider": "QvRestConnector.exe",
      "capabilities": [
        "datasource-specific-capabity"
      ],
      "dataSourceId": "rest",
      "providerName": "Qlik® REST Connector",
      "qriDefinition": {
        "itemPart": {
          "prefix": "#",
          "template": "{schema}.{table}",
          "properties": [
            "schema"
          ]
        },
        "pathPart": {
          "prefix": "#",
          "template": "{schema}.{table}",
          "properties": [
            "schema"
          ]
        },
        "qriPrefix": "qri:db:sap-sql://",
        "connectionPart": {
          "template": "{schema}.{table}",
          "properties": [
            "schema"
          ]
        }
      },
      "dataLoadUrlOverride": "ml-endpoints:50055",
      "dataSourcePropertyName": "sourceType"
    }
  ],
  "lastUpdated": "2023-11-03T15:45:14.195Z",
  "connectorNodes": [
    {
      "url": "localhost:50060",
      "state": "READY",
      "contractType": 2,
      "providerName": "Qlik® REST Connector",
      "cachedDataSources": [
        "rest"
      ],
      "dataSourcesUpdated": "true"
    }
  ]
}

Facts

Rate limit	Tier 1 (1000 requests per minute)
Categories	externalmanage

Path Parameters

dataSourceIdstring
Required

Datasource ID

Responses

200

application/json

API spec returned

application/jsonobject
Show application/json properties
- connectorVersionstring
  Required
  
  Datasource provider (i.e. connector) version
- connectorProviderstring
  Required
  
  Datasource provider
- connectionPropertiesobject
  Required
  
  List of properties required for the given datasource

401

application/json

Unauthorized request (Bad JWT token etc)

application/jsonobject
Show application/json properties
- errorsarray of objects

404

application/json

Datasource not found or it is not enabled

application/jsonobject
Show application/json properties
- errorsarray of objects

500

application/json

Internal errors

application/jsonobject
Show application/json properties
- errorsarray of objects

503

application/json

Service unavailable, happens when request to connector or down stream services fails

application/jsonobject
Show application/json properties
- errorsarray of objects

GET /v1/data-sources/{dataSourceId}/api-specs

curl "https://your-tenant.us.qlikcloud.com/api/v1/data-sources/{dataSourceId}/api-specs" \
-H "Authorization: Bearer <API-key>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/data-sources/{dataSourceId}/api-specs',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)

This API is not included yet in qlik-cli

Response

{
  "connectorVersion": "1.180.0",
  "connectorProvider": "QvRestConnector.exe",
  "connectionProperties": "{\"property1\": \"value\", \"property2\": \"value2\"}"
}

Facts

Rate limit	Tier 1 (1000 requests per minute)
Categories	externalmanage

Query Parameters

forceRefreshboolean

Force to get a refreshed list from backend. Cached list will be returned if not set or set to false.

Path Parameters

dataSourceIdstring
Required

Datasource ID

Responses

200

application/json

Gateways list returned

application/jsonobject
Show application/json properties
- gatewaysarray of objects
  
  List of gateway ID's for given datasource ID
  
  Show gateways properties
  
  idstring
  
  Gateway ID
  
  namestring
  
  Gateway name
  
  defaultboolean
  
  Whether the gateway is default
- refreshedAtstring
  
  Time stamp when the gateways data were refreshed

401

application/json

Unauthorized request (Bad JWT token etc)

application/jsonobject
Show application/json properties
- errorsarray of objects

404

application/json

Datasource not found (or not enabled), or no gateway is configured for the tenant

application/jsonobject
Show application/json properties
- errorsarray of objects

500

application/json

General internal errors

application/jsonobject
Show application/json properties
- errorsarray of objects

GET /v1/data-sources/{dataSourceId}/gateways

curl "https://your-tenant.us.qlikcloud.com/api/v1/data-sources/{dataSourceId}/gateways" \
-H "Authorization: Bearer <API-key>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/data-sources/{dataSourceId}/gateways',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)

This API is not included yet in qlik-cli

Response

{
  "gateways": [
    {
      "id": "051YTx0OGDlfQ_66H3NyXwK24HEEyyJI::a6CxFtkInvsJnrNXCOVWR8pQOwaphpU0",
      "name": "MyGateway",
      "default": true
    }
  ],
  "refreshedAt": "2024-01-18T02:25:59.521Z"
}

Data sources

Endpoints

Get data sources

Facts

Query Parameters

Responses

200

401

404

500

Response

Get 'connectionProperties' for a given datasource

Facts

Path Parameters

Responses

200

401

404

500

503

Response

Get list available gateway ID's for a given datasource

Facts

Query Parameters

Path Parameters

Responses

200

401

404

500

Response