Site Administration REST API Reference

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

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

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

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

次のリンクを開きます：http://＜サーバ＞:＜ポート番号＞/qcbin/api-doc/sa/v2/。

または、ALM qcbin ページ（http://＜ALM サーバ＞:＜ポート番号＞/qcbin/）で、［ツール］リンクをクリックします。［ツール］ページの下部にある［Site Administration REST API Guidance］リンクをクリックします。
サイド・メニューから、関連するセクションを展開します。

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

SaaS only タグが設定された API は、SaaS でのみ使用できます。オンプレミス環境では使用できません。

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

各 API の「Permissions」セクションでは、API を呼び出すために必要な権限について説明しています。

API を呼び出す前に、「Permissions」セクションを読むことをお勧めします。