Dcaas

Download specification

DEPRECATED. Use POST /v1/data-connections to create connection.

Facts

Rate limit Tier 2 (100 requests per minute)
Categories externalmanage
Deprecated This endpoint is deprecated and will eventually be removed. Read our API policy here.

Request Body

Required

application/json

  • application/jsonobject
    Show application/json properties
    • tagsarray of strings

      string tags (32 or less) persisted with the connection object

    • spaceIdstring

      Target connection space ID

    • authUrlOnlyboolean

      When set to true, only authentication URL will be returned if datasource supports OAuth (other properties set in the request will ignored). This property will be ignored if the request is not OAuth or datasource doesn't support OAuth

      default = false

    • dataSourceIdstring
      Required

      Datasource ID

    • connectionNamestring
      Required

      Connection name

    • connectionPropertiesobject
      Required

      List of connection properties required to create dataconnection for a given datasource, which is defined by the response of 'GET /v1/data-datasources/:{datasourceId}/api-specs'

Responses

201

application/json

Data connection created

  • application/jsonobject
    One of:
    • CreateConnectionResobject
      Show CreateConnectionRes properties
      • userIdstring
        Required

        User ID

      • spaceIdstring

        Space ID

      • tenantIdstring
        Required

        Tenant ID

      • updateAtstring
        Required

        Updated at time stamp

      • createdAtstring
        Required

        Created at time stamp

      • connectionIdstring
        Required

        Connection ID

      • dataSourceIdstring
        Required

        Datasource ID

      • credentialsIdstring

        Credentials ID (if credentials are included in the request)

      • connectionNamestring
        Required

        Connection name
    • AuthUrlResponseobject

      Response returned when 'authUrlOnly' is set to true in the request body

      Show AuthUrlResponse properties
      • authUrlstring
        Required

        Authentication URL for OAuth datasource

400

application/json

Bad request

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

401

application/json

Unauthorized request (Bad JWT token etc)

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

403

application/json

Access forbidden, happens when feature or datasource 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
POST /v1/dcaas/actions/data-connections 
curl "https://your-tenant.us.qlikcloud.com/api/v1/dcaas/actions/data-connections" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <API-key>" \
-d '{"tags":"[\"tag1\", \"tag2\"]","spaceId":"6226583d53a69876774d4f96","authUrlOnly":false,"dataSourceId":"rest","connectionName":"MyConnection","connectionProperties":"{\"property1\": \"value\", \"property2\": \"value\"}"}'

const https = require('https')
  const data = JSON.stringify({"tags":"[\"tag1\", \"tag2\"]","spaceId":"6226583d53a69876774d4f96","authUrlOnly":false,"dataSourceId":"rest","connectionName":"MyConnection","connectionProperties":"{\"property1\": \"value\", \"property2\": \"value\"}"})
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/dcaas/actions/data-connections',
    'method': 'POST',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  req.write(data)
  

This API is not included yet in qlik-cli

Request

{
  "tags": "[\"tag1\", \"tag2\"]",
  "spaceId": "6226583d53a69876774d4f96",
  "authUrlOnly": false,
  "dataSourceId": "rest",
  "connectionName": "MyConnection",
  "connectionProperties": "{\"property1\": \"value\", \"property2\": \"value\"}"
}

Response

{
  "userId": "Ip1R89NWKqEYje6jxc6wEkJEQsiPG7uz",
  "spaceId": "641c53f71ecb12d7c450f687",
  "tenantId": "xqFQ0k66vSR8f9F7J-zZtHZQkiYrCpc2",
  "updateAt": "2023-03-23T13:30:55.351Z",
  "createdAt": "2023-03-23T13:30:55.351Z",
  "connectionId": "44054965-a970-458b-8c82-1fbf2934f87a",
  "dataSourceId": "rest",
  "credentialsId": "d24799e4-e872-432b-8c5d-b9012afc6ff7",
  "connectionName": "My connection"
}

DEPRECATED. Use GET /v1/data-connections/{connectionId}?parseConnection=true to get connection with parsed connection properties.

Facts

Rate limit Tier 1 (1000 requests per minute)
Categories externalmanage
Deprecated This endpoint is deprecated and will eventually be removed. Read our API policy here.

Path Parameters

  • connectionIdstring
    Required

    ID of the connection

    format = "uuid"

Responses

200

application/json

Connection returned

  • application/jsonobject
    Show application/json properties
    • tagsarray of strings

      string tags associated with the connection

    • userIdstring
      Required

      User ID

    • spaceIdstring

      Space ID

    • tenantIdstring
      Required

      Tenant ID

    • updateAtstring
      Required

      Updated at time stamp

    • createdAtstring
      Required

      Created at time stamp

    • connectionIdstring
      Required

      Connection ID

    • dataSourceIdstring
      Required

      Datasource ID

    • credentialsIdstring

      Credentials ID (associated with the connection, either embedded or separated)

    • connectionNamestring
      Required

      Connection name

    • connectionPropertiesobject
      Required

      List of connection properties

401

application/json

Unauthorized request (Bad JWT token etc)

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

403

application/json

Access forbidden, happens when feature or datasource is not enabled

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

404

application/json

Access forbidden, happens when feature or datasource 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/dcaas/actions/data-connections/{connectionId} 
curl "https://your-tenant.us.qlikcloud.com/api/v1/dcaas/actions/data-connections/{connectionId}" \
-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/dcaas/actions/data-connections/{connectionId}',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  

This API is not included yet in qlik-cli

Response

{
  "tags": "[\"tag1\", \"tag2\"]",
  "userId": "string",
  "spaceId": "641c53f71ecb12d7c450f687",
  "tenantId": "1f25B1AD6zH6cQ-TovCAuXbCtgfSTrSC",
  "updateAt": "2023-03-23T13:30:55.351Z",
  "createdAt": "2023-03-23T13:30:55.351Z",
  "connectionId": "44054965-a970-458b-8c82-1fbf2934f87a",
  "dataSourceId": "rest",
  "credentialsId": "d24799e4-e872-432b-8c5d-b9012afc6ff7",
  "connectionName": "My Connection 1",
  "connectionProperties": "{property1: \"value\"}"
}

DEPRECATED. Use GET /v1/data-sources/{dataSourceId}/api-specs to return 'connectionProperties' for a given datasource.

Facts

Rate limit Tier 1 (1000 requests per minute)
Categories externalmanage
Deprecated This endpoint is deprecated and will eventually be removed. Read our API policy here.

Query 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

403

application/json

Access forbidden, happens when feature or datasource 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/dcaas/actions/data-connections/api-specs 
curl "https://your-tenant.us.qlikcloud.com/api/v1/dcaas/actions/data-connections/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/dcaas/actions/data-connections/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\"}"
}