お問い合わせ
5 分で読むことができます。

Qlik Sense SaaS:APIを利用してアプリ一覧を取得する

2025年4月01日

目次

 

はじめに

Qlik Sense SaaSでAPIを使用してQlikのスペースやスクリプト、アプリの一覧を取得する方法です。
参考:Qlik APIs | Qlik Developer Portal

 

環境

  • Qlik Sense SaaS(執筆日:2025/03/23)
  • コマンドプロンプト:Version 10.0.26100.3476

 

手順

事前準備1:テナント情報の取得

Qlik APIを実行するために必要なテナント情報を取得します。

  1. Qlikの右上のアイコンから「アプリについて」をクリックする
    2025-03-23-15-32-02
  2. テナント情報が表示されるので、「テナント エイリアス ホスト名」をコピーしておく
    2025-03-23-15-30-18

 

事前準備2:APIキーの取得

Qlik APIを実行するために必要なAPIキーを生成します。
参考:API キーの管理 | Qlik Cloud ヘルプ

  1. Qlikのナビゲーションメニューを開き、「管理」→「設定」をクリックする
    2025-03-23-15-33-04
  1. APIキー項目のAPIを有効にし、「新しく生成」をクリックする
    ※APIキーを生成するには「管理者ロール」が必要
    2025-03-23-14-58-23
  1. 「新規キーの生成」をクリックする
    2025-03-23-14-59-22
  1. APIキーの説明と有効期限を入力し、「生成」をクリックする
    2025-03-23-15-02-01
  1. APIキーをコピーし安全な場所に保管し、「コピーして閉じる」をクリックする
    2025-03-23-15-04-06

 

APIの実行:スペース一覧の取得

curlコマンドを使用して、Qlikのスペース一覧を取得します。

Spaces というエンドポイントを使用します。
詳細はQlik Developer Portalを参考にしてください。

参考:Spaces REST | Qlik Developer Portal

コマンドプロンプトを立ち上げ、次のコマンドを入してください。

curl "https://<テナント情報>/api/v1/spaces" -H "Authorization: Bearer <アクセストークン>"
  • テナント情報:事前準備1で取得した「テナント エイリアス ホスト名」
  • アクセストークン:事前準備2で取得した「APIキー」

結果がjson形式で返ってきます。(初期値は10件)
取得できる件数の上限は100件までです。


スペースを100件まで取得するコマンドは次の通りです。

curl "https://<テナント情報>/api/v1/spaces?limit=100" -H "Authorization: Bearer <アクセストークン>"

 

APIの実行:アイテム一覧の取得

アプリ、オートメーションやデータセットなどの一覧を取得します。

参考:Items REST | Qlik Developer Portal

コマンドプロンプトを立ち上げ、つぎのコマンドを入してください。

curl "https://<テナント情報>/api/v1/items" -H "Authorization: Bearer <アクセストークン>"

結果がjson形式で返ってきます。(初期値は10件)


特定のスペース内のアイテムのみを100件取得するコマンドは次の通りです。

curl "https://<テナント情報>/api/v1/items?spaceId=<スペースID>&limit=100" -H "Authorization: Bearer <アクセストークン>"


101個以降のアイテムを取得したい場合は、上記のコマンド実施時に返ってきたjsonの「.links.next.href」に記載されているURLをcurlコマンド投げてあげればよいです。

curl "<.links.next.href要素の内容>" -H "Authorization: Bearer <アクセストークン>"

 

おわりに

Qlik APIの実行自体は比較的簡単にできますし、batやPythonを使えば、アイテム数が100以上あるときに101以降の要素を取得するようにループして、すべての要素を取得することもできます。
アプリやスペース数が多く管理が大変なときにAPIを使ってみてください。

Topics: Qlik api Qlik Sense
saya

Written by saya

SQLがすきです。でもカービィもすきです。

Qlik_No1_2022
QSナレッジ事例バナー
DXバナー
Qlikseminar
qs_trial
Qllikseminar
Vizlibナレッジ
Vizlibセミナー
qv_knowledge
book_kawaii
Snowflake_バナー

新着記事

タグ別の記事

全て表示