Data sources
Lists data sources available on the tenant for the creation of analytics data connections.
Endpoints
Gets the list of data sources available on the node.
Facts
Rate limit | Tier 1 (1000 requests per minute) |
Categories | manage |
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
application/json properties
- dataSourcesarray of objectsRequired
List of datasources metadata object
dataSources properties
- namestringRequired
Datasource name
- uiInfoobject
UI related metadata (only present when 'includeui' is set to true in query)
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
-
- providerstringRequired
Connector provider
- capabilitiesarray of strings
List of capabilities supported by the datasource
- dataSourceIdstringRequired
Unique identifier of datasource
- providerNamestringRequired
Provider name
- qriDefinitionobject
Qri definition template
qriDefinition properties
- itemPartobject
itemPart properties
- prefixstring
Prefix of the template
- templatestringRequired
Qri template
- propertiesarray of stringsRequired
List of properties used in template
-
- pathPartobjectRequired
pathPart properties
- prefixstring
Prefix of the template
- templatestringRequired
Qri template
- propertiesarray of stringsRequired
List of properties used in template
-
- qriPrefixstringRequired
Qri prefix
- connectionPartobjectRequired
connectionPart properties
- templatestringRequired
Qri template
- propertiesarray of stringsRequired
List of properties used in template
-
-
- dataLoadUrlOverridestring
Override value of dataload URL (could be null)
- dataSourcePropertyNamestring
Datasource property name (could be null)
-
- lastUpdatedstringRequired
Time stamp of last updated
- connectorNodesarray of objects
List of connector nodes (only present when query parameter 'detail' is set to true)
connectorNodes properties
- urlstringRequired
URL of connector node
- statestringRequired
State of the connector node
- contractTypenumberRequired
Contract type used to communicate with the connector (between 0 and 3)
- providerNamestringRequired
Connector provider name
- cachedDataSourcesarray of strings
List of datasource Ids provided by the provider
- dataSourcesUpdatedbooleanRequired
Indicates if the datasources is up to date
-
-
401
application/json
Unauthorized request (Bad JWT token etc)
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestringRequired
A service specific error code string
- metaobject
Additional metadata associated with the error
- titlestringRequired
Summary of the error
- detailstring
Concrete detail about the error
-
-
404
application/json
Datasource not found or it is not enabled
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestringRequired
A service specific error code string
- metaobject
Additional metadata associated with the error
- titlestringRequired
Summary of the error
- detailstring
Concrete detail about the error
-
-
500
application/json
Internal errors
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestringRequired
A service specific error code string
- metaobject
Additional metadata associated with the error
- titlestringRequired
Summary of the error
- detailstring
Concrete detail about the error
-
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/data-sources" \-H "Authorization: Bearer <access_token>"
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 <access_token>' } } 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": { "qriPrefix": "qri:db:sap-sql://" }, "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 | manage |
Path Parameters
- dataSourceIdstringRequired
Datasource ID
Responses
200
application/json
API spec returned
- application/jsonobject
application/json properties
- connectorVersionstringRequired
Datasource provider (i.e. connector) version
- connectorProviderstringRequired
Datasource provider
- connectionPropertiesobjectRequired
List of properties required for the given datasource
-
401
application/json
Unauthorized request (Bad JWT token etc)
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestringRequired
A service specific error code string
- metaobject
Additional metadata associated with the error
- titlestringRequired
Summary of the error
- detailstring
Concrete detail about the error
-
-
404
application/json
Datasource not found or it is not enabled
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestringRequired
A service specific error code string
- metaobject
Additional metadata associated with the error
- titlestringRequired
Summary of the error
- detailstring
Concrete detail about the error
-
-
500
application/json
Internal errors
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestringRequired
A service specific error code string
- metaobject
Additional metadata associated with the error
- titlestringRequired
Summary of the error
- detailstring
Concrete detail about the error
-
-
503
application/json
Service unavailable, happens when request to connector or down stream services fails
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestringRequired
A service specific error code string
- metaobject
Additional metadata associated with the error
- titlestringRequired
Summary of the error
- detailstring
Concrete detail about the error
-
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/data-sources/{dataSourceId}/api-specs" \-H "Authorization: Bearer <access_token>"
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 <access_token>' } } 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 | manage |
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
- dataSourceIdstringRequired
Datasource ID
Responses
200
application/json
Gateways list returned
- application/jsonobject
application/json properties
- gatewaysarray of objects
List of gateway ID's for given datasource ID
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
application/json properties
- errorsarray of objects
errors properties
- codestringRequired
A service specific error code string
- metaobject
Additional metadata associated with the error
- titlestringRequired
Summary of the error
- detailstring
Concrete detail about the error
-
-
404
application/json
Datasource not found (or not enabled), or no gateway is configured for the tenant
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestringRequired
A service specific error code string
- metaobject
Additional metadata associated with the error
- titlestringRequired
Summary of the error
- detailstring
Concrete detail about the error
-
-
500
application/json
General internal errors
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestringRequired
A service specific error code string
- metaobject
Additional metadata associated with the error
- titlestringRequired
Summary of the error
- detailstring
Concrete detail about the error
-
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/data-sources/{dataSourceId}/gateways" \-H "Authorization: Bearer <access_token>"
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 <access_token>' } } 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"}