Extensions
Visualization extensions is a capability in Qlik Sense which allows third-party visualizations and other presentation objects to be used in the Qlik Sense client.
Lists all imported extensions in the tenant.
Facts
Rate limit | Tier 1 (1000 requests per minute) |
Categories | extend |
Responses
200
application/json
OK. Lists all extensions.
- application/jsonobject
application/json properties
- dataarray of objectsRequired
The extension model.
data properties
- idstring
- fileobject
The file that was uploaded with the extension.
- iconstring
Icon to show in the client.
- namestring
The display name of this extension.
- tagsarray of strings
List of tags.
- typestring
The type of this extension (visualization, etc.).
- authorstring
Author of the extension.
- bundleobject
Object containing meta data regarding the bundle the extension belongs to. If it does not belong to a bundle, this object is not defined.
bundle properties
- idstring
Unique identifier of the bundle.
- namestring
Name of the bundle.
- descriptionstring
Description of the bundle.
-
- userIdstring
- bundledboolean
If the extension is part of an extension bundle.
- licensestring
Under which license this extension is published.
- previewstring
Path to an image that enables users to preview the extension.
- versionstring
Version of the extension.
- checksumstring
Checksum of the extension contents.
- homepagestring
Home page of the extension.
- keywordsstring
Keywords for the extension.
- loadpathstring
Relative path to the extension's entry file, defaults to
filename
from the qext file. - supplierstring
Supplier of the extension.
- tenantIdstring
- updateAtstring
- createdAtstring
- supernovaboolean
If the extension is a supernova extension or not.
- deprecatedstring
A date noting when the extension was deprecated.
- repositorystring
Link to the extension source code.
- descriptionstring
Description of the extension.
- qextVersionstring
The version from the qext file that was uploaded with this extension.
- dependenciesobject
Map of dependencies describing version of the component it requires.
- qextFilenamestring
The name of the qext file that was uploaded with this extension.
-
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/extensions" \
-H "Authorization: Bearer <API-key>"
const https = require('https')
const data = JSON.stringify("")
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/extensions',
'method': 'GET',
'headers': {
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
qlik extension ls
Response
{
"data": [
{
"id": "string",
"file": {},
"icon": "string",
"name": "string",
"tags": [
"string"
],
"type": "string",
"author": "string",
"bundle": {
"id": "string",
"name": "string",
"description": "string"
},
"userId": "string",
"bundled": true,
"license": "string",
"preview": "string",
"version": "string",
"checksum": "string",
"homepage": "string",
"keywords": "string",
"loadpath": "string",
"supplier": "string",
"tenantId": "string",
"updateAt": "string",
"createdAt": "string",
"supernova": true,
"deprecated": "string",
"repository": "string",
"description": "string",
"qextVersion": "string",
"dependencies": {},
"qextFilename": "string"
}
]
}
Creates a new extension. Accepts either provided file or data object. The name of the new extension must be different to any existing extensions.
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories | extend |
Request Body
Requiredmultipart/form-data
- multipart/form-dataobject
multipart/form-data properties
- dataobject
The extension model.
data properties
- fileobject
The file that was uploaded with the extension.
- iconstring
Icon to show in the client.
- namestring
The display name of this extension.
- tagsarray of strings
List of tags.
- typestring
The type of this extension (visualization, etc.).
- authorstring
Author of the extension.
- bundleobject
Object containing meta data regarding the bundle the extension belongs to. If it does not belong to a bundle, this object is not defined.
bundle properties
- idstring
Unique identifier of the bundle.
- namestring
Name of the bundle.
- descriptionstring
Description of the bundle.
-
- bundledboolean
If the extension is part of an extension bundle.
- licensestring
Under which license this extension is published.
- previewstring
Path to an image that enables users to preview the extension.
- versionstring
Version of the extension.
- checksumstring
Checksum of the extension contents.
- homepagestring
Home page of the extension.
- keywordsstring
Keywords for the extension.
- loadpathstring
Relative path to the extension's entry file, defaults to
filename
from the qext file. - supplierstring
Supplier of the extension.
- supernovaboolean
If the extension is a supernova extension or not.
- deprecatedstring
A date noting when the extension was deprecated.
- repositorystring
Link to the extension source code.
- descriptionstring
Description of the extension.
- qextVersionstring
The version from the qext file that was uploaded with this extension.
- dependenciesobject
Map of dependencies describing version of the component it requires.
- qextFilenamestring
The name of the qext file that was uploaded with this extension.
-
- filestring
Extension archive.
-
Responses
201
application/json
Created. Creates a new extension and returns it.
The extension model.
- application/jsonobject
The extension model.
application/json properties
- idstring
- fileobject
The file that was uploaded with the extension.
- iconstring
Icon to show in the client.
- namestring
The display name of this extension.
- tagsarray of strings
List of tags.
- typestring
The type of this extension (visualization, etc.).
- authorstring
Author of the extension.
- bundleobject
Object containing meta data regarding the bundle the extension belongs to. If it does not belong to a bundle, this object is not defined.
bundle properties
- idstring
Unique identifier of the bundle.
- namestring
Name of the bundle.
- descriptionstring
Description of the bundle.
-
- userIdstring
- bundledboolean
If the extension is part of an extension bundle.
- licensestring
Under which license this extension is published.
- previewstring
Path to an image that enables users to preview the extension.
- versionstring
Version of the extension.
- checksumstring
Checksum of the extension contents.
- homepagestring
Home page of the extension.
- keywordsstring
Keywords for the extension.
- loadpathstring
Relative path to the extension's entry file, defaults to
filename
from the qext file. - supplierstring
Supplier of the extension.
- tenantIdstring
- updateAtstring
- createdAtstring
- supernovaboolean
If the extension is a supernova extension or not.
- deprecatedstring
A date noting when the extension was deprecated.
- repositorystring
Link to the extension source code.
- descriptionstring
Description of the extension.
- qextVersionstring
The version from the qext file that was uploaded with this extension.
- dependenciesobject
Map of dependencies describing version of the component it requires.
- qextFilenamestring
The name of the qext file that was uploaded with this extension.
-
409
application/json
Conflict. Resource with same unique identity already exists.
An error object.
- application/jsonobject
An error object.
application/json properties
- metaobject
Object containing meta data regarding an error. It does not necessarily contain all the properties.
meta properties
- stackstring
Full stack trace of the error that was raised.
- messagestring
A more detailed message explaining the error.
- resourceNamestring
Name of the resource related to the error. If there is a conflict, it is the name of the model attempting to be created.
-
- titlestringRequired
Title of the HTTP status code.
- sourceobject
Optional JSON patch object pointing to an invalid property.
- statusnumber
The HTTP status code.
-
415
application/json
Unsupported media type. Body of the payload is not a valid JSON object.
An error object.
- application/jsonobject
An error object.
application/json properties
- metaobject
Object containing meta data regarding an error. It does not necessarily contain all the properties.
meta properties
- stackstring
Full stack trace of the error that was raised.
- messagestring
A more detailed message explaining the error.
- resourceNamestring
Name of the resource related to the error. If there is a conflict, it is the name of the model attempting to be created.
-
- titlestringRequired
Title of the HTTP status code.
- sourceobject
Optional JSON patch object pointing to an invalid property.
- statusnumber
The HTTP status code.
-
422
application/json
Unprocessable entity. Validation error.
An error object.
- application/jsonobject
An error object.
application/json properties
- metaobject
Object containing meta data regarding an error. It does not necessarily contain all the properties.
meta properties
- stackstring
Full stack trace of the error that was raised.
- messagestring
A more detailed message explaining the error.
- resourceNamestring
Name of the resource related to the error. If there is a conflict, it is the name of the model attempting to be created.
-
- titlestringRequired
Title of the HTTP status code.
- sourceobject
Optional JSON patch object pointing to an invalid property.
- statusnumber
The HTTP status code.
-
default
application/json
Unexpected error.
An error object.
- application/jsonobject
An error object.
application/json properties
- metaobject
Object containing meta data regarding an error. It does not necessarily contain all the properties.
meta properties
- stackstring
Full stack trace of the error that was raised.
- messagestring
A more detailed message explaining the error.
- resourceNamestring
Name of the resource related to the error. If there is a conflict, it is the name of the model attempting to be created.
-
- titlestringRequired
Title of the HTTP status code.
- sourceobject
Optional JSON patch object pointing to an invalid property.
- statusnumber
The HTTP status code.
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/extensions" \
-X POST \
-H "Content-type: multipart/form-data" \
-H "Authorization: Bearer <API-key>" \
-F "data={\"id\":\"string\",\"file\":{},\"icon\":\"string\",\"name\":\"string\",\"tags\":[\"string\"],\"type\":\"string\",\"author\":\"string\",\"bundle\":{\"id\":\"string\",\"name\":\"string\",\"description\":\"string\"},\"userId\":\"string\",\"bundled\":true,\"license\":\"string\",\"preview\":\"string\",\"version\":\"string\",\"checksum\":\"string\",\"homepage\":\"string\",\"keywords\":\"string\",\"loadpath\":\"string\",\"supplier\":\"string\",\"tenantId\":\"string\",\"updateAt\":\"string\",\"createdAt\":\"string\",\"supernova\":true,\"deprecated\":\"string\",\"repository\":\"string\",\"description\":\"string\",\"qextVersion\":\"string\",\"dependencies\":{},\"qextFilename\":\"string\"}" \
-F "file=@/path/to/file"
const https = require('https')
const data = JSON.stringify({"data":{"file":{},"icon":"string","name":"string","tags":["string"],"type":"string","author":"string","bundle":{"id":"string","name":"string","description":"string"},"bundled":true,"license":"string","preview":"string","version":"string","checksum":"string","homepage":"string","keywords":"string","loadpath":"string","supplier":"string","supernova":true,"deprecated":"string","repository":"string","description":"string","qextVersion":"string","dependencies":{},"qextFilename":"string"},"file":"string"})
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/extensions',
'method': 'POST',
'headers': {
'Content-type': 'multipart/form-data',
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
req.write(formData)
qlik extension create \
--file="string"
Request
{
"data": {
"file": {},
"icon": "string",
"name": "string",
"tags": [
"string"
],
"type": "string",
"author": "string",
"bundle": {
"id": "string",
"name": "string",
"description": "string"
},
"bundled": true,
"license": "string",
"preview": "string",
"version": "string",
"checksum": "string",
"homepage": "string",
"keywords": "string",
"loadpath": "string",
"supplier": "string",
"supernova": true,
"deprecated": "string",
"repository": "string",
"description": "string",
"qextVersion": "string",
"dependencies": {},
"qextFilename": "string"
},
"file": "string"
}
Response
{
"id": "string",
"file": {},
"icon": "string",
"name": "string",
"tags": [
"string"
],
"type": "string",
"author": "string",
"bundle": {
"id": "string",
"name": "string",
"description": "string"
},
"userId": "string",
"bundled": true,
"license": "string",
"preview": "string",
"version": "string",
"checksum": "string",
"homepage": "string",
"keywords": "string",
"loadpath": "string",
"supplier": "string",
"tenantId": "string",
"updateAt": "string",
"createdAt": "string",
"supernova": true,
"deprecated": "string",
"repository": "string",
"description": "string",
"qextVersion": "string",
"dependencies": {},
"qextFilename": "string"
}
Returns a specific extension matching either extension ID or extension name.
Facts
Rate limit | Tier 1 (1000 requests per minute) |
Categories | extend |
Path Parameters
- idstringRequired
Extension identifier or its qextFilename.
Responses
200
application/json
OK. Returns extension with {id}.
The extension model.
- application/jsonobject
The extension model.
application/json properties
- idstring
- fileobject
The file that was uploaded with the extension.
- iconstring
Icon to show in the client.
- namestring
The display name of this extension.
- tagsarray of strings
List of tags.
- typestring
The type of this extension (visualization, etc.).
- authorstring
Author of the extension.
- bundleobject
Object containing meta data regarding the bundle the extension belongs to. If it does not belong to a bundle, this object is not defined.
bundle properties
- idstring
Unique identifier of the bundle.
- namestring
Name of the bundle.
- descriptionstring
Description of the bundle.
-
- userIdstring
- bundledboolean
If the extension is part of an extension bundle.
- licensestring
Under which license this extension is published.
- previewstring
Path to an image that enables users to preview the extension.
- versionstring
Version of the extension.
- checksumstring
Checksum of the extension contents.
- homepagestring
Home page of the extension.
- keywordsstring
Keywords for the extension.
- loadpathstring
Relative path to the extension's entry file, defaults to
filename
from the qext file. - supplierstring
Supplier of the extension.
- tenantIdstring
- updateAtstring
- createdAtstring
- supernovaboolean
If the extension is a supernova extension or not.
- deprecatedstring
A date noting when the extension was deprecated.
- repositorystring
Link to the extension source code.
- descriptionstring
Description of the extension.
- qextVersionstring
The version from the qext file that was uploaded with this extension.
- dependenciesobject
Map of dependencies describing version of the component it requires.
- qextFilenamestring
The name of the qext file that was uploaded with this extension.
-
403
application/json
Forbidden. User is not authorized to read extension with {id}.
An error object.
- application/jsonobject
An error object.
application/json properties
- metaobject
Object containing meta data regarding an error. It does not necessarily contain all the properties.
meta properties
- stackstring
Full stack trace of the error that was raised.
- messagestring
A more detailed message explaining the error.
- resourceNamestring
Name of the resource related to the error. If there is a conflict, it is the name of the model attempting to be created.
-
- titlestringRequired
Title of the HTTP status code.
- sourceobject
Optional JSON patch object pointing to an invalid property.
- statusnumber
The HTTP status code.
-
404
application/json
Not found. Could not find the extension with {id}.
An error object.
- application/jsonobject
An error object.
application/json properties
- metaobject
Object containing meta data regarding an error. It does not necessarily contain all the properties.
meta properties
- stackstring
Full stack trace of the error that was raised.
- messagestring
A more detailed message explaining the error.
- resourceNamestring
Name of the resource related to the error. If there is a conflict, it is the name of the model attempting to be created.
-
- titlestringRequired
Title of the HTTP status code.
- sourceobject
Optional JSON patch object pointing to an invalid property.
- statusnumber
The HTTP status code.
-
410
application/json
Gone. Extension with {id} has been deleted.
An error object.
- application/jsonobject
An error object.
application/json properties
- metaobject
Object containing meta data regarding an error. It does not necessarily contain all the properties.
meta properties
- stackstring
Full stack trace of the error that was raised.
- messagestring
A more detailed message explaining the error.
- resourceNamestring
Name of the resource related to the error. If there is a conflict, it is the name of the model attempting to be created.
-
- titlestringRequired
Title of the HTTP status code.
- sourceobject
Optional JSON patch object pointing to an invalid property.
- statusnumber
The HTTP status code.
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/extensions/{id}" \
-H "Authorization: Bearer <API-key>"
const https = require('https')
const data = JSON.stringify("")
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/extensions/{id}',
'method': 'GET',
'headers': {
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
qlik extension get <extensionId>
Response
{
"id": "string",
"file": {},
"icon": "string",
"name": "string",
"tags": [
"string"
],
"type": "string",
"author": "string",
"bundle": {
"id": "string",
"name": "string",
"description": "string"
},
"userId": "string",
"bundled": true,
"license": "string",
"preview": "string",
"version": "string",
"checksum": "string",
"homepage": "string",
"keywords": "string",
"loadpath": "string",
"supplier": "string",
"tenantId": "string",
"updateAt": "string",
"createdAt": "string",
"supernova": true,
"deprecated": "string",
"repository": "string",
"description": "string",
"qextVersion": "string",
"dependencies": {},
"qextFilename": "string"
}
Updates a specific extension matching either extension ID or extension name. Accepts either provided file or data object.
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories | extend |
Path Parameters
- idstringRequired
Extension identifier or its qextFilename.
Request Body
Requiredmultipart/form-data
- multipart/form-dataobject
multipart/form-data properties
- dataobject
The extension model.
data properties
- fileobject
The file that was uploaded with the extension.
- iconstring
Icon to show in the client.
- namestring
The display name of this extension.
- tagsarray of strings
List of tags.
- typestring
The type of this extension (visualization, etc.).
- authorstring
Author of the extension.
- bundleobject
Object containing meta data regarding the bundle the extension belongs to. If it does not belong to a bundle, this object is not defined.
bundle properties
- idstring
Unique identifier of the bundle.
- namestring
Name of the bundle.
- descriptionstring
Description of the bundle.
-
- bundledboolean
If the extension is part of an extension bundle.
- licensestring
Under which license this extension is published.
- previewstring
Path to an image that enables users to preview the extension.
- versionstring
Version of the extension.
- checksumstring
Checksum of the extension contents.
- homepagestring
Home page of the extension.
- keywordsstring
Keywords for the extension.
- loadpathstring
Relative path to the extension's entry file, defaults to
filename
from the qext file. - supplierstring
Supplier of the extension.
- supernovaboolean
If the extension is a supernova extension or not.
- deprecatedstring
A date noting when the extension was deprecated.
- repositorystring
Link to the extension source code.
- descriptionstring
Description of the extension.
- qextVersionstring
The version from the qext file that was uploaded with this extension.
- dependenciesobject
Map of dependencies describing version of the component it requires.
- qextFilenamestring
The name of the qext file that was uploaded with this extension.
-
- filestring
Extension archive.
-
Responses
200
application/json
OK. Extension has been updated.
The extension model.
- application/jsonobject
The extension model.
application/json properties
- idstring
- fileobject
The file that was uploaded with the extension.
- iconstring
Icon to show in the client.
- namestring
The display name of this extension.
- tagsarray of strings
List of tags.
- typestring
The type of this extension (visualization, etc.).
- authorstring
Author of the extension.
- bundleobject
Object containing meta data regarding the bundle the extension belongs to. If it does not belong to a bundle, this object is not defined.
bundle properties
- idstring
Unique identifier of the bundle.
- namestring
Name of the bundle.
- descriptionstring
Description of the bundle.
-
- userIdstring
- bundledboolean
If the extension is part of an extension bundle.
- licensestring
Under which license this extension is published.
- previewstring
Path to an image that enables users to preview the extension.
- versionstring
Version of the extension.
- checksumstring
Checksum of the extension contents.
- homepagestring
Home page of the extension.
- keywordsstring
Keywords for the extension.
- loadpathstring
Relative path to the extension's entry file, defaults to
filename
from the qext file. - supplierstring
Supplier of the extension.
- tenantIdstring
- updateAtstring
- createdAtstring
- supernovaboolean
If the extension is a supernova extension or not.
- deprecatedstring
A date noting when the extension was deprecated.
- repositorystring
Link to the extension source code.
- descriptionstring
Description of the extension.
- qextVersionstring
The version from the qext file that was uploaded with this extension.
- dependenciesobject
Map of dependencies describing version of the component it requires.
- qextFilenamestring
The name of the qext file that was uploaded with this extension.
-
403
application/json
Forbidden. User is not authorized to update extension with {id}.
An error object.
- application/jsonobject
An error object.
application/json properties
- metaobject
Object containing meta data regarding an error. It does not necessarily contain all the properties.
meta properties
- stackstring
Full stack trace of the error that was raised.
- messagestring
A more detailed message explaining the error.
- resourceNamestring
Name of the resource related to the error. If there is a conflict, it is the name of the model attempting to be created.
-
- titlestringRequired
Title of the HTTP status code.
- sourceobject
Optional JSON patch object pointing to an invalid property.
- statusnumber
The HTTP status code.
-
404
application/json
Not found. Could not find the extension with {id}.
An error object.
- application/jsonobject
An error object.
application/json properties
- metaobject
Object containing meta data regarding an error. It does not necessarily contain all the properties.
meta properties
- stackstring
Full stack trace of the error that was raised.
- messagestring
A more detailed message explaining the error.
- resourceNamestring
Name of the resource related to the error. If there is a conflict, it is the name of the model attempting to be created.
-
- titlestringRequired
Title of the HTTP status code.
- sourceobject
Optional JSON patch object pointing to an invalid property.
- statusnumber
The HTTP status code.
-
409
application/json
Conflict. Resource with same unique identity already exists.
An error object.
- application/jsonobject
An error object.
application/json properties
- metaobject
Object containing meta data regarding an error. It does not necessarily contain all the properties.
meta properties
- stackstring
Full stack trace of the error that was raised.
- messagestring
A more detailed message explaining the error.
- resourceNamestring
Name of the resource related to the error. If there is a conflict, it is the name of the model attempting to be created.
-
- titlestringRequired
Title of the HTTP status code.
- sourceobject
Optional JSON patch object pointing to an invalid property.
- statusnumber
The HTTP status code.
-
415
application/json
Unsupported media type. Body of the payload is not a valid JSON object.
An error object.
- application/jsonobject
An error object.
application/json properties
- metaobject
Object containing meta data regarding an error. It does not necessarily contain all the properties.
meta properties
- stackstring
Full stack trace of the error that was raised.
- messagestring
A more detailed message explaining the error.
- resourceNamestring
Name of the resource related to the error. If there is a conflict, it is the name of the model attempting to be created.
-
- titlestringRequired
Title of the HTTP status code.
- sourceobject
Optional JSON patch object pointing to an invalid property.
- statusnumber
The HTTP status code.
-
422
application/json
Unprocessable entity. Validation error.
An error object.
- application/jsonobject
An error object.
application/json properties
- metaobject
Object containing meta data regarding an error. It does not necessarily contain all the properties.
meta properties
- stackstring
Full stack trace of the error that was raised.
- messagestring
A more detailed message explaining the error.
- resourceNamestring
Name of the resource related to the error. If there is a conflict, it is the name of the model attempting to be created.
-
- titlestringRequired
Title of the HTTP status code.
- sourceobject
Optional JSON patch object pointing to an invalid property.
- statusnumber
The HTTP status code.
-
default
application/json
Unexpected error.
An error object.
- application/jsonobject
An error object.
application/json properties
- metaobject
Object containing meta data regarding an error. It does not necessarily contain all the properties.
meta properties
- stackstring
Full stack trace of the error that was raised.
- messagestring
A more detailed message explaining the error.
- resourceNamestring
Name of the resource related to the error. If there is a conflict, it is the name of the model attempting to be created.
-
- titlestringRequired
Title of the HTTP status code.
- sourceobject
Optional JSON patch object pointing to an invalid property.
- statusnumber
The HTTP status code.
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/extensions/{id}" \
-X PATCH \
-H "Content-type: multipart/form-data" \
-H "Authorization: Bearer <API-key>" \
-F "data={\"id\":\"string\",\"file\":{},\"icon\":\"string\",\"name\":\"string\",\"tags\":[\"string\"],\"type\":\"string\",\"author\":\"string\",\"bundle\":{\"id\":\"string\",\"name\":\"string\",\"description\":\"string\"},\"userId\":\"string\",\"bundled\":true,\"license\":\"string\",\"preview\":\"string\",\"version\":\"string\",\"checksum\":\"string\",\"homepage\":\"string\",\"keywords\":\"string\",\"loadpath\":\"string\",\"supplier\":\"string\",\"tenantId\":\"string\",\"updateAt\":\"string\",\"createdAt\":\"string\",\"supernova\":true,\"deprecated\":\"string\",\"repository\":\"string\",\"description\":\"string\",\"qextVersion\":\"string\",\"dependencies\":{},\"qextFilename\":\"string\"}" \
-F "file=@/path/to/file"
const https = require('https')
const data = JSON.stringify({"data":{"file":{},"icon":"string","name":"string","tags":["string"],"type":"string","author":"string","bundle":{"id":"string","name":"string","description":"string"},"bundled":true,"license":"string","preview":"string","version":"string","checksum":"string","homepage":"string","keywords":"string","loadpath":"string","supplier":"string","supernova":true,"deprecated":"string","repository":"string","description":"string","qextVersion":"string","dependencies":{},"qextFilename":"string"},"file":"string"})
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/extensions/{id}',
'method': 'PATCH',
'headers': {
'Content-type': 'multipart/form-data',
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
req.write(formData)
qlik extension patch <extensionId> \
--file="string"
Request
{
"data": {
"file": {},
"icon": "string",
"name": "string",
"tags": [
"string"
],
"type": "string",
"author": "string",
"bundle": {
"id": "string",
"name": "string",
"description": "string"
},
"bundled": true,
"license": "string",
"preview": "string",
"version": "string",
"checksum": "string",
"homepage": "string",
"keywords": "string",
"loadpath": "string",
"supplier": "string",
"supernova": true,
"deprecated": "string",
"repository": "string",
"description": "string",
"qextVersion": "string",
"dependencies": {},
"qextFilename": "string"
},
"file": "string"
}
Response
{
"id": "string",
"file": {},
"icon": "string",
"name": "string",
"tags": [
"string"
],
"type": "string",
"author": "string",
"bundle": {
"id": "string",
"name": "string",
"description": "string"
},
"userId": "string",
"bundled": true,
"license": "string",
"preview": "string",
"version": "string",
"checksum": "string",
"homepage": "string",
"keywords": "string",
"loadpath": "string",
"supplier": "string",
"tenantId": "string",
"updateAt": "string",
"createdAt": "string",
"supernova": true,
"deprecated": "string",
"repository": "string",
"description": "string",
"qextVersion": "string",
"dependencies": {},
"qextFilename": "string"
}
Deletes a specific extension matching either extension ID or extension name.
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories | extend |
Path Parameters
- idstringRequired
Extension identifier or its qextFilename.
Responses
204
No content. Soft deletes the extension.
403
application/json
Forbidden. User is not authorized to delete extension with {id}.
An error object.
- application/jsonobject
An error object.
application/json properties
- metaobject
Object containing meta data regarding an error. It does not necessarily contain all the properties.
meta properties
- stackstring
Full stack trace of the error that was raised.
- messagestring
A more detailed message explaining the error.
- resourceNamestring
Name of the resource related to the error. If there is a conflict, it is the name of the model attempting to be created.
-
- titlestringRequired
Title of the HTTP status code.
- sourceobject
Optional JSON patch object pointing to an invalid property.
- statusnumber
The HTTP status code.
-
404
application/json
Not found. Could not find the extension with {id}.
An error object.
- application/jsonobject
An error object.
application/json properties
- metaobject
Object containing meta data regarding an error. It does not necessarily contain all the properties.
meta properties
- stackstring
Full stack trace of the error that was raised.
- messagestring
A more detailed message explaining the error.
- resourceNamestring
Name of the resource related to the error. If there is a conflict, it is the name of the model attempting to be created.
-
- titlestringRequired
Title of the HTTP status code.
- sourceobject
Optional JSON patch object pointing to an invalid property.
- statusnumber
The HTTP status code.
-
410
application/json
Gone. Extension with {id} has been deleted.
An error object.
- application/jsonobject
An error object.
application/json properties
- metaobject
Object containing meta data regarding an error. It does not necessarily contain all the properties.
meta properties
- stackstring
Full stack trace of the error that was raised.
- messagestring
A more detailed message explaining the error.
- resourceNamestring
Name of the resource related to the error. If there is a conflict, it is the name of the model attempting to be created.
-
- titlestringRequired
Title of the HTTP status code.
- sourceobject
Optional JSON patch object pointing to an invalid property.
- statusnumber
The HTTP status code.
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/extensions/{id}" \
-X DELETE \
-H "Authorization: Bearer <API-key>"
const https = require('https')
const data = JSON.stringify("")
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/extensions/{id}',
'method': 'DELETE',
'headers': {
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
qlik extension rm <extensionId>
Downloads all files in the extension matching either extension ID or extension name as a .zip
archive.
Facts
Rate limit | Tier 1 (1000 requests per minute) |
Categories | extend |
Path Parameters
- idstringRequired
Extension identifier or its qextFilename.
Responses
200
OK. Extension exists. Returns the extension archive.
403
application/json
Forbidden. User is not authorized to read extension with {id}.
An error object.
- application/jsonobject
An error object.
application/json properties
- metaobject
Object containing meta data regarding an error. It does not necessarily contain all the properties.
meta properties
- stackstring
Full stack trace of the error that was raised.
- messagestring
A more detailed message explaining the error.
- resourceNamestring
Name of the resource related to the error. If there is a conflict, it is the name of the model attempting to be created.
-
- titlestringRequired
Title of the HTTP status code.
- sourceobject
Optional JSON patch object pointing to an invalid property.
- statusnumber
The HTTP status code.
-
404
application/json
Not found. Could not find the extension with {id}.
An error object.
- application/jsonobject
An error object.
application/json properties
- metaobject
Object containing meta data regarding an error. It does not necessarily contain all the properties.
meta properties
- stackstring
Full stack trace of the error that was raised.
- messagestring
A more detailed message explaining the error.
- resourceNamestring
Name of the resource related to the error. If there is a conflict, it is the name of the model attempting to be created.
-
- titlestringRequired
Title of the HTTP status code.
- sourceobject
Optional JSON patch object pointing to an invalid property.
- statusnumber
The HTTP status code.
-
410
application/json
Gone. Extension with {id} has been deleted.
An error object.
- application/jsonobject
An error object.
application/json properties
- metaobject
Object containing meta data regarding an error. It does not necessarily contain all the properties.
meta properties
- stackstring
Full stack trace of the error that was raised.
- messagestring
A more detailed message explaining the error.
- resourceNamestring
Name of the resource related to the error. If there is a conflict, it is the name of the model attempting to be created.
-
- titlestringRequired
Title of the HTTP status code.
- sourceobject
Optional JSON patch object pointing to an invalid property.
- statusnumber
The HTTP status code.
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/extensions/{id}/file" \
-H "Authorization: Bearer <API-key>"
const https = require('https')
const data = JSON.stringify("")
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/extensions/{id}/file',
'method': 'GET',
'headers': {
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
qlik extension file ls
Downloads a specific file from the extension matching either extension ID or extension name, identified by the file path within the imported extension.
Facts
Rate limit | Tier 1 (1000 requests per minute) |
Categories | extend |
Path Parameters
- filepathstringRequired
Path to the file location within the specified extension archive. Folders separated with forward slashes.
- idstringRequired
Extension identifier or its qextFilename.
Responses
200
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}.
An error object.
- application/jsonobject
An error object.
application/json properties
- metaobject
Object containing meta data regarding an error. It does not necessarily contain all the properties.
meta properties
- stackstring
Full stack trace of the error that was raised.
- messagestring
A more detailed message explaining the error.
- resourceNamestring
Name of the resource related to the error. If there is a conflict, it is the name of the model attempting to be created.
-
- titlestringRequired
Title of the HTTP status code.
- sourceobject
Optional JSON patch object pointing to an invalid property.
- statusnumber
The HTTP status code.
-
404
application/json
Not found. Could not find the extension with {id} or the file does not exist in the archive.
An error object.
- application/jsonobject
An error object.
application/json properties
- metaobject
Object containing meta data regarding an error. It does not necessarily contain all the properties.
meta properties
- stackstring
Full stack trace of the error that was raised.
- messagestring
A more detailed message explaining the error.
- resourceNamestring
Name of the resource related to the error. If there is a conflict, it is the name of the model attempting to be created.
-
- titlestringRequired
Title of the HTTP status code.
- sourceobject
Optional JSON patch object pointing to an invalid property.
- statusnumber
The HTTP status code.
-
410
application/json
Gone. Extension with {id} has been deleted.
An error object.
- application/jsonobject
An error object.
application/json properties
- metaobject
Object containing meta data regarding an error. It does not necessarily contain all the properties.
meta properties
- stackstring
Full stack trace of the error that was raised.
- messagestring
A more detailed message explaining the error.
- resourceNamestring
Name of the resource related to the error. If there is a conflict, it is the name of the model attempting to be created.
-
- titlestringRequired
Title of the HTTP status code.
- sourceobject
Optional JSON patch object pointing to an invalid property.
- statusnumber
The HTTP status code.
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/extensions/{id}/file/{filepath}" \
-H "Authorization: Bearer <API-key>"
const https = require('https')
const data = JSON.stringify("")
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/extensions/{id}/file/{filepath}',
'method': 'GET',
'headers': {
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
qlik extension file get <filepath>