REST API (v1)
*对于新开发,强烈建议使用 Swagger API。仍对 REST API (v1) 进行维护,但不再计划进行进一步开发。有关支持信息,另请参阅:Codebeamer 中的 REST API (v1) 支持
可通过 REST API 访问 Codebeamer 资源。
REST API 替代了基于 Hessian 的旧版远程 API (可通过 /cb/remote-api URL 访问),具有以下优点:
完全独立于平台。
完全无状态。不必担心会话关闭和会话超时过期。
完全自我说明。
区域设置感知:返回数据,并且可以使用客户端/用户的首选语言 (只要服务器支持该语言) 进行提交。
基于开放 Web 标准:
HTTP,用于通信协议。
JSON,用于数据交换。
JSON Schema,用于数据说明。
客户端不需要任何 Codebeamer 客户端库或任何特定的第三方库。
实际上,只需在任意 Web 浏览器的地址栏中输入查询的 URL,即可通过该浏览器执行/测试查询 (GET)。
REST API 的 URL 通常为 https://{hostname}/cb/rest
在以下各部分中,我们将使用占位符 {RestURL} 来引用 REST API 的 URL。
*为了提高可读性,我们将在说明 REST API 方法时,省略 {RestURL} 部分,而仅显示相对 URI。
这对您有帮助吗?