topic Re: How to get list of app sheets from REST API? in Integration, Extension & APIs

How to get list of app sheets from REST API?

Mon, 20 Feb 2017 16:18:20 GMT

Hi,

I would like to get the list of available sheets for a given app from the REST API.

I manage to get the list of available apps with the qrs/app endpoint, but I don't find any way to get the list of available sheets in an app.

What is the endpoint to get the list of sheets?

Thanks,

Michaël

Re: How to get list of app sheets from REST API?

Øystein_Kolsrud — Tue, 21 Feb 2017 07:30:30 GMT

To get the list of sheets I believe you will have to go through the engine API. Exactly how to do that depends on the technology you use for your connection.

Re: How to get list of app sheets from REST API?

Tue, 21 Feb 2017 07:53:11 GMT

Hello Øystein, thanks for your answer.

What do you mean by the technology I use for my connection? I do HTTP calls with a X-Qlik-Xrfkey header, with certifications files (PEM), on port 4242 of our Qlik Sense server.

I tried to call the /qrs/app/object?filter=app.id eq <ID of the app> endpoint, which could have returned the list of sheets among others, but unfortunately this doesn't return anything.

Re: How to get list of app sheets from REST API?

Tue, 21 Feb 2017 08:43:53 GMT

Hi Michael,

As Oystein suggested you have to use the Engine API, not the QRS endpoint. Check: https://help.qlik.com/en-US/sense-developer/3.2/Subsystems/EngineAPI/Content/introducing-engine-API.htm

The easier way to get the sheets is using a macro that combines CreateSessionObject + GetLayout.

I also suggest you have a look at the Engine API Explorer tool in the Dev Hub. It will help you to get up to speed since it contains some interesting macros that you can perhaps use. (Including get sheets).

Re: How to get list of app sheets from REST API?

Tue, 21 Feb 2017 09:17:52 GMT

Hi Jose,

That's interesting indeed, as I manage to list the sheets in the Engine API Explorer, with the Engine API.

But can the Engine API be called with HTTP queries?

Regards,

Michaël

Re: How to get list of app sheets from REST API?

Øystein_Kolsrud — Tue, 21 Feb 2017 09:39:29 GMT

Well, by "technology" I primarily meant your choice of programming language. We have APIs for working with the engine in both JavaScript and C#, so if you use any of those languages, then there are tools available for you to make your life easier.

Re: How to get list of app sheets from REST API?

Tue, 21 Feb 2017 11:33:10 GMT

Engine API follows JSON-RPC specification... But if you are in a Javascript context another interesting approach could be using the Enigma.js framework. GitHub - qlik-oss/enigma.js: JavaScript library for consuming Qlik backend services.

Re: How to get list of app sheets from REST API?

Alexander_Thor — Tue, 21 Feb 2017 16:58:10 GMT

Hey,

The QRS stores sheets and stories metadata so you can query the QRS API to extract that information.

A example query via the Proxy (you can add additional filters if you just want a single app):

HTTP GET

https://servername/qrs/app/object/full?filter=objectType+eq+%27sheet%27&Xrfkey=abcdefghijklmnop‌

If you want to get information and interact with the actual sheet object then you would have load the document into memory and use the Engine API.

As a side note, the QRS has one id for the sheet which is the reference to the row in the QRS db. There is also a property on the returned entity that's engineObjectId which indicates the ID that the Engine uses and sub-sequentially which you would use with the Engine API.

Re: How to get list of app sheets from REST API?

Alexander_Thor — Tue, 21 Feb 2017 17:04:28 GMT

As app.id is not part of the main entity add /full/ to your url to instantiate additional properties and relationships.
This will also allow you to filter on related entities such as app.id

Sample request via the Proxy:
https://servername/qrs/app/object/full?filter=app.id eq <some guid>&Xrfkey=abcdefghijklmnop

PS. You probably want to filter by objectType in conjuncation or you will get, pardon my french, a shit ton of results for a large document

Re: How to get list of app sheets from REST API?

Tue, 21 Feb 2017 18:03:12 GMT

Hi Alexander!

Thank you for your answer, I think we are close to it!

I had already tried your solution, but surprisingly the app.id seems not to work. No results are returned when I add this filter. That's really too bad, as it seems to be a nice solution, and in conjunction with the filter=objectType+eq+%27sheet filter you mentioned in your other post, it should do the trick.

I'm going to make some other tests, and I will let you know.

Re: How to get list of app sheets from REST API?

Tue, 21 Feb 2017 18:08:39 GMT

I made some other tries, and it finally worked with the two filters (app.id and objectType)!

Thank you all and thank you Alexander!

Re: How to get list of app sheets from REST API?

Tue, 21 Feb 2017 18:11:17 GMT

Ok, thank you for the clarification.

I am using PHP, so unfortunately there are no available tools to easily make calls to the Engine API. Thank you anyway for your answer, as it seems I could use the Engine API by connecting to the web socket with PHP.

For now, I will be using the QRS as Alexander Karlsson mentioned.

Re: How to get list of app sheets from REST API?

Tue, 21 Feb 2017 18:12:39 GMT

Thank you for your answer Jose. I can actually make use of the QRS API as Alexander mentioned.

I am using PHP, but I think I could make use of the Engine API by connecting to the websocket. I will stick to the QRS for now, as it fulfils my needs.

Re: How to get list of app sheets from REST API?

Dipankar_Mazumdar — Tue, 09 May 2017 05:50:32 GMT

Hi akl‌,

Do you know of any endpoint to get the sheetid of a bookmark using the QRS API?

I am using this request below to retrieve bookmarks for a particular application:

POST https://qlikserver.domain.local/qrs/app/object/table?filter=app.id+eq+a867de93-318c-426c-b9fa-201b45447130+and+objectType+eq+%27bookmark%27&Xrfkey=testtesttesttest

BODY:

{"entity":"App.Object","columns":[{"name":"id","columnType":"Property","definition":"id"},{"name":"privileges","columnType":"Privileges","definition":"privileges"},{"name":"name","columnType":"Property","definition":"name"},{"name":"objectType","columnType":"Property","definition":"objectType"},{"name":"owner","columnType":"Property","definition":"owner"},{"name":"approved","columnType":"Property","definition":"approved"},{"name":"published","columnType":"Property","definition":"published"},{"name":"modifiedDate","columnType":"Property","definition":"modifiedDate"},{"name":"app.name","columnType":"Property","definition":"app.name"}]}

I guess there should be some mapping between the bookmarks and sheetID, isn't it?

Thanks!

Re: How to get list of app sheets from REST API?

Anonymous — Mon, 04 Jun 2018 20:27:49 GMT

Dipankar,

did you get the solution? We are doing the same and looking for the options

Re: How to get list of app sheets from REST API?

sivahere2003 — Fri, 14 Jun 2019 03:55:01 GMT

Hi What value did you pass for app.id and objectType?

I believe app.id will be your app id and objectType??