REST API

内置的 REST API 接口向您提供了可视化 RESTful Web 服务的方法。API 文档可使用 Swagger 构建，在其中能够测试 API 操作并立即查看结果，从而帮助您更快地扫描应用程序。

关于此任务

通过遵循该示例来了解如何使用交互式框架来通过使用 /api/v2/Apps/ImportFile REST API 导入应用程序清单。

过程

  1. 转至 Swagger 页面，并将其加入书签以备将来参考。
  2. 使用您的 HCL 标识登录到 Swagger。
    1. 展开帐户 API 并单击 POST api/v2/Account/ApiKeyLogin 以展开操作详细信息。
    2. 单击 Example Value 框中的文本，将其作为 JSON 对象请求复制到 apiKey 框中。
    3. 将 "string" 参数替换为您的 HCL 标识用户名和密码。保留引号。
    4. 单击请尝试！。
    5. 从响应主体复制 "Token" 值。
    6. 将其粘贴到 Swagger 界面顶部的访问令牌字段中。
      从现在开始，令牌将自动应用于所有 API 调用。
  3. 创建资产组：
    1. 展开资产组 API 并单击 POST /api/v2/AssetGroups。
    2. 在 Parameters 部分中，单击 Example Value 编辑框中的文本，以复制文本作为 IBMIdModel 框的 JSON 对象请求。
    3. 将 "string" 参数替换为资产组的名称和描述。保留引号。获取资产组标识
    4. 单击请尝试！。
    5. 记下响应主体部分中的标识。
      您将需要在下一个 API 中使用该标识。
  4. 导入应用程序清单文件：
    1. 展开应用程序 API 并单击 POST /api/V2/Apps/ImportFile。
      在实施部分中，有一个样本文件，可下载该文件以了解文件中包含的属性类型。
    2. 在参数部分的 Value 字段中输入来自步骤 3d 的 assetGroupId。
    3. 单击 fileToUpload 部分中的浏览，以查找要导入的应用程序的 CSV 文件。
    4. 单击请尝试！。
    5. 在响应头部分中，从 "Location" 行复制标识。用于导入应用程序的 JobID
    6. 展开 POST /api/v2/Apps/ImportJobs/{jobId} API。
    7. 在 jobID 字段中输入标识。
    8. 单击请尝试！。

结果

成功的导入如下：成功应用程序导入