DTP の REST API エンドポイントを利用すると、ビルド、静的解析、カバレッジなど、DTP でホストされるデータにプログラム的にアクセスできます。開発者は、REST API を使用して DTP と他のアプリケーションを統合できます。

このセクションの内容:

認証

DTP REST API は、SSL (HTTPS) 経由でのみ使用可能です。4.9.3 より前のバージョンからアップグレードした場合は、SSL ポートを手動で有効にする必要があります。詳細については「Enabling SSL」を参照してください。

デフォルトでは、API はベーシック認証を使用します。これは、次の形式の Authorization HTTP ヘッダーを使用して API に渡すことができます。

Authorization: Basic <USERNAME>:<PASSWORD> 

ユーザー名とパスワードは Base64 エンコードである必要があります。必要なユーザー名/パスワードは、DTP へのログインに必要なユーザー名/パスワードと同じです。

OpenID Connect モードで DTP を実行している場合、ベーシック認証はサポートされません。代わりに、OpenID Connect プロバイダーからの認証トークンを HTTP ヘッダーで渡す必要があります。詳細については「Configuring OpenID Connect」を参照してください。

API ドキュメントへのアクセス

1. GUI から API のドキュメントにアクセスするには、[ヘルプ] メニュー (クエスチョン マークのアイコン) から [API ドキュメント] をクリックします。
   

   

   Info
   title ブラウザーから API にアクセスする
   ブラウザーのアドレス バーに https://<HOST>:<PORT>/grs/api と入力して API ドキュメントを参照することもできます。通常、DTP がポート番号 80 にデプロイされている場合は、URL は https://<HOST>/grs/api です。他のポートにデプロイされている場合、通常 https のポートは 8443 です。

2. リソースをクリックすると、そのパラメーターが表示されます。
   
   

3. リソース セクションの [More Information] をクリックすると、完全なドキュメントが表示されます。