REST API

組み込みの REST API インターフェースは、RESTful Web サービスを視覚化する方法を提供します。API 資料は Swagger を使用して作成されています。この資料を使用すると API 操作をテストしてすぐに結果を確認できるので、アプリケーションをより迅速にスキャンできます。

このタスクについて

以下に例示するアプリケーション・インベントリーのインポート手順に従って、対話式フレームワークの使用方法を学習します。この例では、/api/v2/Apps/ImportFile REST API を使用しています。

手順

  1. 「ツール」 > 「API」を選択します。
  2. ページの右側にある「Swagger」リンクをクリックします。Swagger に自動的にログインします。
  3. 資産グループを、次の手順で作成します。
    1. Asset Groups API を展開し、「POST /api/v2/AssetGroups」をクリックします。
    2. 「Parameters」セクションで、 Example Value 編集ボックス内のテキストをクリックして、テキストを JSON オブジェクト要求として IBMIdModel ボックスにコピーします。
    3. "string" パラメーターに資産グループの名前と説明を指定します。引用符はそのまま保持します。資産グループ ID の取得
    4. 「Try it out!」をクリックします。
    5. 「Response Body」セクションの ID をメモしておきます。
      この ID は次の API で必要になります。
  4. アプリケーション・インベントリー・ファイルを、次の手順でインポートします。
    1. Applications API を展開し、「POST /api/V2/Apps/ImportFile」をクリックします。
      「Implementation」セクションには、ファイルに組み込む属性のタイプを把握するためにダウンロードできるサンプル・ファイルがあります。
    2. ステップ 3d の「assetGroupId」を「Parameters」セクションの Value フィールドに入力します。
    3. 「fileToUpload」セクションの「Browse」をクリックして、インポートするアプリケーションの CSV ファイルを見つけます。
    4. 「Try it out!」をクリックします。
    5. 「Response Headers」セクションで、"Location" 行から ID をコピーします。アプリケーションをインポートするためのジョブ ID
    6. POST /api/v2/Apps/ImportJobs/{jobId} API を展開します。
    7. 「JobID」フィールドに ID を入力します。
    8. 「Try it out!」をクリックします。

タスクの結果

インポートが成功すると、次のようになります。成功したアプリケーションのインポート