站点管理 REST API 参考
您可以使用站点管理 REST API 在“站点管理”中访问和使用 ALM 数据。站点管理 REST API 参考为站点管理基于 REST 的 API 提供了完整的联机参考。
在本主题中︰
访问 SA REST API 文档
站点管理 REST API 文档嵌入在产品中。
要访问站点管理 REST API 文档,请执行以下操作:
-
打开以下链接:“http://<服务器>:<端口号>/qcbin/api-doc/sa/v2/”。
或者,在 ALM qcbin 页面 (http://<ALM 服务器>:<端口号>/qcbin/) 中,单击“工具”链接。在“工具”页面的底部,单击“站点管理 REST API 指南”链接。
-
从侧面菜单中展开相关部分。
此文档包含 URL 以 qcbin/v2/sa/api 开头的所有 REST API。
仅限 SaaS 的 API
具有“仅限 SaaS”标记的 API 仅适用于 SaaS。您不能将这些 API 用于本地环境。
对于本地环境,可以使用所有不带此标记的 API。
权限
每个 API 的“权限”部分解释了调用该 API 所需的权限。
我们建议您在调用 API 之前阅读“权限”部分。