站点管理 REST API 参考

您可以使用站点管理 REST API 在“站点管理”中访问和使用 ALM 数据。ALM 站点管理 REST API 参考为站点管理基于 REST 的 API 提供了完整的联机参考。

文档增强功能

站点管理 REST API 文档包括以下增强功能:

  • 使用 Swagger API 描述格式，使文档更具可读性。

  • 包括适用于 SaaS 的站点管理 REST API。

访问 SA REST API 文档

站点管理 REST API 文档嵌入在产品中。

要访问站点管理 REST API 文档，请执行以下操作:

  1. 在 ALM qcbin 页面 (http://<ALM 服务器>:<端口号>/qcbin/) 中，单击“工具”链接。

  2. 在 ALM 工具页面的底部，单击“ALM REST API 文档”链接。

    此文档包含 URL 以 qcbin/v2/sa/api 开头的所有 REST API。

返回页首

SA REST API 标记

以下标记已添加到站点管理 REST API:

标记 描述
仅限 SaaS

已为仅适用于 ALM SaaS 的 REST API 添加此标签。您不能将这些 API 用于本地环境。

对于本地环境，可以使用所有不带此标记的 API。
仅限站点管理员

已为需要 ALM SaaS 的站点管理员权限的 REST API 添加此标签。客户管理员不能使用这些 API。

注: 每个可用于本地的 REST API 都需要站点管理员权限。但是，并非所有这些 API 都包含此标记，除非它们也可供 SaaS 站点管理员使用。

返回页首

权限

对于本地环境，所有 SA REST API 都需要站点管理员权限。

对于 ALM SaaS，用户是否可以使用 API 以及 API 返回的内容取决于用户的角色权限。例如，同一个 API 可能会为站点管理员和客户管理员返回不同的数据。为确保您拥有所需的权限，我们建议您以客户管理员角色调用 SaaS API (仅限站点管理员的 API 除外)。

返回页首