topic Re: Get the SheetID by name in App Development

Get the SheetID by name

bean — Thu, 28 May 2026 12:06:42 GMT

Hi there,

We want to hyperlink to another sheet. Since SheetIDs change from app instance to instance, I'm looking for a function to retrieve a particular sheet's ID in an expression or during load (and put result in a variable).

The URL to an sheet looks like

https://<Server name>/sense/app/<App ID>/sheet/<Sheet ID>/state/analysis

and using an expression I can resolve most parts dynamically. But not yet the sheet ID being here YMSKeu

='https://' & GetSysAttr('tenantUrlAlias') & '/sense/app/' & DocumentName() & '/sheet/YMSKeu/state/analysis'

Any idea how to find the right sheet ID e.g. from it's name? ObjectId() or GetActiveSheetId() do not help since I'm looking for another sheet than the function is running in.

Thanx so much

Re: Get the SheetID by name

Or — Thu, 28 May 2026 13:52:49 GMT

You should be able to use the Qlik API to get the list of sheets from the app:

GET https://<YourServer>/qrs/app/object?filter=app.id eq <AppID> and objectType eq 'sheet'

see e.g. https://community.qlik.com/t5/Integration-Extension-APIs/QlikSense-RestAPI-Get-Sheet-Info-for-App/td-p/1702886

DocumentName() will get you the ID of the current app to pass along to the API, though note that using this in script will use the ID of the app where it was last reloaded so it is important that the reload happens on the published app rather than a manual reload in someone's work and then publish.

Re: Get the SheetID by name

Chanty4u — Sat, 30 May 2026 17:34:15 GMT

May be try this

GetActiveSheetId()

ObjectId()

SheetTitle()

Re: Get the SheetID by name

bean — Mon, 01 Jun 2026 10:40:42 GMT

Thanks for the idea using the API.
From GET https://<YourServer>/api/v1/apps/{appID} I get meaningful results, so my API key seems be working.
But using /qrs/about or other basic qrs calls there are no responses. I'm setting the parameter Xrfkey and header x-Qlik-Xrfkey.
I fear that this works only for Sense Windows and not for the Qlik Sense Cloud ..

Re: Get the SheetID by name

Or — Mon, 01 Jun 2026 11:10:29 GMT

I had assumed you are using Enterprise, since your link structure included <Server name>, but looking at it again I see your second link had tenant ID. Are you using a mixed environment with both Cloud and Client-managed? They do tend to have different offerings in this regard, so you may need to script through testing which one you're on first and then use the relevant API.

For cloud, have a look at this for the API you presumably need. It's fairly straightforward, luckily:

https://qlik.dev/toolkits/qlik-api/examples/app-sheet-list/

Re: Get the SheetID by name

bean — Mon, 01 Jun 2026 15:12:23 GMT

I'm completely in the cloud, no enterprise setup.

With node.js I'm completely lost - finally I need the information about the sheet's ID in the load script. Using node.js from outside Qlik is clear and that works. But how to access the API (which one?) from a load script remains open.

Re: Get the SheetID by name

Or — Tue, 02 Jun 2026 13:40:16 GMT

I'm a bit outside of my comfort zone here, since I've never attempted to do this from within a script, but I had a chat with my local LLM and after some wrangling, it suggested this:

[...]you can extract this information natively using Qlik’s REST Connector paired with the Qlik Cloud Evaluations API. This API evaluates app structures over standard HTTP and outputs app metadata, including public sheet details.

Step 1: Create the REST Connection

Before editing your script, you must set up a generic REST data connection in your Qlik Cloud Space:

Open your Data Load Editor.
Click Create new connection and select REST.
Configure the following parameters:
- URL: https://<your-tenant>.<region>:// (We will dynamically overwrite EMPTY in the script).
- Method: POST
- Request body: {} (A blank JSON object).
- Query headers:
  - Authorization: Bearer YOUR_API_KEY
  - Content-Type: application/json
Name the connection QlikCloud_EvaluationsAPI and save it.

Step 2: The Load Script

Paste this script block into your Data Load Editor. It dynamically rewrites the URL to insert your target App ID and extracts the sheet data into a Qlik data table.

// 1. Define your connection variables
SET vTenantUrl = '://qlikcloud.com'; // Replace with your actual Qlik tenant URL
SET vAppId     = 'YOUR_TARGET_APP_ID';               // Replace with the specific App ID you want to scan

// 2. Fetch the sheet metadata using the Evaluations API
Sheets_Raw:
SQL SELECT 
    "id" AS "Sheet_ID",
    "type" AS "Object_Type",
    "__KEY_public",
    "__FK_public"
FROM JSON (wrap on) "root" PK "__KEY_root"
WITH CONNECTION (
    URL "https://$(vTenantUrl)/v1/apps/$(vAppId)/evaluations",
    HTTPHEADER "Content-Type" "application/json"
);

// 3. Extract descriptive details (like Titles) linked to those sheets
Sheet_Meta:
SQL SELECT 
    "title" AS "Sheet_Title",
    "description" AS "Sheet_Description",
    "__FK_meta"
FROM JSON (wrap on) "meta" PK "__KEY_meta"
FK "__FK_meta" TRANSFERRES "__KEY_public"; 
// Note: Transferres links the underlying relational structure built by the REST connector

// 4. Resolve and combine the fields into a clean final table
[App Sheets]:
NoConcatenate
LOAD 
    [Sheet_ID],
    [Sheet_Title],
    [Sheet_Description]
RESIDENT Sheets_Raw
LEFT JOIN (Sheets_Raw)
LOAD 
    [Sheet_Title],
    [Sheet_Description],
    [__FK_meta] AS [__KEY_public]
RESIDENT Sheet_Meta;

// 5. Clean up temporary extraction tables
DROP TABLES Sheets_Raw, Sheet_Meta;

Use code with caution.

Apologies if this isn't helpful - I generally avoid using AI generated information here, but I couldn't find a definitive source elsewhere and as mentioned I don't have first-hand experience attempting this.