Site Administration REST API Reference

サイト管理 REST API を使用すると、サイト管理の ALM データにアクセスして操作できます。ALM Site Administration REST API Reference は、サイト管理の REST ベース API の完全なオンライン・リファレンスです。

ドキュメントの機能強化

サイト管理 REST API ドキュメントは、次のように機能が強化されています。

  • ドキュメントを読みやすくするために、Swagger API 記述形式を使用します。

  • SaaS 用のサイト管理 REST API が追加されました。

サイト管理 REST API ドキュメントへのアクセス

サイト管理 REST API ドキュメントは製品に組み込まれています。

サイト管理 REST API ドキュメントにアクセスするには、次の手順を実行します。

  1. ALM qcbin ページ（http://＜ALM サーバ＞:＜ポート番号＞/qcbin/）で、［ツール］リンクをクリックします。

  2. ［ALMツール］ページの下部にある［ALM REST API Documentation］リンクをクリックします。

    このドキュメントには、qcbin/v2/sa/api で始まる URL を持つすべての REST API が含まれています。

先頭に戻る

サイト管理 REST API のタグ

次のタグがサイト管理 REST API に追加されます。

タグ 説明
SaaS only

このタグは、ALM SaaS でのみ使用できる REST API に追加されます。オンプレミス環境では使用できません。

オンプレミスの場合、このタグが付いていないすべての API を使用できます。
Site Admin only

このタグは、ALM SaaS のサイト管理者権限を必要とする REST API に追加されます。顧客管理者はこれらの API を使用できません。

注：オンプレミスで利用可能なすべての REST API には、サイト管理者の権限が必要です。ただし、これらの API を SaaS サイト管理者も利用可能な場合を除き、これらの API のすべてにこのタグが含まれるわけではありません。

先頭に戻る

権限

オンプレミスの場合、すべてのサイト管理 REST API にはサイト管理者の権限が必要です。

ALM SaaS の場合、ユーザが API を使用できるかどうか、および API が返すデータは、ユーザ・ロールの権限によって異なります。たとえば、同じ API でも、サイト管理者と顧客管理者で異なるデータが返る場合があります。必要な権限があることを確認するには、顧客管理者ロールで SaaS API（Site Admin only の API を除く）を呼び出すことをお勧めします。

先頭に戻る