このページを共有

# インタラクティブAPIクライアント

インタラクティブAPIクライアントは、ALM Octane UI内からAPI呼び出しを行うことができる組み込みクライアントです。

このトピックの内容:

## 概要

ALM Octaneユーザーは、インタラクティブAPIクライアントを使用して次のことができます。

- サポートされているエンティティについて調べて学習します。

- ALM Octaneにデータをリクエストします。

- ALM Octaneのデータを変更します。

アクセスできるエンティティ、および実行できる操作は、ログインに使用するAPIアクセスクライアントIDとシークレットに割り当てられたロールと権限に基づいています。

注: サイト管理アクション (構成パラメーターの設定など) を実行するには、REST APIクライアントツールを使用してサイト管理者としてログインします。インタラクティブAPIクライアントを使用してこれらのアクションを実行することはできません。詳細については、認証を参照してください。

ALM Octaneは、インタラクティブAPIクライアントから直接、または例をコードにコピーすることで操作できます。

トップに戻る

## REST APIをインタラクティブに操作する方法

これらの手順に従って、REST APIをインタラクティブに操作します。

1. 前提条件: APIアクセスクライアントIDとシークレットを取得します。詳細については、APIアクセスのセットアップを参照してください。

2. ALM Octaneヘルプメニューで、インタラクティブAPIクライアントをクリックします。

   ヒント: インタラクティブAPIクライアントにアクセスする別の方法は、次のURLを使用することです:`http://<server>:<port>/ui/swagger-ui/swagger.jsp`

3. クライアントIDとシークレットを入力します (ユーザー名とパスワードではありません)。

   Loginをクリックします

4. ワークスペースを選択します。

5. エンティティのリソースと操作が表示されます。ロール (APIアクセスキーで定義されている) および現在のワークスペースで使用できるエンティティと操作のみが使用可能です。

   Generic APIsをクリックしてすべてのリソースを表示するか、CI/CD APIsをクリックして継続的デリバリに関連するリソースのサブセットを表示できます。

   エンティティリソースを折りたたむか展開して、その操作 (DELETE、GET、POST、PUT) を表示 /非表示にします。

   注意: POST、PUT、およびDELETE操作は、不具合やテストの追加や編集など、データを変更します。あなたと他のユーザーは、これらの変更をALM Octaneでリアルタイムに表示できます。

6. エンティティと操作を選択し、パラメーター値を入力します。インタラクティブAPIクライアントは、たとえば、必須フィールドが欠落している場合に、リクエストを確認することでガイドします。

7. Executeをクリックして、指定したパラメーターを使用して操作を実行するか、例または構文をコードにコピーします。

   返される応答コードの詳細については、エラーとステータスコードを参照してください。

トップに戻る

参照情報:

- APIアクセスのセットアップ
- REST APIの操作方法

https://admhelp.microfocus.com ALM Octane 8942
検索結果を改善するためのヒント... ALM Octaneヘルプセンター ALM Octaneヘルプ 15.1.90 すべて ローカルヘルプセンターを表示 オンラインヘルプセンターを表示 戻る ブラウザーの履歴内を戻る 進む ブラウザーの履歴内を進む 検索のハイライトを削除する 次のトピック 次のトピックに進む 前のトピック 前のトピックに戻る 現在のトピックを印刷 バージョン: