Themes

Themes enable you to customize/style the Qlik Sense client experience.

Download specification

List all themes

Lists all imported themes in the tenant.

Facts

Rate limit Tier 1 (1000 requests per minute)
Categories extend

Responses

200

application/json

OK. Lists all themes.

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

      The theme model.

      Show data properties
      • idstring
      • fileobject

        The file that was uploaded with the theme.

      • iconstring

        Icon to show in the client.

      • namestring

        The display name of this theme.

      • tagsarray of strings

        List of tags.

      • typestring

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

      • authorstring

        Author of the theme.

      • userIdstring
      • licensestring

        Under which license this theme is published.

      • versionstring

        Version of the theme.

      • homepagestring

        Home page of the theme.

      • keywordsstring

        Keywords for the theme.

      • supplierstring

        Supplier of the theme.

      • tenantIdstring
      • updateAtstring

        format = "date"

      • createdAtstring

        format = "date"

      • repositorystring

        Link to the theme source code.

      • descriptionstring

        Description of the theme.

      • 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 theme.
GET /v1/themes 
curl "https://your-tenant.us.qlikcloud.com/api/v1/themes" \
-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/themes',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)
  

qlik theme ls

Response

{
  "data": [
    {
      "id": "string",
      "file": {},
      "icon": "string",
      "name": "string",
      "tags": [
        "string"
      ],
      "type": "string",
      "author": "string",
      "userId": "string",
      "license": "string",
      "version": "string",
      "homepage": "string",
      "keywords": "string",
      "supplier": "string",
      "tenantId": "string",
      "updateAt": "string",
      "createdAt": "string",
      "repository": "string",
      "description": "string",
      "qextVersion": "string",
      "dependencies": {},
      "qextFilename": "string"
    }
  ]
}

Create a new theme

Creates a new theme. Accepts either provided file or data object. The name of the new theme must be different to any existing themes.

Facts

Rate limit Tier 2 (100 requests per minute)
Categories extend

Request Body

Required

multipart/form-data

  • multipart/form-dataobject
    Show multipart/form-data properties
    • dataobject

      The theme model.

      Show data properties
      • fileobject

        The file that was uploaded with the theme.

      • iconstring

        Icon to show in the client.

      • namestring

        The display name of this theme.

      • tagsarray of strings

        List of tags.

      • typestring

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

      • authorstring

        Author of the theme.

      • licensestring

        Under which license this theme is published.

      • versionstring

        Version of the theme.

      • homepagestring

        Home page of the theme.

      • keywordsstring

        Keywords for the theme.

      • supplierstring

        Supplier of the theme.

      • repositorystring

        Link to the theme source code.

      • descriptionstring

        Description of the theme.

      • 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 theme.
    • filestring

      Theme archive.

      format = "binary"

Responses

201

application/json

Created. Creates a new theme and returns it.

The theme model.

  • application/jsonobject

    The theme model.

    Show application/json properties
    • idstring
    • fileobject

      The file that was uploaded with the theme.

    • iconstring

      Icon to show in the client.

    • namestring

      The display name of this theme.

    • tagsarray of strings

      List of tags.

    • typestring

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

    • authorstring

      Author of the theme.

    • userIdstring
    • licensestring

      Under which license this theme is published.

    • versionstring

      Version of the theme.

    • homepagestring

      Home page of the theme.

    • keywordsstring

      Keywords for the theme.

    • supplierstring

      Supplier of the theme.

    • tenantIdstring
    • updateAtstring

      format = "date"

    • createdAtstring

      format = "date"

    • repositorystring

      Link to the theme source code.

    • descriptionstring

      Description of the theme.

    • 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 theme.

409

application/json

Conflict. Resource with same unique identity already exists.

An error object.

  • application/jsonobject

    An error object.

    Show application/json properties
    • metaobject

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

      Show 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.
    • titlestring
      Required

      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.

    Show application/json properties
    • metaobject

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

      Show 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.
    • titlestring
      Required

      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.

    Show application/json properties
    • metaobject

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

      Show 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.
    • titlestring
      Required

      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.

    Show application/json properties
    • metaobject

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

      Show 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.
    • titlestring
      Required

      Title of the HTTP status code.

    • sourceobject

      Optional JSON patch object pointing to an invalid property.

    • statusnumber

      The HTTP status code.
POST /v1/themes 
curl "https://your-tenant.us.qlikcloud.com/api/v1/themes" \
-X POST \
-H "Content-type: multipart/form-data" \
-H "Authorization: Bearer <access_token>" \
-F "data={\"id\":\"string\",\"file\":{},\"icon\":\"string\",\"name\":\"string\",\"tags\":[\"string\"],\"type\":\"string\",\"author\":\"string\",\"userId\":\"string\",\"license\":\"string\",\"version\":\"string\",\"homepage\":\"string\",\"keywords\":\"string\",\"supplier\":\"string\",\"tenantId\":\"string\",\"updateAt\":\"string\",\"createdAt\":\"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","license":"string","version":"string","homepage":"string","keywords":"string","supplier":"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/themes',
    'method': 'POST',
    'headers': {
      'Content-type': 'multipart/form-data',
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)
  req.write(formData)
  

qlik theme create \
--file="string"

Request

{
  "data": {
    "file": {},
    "icon": "string",
    "name": "string",
    "tags": [
      "string"
    ],
    "type": "string",
    "author": "string",
    "license": "string",
    "version": "string",
    "homepage": "string",
    "keywords": "string",
    "supplier": "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",
  "userId": "string",
  "license": "string",
  "version": "string",
  "homepage": "string",
  "keywords": "string",
  "supplier": "string",
  "tenantId": "string",
  "updateAt": "string",
  "createdAt": "string",
  "repository": "string",
  "description": "string",
  "qextVersion": "string",
  "dependencies": {},
  "qextFilename": "string"
}

Return specific theme

Returns a specific theme matching either theme ID or theme name.

Facts

Rate limit Tier 1 (1000 requests per minute)
Categories extend

Path Parameters

  • idstring
    Required

    Theme identifier or its qextFilename

Responses

200

application/json

OK. Returns theme with {id}.

The theme model.

  • application/jsonobject

    The theme model.

    Show application/json properties
    • idstring
    • fileobject

      The file that was uploaded with the theme.

    • iconstring

      Icon to show in the client.

    • namestring

      The display name of this theme.

    • tagsarray of strings

      List of tags.

    • typestring

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

    • authorstring

      Author of the theme.

    • userIdstring
    • licensestring

      Under which license this theme is published.

    • versionstring

      Version of the theme.

    • homepagestring

      Home page of the theme.

    • keywordsstring

      Keywords for the theme.

    • supplierstring

      Supplier of the theme.

    • tenantIdstring
    • updateAtstring

      format = "date"

    • createdAtstring

      format = "date"

    • repositorystring

      Link to the theme source code.

    • descriptionstring

      Description of the theme.

    • 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 theme.

403

application/json

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

An error object.

  • application/jsonobject

    An error object.

    Show application/json properties
    • metaobject

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

      Show 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.
    • titlestring
      Required

      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 theme with {id}.

An error object.

  • application/jsonobject

    An error object.

    Show application/json properties
    • metaobject

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

      Show 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.
    • titlestring
      Required

      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. Theme with {id} has been deleted.

An error object.

  • application/jsonobject

    An error object.

    Show application/json properties
    • metaobject

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

      Show 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.
    • titlestring
      Required

      Title of the HTTP status code.

    • sourceobject

      Optional JSON patch object pointing to an invalid property.

    • statusnumber

      The HTTP status code.
GET /v1/themes/{id} 
curl "https://your-tenant.us.qlikcloud.com/api/v1/themes/{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/themes/{id}',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)
  

qlik theme get <themeId>

Response

{
  "id": "string",
  "file": {},
  "icon": "string",
  "name": "string",
  "tags": [
    "string"
  ],
  "type": "string",
  "author": "string",
  "userId": "string",
  "license": "string",
  "version": "string",
  "homepage": "string",
  "keywords": "string",
  "supplier": "string",
  "tenantId": "string",
  "updateAt": "string",
  "createdAt": "string",
  "repository": "string",
  "description": "string",
  "qextVersion": "string",
  "dependencies": {},
  "qextFilename": "string"
}

Update a specific theme

Updates a specific theme matching either theme ID or theme name. Accepts either provided file or data object.

Facts

Rate limit Tier 2 (100 requests per minute)
Categories extend

Path Parameters

  • idstring
    Required

    Theme identifier or its qextFilename.

Request Body

Required

multipart/form-data

  • multipart/form-dataobject
    Show multipart/form-data properties
    • dataobject

      The theme model.

      Show data properties
      • fileobject

        The file that was uploaded with the theme.

      • iconstring

        Icon to show in the client.

      • namestring

        The display name of this theme.

      • tagsarray of strings

        List of tags.

      • typestring

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

      • authorstring

        Author of the theme.

      • licensestring

        Under which license this theme is published.

      • versionstring

        Version of the theme.

      • homepagestring

        Home page of the theme.

      • keywordsstring

        Keywords for the theme.

      • supplierstring

        Supplier of the theme.

      • repositorystring

        Link to the theme source code.

      • descriptionstring

        Description of the theme.

      • 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 theme.
    • filestring

      Theme archive.

      format = "binary"

Responses

200

application/json

OK. Theme has been updated.

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

      The theme model.

      Show data properties
      • idstring
      • fileobject

        The file that was uploaded with the theme.

      • iconstring

        Icon to show in the client.

      • namestring

        The display name of this theme.

      • tagsarray of strings

        List of tags.

      • typestring

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

      • authorstring

        Author of the theme.

      • userIdstring
      • licensestring

        Under which license this theme is published.

      • versionstring

        Version of the theme.

      • homepagestring

        Home page of the theme.

      • keywordsstring

        Keywords for the theme.

      • supplierstring

        Supplier of the theme.

      • tenantIdstring
      • updateAtstring

        format = "date"

      • createdAtstring

        format = "date"

      • repositorystring

        Link to the theme source code.

      • descriptionstring

        Description of the theme.

      • 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 theme.

403

application/json

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

An error object.

  • application/jsonobject

    An error object.

    Show application/json properties
    • metaobject

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

      Show 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.
    • titlestring
      Required

      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 theme with {id}.

An error object.

  • application/jsonobject

    An error object.

    Show application/json properties
    • metaobject

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

      Show 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.
    • titlestring
      Required

      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.

    Show application/json properties
    • metaobject

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

      Show 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.
    • titlestring
      Required

      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.

    Show application/json properties
    • metaobject

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

      Show 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.
    • titlestring
      Required

      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.

    Show application/json properties
    • metaobject

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

      Show 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.
    • titlestring
      Required

      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.

    Show application/json properties
    • metaobject

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

      Show 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.
    • titlestring
      Required

      Title of the HTTP status code.

    • sourceobject

      Optional JSON patch object pointing to an invalid property.

    • statusnumber

      The HTTP status code.
PATCH /v1/themes/{id} 
curl "https://your-tenant.us.qlikcloud.com/api/v1/themes/{id}" \
-X PATCH \
-H "Content-type: multipart/form-data" \
-H "Authorization: Bearer <access_token>" \
-F "data={\"id\":\"string\",\"file\":{},\"icon\":\"string\",\"name\":\"string\",\"tags\":[\"string\"],\"type\":\"string\",\"author\":\"string\",\"userId\":\"string\",\"license\":\"string\",\"version\":\"string\",\"homepage\":\"string\",\"keywords\":\"string\",\"supplier\":\"string\",\"tenantId\":\"string\",\"updateAt\":\"string\",\"createdAt\":\"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","license":"string","version":"string","homepage":"string","keywords":"string","supplier":"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/themes/{id}',
    'method': 'PATCH',
    'headers': {
      'Content-type': 'multipart/form-data',
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)
  req.write(formData)
  

qlik theme patch <themeId> \
--file="string"

Request

{
  "data": {
    "file": {},
    "icon": "string",
    "name": "string",
    "tags": [
      "string"
    ],
    "type": "string",
    "author": "string",
    "license": "string",
    "version": "string",
    "homepage": "string",
    "keywords": "string",
    "supplier": "string",
    "repository": "string",
    "description": "string",
    "qextVersion": "string",
    "dependencies": {},
    "qextFilename": "string"
  },
  "file": "string"
}

Response

{
  "data": [
    {
      "id": "string",
      "file": {},
      "icon": "string",
      "name": "string",
      "tags": [
        "string"
      ],
      "type": "string",
      "author": "string",
      "userId": "string",
      "license": "string",
      "version": "string",
      "homepage": "string",
      "keywords": "string",
      "supplier": "string",
      "tenantId": "string",
      "updateAt": "string",
      "createdAt": "string",
      "repository": "string",
      "description": "string",
      "qextVersion": "string",
      "dependencies": {},
      "qextFilename": "string"
    }
  ]
}

Delete specific theme

Deletes a specific theme matching either theme ID or theme name.

Facts

Rate limit Tier 2 (100 requests per minute)
Categories extend

Path Parameters

  • idstring
    Required

    Theme identifier or its qextFilename.

Responses

204

No content. Soft deletes the theme.

403

application/json

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

An error object.

  • application/jsonobject

    An error object.

    Show application/json properties
    • metaobject

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

      Show 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.
    • titlestring
      Required

      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 theme with {id}.

An error object.

  • application/jsonobject

    An error object.

    Show application/json properties
    • metaobject

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

      Show 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.
    • titlestring
      Required

      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. Theme with {id} has been deleted.

An error object.

  • application/jsonobject

    An error object.

    Show application/json properties
    • metaobject

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

      Show 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.
    • titlestring
      Required

      Title of the HTTP status code.

    • sourceobject

      Optional JSON patch object pointing to an invalid property.

    • statusnumber

      The HTTP status code.
DELETE /v1/themes/{id} 
curl "https://your-tenant.us.qlikcloud.com/api/v1/themes/{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/themes/{id}',
    'method': 'DELETE',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)
  

qlik theme rm <themeId>

Download theme as an archive

Downloads all files in the theme matching either theme ID or theme name as a .zip archive.

Facts

Rate limit Tier 1 (1000 requests per minute)
Categories extend

Path Parameters

  • idstring
    Required

    Theme identifier or its qextFilename

Responses

200

OK. Theme exists. Returns the theme archive.

403

application/json

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

An error object.

  • application/jsonobject

    An error object.

    Show application/json properties
    • metaobject

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

      Show 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.
    • titlestring
      Required

      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 theme with {id}.

An error object.

  • application/jsonobject

    An error object.

    Show application/json properties
    • metaobject

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

      Show 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.
    • titlestring
      Required

      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. Theme with {id} has been deleted.

An error object.

  • application/jsonobject

    An error object.

    Show application/json properties
    • metaobject

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

      Show 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.
    • titlestring
      Required

      Title of the HTTP status code.

    • sourceobject

      Optional JSON patch object pointing to an invalid property.

    • statusnumber

      The HTTP status code.
GET /v1/themes/{id}/file 
curl "https://your-tenant.us.qlikcloud.com/api/v1/themes/{id}/file" \
-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/themes/{id}/file',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)
  

qlik theme file ls

Download file from theme archive

Downloads a file from the theme matching either theme ID or theme name, identified by the file path within the imported extension.

Facts

Rate limit Tier 1 (1000 requests per minute)
Categories extend

Path Parameters

  • filepathstring
    Required

    Path to the file location within the specified theme archive. Folders separated with forward slashes.

  • idstring
    Required

    Theme identifier or its qextFilename.

Responses

200

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

403

application/json

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

An error object.

  • application/jsonobject

    An error object.

    Show application/json properties
    • metaobject

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

      Show 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.
    • titlestring
      Required

      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 a theme with {id} or the file does not exist in the archive.

An error object.

  • application/jsonobject

    An error object.

    Show application/json properties
    • metaobject

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

      Show 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.
    • titlestring
      Required

      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. Theme with {id} has been deleted.

An error object.

  • application/jsonobject

    An error object.

    Show application/json properties
    • metaobject

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

      Show 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.
    • titlestring
      Required

      Title of the HTTP status code.

    • sourceobject

      Optional JSON patch object pointing to an invalid property.

    • statusnumber

      The HTTP status code.
GET /v1/themes/{id}/file/{filepath} 
curl "https://your-tenant.us.qlikcloud.com/api/v1/themes/{id}/file/{filepath}" \
-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/themes/{id}/file/{filepath}',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)
  

qlik theme file get <filepath>