Knowledge

Qlik Sense App Integration API Theme not working as documented

Article Number: 000066953 | Last Modified: 2019/10/23

Description

Per documentation, App Integration API support for custom themes were added in Qlik Sense February 2019.

https://help.qlik.com/en-US/sense-developer/February2019/Subsystems/APIs/Content/Sense_ClientAPIs/app-integration-api.htm

However, there is an error in the documentation stating that theme id is needed to pull the theme.

Themes

theme/{theme-id}

You add a theme definition by stating the theme ID in addition to the Base URL. If no theme is stated, the default theme set in the Qlik Sense app will be used.

Syntax: Base URL + theme

http[s]://<machinename | servername>/{virtual proxy}/sense/app/{appid}/sheet/{sheetid}/state/analysis/theme/{themeid}

Environment:

Qlik Sense February 2019

Cause

This is currently being investigated as a defect, and actively being worked on. Information provided on this defect is given as is at the time of documenting. For up to date information, please review the most recent Release Notes, or contact support with the ID HLP-4645 for reference.

Resolution

Despite some documentation, the theme GUID is not used, rather the specified name as in mentioned in qExt file of the theme extension.

So, if creating links for custom themes named 'Template_Theme' and 'qlik custom theme' should look as exampled below:

http[s]://<machinename | servername>/{virtual proxy}/sense/app/{appid}/sheet/{sheetid}/state/analysis/theme/Template_Theme

http[s]://<machinename | servername>/{virtual proxy}/sense/app/{appid}/sheet/{sheetid}/state/analysis/qlik%20custom%20theme

Notes:

Please use URL encoding for special characters like spaces exampled above
Also be aware, the theme name is case sensitive.

Get Answers

Find Answers

Qlik Community

Collaborate with over 60,000 Qlik technologists and members around the world to get answers to your questions, and maximize success.

Join Us

Get Support

Have a Question?

Search Qlik's Support Knowledge database or request assisted support for highly complex issues.

Submit a case

Talk with a Representative

Critical Issues

Experiencing a serious issue, please contact us by phone. For Data Integration related issues please refer to your onboarding documentation for current phone number.

Call Us