List the content libraries

List the content libraries by using the GetContentLibraries method.

List the content files in a content library by using the GetLibraryContent method.

These methods can be used with Qlik Sense Enterprise and Qlik Sense Desktop.

Global content library

In Qlik Sense Desktop, the content files are retrieved from:

%userprofile%\Documents\Qlik\Sense\Content\Default

In Qlik Sense Enterprise, the content files are retrieved from the Qlik Sense repository.

App specific content library

The embedded files are returned.

Examples

Example 1:

In this example, the app identifier is 8383E273-9AF8-465F-B30C-8274263823A1.

1. List the content libraries in the app using the GetContentLibraries method.

The client sends:

{ "jsonrpc": "2.0", "id": 3, "method": "GetContentLibraries", "handle": 1, "params": [] }

The engine returns:

{ "jsonrpc": "2.0", "id": 3, "result": { "qList": { "qItems": [ { "qName": "Default" }, { "qName": "8383E273-9AF8-465F-B30C-8274263823A1", "qAppSpecific": true } ] } } }

The global library is named Default. The app specific library is named after the identifier of the app and the property qAppSpecific is set to true for the app specific content library.

2. List the content files that are specific to the app, using the GetLibraryContent method

The name of the content library is 8383E273-9AF8-465F-B30C-8274263823A1.

The client sends:

{ "jsonrpc": "2.0", "id": 5, "method": "GetLibraryContent", "handle": 1, "params": [ "8383E273-9AF8-465F-B30C-8274263823A1" ] }

The engine returns:

{ "jsonrpc": "2.0", "id": 5, "result": { "qList": { "qItems": [ { "qUrlDef": "/appcontent/8383e273-9af8-465f-b30c-8274263823a1/default/flower.png", "qUrl": "/appcontent/8383e273-9af8-465f-b30c-8274263823a1/default/flower.png" }, { "qUrlDef": "/appcontent/8383e273-9af8-465f-b30c-8274263823a1/default/HelloWorld.docx", "qUrl": "/appcontent/8383e273-9af8-465f-b30c-8274263823a1/default/HelloWorld.docx" }, { "qUrlDef": "/appcontent/8383e273-9af8-465f-b30c-8274263823a1/default/readme.txt", "qUrl": "/appcontent/8383e273-9af8-465f-b30c-8274263823a1/default/readme.txt" } ] } } }

The list of the content files is displayed.

Example 2:

1. List the content libraries in the app using the GetContentLibraries method.

The client sends:

{ "jsonrpc": "2.0", "id": 3, "method": "GetContentLibraries", "handle": 1, "params": [] }

The engine returns:

{ "jsonrpc": "2.0", "id": 3, "result": { "qList": { "qItems": [ { "qName": "default" }, { "qName": "appcontent", "qAppSpecific": true } ] } } }

The global library is named default. The app specific library is named appcontent and the property qAppSpecific is set to true for the app specific content library.

2. List the content files that are specific to the app, using the GetLibraryContent method

The name of the content library is appcontent.

The client sends:

{ "jsonrpc": "2.0", "id": 4, "method": "GetLibraryContent", "handle": 1, "params": [ "appcontent" ] }

The engine returns:

{ "jsonrpc": "2.0", "id": 4, "result": { "qList": { "qItems": [ { "qUrlDef": "/media/default/readme.txt", "qUrl": "/media/758e644e8be3e284c40a71a8bbb21aad/default/readme.txt" }, { "qUrlDef": "/media/default/Jpeg.jpg", "qUrl": "/media/758e644e8be3e284c40a71a8bbb21aad/default/Jpeg.jpg" }, { "qUrlDef": "/media/default/HelloWorld.docx", "qUrl": "/media/758e644e8be3e284c40a71a8bbb21aad/default/HelloWorld.docx" } ] } } }

The list of the embedded content files is displayed.

3. List the content files from the global content library, using the GetLibraryContent method

The name of the content library is default.

The client sends:

{ "jsonrpc": "2.0", "id": 5, "method": "GetLibraryContent", "handle": 1, "params": [ "default" ] }

The engine returns:

{ "jsonrpc": "2.0", "id": 5, "result": { "qList": { "qItems": [ { "qUrlDef": "/content/default/Qlik_default_feathers.png", "qUrl": "/content/default/Qlik_default_feathers.png" }, { "qUrlDef": "/content/default/Qlik_default_flower.png", "qUrl": "/content/default/Qlik_default_flower.png" }, { "qUrlDef": "/content/default/Qlik_default_green.png", "qUrl": "/content/default/Qlik_default_green.png" }, { "qUrlDef": "/content/default/Qlik_default_leaf.png", "qUrl": "/content/default/Qlik_default_leaf.png" }, { "qUrlDef": "/content/default/Qlik_default_orange.png", "qUrl": "/content/default/Qlik_default_orange.png" }, { "qUrlDef": "/content/default/Qlik_default_plant.png", "qUrl": "/content/default/Qlik_default_plant.png" }, { "qUrlDef": "/content/default/Qlik_default_qlikCircles.png", "qUrl": "/content/default/Qlik_default_qlikCircles.png" } ] } } }

The list of the content files that are common to all apps on the disk is displayed. These files are not embedded in the qvf file.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!

Leave your feedback here