Knowledgebases

Knowledgebases are collections of individual data sources, that are indexed for use in generating responses to user questions via Assistants for Qlik Answers.

Download specification

List knowledgebases

Returns a list of all knowledgebases the user has access to.

Facts

Rate limit Tier 1 (1000 requests per minute)
Categories

Query Parameters

  • limitinteger

    The number of knowledgebases to get.

  • nextstring

    Optional parameter to request the next page.

  • prevstring

    Optional parameter to request the previous page.

  • sortstring

    Optional resource field name to sort on, case insensitive, eg. name. Can be prefixed with - to set descending order, defaults to ascending.

    Can be one of: "NAME""-NAME""DESCRIPTION""-DESCRIPTION""CREATED""-CREATED""UPDATED""-UPDATED"

  • countTotalbooleanDeprecated

    Optional parameter to request total count for query

Responses

200

application/json

Successful Operation.

  • application/jsonobject
    Show application/json properties
    • dataarray of objects
      Required
      Show data properties
      • idstring
        Required

        Unique identifier of the knowledgebase

      • namestring
        Required

        Name of the knowledgebase

      • tagsarray of strings
        Required

        List of tags associated with the knowledgebase.

      • ownerIdstring
        Required

        The unique identifier of the knowledgebase owner

      • spaceIdstring
        Required

        The unique identifier of the space containing the knowledgebase

      • tenantIdstring

        Unique identifier of the tenant

      • createdAtstring
        Required

        Datetime when the knowledgebase was created

      • createdBystring
        Required

        Unique identifier of the user who created the knowledgebase

      • updatedAtstring
        Required

        Datetime when the knowledgebase was updated

      • updatedBystring
        Required

        The unique identifier of the user who last updated the knowledgebase

      • descriptionstring
        Required

        Description of the knowledgebase

      • lastIndexedAtstring

        Datetime when the knowledgebase was last indexed

      • contentSummaryobject
        Required
        Show contentSummary properties
        • fileSizeinteger
          Required
        • textSizeinteger
          Required
        • fileCountinteger
          Required
        • effectivePagesinteger
          Required
      • selectedErrorsCountinteger

        Number of selected errors to store in the case of any failed datasources.

    • linksobject
      Show links properties
      • nextobject
        Show next properties
        • hrefstring
      • prevobject
        Show prev properties
        • hrefstring
      • selfobject
        Show self properties
        • hrefstring

400

application/json

The request is in incorrect format.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

403

application/json

The user does not have privileges to perform the requested action.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
GET /v1/knowledgebases
curl "https://your-tenant.us.qlikcloud.com/api/v1/knowledgebases" \
-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/knowledgebases',
'method': 'GET',
'headers': {
'Authorization': 'Bearer <access_token>'
}
}
const req = https.request(options)
This API is not included yet in qlik-cli

Response

{
"data": [
{
"id": "f256b3e4-03e0-4f74-ae46-a4d43882ee5d",
"name": "Organization wide knowledgebase",
"tags": [
"Red",
"Sales"
],
"ownerId": "507f191e810c19729de860ea",
"spaceId": "507f191e810c19729de860ea",
"tenantId": "507f191e810c19729de860ea",
"createdAt": "2021-10-02T14:20:50.52Z",
"createdBy": "507f191e810c19729de860ea",
"updatedAt": "2021-10-02T14:20:50.52Z",
"updatedBy": "507f191e810c19729de860ea",
"description": "This knowledgebase is used for...",
"lastIndexedAt": "2021-10-02T14:20:50.52Z",
"contentSummary": {
"fileSize": 42,
"textSize": 42,
"fileCount": 42,
"effectivePages": 42
},
"selectedErrorsCount": 10
}
],
"links": {
"next": {
"href": "string"
},
"prev": {
"href": "string"
},
"self": {
"href": "string"
}
}
}

Create new knowledgebase

Creates a new knowledgebase.

Facts

Rate limit Tier 2 (100 requests per minute)
Categories

Request Body

application/json

  • application/jsonobject
    Show application/json properties
    • namestring
      Required

      Name of the knowledgebase

    • tagsarray of strings

      List of tags for knowledgebase

    • spaceIdstring
      Required

      Unique identifier of the space to contain the knowledgebase

    • descriptionstring

      Description of the knowledgebase

    • selectedErrorsCountinteger

      Number of selected errors to store in the case of any failed datasources. Optional value with a default of 10.

Responses

201

application/json

Successfully created a new knowledgebase.

  • application/jsonobject
    Show application/json properties
    • idstring
      Required

      Unique identifier of the knowledgebase

    • namestring
      Required

      Name of the knowledgebase

    • tagsarray of strings
      Required

      List of tags associated with the knowledgebase.

    • ownerIdstring
      Required

      The unique identifier of the knowledgebase owner

    • spaceIdstring
      Required

      The unique identifier of the space containing the knowledgebase

    • tenantIdstring

      Unique identifier of the tenant

    • createdAtstring
      Required

      Datetime when the knowledgebase was created

    • createdBystring
      Required

      Unique identifier of the user who created the knowledgebase

    • updatedAtstring
      Required

      Datetime when the knowledgebase was updated

    • updatedBystring
      Required

      The unique identifier of the user who last updated the knowledgebase

    • descriptionstring
      Required

      Description of the knowledgebase

    • lastIndexedAtstring

      Datetime when the knowledgebase was last indexed

    • contentSummaryobject
      Required
      Show contentSummary properties
      • fileSizeinteger
        Required
      • textSizeinteger
        Required
      • fileCountinteger
        Required
      • effectivePagesinteger
        Required
    • selectedErrorsCountinteger

      Number of selected errors to store in the case of any failed datasources.

400

application/json

The request is in incorrect format.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

403

application/json

The user does not have privileges to perform the requested action.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
POST /v1/knowledgebases
curl "https://your-tenant.us.qlikcloud.com/api/v1/knowledgebases" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"name":"Organization wide knowledgebase","tags":["Red","Sales"],"spaceId":"507f191e810c19729de860ea","description":"This knowledgebase is used for...","selectedErrorsCount":10}'
const https = require('https')
const data = JSON.stringify({"name":"Organization wide knowledgebase","tags":["Red","Sales"],"spaceId":"507f191e810c19729de860ea","description":"This knowledgebase is used for...","selectedErrorsCount":10})
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/knowledgebases',
'method': 'POST',
'headers': {
'Content-type': 'application/json',
'Authorization': 'Bearer <access_token>'
}
}
const req = https.request(options)
req.write(data)
This API is not included yet in qlik-cli

Request

{
"name": "Organization wide knowledgebase",
"tags": [
"Red",
"Sales"
],
"spaceId": "507f191e810c19729de860ea",
"description": "This knowledgebase is used for...",
"selectedErrorsCount": 10
}

Response

{
"id": "f256b3e4-03e0-4f74-ae46-a4d43882ee5d",
"name": "Organization wide knowledgebase",
"tags": [
"Red",
"Sales"
],
"ownerId": "507f191e810c19729de860ea",
"spaceId": "507f191e810c19729de860ea",
"tenantId": "507f191e810c19729de860ea",
"createdAt": "2021-10-02T14:20:50.52Z",
"createdBy": "507f191e810c19729de860ea",
"updatedAt": "2021-10-02T14:20:50.52Z",
"updatedBy": "507f191e810c19729de860ea",
"description": "This knowledgebase is used for...",
"lastIndexedAt": "2021-10-02T14:20:50.52Z",
"contentSummary": {
"fileSize": 42,
"textSize": 42,
"fileCount": 42,
"effectivePages": 42
},
"selectedErrorsCount": 10
}

Retrieve a knowledgebase

Retrieves a specific knowledgebase.

Facts

Rate limit Tier 1 (1000 requests per minute)
Categories

Path Parameters

  • idstring
    Required

    The id of the knowledgebase to retrieve.

Responses

200

application/json

Successfully retrieved the knowledgebase.

  • application/jsonobject
    Show application/json properties
    • idstring
      Required

      Unique identifier of the knowledgebase

    • namestring
      Required

      Name of the knowledgebase

    • tagsarray of strings
      Required

      List of tags associated with the knowledgebase.

    • ownerIdstring
      Required

      The unique identifier of the knowledgebase owner

    • spaceIdstring
      Required

      The unique identifier of the space containing the knowledgebase

    • tenantIdstring

      Unique identifier of the tenant

    • createdAtstring
      Required

      Datetime when the knowledgebase was created

    • createdBystring
      Required

      Unique identifier of the user who created the knowledgebase

    • updatedAtstring
      Required

      Datetime when the knowledgebase was updated

    • updatedBystring
      Required

      The unique identifier of the user who last updated the knowledgebase

    • descriptionstring
      Required

      Description of the knowledgebase

    • lastIndexedAtstring

      Datetime when the knowledgebase was last indexed

    • contentSummaryobject
      Required
      Show contentSummary properties
      • fileSizeinteger
        Required
      • textSizeinteger
        Required
      • fileCountinteger
        Required
      • effectivePagesinteger
        Required
    • selectedErrorsCountinteger

      Number of selected errors to store in the case of any failed datasources.

    • datasourcesarray of objects

      Specification on where to fetch the files for. This is required when the type == 'file'. Only one of path and files can be set. Path takes precedence if both are provided.

      Show datasources properties
      • idstring
        Required

        Unique identifier of the datasource

      • namestring

        Name of the datasource

      • typestring
        Required

        Can be one of: "file""web""database"

      • spaceIdstring

        The unique identifier of the space containing the datasource

      • chunkingobject
        Show chunking properties
        • sizeinteger
          Required

          Size of chunks

        • typestring
          Required

          Chunking strategy

        • overlapinteger
          Required

          Chunk overlap, should be less than size

        • separatorsarray of strings
          Required

          List of separators to chunk by

        • keepSeparatorboolean
          Required

          Allows to keep or remove separators used

      • syncInfoobject
        Show syncInfo properties
        • statusstring
          Required

          Sync status

          Can be one of: "neverIndexed""progress""completed""completedWithError""toAdd""toDelete"

        • startedAtstring
          Required

          Datetime when the sync task was started

        • lastSyncIdstring

          sync Id

        • completedAtstring
          Required

          Datetime when the sync task was completed

      • fileConfigobject

        Specification on where to fetch the files for. This is required when the type == 'file'. Only one of path and files can be set. Path takes precedence if both are provided.

        Show fileConfig properties
        • filesarray of strings
        • scopeobject

          Scope for the file crawler.

          Show scope properties
          • depthinteger
            Required

            The number of levels of sub folders that should be considered

          • maxSizeinteger

            Optional parameter. Max size of downloaded files in bytes

          • extensionsarray of strings

            list of file extensions to be considered

          • maxFilesTotalinteger

            Total number of files that should be considered

          • modifiedAfterstring

            only files modified after this time should be indexed. If set older files will be removed from index.

          • maxFilesPerFolderinteger

            Maximum number of files per folder that should be considered

        • folderstring

          Root folder for traversing.

        • userIdstring
          Required

          userId of the owner of the datasource fileConfig

        • connectionIdstring
          Required

          connection id to be used to retrieve the raw data

        • crawlPatternsarray of objects

          Pattern matching links to crawl

          Show crawlPatterns properties
          • typestring
            Required

            include or exclude

            Can be one of: "include""exclude"

          • patternstring
            Required

            Regex patterna to filter links on

      • sourceCountinteger

        The number of times that a datasource was referenced as a source in an answer

      • crawlerConfigobject

        Configuration for webcrawling

        Show crawlerConfig properties
        • urlstring
          Required

          Seed URL that crawling will start on.

        • scopeobject
          Required

          Scope for th webcrawler

          Show scope properties
          • depthinteger
            Required

            The number of levels of links the crawler will traverse

          • scopestring
            Required

            The scope that the crawler will crawl.

            Can be one of: "all""domain""subdomain"

          • maxSizeinteger

            Optional parameter. Max size of downloaded files in bytes

          • maxLinksinteger

            Maximum number of links per page that will be extracted

          • downloadFilesboolean

            if set to true crawler will try to download and index other supported content like pdf:s from links

        • crawlPatternsarray of objects

          Pattern matching links to crawl

          Show crawlPatterns properties
          • typestring
            Required

            include or exclude

            Can be one of: "include""exclude"

          • patternstring
            Required

            Regex patterna to filter links on

        • indexPatternsarray of objects

          Pattern matching links to index

          Show indexPatterns properties
          • typestring
            Required

            include or exclude

            Can be one of: "include""exclude"

          • patternstring
            Required

            Regex patterna to filter links on

      • contentSummaryobject
        Required
        Show contentSummary properties
        • fileSizeinteger
          Required
        • textSizeinteger
          Required
        • fileCountinteger
          Required
        • effectivePagesinteger
          Required

400

application/json

The request is in incorrect format.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

403

application/json

The operation failed due to insufficient permissions.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

404

application/json

The knowledgebase is not found

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
GET /v1/knowledgebases/{id}
curl "https://your-tenant.us.qlikcloud.com/api/v1/knowledgebases/{id}" \
-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/knowledgebases/{id}',
'method': 'GET',
'headers': {
'Authorization': 'Bearer <access_token>'
}
}
const req = https.request(options)
This API is not included yet in qlik-cli

Response

{
"id": "f256b3e4-03e0-4f74-ae46-a4d43882ee5d",
"name": "Organization wide knowledgebase",
"tags": [
"Red",
"Sales"
],
"ownerId": "507f191e810c19729de860ea",
"spaceId": "507f191e810c19729de860ea",
"tenantId": "507f191e810c19729de860ea",
"createdAt": "2021-10-02T14:20:50.52Z",
"createdBy": "507f191e810c19729de860ea",
"updatedAt": "2021-10-02T14:20:50.52Z",
"updatedBy": "507f191e810c19729de860ea",
"description": "This knowledgebase is used for...",
"lastIndexedAt": "2021-10-02T14:20:50.52Z",
"contentSummary": {
"fileSize": 42,
"textSize": 42,
"fileCount": 42,
"effectivePages": 42
},
"selectedErrorsCount": 10,
"datasources": [
{
"id": "f256b3e4-03e0-4f74-ae46-a4d43882ee5d",
"name": "string",
"type": "file",
"spaceId": "507f191e810c19729de860ea",
"chunking": {
"size": 1024,
"type": "recursive",
"overlap": 20,
"separators": [
"\n",
".",
" "
],
"keepSeparator": false
},
"syncInfo": {
"status": "neverIndexed",
"startedAt": "2021-10-02T14:20:50.52Z",
"lastSyncId": "f256b3e4-03e0-4f74-ae46-a4d43882ee5d",
"completedAt": "2021-10-02T14:20:50.52Z"
},
"fileConfig": {
"files": [
"string"
],
"scope": {
"depth": 1,
"maxSize": 1000000,
"extensions": [
"pdf"
],
"maxFilesTotal": 50,
"modifiedAfter": "2021-10-02T14:20:50.52Z",
"maxFilesPerFolder": 100
},
"folder": "folderA/folderB",
"userId": "507f191e810c19729de860ea",
"connectionId": "f256b3e4-03e0-4f74-ae46-a4d43882ee5d",
"crawlPatterns": [
{
"type": "include",
"pattern": "(.*)example(.*)"
}
]
},
"sourceCount": 10,
"crawlerConfig": {
"url": "http://www.example.com",
"scope": {
"depth": 1,
"scope": "all",
"maxSize": 1000000,
"maxLinks": 100,
"downloadFiles": false
},
"crawlPatterns": [
{
"type": "include",
"pattern": "(.*)example(.*)"
}
],
"indexPatterns": [
{
"type": "include",
"pattern": "(.*)example(.*)"
}
]
},
"contentSummary": {
"fileSize": 42,
"textSize": 42,
"fileCount": 42,
"effectivePages": 42
}
}
]
}

Update a knowledgebase

Updates properties of a specific knowledgebase.

Facts

Rate limit Tier 2 (100 requests per minute)
Categories

Header Parameters

  • if-matchstring

    Optional header to do conditional updates. Using the Etag value that was returned the last time the knowledgebase was fetched.

Path Parameters

  • idstring
    Required

    The knowledgebase id.

Request Body

Required

application/json

An array of JSON Patch documents

  • application/jsonarray of objects

    An array of JSON Patch documents

    Show application/json properties
    • opstring
      Required

      The operation to be performed.

      Can be one of: "REPLACE"

    • pathstring
      Required

      A JSON Pointer.

    • valuestring|number|boolean
      Required

      The value to be used for this operation.

      One of:
      • string
      • number
      • boolean

Responses

204

Knowledgebase updated successfully.

400

application/json

Bad request. Payload could not be parsed to a JSON Patch or Patch operations are invalid.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

401

application/json

Not authorized.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

403

application/json

The operation failed due to insufficient permissions.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

404

application/json

The term to patch was not found.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

429

application/json

Request has been rate limited.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
PATCH /v1/knowledgebases/{id}
curl "https://your-tenant.us.qlikcloud.com/api/v1/knowledgebases/{id}" \
-X PATCH \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '[{"op":"replace","path":"/name","value":"new name"},{"op":"replace","path":"/description","value":"new description"}]'
const https = require('https')
const data = JSON.stringify([{"op":"replace","path":"/name","value":"new name"},{"op":"replace","path":"/description","value":"new description"}])
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/knowledgebases/{id}',
'method': 'PATCH',
'headers': {
'Content-type': 'application/json',
'Authorization': 'Bearer <access_token>'
}
}
const req = https.request(options)
req.write(data)
This API is not included yet in qlik-cli

Request

[
{
"op": "replace",
"path": "/name",
"value": "new name"
},
{
"op": "replace",
"path": "/description",
"value": "new description"
}
]

Delete a knowledgebase

Deletes a knowledgebase and all of its resources.

Facts

Rate limit Tier 2 (100 requests per minute)
Categories

Path Parameters

  • idstring
    Required

    The id of the knowledgebase to delete.

Responses

204

Successful Operation.

400

application/json

The request is in incorrect format.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

403

application/json

The operation failed due to insufficient permissions.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

404

application/json

The knowledgebase is not found

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
DELETE /v1/knowledgebases/{id}
curl "https://your-tenant.us.qlikcloud.com/api/v1/knowledgebases/{id}" \
-X DELETE \
-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/knowledgebases/{id}',
'method': 'DELETE',
'headers': {
'Authorization': 'Bearer <access_token>'
}
}
const req = https.request(options)
This API is not included yet in qlik-cli

Add a datasource to a knowledgebase

Adds a datasource to a knowledgebase.

Facts

Rate limit Tier 2 (100 requests per minute)
Categories

Path Parameters

  • idstring
    Required

    The id of the knowledgebase.

Request Body

application/json

Specification on where to fetch the files for. This is required when the type == 'file'. Only one of path and files can be set. Path takes precedence if both are provided.

  • application/jsonobject

    Specification on where to fetch the files for. This is required when the type == 'file'. Only one of path and files can be set. Path takes precedence if both are provided.

    Show application/json properties
    • namestring
      Required

      Name of the datasource

    • typestring
      Required

      Can be one of: "file""web""database"

    • fileConfigobject

      Specification on where to fetch the files for. This is required when the type == 'file'. Only one of path and files can be set. Path takes precedence if both are provided.

      Show fileConfig properties
      • filesarray of strings
      • scopeobject

        Scope for the file crawler.

        Show scope properties
        • depthinteger
          Required

          The number of levels of sub folders that should be considered

        • maxSizeinteger

          Optional parameter. Max size of downloaded files in bytes

        • extensionsarray of strings

          list of file extensions to be considered

        • maxFilesTotalinteger

          Total number of files that should be considered

        • modifiedAfterstring

          only files modified after this time should be indexed. If set older files will be removed from index.

        • maxFilesPerFolderinteger

          Maximum number of files per folder that should be considered

      • folderstring

        Root folder for traversing.

      • userIdstring
        Required

        userId of the owner of the datasource fileConfig

      • connectionIdstring
        Required

        connection id to be used to retrieve the raw data

      • crawlPatternsarray of objects

        Pattern matching links to crawl

        Show crawlPatterns properties
        • typestring
          Required

          include or exclude

          Can be one of: "include""exclude"

        • patternstring
          Required

          Regex patterna to filter links on

    • crawlerConfigobject

      Configuration for webcrawling

      Show crawlerConfig properties
      • urlstring
        Required

        Seed URL that crawling will start on.

      • scopeobject
        Required

        Scope for th webcrawler

        Show scope properties
        • depthinteger
          Required

          The number of levels of links the crawler will traverse

        • scopestring
          Required

          The scope that the crawler will crawl.

          Can be one of: "all""domain""subdomain"

        • maxSizeinteger

          Optional parameter. Max size of downloaded files in bytes

        • maxLinksinteger

          Maximum number of links per page that will be extracted

        • downloadFilesboolean

          if set to true crawler will try to download and index other supported content like pdf:s from links

      • crawlPatternsarray of objects

        Pattern matching links to crawl

        Show crawlPatterns properties
        • typestring
          Required

          include or exclude

          Can be one of: "include""exclude"

        • patternstring
          Required

          Regex patterna to filter links on

      • indexPatternsarray of objects

        Pattern matching links to index

        Show indexPatterns properties
        • typestring
          Required

          include or exclude

          Can be one of: "include""exclude"

        • patternstring
          Required

          Regex patterna to filter links on

Responses

201

application/json

Successfully added a datasource to the knowledgebase.

Specification on where to fetch the files for. This is required when the type == 'file'. Only one of path and files can be set. Path takes precedence if both are provided.

  • application/jsonobject

    Specification on where to fetch the files for. This is required when the type == 'file'. Only one of path and files can be set. Path takes precedence if both are provided.

    Show application/json properties
    • idstring
      Required

      Unique identifier of the datasource

    • namestring

      Name of the datasource

    • typestring
      Required

      Can be one of: "file""web""database"

    • spaceIdstring

      The unique identifier of the space containing the datasource

    • chunkingobject
      Show chunking properties
      • sizeinteger
        Required

        Size of chunks

      • typestring
        Required

        Chunking strategy

      • overlapinteger
        Required

        Chunk overlap, should be less than size

      • separatorsarray of strings
        Required

        List of separators to chunk by

      • keepSeparatorboolean
        Required

        Allows to keep or remove separators used

    • syncInfoobject
      Show syncInfo properties
      • statusstring
        Required

        Sync status

        Can be one of: "neverIndexed""progress""completed""completedWithError""toAdd""toDelete"

      • startedAtstring
        Required

        Datetime when the sync task was started

      • lastSyncIdstring

        sync Id

      • completedAtstring
        Required

        Datetime when the sync task was completed

    • fileConfigobject

      Specification on where to fetch the files for. This is required when the type == 'file'. Only one of path and files can be set. Path takes precedence if both are provided.

      Show fileConfig properties
      • filesarray of strings
      • scopeobject

        Scope for the file crawler.

        Show scope properties
        • depthinteger
          Required

          The number of levels of sub folders that should be considered

        • maxSizeinteger

          Optional parameter. Max size of downloaded files in bytes

        • extensionsarray of strings

          list of file extensions to be considered

        • maxFilesTotalinteger

          Total number of files that should be considered

        • modifiedAfterstring

          only files modified after this time should be indexed. If set older files will be removed from index.

        • maxFilesPerFolderinteger

          Maximum number of files per folder that should be considered

      • folderstring

        Root folder for traversing.

      • userIdstring
        Required

        userId of the owner of the datasource fileConfig

      • connectionIdstring
        Required

        connection id to be used to retrieve the raw data

      • crawlPatternsarray of objects

        Pattern matching links to crawl

        Show crawlPatterns properties
        • typestring
          Required

          include or exclude

          Can be one of: "include""exclude"

        • patternstring
          Required

          Regex patterna to filter links on

    • sourceCountinteger

      The number of times that a datasource was referenced as a source in an answer

    • crawlerConfigobject

      Configuration for webcrawling

      Show crawlerConfig properties
      • urlstring
        Required

        Seed URL that crawling will start on.

      • scopeobject
        Required

        Scope for th webcrawler

        Show scope properties
        • depthinteger
          Required

          The number of levels of links the crawler will traverse

        • scopestring
          Required

          The scope that the crawler will crawl.

          Can be one of: "all""domain""subdomain"

        • maxSizeinteger

          Optional parameter. Max size of downloaded files in bytes

        • maxLinksinteger

          Maximum number of links per page that will be extracted

        • downloadFilesboolean

          if set to true crawler will try to download and index other supported content like pdf:s from links

      • crawlPatternsarray of objects

        Pattern matching links to crawl

        Show crawlPatterns properties
        • typestring
          Required

          include or exclude

          Can be one of: "include""exclude"

        • patternstring
          Required

          Regex patterna to filter links on

      • indexPatternsarray of objects

        Pattern matching links to index

        Show indexPatterns properties
        • typestring
          Required

          include or exclude

          Can be one of: "include""exclude"

        • patternstring
          Required

          Regex patterna to filter links on

    • contentSummaryobject
      Required
      Show contentSummary properties
      • fileSizeinteger
        Required
      • textSizeinteger
        Required
      • fileCountinteger
        Required
      • effectivePagesinteger
        Required

400

application/json

The request is in incorrect format.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

403

application/json

The user does not have privileges to perform the requested action.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

404

application/json

The knowledgebase is not found.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
POST /v1/knowledgebases/{id}/datasources
curl "https://your-tenant.us.qlikcloud.com/api/v1/knowledgebases/{id}/datasources" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"name":"string","type":"file","fileConfig":{"files":["string"],"scope":{"depth":1,"maxSize":1000000,"extensions":["pdf"],"maxFilesTotal":50,"modifiedAfter":"2021-10-02T14:20:50.52Z","maxFilesPerFolder":100},"folder":"folderA/folderB","userId":"507f191e810c19729de860ea","connectionId":"f256b3e4-03e0-4f74-ae46-a4d43882ee5d","crawlPatterns":[{"type":"include","pattern":"(.*)example(.*)"}]},"crawlerConfig":{"url":"http://www.example.com","scope":{"depth":1,"scope":"all","maxSize":1000000,"maxLinks":100,"downloadFiles":false},"crawlPatterns":[{"type":"include","pattern":"(.*)example(.*)"}],"indexPatterns":[{"type":"include","pattern":"(.*)example(.*)"}]}}'
const https = require('https')
const data = JSON.stringify({"name":"string","type":"file","fileConfig":{"files":["string"],"scope":{"depth":1,"maxSize":1000000,"extensions":["pdf"],"maxFilesTotal":50,"modifiedAfter":"2021-10-02T14:20:50.52Z","maxFilesPerFolder":100},"folder":"folderA/folderB","userId":"507f191e810c19729de860ea","connectionId":"f256b3e4-03e0-4f74-ae46-a4d43882ee5d","crawlPatterns":[{"type":"include","pattern":"(.*)example(.*)"}]},"crawlerConfig":{"url":"http://www.example.com","scope":{"depth":1,"scope":"all","maxSize":1000000,"maxLinks":100,"downloadFiles":false},"crawlPatterns":[{"type":"include","pattern":"(.*)example(.*)"}],"indexPatterns":[{"type":"include","pattern":"(.*)example(.*)"}]}})
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/knowledgebases/{id}/datasources',
'method': 'POST',
'headers': {
'Content-type': 'application/json',
'Authorization': 'Bearer <access_token>'
}
}
const req = https.request(options)
req.write(data)
This API is not included yet in qlik-cli

Request

{
"name": "string",
"type": "file",
"fileConfig": {
"files": [
"string"
],
"scope": {
"depth": 1,
"maxSize": 1000000,
"extensions": [
"pdf"
],
"maxFilesTotal": 50,
"modifiedAfter": "2021-10-02T14:20:50.52Z",
"maxFilesPerFolder": 100
},
"folder": "folderA/folderB",
"userId": "507f191e810c19729de860ea",
"connectionId": "f256b3e4-03e0-4f74-ae46-a4d43882ee5d",
"crawlPatterns": [
{
"type": "include",
"pattern": "(.*)example(.*)"
}
]
},
"crawlerConfig": {
"url": "http://www.example.com",
"scope": {
"depth": 1,
"scope": "all",
"maxSize": 1000000,
"maxLinks": 100,
"downloadFiles": false
},
"crawlPatterns": [
{
"type": "include",
"pattern": "(.*)example(.*)"
}
],
"indexPatterns": [
{
"type": "include",
"pattern": "(.*)example(.*)"
}
]
}
}

Response

{
"id": "f256b3e4-03e0-4f74-ae46-a4d43882ee5d",
"name": "string",
"type": "file",
"spaceId": "507f191e810c19729de860ea",
"chunking": {
"size": 1024,
"type": "recursive",
"overlap": 20,
"separators": [
"\n",
".",
" "
],
"keepSeparator": false
},
"syncInfo": {
"status": "neverIndexed",
"startedAt": "2021-10-02T14:20:50.52Z",
"lastSyncId": "f256b3e4-03e0-4f74-ae46-a4d43882ee5d",
"completedAt": "2021-10-02T14:20:50.52Z"
},
"fileConfig": {
"files": [
"string"
],
"scope": {
"depth": 1,
"maxSize": 1000000,
"extensions": [
"pdf"
],
"maxFilesTotal": 50,
"modifiedAfter": "2021-10-02T14:20:50.52Z",
"maxFilesPerFolder": 100
},
"folder": "folderA/folderB",
"userId": "507f191e810c19729de860ea",
"connectionId": "f256b3e4-03e0-4f74-ae46-a4d43882ee5d",
"crawlPatterns": [
{
"type": "include",
"pattern": "(.*)example(.*)"
}
]
},
"sourceCount": 10,
"crawlerConfig": {
"url": "http://www.example.com",
"scope": {
"depth": 1,
"scope": "all",
"maxSize": 1000000,
"maxLinks": 100,
"downloadFiles": false
},
"crawlPatterns": [
{
"type": "include",
"pattern": "(.*)example(.*)"
}
],
"indexPatterns": [
{
"type": "include",
"pattern": "(.*)example(.*)"
}
]
},
"contentSummary": {
"fileSize": 42,
"textSize": 42,
"fileCount": 42,
"effectivePages": 42
}
}

Update a knowledgebase datasource

Updates a specified datasource.

Facts

Rate limit Tier 2 (100 requests per minute)
Categories

Path Parameters

  • datasourceIdstring
    Required

    The id of the datasource to update.

  • idstring
    Required

    The id of a knowledgebase.

Request Body

application/json

Specification on where to fetch the files for. This is required when the type == 'file'. Only one of path and files can be set. Path takes precedence if both are provided.

  • application/jsonobject

    Specification on where to fetch the files for. This is required when the type == 'file'. Only one of path and files can be set. Path takes precedence if both are provided.

    Show application/json properties
    • idstring
      Required

      Unique identifier of the datasource

    • namestring

      Name of the datasource

    • typestring
      Required

      Can be one of: "file""web""database"

    • spaceIdstring

      The unique identifier of the space containing the datasource

    • chunkingobject
      Show chunking properties
      • sizeinteger
        Required

        Size of chunks

      • typestring
        Required

        Chunking strategy

      • overlapinteger
        Required

        Chunk overlap, should be less than size

      • separatorsarray of strings
        Required

        List of separators to chunk by

      • keepSeparatorboolean
        Required

        Allows to keep or remove separators used

    • syncInfoobject
      Show syncInfo properties
      • lastSyncIdstring

        sync Id

    • fileConfigobject

      Specification on where to fetch the files for. This is required when the type == 'file'. Only one of path and files can be set. Path takes precedence if both are provided.

      Show fileConfig properties
      • filesarray of strings
      • scopeobject

        Scope for the file crawler.

        Show scope properties
        • depthinteger
          Required

          The number of levels of sub folders that should be considered

        • maxSizeinteger

          Optional parameter. Max size of downloaded files in bytes

        • extensionsarray of strings

          list of file extensions to be considered

        • maxFilesTotalinteger

          Total number of files that should be considered

        • modifiedAfterstring

          only files modified after this time should be indexed. If set older files will be removed from index.

        • maxFilesPerFolderinteger

          Maximum number of files per folder that should be considered

      • folderstring

        Root folder for traversing.

      • userIdstring
        Required

        userId of the owner of the datasource fileConfig

      • connectionIdstring
        Required

        connection id to be used to retrieve the raw data

      • crawlPatternsarray of objects

        Pattern matching links to crawl

        Show crawlPatterns properties
        • typestring
          Required

          include or exclude

          Can be one of: "include""exclude"

        • patternstring
          Required

          Regex patterna to filter links on

    • sourceCountinteger

      The number of times that a datasource was referenced as a source in an answer

    • crawlerConfigobject

      Configuration for webcrawling

      Show crawlerConfig properties
      • urlstring
        Required

        Seed URL that crawling will start on.

      • scopeobject
        Required

        Scope for th webcrawler

        Show scope properties
        • depthinteger
          Required

          The number of levels of links the crawler will traverse

        • scopestring
          Required

          The scope that the crawler will crawl.

          Can be one of: "all""domain""subdomain"

        • maxSizeinteger

          Optional parameter. Max size of downloaded files in bytes

        • maxLinksinteger

          Maximum number of links per page that will be extracted

        • downloadFilesboolean

          if set to true crawler will try to download and index other supported content like pdf:s from links

      • crawlPatternsarray of objects

        Pattern matching links to crawl

        Show crawlPatterns properties
        • typestring
          Required

          include or exclude

          Can be one of: "include""exclude"

        • patternstring
          Required

          Regex patterna to filter links on

      • indexPatternsarray of objects

        Pattern matching links to index

        Show indexPatterns properties
        • typestring
          Required

          include or exclude

          Can be one of: "include""exclude"

        • patternstring
          Required

          Regex patterna to filter links on

    • contentSummaryobject
      Required
      Show contentSummary properties
      • fileSizeinteger
        Required
      • textSizeinteger
        Required
      • fileCountinteger
        Required
      • effectivePagesinteger
        Required

Responses

200

application/json

Successfully updated the datasource.

Specification on where to fetch the files for. This is required when the type == 'file'. Only one of path and files can be set. Path takes precedence if both are provided.

  • application/jsonobject

    Specification on where to fetch the files for. This is required when the type == 'file'. Only one of path and files can be set. Path takes precedence if both are provided.

    Show application/json properties
    • idstring
      Required

      Unique identifier of the datasource

    • namestring

      Name of the datasource

    • typestring
      Required

      Can be one of: "file""web""database"

    • spaceIdstring

      The unique identifier of the space containing the datasource

    • chunkingobject
      Show chunking properties
      • sizeinteger
        Required

        Size of chunks

      • typestring
        Required

        Chunking strategy

      • overlapinteger
        Required

        Chunk overlap, should be less than size

      • separatorsarray of strings
        Required

        List of separators to chunk by

      • keepSeparatorboolean
        Required

        Allows to keep or remove separators used

    • syncInfoobject
      Show syncInfo properties
      • statusstring
        Required

        Sync status

        Can be one of: "neverIndexed""progress""completed""completedWithError""toAdd""toDelete"

      • startedAtstring
        Required

        Datetime when the sync task was started

      • lastSyncIdstring

        sync Id

      • completedAtstring
        Required

        Datetime when the sync task was completed

    • fileConfigobject

      Specification on where to fetch the files for. This is required when the type == 'file'. Only one of path and files can be set. Path takes precedence if both are provided.

      Show fileConfig properties
      • filesarray of strings
      • scopeobject

        Scope for the file crawler.

        Show scope properties
        • depthinteger
          Required

          The number of levels of sub folders that should be considered

        • maxSizeinteger

          Optional parameter. Max size of downloaded files in bytes

        • extensionsarray of strings

          list of file extensions to be considered

        • maxFilesTotalinteger

          Total number of files that should be considered

        • modifiedAfterstring

          only files modified after this time should be indexed. If set older files will be removed from index.

        • maxFilesPerFolderinteger

          Maximum number of files per folder that should be considered

      • folderstring

        Root folder for traversing.

      • userIdstring
        Required

        userId of the owner of the datasource fileConfig

      • connectionIdstring
        Required

        connection id to be used to retrieve the raw data

      • crawlPatternsarray of objects

        Pattern matching links to crawl

        Show crawlPatterns properties
        • typestring
          Required

          include or exclude

          Can be one of: "include""exclude"

        • patternstring
          Required

          Regex patterna to filter links on

    • sourceCountinteger

      The number of times that a datasource was referenced as a source in an answer

    • crawlerConfigobject

      Configuration for webcrawling

      Show crawlerConfig properties
      • urlstring
        Required

        Seed URL that crawling will start on.

      • scopeobject
        Required

        Scope for th webcrawler

        Show scope properties
        • depthinteger
          Required

          The number of levels of links the crawler will traverse

        • scopestring
          Required

          The scope that the crawler will crawl.

          Can be one of: "all""domain""subdomain"

        • maxSizeinteger

          Optional parameter. Max size of downloaded files in bytes

        • maxLinksinteger

          Maximum number of links per page that will be extracted

        • downloadFilesboolean

          if set to true crawler will try to download and index other supported content like pdf:s from links

      • crawlPatternsarray of objects

        Pattern matching links to crawl

        Show crawlPatterns properties
        • typestring
          Required

          include or exclude

          Can be one of: "include""exclude"

        • patternstring
          Required

          Regex patterna to filter links on

      • indexPatternsarray of objects

        Pattern matching links to index

        Show indexPatterns properties
        • typestring
          Required

          include or exclude

          Can be one of: "include""exclude"

        • patternstring
          Required

          Regex patterna to filter links on

    • contentSummaryobject
      Required
      Show contentSummary properties
      • fileSizeinteger
        Required
      • textSizeinteger
        Required
      • fileCountinteger
        Required
      • effectivePagesinteger
        Required

400

application/json

The request is in incorrect format.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

403

application/json

The operation failed due to insufficient permissions.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

404

application/json

The record is not found

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
PUT /v1/knowledgebases/{id}/datasources/{datasourceId}
curl "https://your-tenant.us.qlikcloud.com/api/v1/knowledgebases/{id}/datasources/{datasourceId}" \
-X PUT \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"id":"f256b3e4-03e0-4f74-ae46-a4d43882ee5d","name":"string","type":"file","spaceId":"507f191e810c19729de860ea","chunking":{"size":1024,"type":"recursive","overlap":20,"separators":["\n","."," "],"keepSeparator":false},"syncInfo":{"lastSyncId":"f256b3e4-03e0-4f74-ae46-a4d43882ee5d"},"fileConfig":{"files":["string"],"scope":{"depth":1,"maxSize":1000000,"extensions":["pdf"],"maxFilesTotal":50,"modifiedAfter":"2021-10-02T14:20:50.52Z","maxFilesPerFolder":100},"folder":"folderA/folderB","userId":"507f191e810c19729de860ea","connectionId":"f256b3e4-03e0-4f74-ae46-a4d43882ee5d","crawlPatterns":[{"type":"include","pattern":"(.*)example(.*)"}]},"sourceCount":10,"crawlerConfig":{"url":"http://www.example.com","scope":{"depth":1,"scope":"all","maxSize":1000000,"maxLinks":100,"downloadFiles":false},"crawlPatterns":[{"type":"include","pattern":"(.*)example(.*)"}],"indexPatterns":[{"type":"include","pattern":"(.*)example(.*)"}]},"contentSummary":{"fileSize":42,"textSize":42,"fileCount":42,"effectivePages":42}}'
const https = require('https')
const data = JSON.stringify({"id":"f256b3e4-03e0-4f74-ae46-a4d43882ee5d","name":"string","type":"file","spaceId":"507f191e810c19729de860ea","chunking":{"size":1024,"type":"recursive","overlap":20,"separators":["\n","."," "],"keepSeparator":false},"syncInfo":{"lastSyncId":"f256b3e4-03e0-4f74-ae46-a4d43882ee5d"},"fileConfig":{"files":["string"],"scope":{"depth":1,"maxSize":1000000,"extensions":["pdf"],"maxFilesTotal":50,"modifiedAfter":"2021-10-02T14:20:50.52Z","maxFilesPerFolder":100},"folder":"folderA/folderB","userId":"507f191e810c19729de860ea","connectionId":"f256b3e4-03e0-4f74-ae46-a4d43882ee5d","crawlPatterns":[{"type":"include","pattern":"(.*)example(.*)"}]},"sourceCount":10,"crawlerConfig":{"url":"http://www.example.com","scope":{"depth":1,"scope":"all","maxSize":1000000,"maxLinks":100,"downloadFiles":false},"crawlPatterns":[{"type":"include","pattern":"(.*)example(.*)"}],"indexPatterns":[{"type":"include","pattern":"(.*)example(.*)"}]},"contentSummary":{"fileSize":42,"textSize":42,"fileCount":42,"effectivePages":42}})
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/knowledgebases/{id}/datasources/{datasourceId}',
'method': 'PUT',
'headers': {
'Content-type': 'application/json',
'Authorization': 'Bearer <access_token>'
}
}
const req = https.request(options)
req.write(data)
This API is not included yet in qlik-cli

Request

{
"id": "f256b3e4-03e0-4f74-ae46-a4d43882ee5d",
"name": "string",
"type": "file",
"spaceId": "507f191e810c19729de860ea",
"chunking": {
"size": 1024,
"type": "recursive",
"overlap": 20,
"separators": [
"\n",
".",
" "
],
"keepSeparator": false
},
"syncInfo": {
"lastSyncId": "f256b3e4-03e0-4f74-ae46-a4d43882ee5d"
},
"fileConfig": {
"files": [
"string"
],
"scope": {
"depth": 1,
"maxSize": 1000000,
"extensions": [
"pdf"
],
"maxFilesTotal": 50,
"modifiedAfter": "2021-10-02T14:20:50.52Z",
"maxFilesPerFolder": 100
},
"folder": "folderA/folderB",
"userId": "507f191e810c19729de860ea",
"connectionId": "f256b3e4-03e0-4f74-ae46-a4d43882ee5d",
"crawlPatterns": [
{
"type": "include",
"pattern": "(.*)example(.*)"
}
]
},
"sourceCount": 10,
"crawlerConfig": {
"url": "http://www.example.com",
"scope": {
"depth": 1,
"scope": "all",
"maxSize": 1000000,
"maxLinks": 100,
"downloadFiles": false
},
"crawlPatterns": [
{
"type": "include",
"pattern": "(.*)example(.*)"
}
],
"indexPatterns": [
{
"type": "include",
"pattern": "(.*)example(.*)"
}
]
},
"contentSummary": {
"fileSize": 42,
"textSize": 42,
"fileCount": 42,
"effectivePages": 42
}
}

Response

{
"id": "f256b3e4-03e0-4f74-ae46-a4d43882ee5d",
"name": "string",
"type": "file",
"spaceId": "507f191e810c19729de860ea",
"chunking": {
"size": 1024,
"type": "recursive",
"overlap": 20,
"separators": [
"\n",
".",
" "
],
"keepSeparator": false
},
"syncInfo": {
"status": "neverIndexed",
"startedAt": "2021-10-02T14:20:50.52Z",
"lastSyncId": "f256b3e4-03e0-4f74-ae46-a4d43882ee5d",
"completedAt": "2021-10-02T14:20:50.52Z"
},
"fileConfig": {
"files": [
"string"
],
"scope": {
"depth": 1,
"maxSize": 1000000,
"extensions": [
"pdf"
],
"maxFilesTotal": 50,
"modifiedAfter": "2021-10-02T14:20:50.52Z",
"maxFilesPerFolder": 100
},
"folder": "folderA/folderB",
"userId": "507f191e810c19729de860ea",
"connectionId": "f256b3e4-03e0-4f74-ae46-a4d43882ee5d",
"crawlPatterns": [
{
"type": "include",
"pattern": "(.*)example(.*)"
}
]
},
"sourceCount": 10,
"crawlerConfig": {
"url": "http://www.example.com",
"scope": {
"depth": 1,
"scope": "all",
"maxSize": 1000000,
"maxLinks": 100,
"downloadFiles": false
},
"crawlPatterns": [
{
"type": "include",
"pattern": "(.*)example(.*)"
}
],
"indexPatterns": [
{
"type": "include",
"pattern": "(.*)example(.*)"
}
]
},
"contentSummary": {
"fileSize": 42,
"textSize": 42,
"fileCount": 42,
"effectivePages": 42
}
}

Delete a knowledgebase datasource

Deletes a specified datasource and all its resources.

Facts

Rate limit Tier 2 (100 requests per minute)
Categories

Path Parameters

  • datasourceIdstring
    Required

    The id of the datasource to delete.

  • idstring
    Required

    The id of the knowledgebase the datasource belongs to.

Responses

204

Successful Operation.

400

application/json

The request is in incorrect format.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

403

application/json

The operation failed due to insufficient permissions.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

404

application/json

The knowledgebase is not found

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
DELETE /v1/knowledgebases/{id}/datasources/{datasourceId}
curl "https://your-tenant.us.qlikcloud.com/api/v1/knowledgebases/{id}/datasources/{datasourceId}" \
-X DELETE \
-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/knowledgebases/{id}/datasources/{datasourceId}',
'method': 'DELETE',
'headers': {
'Authorization': 'Bearer <access_token>'
}
}
const req = https.request(options)
This API is not included yet in qlik-cli

Cancel sync of a knowledgebase datasource

Cancels ongoing sync for a specified datasource.

Facts

Rate limit Tier 2 (100 requests per minute)
Categories

Path Parameters

  • datasourceIdstring
    Required

    The id of the datasource to cancel sync for.

  • idstring
    Required

    The id of the knowledgebase the datasource belongs to.

Responses

200

application/json

Successfully cancelled sync.

Response when a datasource sync is started, contains the sync Id

  • application/jsonobject

    Response when a datasource sync is started, contains the sync Id

    Show application/json properties
    • idstring
      Required

      Unique identifier of the sync

400

application/json

The request is in incorrect format.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

403

application/json

The user does not have privileges to perform the requested action.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

404

application/json

The resource does not exist.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
POST /v1/knowledgebases/{id}/datasources/{datasourceId}/actions/cancel
curl "https://your-tenant.us.qlikcloud.com/api/v1/knowledgebases/{id}/datasources/{datasourceId}/actions/cancel" \
-X POST \
-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/knowledgebases/{id}/datasources/{datasourceId}/actions/cancel',
'method': 'POST',
'headers': {
'Authorization': 'Bearer <access_token>'
}
}
const req = https.request(options)
This API is not included yet in qlik-cli

Response

{
"id": "f256b3e4-03e0-4f74-ae46-a4d43882ee5d"
}

Download knowledgebase datasource reference

Downloads a specified reference.

Facts

Rate limit Tier 2 (100 requests per minute)
Categories

Path Parameters

  • datasourceIdstring
    Required

    The id of the datasource to download from.

  • idstring
    Required

    The id of the knowledgebase the datasource belongs to.

Request Body

application/json

  • application/jsonobject
    Show application/json properties
    • pathstring
      Required

      file path to the file to downlaod.

Responses

200

application/json

Download a file from a datasource.

Download information for the file.

  • application/jsonobject

    Download information for the file.

    Show application/json properties
    • urlstring
      Required

      URL to download the file.

    • namestring
      Required

      The requested file name.

    • spaceIdstring
      Required

      Space id the file belongs in.

    • fileSizeinteger
      Required

      Size of downloaded file.

    • mimeTypestring
      Required

      The mimetype of the file.

    • lastUpdatedAtstring
      Required

      Date for last time the file was modified.

400

application/json

The request is in incorrect format.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

403

application/json

The user does not have privileges to perform the requested action.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

404

application/json

The resource does not exist.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
POST /v1/knowledgebases/{id}/datasources/{datasourceId}/actions/download
curl "https://your-tenant.us.qlikcloud.com/api/v1/knowledgebases/{id}/datasources/{datasourceId}/actions/download" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"path":"folder/file.pdf"}'
const https = require('https')
const data = JSON.stringify({"path":"folder/file.pdf"})
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/knowledgebases/{id}/datasources/{datasourceId}/actions/download',
'method': 'POST',
'headers': {
'Content-type': 'application/json',
'Authorization': 'Bearer <access_token>'
}
}
const req = https.request(options)
req.write(data)
This API is not included yet in qlik-cli

Request

{
"path": "folder/file.pdf"
}

Response

{
"url": "/v1/temp-contents/65f4287d785c400fe6d1e861",
"name": "stories/content/billy.txt",
"spaceId": "507f191e810c19729de860ea",
"fileSize": 542,
"mimeType": "text/plain",
"lastUpdatedAt": "2020-04-16T23:17:28Z"
}

Sync a knowledgebase datasource

Starts syncing a specified datasource to a specified knowledgebase index.

Facts

Rate limit Tier 2 (100 requests per minute)
Categories

Query Parameters

  • migrateboolean

    Optional parameter to migrate indexed files to docdetails collection

Path Parameters

  • datasourceIdstring
    Required

    The id of the datasource to sync.

  • idstring
    Required

    The id of the knowledgebase the datasource belongs to.

Responses

202

application/json

Successfully started sync.

Response when a datasource sync is started, contains the sync Id

  • application/jsonobject

    Response when a datasource sync is started, contains the sync Id

    Show application/json properties
    • idstring
      Required

      Unique identifier of the sync

400

application/json

The request is in incorrect format.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

403

application/json

The user does not have privileges to perform the requested action.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

404

application/json

The resource does not exist.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
POST /v1/knowledgebases/{id}/datasources/{datasourceId}/actions/sync
curl "https://your-tenant.us.qlikcloud.com/api/v1/knowledgebases/{id}/datasources/{datasourceId}/actions/sync" \
-X POST \
-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/knowledgebases/{id}/datasources/{datasourceId}/actions/sync',
'method': 'POST',
'headers': {
'Authorization': 'Bearer <access_token>'
}
}
const req = https.request(options)
This API is not included yet in qlik-cli

Response

{
"id": "f256b3e4-03e0-4f74-ae46-a4d43882ee5d"
}

List knowledgebase datasource sync histories

Retrieves sync history for a specified datasource in a knowledgebase. Returns a 404 if there is no sync history, or if the calling user doesn't have access to the datasource.

Facts

Rate limit Tier 1 (1000 requests per minute)
Categories

Query Parameters

  • limitinteger

    The number of knowledgebases to get.

  • nextstring

    Optional parameter to request the next page.

  • prevstring

    Optional parameter to request the previous page.

  • sortstring

    Optional resource field name to sort on, case insensitive, eg. name. Can be prefixed with - to set descending order, defaults to ascending.

    Can be one of: "COMPLETED""-COMPLETED"

Path Parameters

  • datasourceIdstring
    Required

    The id of the datasource.

  • idstring
    Required

    The id of the knowledgebase the datasource belongs to.

Responses

200

application/json

List of sync items ordered by the completed time.

  • application/jsonobject
    Show application/json properties
    • dataarray of objects
      Required
      Show data properties
      • idstring
        Required

        sync id

      • statusstring
        Required

        Sync status

        Can be one of: "neverIndexed""progress""completed""completedWithError"

      • docStatsobject
        Required

        Summary of documents processed

        Show docStats properties
        • addedinteger
          Required
        • errorsinteger
          Required
        • deletedinteger
          Required
        • updatedinteger
          Required
        • deltaBytesinteger
          Required
        • deltaTextSizeinteger
          Required
        • largestFileSizeinteger
          Required
        • deltaEffectivePagesinteger
          Required
        • totalBytesProcessedinteger
          Required
      • startedAtstring
        Required

        Datetime when the sync task was started

      • completedAtstring

        Datetime when the sync task was completed

      • triggerTypestring
        Required

        Datasource trigger type, was it manually or automatically synced

      • connectionIdstring
        Required

        Connection id that the datasource used

      • datasourceIdstring
        Required

        datasource id

      • selectedErrorsarray of strings

        populated with up to the first selectedErrorsCount errors if there were any during sync

    • metaobject
      Show meta properties
      • countTotalinteger
    • linksobject
      Show links properties
      • nextobject
        Show next properties
        • hrefstring
      • prevobject
        Show prev properties
        • hrefstring
      • selfobject
        Show self properties
        • hrefstring

400

application/json

The request is in incorrect format.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

403

application/json

The user does not have privileges to perform the requested action.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

404

application/json

The datasource is not found, the datasource has no sync history (no syncs have been run), or the calling user doesn't have access to this datasource in the knowledgebase.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
GET /v1/knowledgebases/{id}/datasources/{datasourceId}/histories
curl "https://your-tenant.us.qlikcloud.com/api/v1/knowledgebases/{id}/datasources/{datasourceId}/histories" \
-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/knowledgebases/{id}/datasources/{datasourceId}/histories',
'method': 'GET',
'headers': {
'Authorization': 'Bearer <access_token>'
}
}
const req = https.request(options)
This API is not included yet in qlik-cli

Response

{
"data": [
{
"id": "f256b3e4-03e0-4f74-ae46-a4d43882ee5d",
"status": [
"neverIndexed | progress | completed | completedWithError"
],
"docStats": {
"added": 1,
"errors": 0,
"deleted": 0,
"updated": 0,
"deltaBytes": 0,
"deltaTextSize": 0,
"largestFileSize": 123044444,
"deltaEffectivePages": 0,
"totalBytesProcessed": 123044444
},
"startedAt": "2021-10-02T14:20:50.52Z",
"completedAt": "2021-10-02T14:20:50.52Z",
"triggerType": [
"manual | schedule"
],
"connectionId": "ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc",
"datasourceId": "f256b3e4-03e0-4f74-ae46-a4d43882ee5d",
"selectedErrors": [
"unsupported file extension"
]
}
],
"meta": {
"countTotal": 42
},
"links": {
"next": {
"href": "string"
},
"prev": {
"href": "string"
},
"self": {
"href": "string"
}
}
}

Retrieve a knowledgebase datasource sync history

Deprecated

Retrieves detailed sync history for a specified datasource.

Facts

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

Path Parameters

  • datasourceIdstring
    Required

    The id of the datasource.

  • idstring
    Required

    The id of the knowledgebase the datasource belongs to.

  • syncIdstring
    Required

    The sync identifier.

Responses

200

application/json

List of sync items ordered by the start time.

  • application/jsonobject
    Show application/json properties
    • idstring
      Required

      document Id

    • errorstring

      error if one happened during sync

    • actionstring
      Required

      acion performed

      Can be one of: "add""delete""update"

    • chunksinteger

      number of chunks

    • sourcestring
      Required

      Source of the document

    • syncIdstring
      Required

      sync Id

    • durationobject
      Show duration properties
      • chunkinteger
        Required
      • embedinteger
        Required
      • parseinteger
        Required
      • storeinteger
        Required
      • downloadinteger
        Required
    • fileSizeinteger

      file size

    • syncedAtstring
      Required

      Datetime when the sync task was executed

    • chunkSizeinteger

      chunk size

    • explicitPagesinteger
      Required

      page count

    • fileStartedAtstring

      Datetime when the file processing started

    • fileCompletedAtstring

      Datetime when the file processing finished

    • fileLastModifiedstring

      Datetime when the file was last modified

400

application/json

The request is in incorrect format.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

403

application/json

The user does not have privileges to perform the requested action.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

404

application/json

The resource does not exist.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
GET /v1/knowledgebases/{id}/datasources/{datasourceId}/histories/{syncId}
curl "https://your-tenant.us.qlikcloud.com/api/v1/knowledgebases/{id}/datasources/{datasourceId}/histories/{syncId}" \
-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/knowledgebases/{id}/datasources/{datasourceId}/histories/{syncId}',
'method': 'GET',
'headers': {
'Authorization': 'Bearer <access_token>'
}
}
const req = https.request(options)
This API is not included yet in qlik-cli

Response

{
"id": "f256b3e4-03e0-4f74-ae46-a4d43882ee5d",
"error": "unsupported file extension",
"action": "add",
"chunks": 10,
"source": "myfile.pdf",
"syncId": "f256b3e4-03e0-4f74-ae46-a4d43882ee5d",
"duration": {
"chunk": 0,
"embed": 996,
"parse": 0,
"store": 3653363805,
"download": 207
},
"fileSize": 123044444,
"syncedAt": "2021-10-02T14:20:50.52Z",
"chunkSize": 14721,
"explicitPages": 42,
"fileStartedAt": "2021-10-02T14:20:50.52Z",
"fileCompletedAt": "2021-10-02T14:21:50.52Z",
"fileLastModified": "2024-02-16T20:06:02Z"
}

Get a knowledgebase datasource schedule

Returns a datasource schedule.

Facts

Rate limit Tier 1 (1000 requests per minute)
Categories

Path Parameters

  • datasourceIdstring
    Required

    The id of the datasource the schedule belongs to.

  • idstring
    Required

    The id of the knowledgebase the schedule belongs to.

Responses

200

application/json

Successfully created a schedule.

  • application/jsonobject
    Show application/json properties
    • ownerIdstring
      Required
    • spaceIdstring
    • tenantIdstring
      Required
    • calendarsarray of objects
      Required

      An event specification relative to the calendar, similar to a traditional cron specification.

      Show calendars properties
      • hourarray of objects
        Required

        Hour range to match (0-23). Default matches 0

        Show hour properties
        • endinteger

          End of the range (inclusive). If end < start, then end is interpreted as equal to start. Optional, defaulted to Start

        • stepinteger

          Step to be take between each value. Optional, defaulted to 1

        • startinteger
          Required

          Start of the range (inclusive)

      • yeararray of objects
        Required

        Year range to match. Default matches all years

        Show year properties
        • endinteger

          End of the range (inclusive). If end < start, then end is interpreted as equal to start. Optional, defaulted to Start

        • stepinteger

          Step to be take between each value. Optional, defaulted to 1

        • startinteger
          Required

          Start of the range (inclusive)

      • montharray of objects
        Required

        Month range to match (1-12). Default matches all months

        Show month properties
        • endinteger

          End of the range (inclusive). If end < start, then end is interpreted as equal to start. Optional, defaulted to Start

        • stepinteger

          Step to be take between each value. Optional, defaulted to 1

        • startinteger
          Required

          Start of the range (inclusive)

      • minutearray of objects
        Required

        Minute range to match (0-59). Default matches 0

        Show minute properties
        • endinteger

          End of the range (inclusive). If end < start, then end is interpreted as equal to start. Optional, defaulted to Start

        • stepinteger

          Step to be take between each value. Optional, defaulted to 1

        • startinteger
          Required

          Start of the range (inclusive)

      • secondarray of objects
        Required

        Second range to match (0-59). Default matches 0

        Show second properties
        • endinteger

          End of the range (inclusive). If end < start, then end is interpreted as equal to start. Optional, defaulted to Start

        • stepinteger

          Step to be take between each value. Optional, defaulted to 1

        • startinteger
          Required

          Start of the range (inclusive)

      • commentstring
        Required

        Description of the intention of this schedule

      • dayOfWeekarray of objects
        Required

        DayOfWeek range to match (0-6; 0 is Sunday). Default matches all days of the week

        Show dayOfWeek properties
        • endinteger

          End of the range (inclusive). If end < start, then end is interpreted as equal to start. Optional, defaulted to Start

        • stepinteger

          Step to be take between each value. Optional, defaulted to 1

        • startinteger
          Required

          Start of the range (inclusive)

      • dayOfMontharray of objects
        Required

        DayOfMonth range to match (1-31). Default matches all days

        Show dayOfMonth properties
        • endinteger

          End of the range (inclusive). If end < start, then end is interpreted as equal to start. Optional, defaulted to Start

        • stepinteger

          Step to be take between each value. Optional, defaulted to 1

        • startinteger
          Required

          Start of the range (inclusive)

    • intervalsarray of objects

      For example, an every of 1 hour with offset of zero would match every hour, on the hour. The same every but an offset of 19 minutes would match every xx:19:00.

      Show intervals properties
      • everystring
        Required

        The period to repeat the interval

      • offsetstring

        A fixed offset added to the intervals period. Optional, defaults to 0

    • datasourceIdstring
    • knowledgebaseIdstring
      Required

400

application/json

The request is in incorrect format.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

403

application/json

The user does not have privileges to perform the requested action.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

404

application/json

The resource does not exist.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
GET /v1/knowledgebases/{id}/datasources/{datasourceId}/schedules
curl "https://your-tenant.us.qlikcloud.com/api/v1/knowledgebases/{id}/datasources/{datasourceId}/schedules" \
-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/knowledgebases/{id}/datasources/{datasourceId}/schedules',
'method': 'GET',
'headers': {
'Authorization': 'Bearer <access_token>'
}
}
const req = https.request(options)
This API is not included yet in qlik-cli

Response

{
"ownerId": "507f191e810c19729de860ed",
"spaceId": "507f191e810c19729de860ec",
"tenantId": "507f191e810c19729de860eb",
"calendars": [
{
"hour": [
{
"end": 42,
"step": 1,
"start": 42
}
],
"year": [
{
"end": 42,
"step": 1,
"start": 42
}
],
"month": [
{
"end": 42,
"step": 1,
"start": 42
}
],
"minute": [
{
"end": 42,
"step": 1,
"start": 42
}
],
"second": [
{
"end": 42,
"step": 1,
"start": 42
}
],
"comment": "string",
"dayOfWeek": [
{
"end": 42,
"step": 1,
"start": 42
}
],
"dayOfMonth": [
{
"end": 42,
"step": 1,
"start": 42
}
]
}
],
"intervals": [
{
"every": "5h30m",
"offset": "0s"
}
],
"datasourceId": "f256b3e4-03e0-4f74-ae46-a4d43882ee5d",
"knowledgebaseId": "f256b3e4-03e0-4f74-ae46-a4d43882ee5d"
}

Create a knowledgebase datasource schedule

Creates or updates a specified datasource schedule.

Facts

Rate limit Tier 2 (100 requests per minute)
Categories

Path Parameters

  • datasourceIdstring
    Required

    The id of the datasource the schedule belongs to.

  • idstring
    Required

    The id of the knowledgebase the schedule belongs to.

Request Body

application/json

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

      An event specification relative to the calendar, similar to a traditional cron specification.

      Show calendars properties
      • hourarray of objects
        Required

        Hour range to match (0-23). Default matches 0

        Show hour properties
        • endinteger

          End of the range (inclusive). If end < start, then end is interpreted as equal to start. Optional, defaulted to Start

        • stepinteger

          Step to be take between each value. Optional, defaulted to 1

        • startinteger
          Required

          Start of the range (inclusive)

      • yeararray of objects
        Required

        Year range to match. Default matches all years

        Show year properties
        • endinteger

          End of the range (inclusive). If end < start, then end is interpreted as equal to start. Optional, defaulted to Start

        • stepinteger

          Step to be take between each value. Optional, defaulted to 1

        • startinteger
          Required

          Start of the range (inclusive)

      • montharray of objects
        Required

        Month range to match (1-12). Default matches all months

        Show month properties
        • endinteger

          End of the range (inclusive). If end < start, then end is interpreted as equal to start. Optional, defaulted to Start

        • stepinteger

          Step to be take between each value. Optional, defaulted to 1

        • startinteger
          Required

          Start of the range (inclusive)

      • minutearray of objects
        Required

        Minute range to match (0-59). Default matches 0

        Show minute properties
        • endinteger

          End of the range (inclusive). If end < start, then end is interpreted as equal to start. Optional, defaulted to Start

        • stepinteger

          Step to be take between each value. Optional, defaulted to 1

        • startinteger
          Required

          Start of the range (inclusive)

      • secondarray of objects
        Required

        Second range to match (0-59). Default matches 0

        Show second properties
        • endinteger

          End of the range (inclusive). If end < start, then end is interpreted as equal to start. Optional, defaulted to Start

        • stepinteger

          Step to be take between each value. Optional, defaulted to 1

        • startinteger
          Required

          Start of the range (inclusive)

      • commentstring
        Required

        Description of the intention of this schedule

      • dayOfWeekarray of objects
        Required

        DayOfWeek range to match (0-6; 0 is Sunday). Default matches all days of the week

        Show dayOfWeek properties
        • endinteger

          End of the range (inclusive). If end < start, then end is interpreted as equal to start. Optional, defaulted to Start

        • stepinteger

          Step to be take between each value. Optional, defaulted to 1

        • startinteger
          Required

          Start of the range (inclusive)

      • dayOfMontharray of objects
        Required

        DayOfMonth range to match (1-31). Default matches all days

        Show dayOfMonth properties
        • endinteger

          End of the range (inclusive). If end < start, then end is interpreted as equal to start. Optional, defaulted to Start

        • stepinteger

          Step to be take between each value. Optional, defaulted to 1

        • startinteger
          Required

          Start of the range (inclusive)

    • intervalsarray of objects

      For example, an every of 1 hour with offset of zero would match every hour, on the hour. The same every but an offset of 19 minutes would match every xx:19:00.

      Show intervals properties
      • everystring
        Required

        The period to repeat the interval

      • offsetstring

        A fixed offset added to the intervals period. Optional, defaults to 0

Responses

200

application/json

Successfully created a schedule.

  • application/jsonobject
    Show application/json properties
    • ownerIdstring
      Required
    • spaceIdstring
    • tenantIdstring
      Required
    • calendarsarray of objects
      Required

      An event specification relative to the calendar, similar to a traditional cron specification.

      Show calendars properties
      • hourarray of objects
        Required

        Hour range to match (0-23). Default matches 0

        Show hour properties
        • endinteger

          End of the range (inclusive). If end < start, then end is interpreted as equal to start. Optional, defaulted to Start

        • stepinteger

          Step to be take between each value. Optional, defaulted to 1

        • startinteger
          Required

          Start of the range (inclusive)

      • yeararray of objects
        Required

        Year range to match. Default matches all years

        Show year properties
        • endinteger

          End of the range (inclusive). If end < start, then end is interpreted as equal to start. Optional, defaulted to Start

        • stepinteger

          Step to be take between each value. Optional, defaulted to 1

        • startinteger
          Required

          Start of the range (inclusive)

      • montharray of objects
        Required

        Month range to match (1-12). Default matches all months

        Show month properties
        • endinteger

          End of the range (inclusive). If end < start, then end is interpreted as equal to start. Optional, defaulted to Start

        • stepinteger

          Step to be take between each value. Optional, defaulted to 1

        • startinteger
          Required

          Start of the range (inclusive)

      • minutearray of objects
        Required

        Minute range to match (0-59). Default matches 0

        Show minute properties
        • endinteger

          End of the range (inclusive). If end < start, then end is interpreted as equal to start. Optional, defaulted to Start

        • stepinteger

          Step to be take between each value. Optional, defaulted to 1

        • startinteger
          Required

          Start of the range (inclusive)

      • secondarray of objects
        Required

        Second range to match (0-59). Default matches 0

        Show second properties
        • endinteger

          End of the range (inclusive). If end < start, then end is interpreted as equal to start. Optional, defaulted to Start

        • stepinteger

          Step to be take between each value. Optional, defaulted to 1

        • startinteger
          Required

          Start of the range (inclusive)

      • commentstring
        Required

        Description of the intention of this schedule

      • dayOfWeekarray of objects
        Required

        DayOfWeek range to match (0-6; 0 is Sunday). Default matches all days of the week

        Show dayOfWeek properties
        • endinteger

          End of the range (inclusive). If end < start, then end is interpreted as equal to start. Optional, defaulted to Start

        • stepinteger

          Step to be take between each value. Optional, defaulted to 1

        • startinteger
          Required

          Start of the range (inclusive)

      • dayOfMontharray of objects
        Required

        DayOfMonth range to match (1-31). Default matches all days

        Show dayOfMonth properties
        • endinteger

          End of the range (inclusive). If end < start, then end is interpreted as equal to start. Optional, defaulted to Start

        • stepinteger

          Step to be take between each value. Optional, defaulted to 1

        • startinteger
          Required

          Start of the range (inclusive)

    • intervalsarray of objects

      For example, an every of 1 hour with offset of zero would match every hour, on the hour. The same every but an offset of 19 minutes would match every xx:19:00.

      Show intervals properties
      • everystring
        Required

        The period to repeat the interval

      • offsetstring

        A fixed offset added to the intervals period. Optional, defaults to 0

    • datasourceIdstring
    • knowledgebaseIdstring
      Required

201

application/json

Successfully created a schedule.

  • application/jsonobject
    Show application/json properties
    • ownerIdstring
      Required
    • spaceIdstring
    • tenantIdstring
      Required
    • calendarsarray of objects
      Required

      An event specification relative to the calendar, similar to a traditional cron specification.

      Show calendars properties
      • hourarray of objects
        Required

        Hour range to match (0-23). Default matches 0

        Show hour properties
        • endinteger

          End of the range (inclusive). If end < start, then end is interpreted as equal to start. Optional, defaulted to Start

        • stepinteger

          Step to be take between each value. Optional, defaulted to 1

        • startinteger
          Required

          Start of the range (inclusive)

      • yeararray of objects
        Required

        Year range to match. Default matches all years

        Show year properties
        • endinteger

          End of the range (inclusive). If end < start, then end is interpreted as equal to start. Optional, defaulted to Start

        • stepinteger

          Step to be take between each value. Optional, defaulted to 1

        • startinteger
          Required

          Start of the range (inclusive)

      • montharray of objects
        Required

        Month range to match (1-12). Default matches all months

        Show month properties
        • endinteger

          End of the range (inclusive). If end < start, then end is interpreted as equal to start. Optional, defaulted to Start

        • stepinteger

          Step to be take between each value. Optional, defaulted to 1

        • startinteger
          Required

          Start of the range (inclusive)

      • minutearray of objects
        Required

        Minute range to match (0-59). Default matches 0

        Show minute properties
        • endinteger

          End of the range (inclusive). If end < start, then end is interpreted as equal to start. Optional, defaulted to Start

        • stepinteger

          Step to be take between each value. Optional, defaulted to 1

        • startinteger
          Required

          Start of the range (inclusive)

      • secondarray of objects
        Required

        Second range to match (0-59). Default matches 0

        Show second properties
        • endinteger

          End of the range (inclusive). If end < start, then end is interpreted as equal to start. Optional, defaulted to Start

        • stepinteger

          Step to be take between each value. Optional, defaulted to 1

        • startinteger
          Required

          Start of the range (inclusive)

      • commentstring
        Required

        Description of the intention of this schedule

      • dayOfWeekarray of objects
        Required

        DayOfWeek range to match (0-6; 0 is Sunday). Default matches all days of the week

        Show dayOfWeek properties
        • endinteger

          End of the range (inclusive). If end < start, then end is interpreted as equal to start. Optional, defaulted to Start

        • stepinteger

          Step to be take between each value. Optional, defaulted to 1

        • startinteger
          Required

          Start of the range (inclusive)

      • dayOfMontharray of objects
        Required

        DayOfMonth range to match (1-31). Default matches all days

        Show dayOfMonth properties
        • endinteger

          End of the range (inclusive). If end < start, then end is interpreted as equal to start. Optional, defaulted to Start

        • stepinteger

          Step to be take between each value. Optional, defaulted to 1

        • startinteger
          Required

          Start of the range (inclusive)

    • intervalsarray of objects

      For example, an every of 1 hour with offset of zero would match every hour, on the hour. The same every but an offset of 19 minutes would match every xx:19:00.

      Show intervals properties
      • everystring
        Required

        The period to repeat the interval

      • offsetstring

        A fixed offset added to the intervals period. Optional, defaults to 0

    • datasourceIdstring
    • knowledgebaseIdstring
      Required

400

application/json

The request is in incorrect format.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

403

application/json

The user does not have privileges to perform the requested action.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

404

application/json

The resource does not exist.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
POST /v1/knowledgebases/{id}/datasources/{datasourceId}/schedules
curl "https://your-tenant.us.qlikcloud.com/api/v1/knowledgebases/{id}/datasources/{datasourceId}/schedules" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"calendars":[{"hour":[{"end":42,"step":1,"start":42}],"year":[{"end":42,"step":1,"start":42}],"month":[{"end":42,"step":1,"start":42}],"minute":[{"end":42,"step":1,"start":42}],"second":[{"end":42,"step":1,"start":42}],"comment":"string","dayOfWeek":[{"end":42,"step":1,"start":42}],"dayOfMonth":[{"end":42,"step":1,"start":42}]}],"intervals":[{"every":"5h30m","offset":"0s"}]}'
const https = require('https')
const data = JSON.stringify({"calendars":[{"hour":[{"end":42,"step":1,"start":42}],"year":[{"end":42,"step":1,"start":42}],"month":[{"end":42,"step":1,"start":42}],"minute":[{"end":42,"step":1,"start":42}],"second":[{"end":42,"step":1,"start":42}],"comment":"string","dayOfWeek":[{"end":42,"step":1,"start":42}],"dayOfMonth":[{"end":42,"step":1,"start":42}]}],"intervals":[{"every":"5h30m","offset":"0s"}]})
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/knowledgebases/{id}/datasources/{datasourceId}/schedules',
'method': 'POST',
'headers': {
'Content-type': 'application/json',
'Authorization': 'Bearer <access_token>'
}
}
const req = https.request(options)
req.write(data)
This API is not included yet in qlik-cli

Request

{
"calendars": [
{
"hour": [
{
"end": 42,
"step": 1,
"start": 42
}
],
"year": [
{
"end": 42,
"step": 1,
"start": 42
}
],
"month": [
{
"end": 42,
"step": 1,
"start": 42
}
],
"minute": [
{
"end": 42,
"step": 1,
"start": 42
}
],
"second": [
{
"end": 42,
"step": 1,
"start": 42
}
],
"comment": "string",
"dayOfWeek": [
{
"end": 42,
"step": 1,
"start": 42
}
],
"dayOfMonth": [
{
"end": 42,
"step": 1,
"start": 42
}
]
}
],
"intervals": [
{
"every": "5h30m",
"offset": "0s"
}
]
}

Response

{
"ownerId": "507f191e810c19729de860ed",
"spaceId": "507f191e810c19729de860ec",
"tenantId": "507f191e810c19729de860eb",
"calendars": [
{
"hour": [
{
"end": 42,
"step": 1,
"start": 42
}
],
"year": [
{
"end": 42,
"step": 1,
"start": 42
}
],
"month": [
{
"end": 42,
"step": 1,
"start": 42
}
],
"minute": [
{
"end": 42,
"step": 1,
"start": 42
}
],
"second": [
{
"end": 42,
"step": 1,
"start": 42
}
],
"comment": "string",
"dayOfWeek": [
{
"end": 42,
"step": 1,
"start": 42
}
],
"dayOfMonth": [
{
"end": 42,
"step": 1,
"start": 42
}
]
}
],
"intervals": [
{
"every": "5h30m",
"offset": "0s"
}
],
"datasourceId": "f256b3e4-03e0-4f74-ae46-a4d43882ee5d",
"knowledgebaseId": "f256b3e4-03e0-4f74-ae46-a4d43882ee5d"
}

Delete knowledgebase datasource schedule

Deletes a datasource schedule.

Facts

Rate limit Tier 2 (100 requests per minute)
Categories

Path Parameters

  • datasourceIdstring
    Required

    The id of the datasource the schedule belongs to.

  • idstring
    Required

    The id of the knowledgebase the schedule belongs to.

Responses

204

Successfully deleted a schedule.

400

application/json

The request is in incorrect format.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

403

application/json

The user does not have privileges to perform the requested action.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

404

application/json

The resource does not exist.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
DELETE /v1/knowledgebases/{id}/datasources/{datasourceId}/schedules
curl "https://your-tenant.us.qlikcloud.com/api/v1/knowledgebases/{id}/datasources/{datasourceId}/schedules" \
-X DELETE \
-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/knowledgebases/{id}/datasources/{datasourceId}/schedules',
'method': 'DELETE',
'headers': {
'Authorization': 'Bearer <access_token>'
}
}
const req = https.request(options)
This API is not included yet in qlik-cli

Retrieve knowledgebase sync history

Retrieves sync history for the specified knowledgebase. Will return a 404 if no sync history exists, or if the calling user does not have access to synced datasources.

Facts

Rate limit Tier 1 (1000 requests per minute)
Categories

Query Parameters

  • limitinteger

    The number of sync histories to get.

  • nextstring

    Optional parameter to request the next page.

  • prevstring

    Optional parameter to request the previous page.

  • sortstring

    Optional resource field name to sort on, case insensitive, eg. name. Can be prefixed with - to set descending order, defaults to ascending.

    Can be one of: "COMPLETED""-COMPLETED"

Path Parameters

  • idstring
    Required

    The id of the knowledgebase.

Responses

200

application/json

List of sync items ordered by the completed time.

  • application/jsonobject
    Show application/json properties
    • dataarray of objects
      Required
      Show data properties
      • idstring
        Required

        sync id

      • statusstring
        Required

        Sync status

        Can be one of: "neverIndexed""progress""completed""completedWithError"

      • docStatsobject
        Required

        Summary of documents processed

        Show docStats properties
        • addedinteger
          Required
        • errorsinteger
          Required
        • deletedinteger
          Required
        • updatedinteger
          Required
        • deltaBytesinteger
          Required
        • deltaTextSizeinteger
          Required
        • largestFileSizeinteger
          Required
        • deltaEffectivePagesinteger
          Required
        • totalBytesProcessedinteger
          Required
      • startedAtstring
        Required

        Datetime when the sync task was started

      • completedAtstring

        Datetime when the sync task was completed

      • triggerTypestring
        Required

        Datasource trigger type, was it manually or automatically synced

      • connectionIdstring
        Required

        Connection id that the datasource used

      • datasourceIdstring
        Required

        datasource id

      • selectedErrorsarray of strings

        populated with up to the first selectedErrorsCount errors if there were any during sync

    • metaobject
      Show meta properties
      • countTotalinteger
    • linksobject
      Show links properties
      • nextobject
        Show next properties
        • hrefstring
      • prevobject
        Show prev properties
        • hrefstring
      • selfobject
        Show self properties
        • hrefstring

400

application/json

The request is in incorrect format.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

403

application/json

The user does not have privileges to perform the requested action.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

404

application/json

The knowledgebase is not found, the knowledgebase has no sync history, or the calling user doesn't have access to the datasources in the knowledgebase.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
GET /v1/knowledgebases/{id}/histories
curl "https://your-tenant.us.qlikcloud.com/api/v1/knowledgebases/{id}/histories" \
-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/knowledgebases/{id}/histories',
'method': 'GET',
'headers': {
'Authorization': 'Bearer <access_token>'
}
}
const req = https.request(options)
This API is not included yet in qlik-cli

Response

{
"data": [
{
"id": "f256b3e4-03e0-4f74-ae46-a4d43882ee5d",
"status": [
"neverIndexed | progress | completed | completedWithError"
],
"docStats": {
"added": 1,
"errors": 0,
"deleted": 0,
"updated": 0,
"deltaBytes": 0,
"deltaTextSize": 0,
"largestFileSize": 123044444,
"deltaEffectivePages": 0,
"totalBytesProcessed": 123044444
},
"startedAt": "2021-10-02T14:20:50.52Z",
"completedAt": "2021-10-02T14:20:50.52Z",
"triggerType": [
"manual | schedule"
],
"connectionId": "ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc",
"datasourceId": "f256b3e4-03e0-4f74-ae46-a4d43882ee5d",
"selectedErrors": [
"unsupported file extension"
]
}
],
"meta": {
"countTotal": 42
},
"links": {
"next": {
"href": "string"
},
"prev": {
"href": "string"
},
"self": {
"href": "string"
}
}
}