Extensions

Extensions is a powerful capability in Qlik Sense which allows third-party visualizations and other presentation objects to be used in the Qlik Sense client.

Endpoints

Skip to section
GET/extensions
POST/extensions
GET/extensions/{id}
PATCH/extensions/{id}
DELETE/extensions/{id}
GET/extensions/{id}/file
GET/extensions/{id}/file/{filepath}

Lists all extensions.

Responses GET /extensions

200
application/json

OK. Lists all extensions.

GET/extensions

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

Response GET /extensions

{
  "data": [
    {
      "id": "string",
      "tenantId": "string",
      "userId": "string",
      "type": "string",
      "name": "string",
      "qextFilename": "string",
      "qextVersion": "string",
      "description": "string",
      "version": "string",
      "author": "string",
      "supplier": "string",
      "homepage": "string",
      "keywords": "string",
      "license": "string",
      "repository": "string",
      "dependencies": {},
      "icon": "string",
      "tags": [],
      "preview": "string",
      "checksum": "string",
      "bundled": true,
      "deprecated": "2021-06-18T08:27:34.724Z",
      "bundle": {
        "id": "string",
        "name": "string",
        "description": "string"
      },
      "supernova": true,
      "file": {},
      "createdAt": "2021-06-18T08:27:34.724Z",
      "updateAt": "2021-06-18T08:27:34.724Z"
    }
  ]
}

Creates a new extension. If a file is provided, the data field is not required.

Request Body POST /extensions

data
multipart/form-data

The extension model.

file
multipart/form-data
string<binary>

Extension archive.

Responses POST /extensions

201
application/json

Created. Creates a new extension and returns it.

409
application/json

Conflict. Resource with same unique identity already exists.

415
application/json

Unsupported media type. Body of the payload is not a valid JSON object.

422
application/json

Unprocessable entity. Validation error.

default
application/json

Unexpected error.

POST/extensions

curl "https://your-tenant.us.qlikcloud.com/api/v1/extensions" \
 -X POST \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: multipart/form-data" \
 -F "file=@/path/to/file" \
 -d '{"id":"string","tenantId":"string","userId":"string","type":"string","name":"string","qextFilename":"string","qextVersion":"string","description":"string","version":"string","author":"string","supplier":"string","homepage":"string","keywords":"string","license":"string","repository":"string","dependencies":{},"icon":"string","tags":[],"preview":"string","checksum":"string","bundled":true,"deprecated":"2021-06-18T08:27:34.725Z","bundle":{"id":"string","name":"string","description":"string"},"supernova":true,"file":{},"createdAt":"2021-06-18T08:27:34.725Z","updateAt":"2021-06-18T08:27:34.725Z"}'

Request POST /extensions

{
  "id": "string",
  "tenantId": "string",
  "userId": "string",
  "type": "string",
  "name": "string",
  "qextFilename": "string",
  "qextVersion": "string",
  "description": "string",
  "version": "string",
  "author": "string",
  "supplier": "string",
  "homepage": "string",
  "keywords": "string",
  "license": "string",
  "repository": "string",
  "dependencies": {},
  "icon": "string",
  "tags": [],
  "preview": "string",
  "checksum": "string",
  "bundled": true,
  "deprecated": "2021-06-18T08:27:34.725Z",
  "bundle": {
    "id": "string",
    "name": "string",
    "description": "string"
  },
  "supernova": true,
  "file": {},
  "createdAt": "2021-06-18T08:27:34.725Z",
  "updateAt": "2021-06-18T08:27:34.725Z"
}

Response POST /extensions

{
  "id": "string",
  "tenantId": "string",
  "userId": "string",
  "type": "string",
  "name": "string",
  "qextFilename": "string",
  "qextVersion": "string",
  "description": "string",
  "version": "string",
  "author": "string",
  "supplier": "string",
  "homepage": "string",
  "keywords": "string",
  "license": "string",
  "repository": "string",
  "dependencies": {},
  "icon": "string",
  "tags": [],
  "preview": "string",
  "checksum": "string",
  "bundled": true,
  "deprecated": "2021-06-18T08:27:34.725Z",
  "bundle": {
    "id": "string",
    "name": "string",
    "description": "string"
  },
  "supernova": true,
  "file": {},
  "createdAt": "2021-06-18T08:27:34.725Z",
  "updateAt": "2021-06-18T08:27:34.725Z"
}

Returns a specific extension.

Path Parameters GET /extensions/{id}

id
string

Extension identifier or its qextFilename.

Responses GET /extensions/{id}

200
application/json

OK. Returns extension with {id}.

403
application/json

Forbidden. User is not authorized to read extension with {id}.

404
application/json

Not found. Could not find the extension with {id}.

410
application/json

Gone. Extension with {id} has been deleted.

GET/extensions/{id}

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

Response GET /extensions/{id}

{
  "id": "string",
  "tenantId": "string",
  "userId": "string",
  "type": "string",
  "name": "string",
  "qextFilename": "string",
  "qextVersion": "string",
  "description": "string",
  "version": "string",
  "author": "string",
  "supplier": "string",
  "homepage": "string",
  "keywords": "string",
  "license": "string",
  "repository": "string",
  "dependencies": {},
  "icon": "string",
  "tags": [],
  "preview": "string",
  "checksum": "string",
  "bundled": true,
  "deprecated": "2021-06-18T08:27:34.725Z",
  "bundle": {
    "id": "string",
    "name": "string",
    "description": "string"
  },
  "supernova": true,
  "file": {},
  "createdAt": "2021-06-18T08:27:34.725Z",
  "updateAt": "2021-06-18T08:27:34.725Z"
}

Updates a specific extension with provided data. If a file is provided, the data field is not required.

Path Parameters PATCH /extensions/{id}

id
string

Extension identifier or its qextFilename.

Request Body PATCH /extensions/{id}

data
multipart/form-data

The extension model.

file
multipart/form-data
string<binary>

Extension archive.

Responses PATCH /extensions/{id}

200
application/json

OK. Extension has been updated.

403
application/json

Forbidden. User is not authorized to update extension with {id}.

404
application/json

Not found. Could not find the extension with {id}.

409
application/json

Conflict. Resource with same unique identity already exists.

415
application/json

Unsupported media type. Body of the payload is not a valid JSON object.

422
application/json

Unprocessable entity. Validation error.

default
application/json

Unexpected error.

PATCH/extensions/{id}

curl "https://your-tenant.us.qlikcloud.com/api/v1/extensions/{id}" \
 -X PATCH \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: multipart/form-data" \
 -F "file=@/path/to/file" \
 -d '{"id":"string","tenantId":"string","userId":"string","type":"string","name":"string","qextFilename":"string","qextVersion":"string","description":"string","version":"string","author":"string","supplier":"string","homepage":"string","keywords":"string","license":"string","repository":"string","dependencies":{},"icon":"string","tags":[],"preview":"string","checksum":"string","bundled":true,"deprecated":"2021-06-18T08:27:34.726Z","bundle":{"id":"string","name":"string","description":"string"},"supernova":true,"file":{},"createdAt":"2021-06-18T08:27:34.726Z","updateAt":"2021-06-18T08:27:34.726Z"}'

Request PATCH /extensions/{id}

{
  "id": "string",
  "tenantId": "string",
  "userId": "string",
  "type": "string",
  "name": "string",
  "qextFilename": "string",
  "qextVersion": "string",
  "description": "string",
  "version": "string",
  "author": "string",
  "supplier": "string",
  "homepage": "string",
  "keywords": "string",
  "license": "string",
  "repository": "string",
  "dependencies": {},
  "icon": "string",
  "tags": [],
  "preview": "string",
  "checksum": "string",
  "bundled": true,
  "deprecated": "2021-06-18T08:27:34.726Z",
  "bundle": {
    "id": "string",
    "name": "string",
    "description": "string"
  },
  "supernova": true,
  "file": {},
  "createdAt": "2021-06-18T08:27:34.726Z",
  "updateAt": "2021-06-18T08:27:34.726Z"
}

Response PATCH /extensions/{id}

{
  "data": [
    {
      "id": "string",
      "tenantId": "string",
      "userId": "string",
      "type": "string",
      "name": "string",
      "qextFilename": "string",
      "qextVersion": "string",
      "description": "string",
      "version": "string",
      "author": "string",
      "supplier": "string",
      "homepage": "string",
      "keywords": "string",
      "license": "string",
      "repository": "string",
      "dependencies": {},
      "icon": "string",
      "tags": [],
      "preview": "string",
      "checksum": "string",
      "bundled": true,
      "deprecated": "2021-06-18T08:27:34.726Z",
      "bundle": {
        "id": "string",
        "name": "string",
        "description": "string"
      },
      "supernova": true,
      "file": {},
      "createdAt": "2021-06-18T08:27:34.726Z",
      "updateAt": "2021-06-18T08:27:34.726Z"
    }
  ]
}

Deletes a specific extension.

Path Parameters DELETE /extensions/{id}

id
string

Extension identifier or its qextFilename.

Responses DELETE /extensions/{id}

204
object

No content. Soft deletes the extension.

403
application/json

Forbidden. User is not authorized to delete extension with {id}.

404
application/json

Not found. Could not find the extension with {id}.

410
application/json

Gone. Extension with {id} has been deleted.

DELETE/extensions/{id}

curl "https://your-tenant.us.qlikcloud.com/api/v1/extensions/{id}" \
 -X DELETE \
 -H "Authorization: Bearer <API-key>"

Downloads the extension as an archive.

Path Parameters GET /extensions/{id}/file

id
string

Extension identifier or its qextFilename.

Responses GET /extensions/{id}/file

200
object

OK. Extension exists. Returns the extension archive.

403
application/json

Forbidden. User is not authorized to read extension with {id}.

404
application/json

Not found. Could not find the extension with {id}.

410
application/json

Gone. Extension with {id} has been deleted.

GET/extensions/{id}/file

curl "https://your-tenant.us.qlikcloud.com/api/v1/extensions/{id}/file" \
 -H "Authorization: Bearer <API-key>"

Downloads a file from the extension archive.

Path Parameters GET /extensions/{id}/file/{filepath}

id
string

Extension identifier or its qextFilename.

filepath
string

Path to the file archive for the specified extension archive. Folders separated with forward slashes.

Responses GET /extensions/{id}/file/{filepath}

200
object

OK. Extension exists and the file specified exists. Returns the specific file.

403
application/json

Forbidden. User is not authorized to read extension with {id}.

404
application/json

Not found. Could not find the extension with {id} or the file does not exist in the archive.

410
application/json

Gone. Extension with {id} has been deleted.

GET/extensions/{id}/file/{filepath}

curl "https://your-tenant.us.qlikcloud.com/api/v1/extensions/{id}/file/{filepath}" \
 -H "Authorization: Bearer <API-key>"

extensions

object

Properties

data

No description

extension

object

The extension model.

Properties

id
string

No description

tenantId
string

No description

userId
string

No description

type
string

The type of this extension (visualization, etc.).

name
string

The display name of this extension.

qextFilename
string

The name of the qext file that was uploaded with this extension.

qextVersion
string

The version from the qext file that was uploaded with this extension.

description
string

Description of the extension.

version
string

Version of the extension.

author
string

Author of the extension.

supplier
string

Supplier of the extension.

homepage
string

Home page of the extension.

keywords
string

Keywords for the extension.

license
string

Under which license this extension is published.

repository
string

Link to the extension source code.

dependencies
object

Map of dependencies describing version of the component it requires.

icon
string

Icon to show in the client.

tags
Array<string>

List of tags.

preview
string

Path to an image that enables users to preview the extension.

checksum
string

Checksum of the extension contents.

bundled
boolean

If the extension is part of an extension bundle.

deprecated
string<date>

A date noting when the extension was deprecated.

bundle

Object containing meta data regarding the bundle the extension belongs to. If it does not belong to a bundle, this object is not defined.

supernova
boolean

If the extension is a supernova extension or not.

file
object

The file that was uploaded with the extension.

createdAt
string<date>

No description

updateAt
string<date>

No description

themes

object

Properties

data

No description

theme

object

The theme model.

Properties

id
string

No description

tenantId
string

No description

userId
string

No description

type
string

The type of this theme (visualization, etc.).

name
string

The display name of this theme.

qextFilename
string

The name of the qext file that was uploaded with this theme.

qextVersion
string

The version from the qext file that was uploaded with this extension.

description
string

Description of the theme.

version
string

Version of the theme.

author
string

Author of the theme.

supplier
string

Supplier of the theme.

homepage
string

Home page of the theme.

keywords
string

Keywords for the theme.

license
string

Under which license this theme is published.

repository
string

Link to the theme source code.

dependencies
object

Map of dependencies describing version of the component it requires.

icon
string

Icon to show in the client.

tags
Array<string>

List of tags.

file
object

The file that was uploaded with the theme.

createdAt
string<date>

No description

updateAt
string<date>

No description

error

An error object.

Properties

status
optional
number

The HTTP status code.

title
string

Title of the HTTP status code.

meta
optional

Object containing meta data regarding an error. It does not necessarily contain all the properties.

source
optional
object

Optional JSON patch object pointing to an invalid property.

meta

Object containing meta data regarding an error. It does not necessarily contain all the properties.

Properties

resourceName
string

Name of the resource related to the error. If there is a conflict, it is the name of the model attempting to be created.

message
string

A more detailed message explaining the error.

stack
string

Full stack trace of the error that was raised.

bundleMeta

Object containing meta data regarding the bundle the extension belongs to. If it does not belong to a bundle, this object is not defined.

Properties

id
string

Unique identifier of the bundle.

name
string

Name of the bundle.

description
string

Description of the bundle.

v4.0.2
Was this page helpful?