目次
はじめに
Qlik Sense SaaSでAPIを使用してQlikのスペースやスクリプト、アプリの一覧を取得する方法です。
参考:Qlik APIs | Qlik Developer Portal
環境
- Qlik Sense SaaS(執筆日:2025/03/23)
- コマンドプロンプト:Version 10.0.26100.3476
手順
事前準備1:テナント情報の取得
Qlik APIを実行するために必要なテナント情報を取得します。
事前準備2:APIキーの取得
Qlik APIを実行するために必要なAPIキーを生成します。
参考:API キーの管理 | Qlik Cloud ヘルプ
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を使ってみてください。