topic Retaining sheets order when fetched via Engine API in Integration, Extension & APIs

Retaining sheets order when fetched via Engine API

sri_c003 — Sat, 16 Nov 2024 19:34:51 GMT

I am able to retrieve the sheets list in an app using the call below.

/iv/qrs/app/object/?Xrfkey=<xrf-key>&filter=app.id eq <app id> and objectType eq 'sheet'

The problem is that this retrieves the sheets in random order and there is no way to tell what order these sheets appear on the sheets list when accessed via HUB UI. Is there any way I could force the engine API return the sheets in the same order as they are on the HUB UI. Or some other kind of parameter I could use to determine this?

Re: Retaining sheets order when fetched via Engine API

Prashant_Naik — Sat, 07 Dec 2019 08:56:52 GMT

Hi Sri,

You can do this using capability API or enigma.js, I dont know about the REST API.

Using enigma.js you can call the method getallinfo() and it will give the list of all objects,master items and sheets.

filter the sheets from the data and pass the id of sheet in getobject() method and call the getlayout() method.

The output data from the getlayout method is in json format just search for the rank word and that will be your sheet rank and sort that rank in ascending form and you will get the sorted sheet details as shows in qlik sense app.

The same steps you can do in dev-hub-engine-api explorer(for checking the data output)

Thanks & Regards,

Prashant

Re: Retaining sheets order when fetched via Engine API

sri_c003 — Mon, 09 Dec 2019 16:05:56 GMT

Thanks Prashant for that explanation.

For us, we use the engine APIs to list the apps and sheets the user has access to, on a non Qlik interface. So we are pretty much tied to using only engine APIs.

"just search for the rank word and that will be your sheet rank" <-- will try to explore this.

Re: Retaining sheets order when fetched via Engine API

Prashant_Naik — Tue, 10 Dec 2019 18:40:49 GMT

Hi Sri,

I have a workaround for you requirement.

In sheet description you can give the sheet number 1,2,3 as such, as per the sheet no maintained in qliksense.

and while fetching data from QRS API i.e

https://<servername>:4242/qrs/app/object/full?filter=app.id eq <app id of qliksense app>&xrfkey=abcdefghijklmnop

filter the objects that have objectType as sheet in there Json array.

And after filtering get the description of each sheet and capture the sheet no that we have given in description.

and as per the sheet no,order the sheet with the Json data we have and there you have your sheets with qlik sense order.

Thanks & Regards,

Prashant