REST API

內建的 REST API 介面可讓您將 RESTful Web 服務視覺化。API 文件是使用 Swagger 來建置的,可讓您測試 API 作業並立即檢視結果,來協助您更快速地掃描應用程式。

執行這項作業的原因和時機

遵循這個範例,使用 /api/v2/Apps/ImportFile REST API 來匯入應用程式庫存,以瞭解如何使用互動式架構。

程序

  1. 選取工具 > API
  2. 按一下頁面右側的 Swagger 連結。您會自動登入到 Swagger。
  3. 建立資產群組:
    1. 展開資產群組 API,然後按一下 POST /api/v2/AssetGroups
    2. 參數區段中,按一下 Example Value編輯框中的文字,將文字當成 JSON 物件要求複製到 IBMIdModel 方框中。
    3. 以資產群組的名稱和說明來取代 "string" 參數。保留引號。取得資產群組 ID
    4. 按一下「試試看!」。
    5. 記下「回應主體」區段中的 ID。
      您在下一個 API 需要用到它。
  4. 匯入應用程式庫存檔:
    1. 展開應用程式 API,然後按一下 POST /api/V2/Apps/ImportFile
      在「實作」區段中,有一個範例檔案可供下載,讓您瞭解要併入您檔案的屬性類型。
    2. 將步驟 3d 的 assetGroupId 輸入「參數」區段的 Value 欄位。
    3. 按一下 fileToUpload 區段中的瀏覽,以尋找要匯入的應用程式 CSV 檔。
    4. 按一下「試試看!」。
    5. 在「回應標頭」區段中,從 "Location" 行中複製 ID。匯入應用程式的 JobID
    6. 展開 POST /api/v2/Apps/ImportJobs/{jobId} API。
    7. jobID 欄位中輸入 ID。
    8. 按一下「試試看!」。

結果

成功的匯入看起來像這樣:應用程式匯入成功