v4.145.0：REST API 支持过滤执行用例

更新时间：2023年6月12日

主要更新内容：

1. 重构“执行用例”资源，支持通过测试用例进行过滤。
2. 项目、发布、工时、关注人、工单、代码提交等资源的 API 有变化。
3. 部分资源重命名，例如：瀑布工作项类型->工作项类型，工时->工作项工时。

重构“执行用例”资源，支持通过测试用例进行过滤

我们对执行用例的根地址进行了调整：

执行用例的根地址由：
/v1/testhub/libraries/{library_id}/plans/{plan_id}/runs
调整为：
/v1/testhub/runs

根地址的调整会影响包括创建、修改、获取执行用例，还有操作执行用例的关联、评论、附件的地址：

（PS：原地址依然有效）

创建一个执行用例
POST /v1/testhub/runs
部分更新一个执行用例
PATCH /v1/testhub/runs/{run_id}
获取一个执行用例
GET /v1/testhub/runs/{run_id}
获取执行用例列表
GET /v1/testhub/runs?plan_id=&case_id=&status=
创建一个执行用例关联
POST /v1/testhub/runs/{run_id}/relations
获取一个执行用例关联
GET /v1/testhub/runs/{run_id}/relations/{relation_id}
获取执行用例关联列表
GET /v1/testhub/runs/{run_id}/relations
删除一个执行用例关联
DELETE /v1/testhub/runs/{run_id}/relations/{relation_id}
创建一个执行用例评论
POST /v1/testhub/runs/{run_id}/comments
获取一个执行用例评论
GET /v1/testhub/runs/{run_id}/comments/{comment_id}
获取执行用例评论列表
GET /v1/testhub/runs/{run_id}/comments
向执行用例评论中上传一个文件
POST /v1/testhub/runs/{run_id}/comments/{comment_id}/files
向执行用例评论中创建一个代码段
POST /v1/testhub/runs/{run_id}/comments/{comment_id}/snippets
获取执行用例评论中的附件列表
GET /v1/testhub/runs/{run_id}/comments/{comment_id}/attachments

根地址调整之后，“获取执行用例列表”支持通过测试计划（plan_id）、测试用例（case_id）和状态（status）进行过滤。这样您就可以使用 GET /v1/testhub/runs?case_id= 获取一个测试用例的执行历史；也可以使用 GET /v1/testhub/runs?plan_id=&status= 获取一个测试计划内失败的用例们。（需要注意的是：使用企业鉴权时，是基于企业内所有的执行用例进行过滤；使用个人鉴权时，是基于个人有权限的执行用例进行过滤）。

这些 API 有变化

删除一个测试用例
DELETE /v1/testhub/cases/{case_id}
获取一个工单关注人
GET /v1/ship/tickets/{ticket_id}/participants/{participant_id}
获取一个阶段关注人
GET /v1/project/projects/{project_id}/phases/{phase_id}/participants/{participant_id}
获取一个里程碑关注人
GET /v1/project/projects/{project_id}/milestones/{milestone_id}/participants/{participant_id}
获取一个测试用例关注人
GET /v1/testhub/cases/{case_id}/participants/{participant_id}
获取工单列表（支持更多筛选）
GET /v1/ship/tickets?product_id=&type_id=&state_id=&priority_id=&keywords=
获取一个项目属性
GET /v1/project/project_properties/{property_id}
获取项目属性列表
GET /v1/project/project_properties
创建一个项目（支持指定开始时间、结束时间、负责人和状态）
POST /v1/project/projects
部分更新一个项目（支持指定开始时间、结束时间、负责人和状态）
PATCH /v1/project/projects/{project_id}
获取一个提交
GET /v1/scm/commits/{commit_id_or_sha}
删除一个工作项工时（支持企业鉴权）
DELETE /v1/project/workloads/{workload_id}

部分资源重命名

为了避免歧义，我们对一些资源进行了重新定位。比如：我们将“瀑布工作项类型”更新为“工作项类型” ，您可以通过“向瀑布项目中增加一个工作项类型”实现在瀑布项目里使用某个工作项类型的目的。同时，我们将“创建一个瀑布类型的工作项”更新为“创建一个自定义类型的工作项”，这里的“自定义类型”包括系统内置的3个自定义类型：需求、任务和缺陷。

如果您只是需要操作 Scrum/Kanban 项目里的工作项，那么还是使用“固定类型”对应的 API，固定类型包括：史诗、特性、故事、任务、缺陷和事务（这里的任务和缺陷，只是和自定义类型里的任务和缺陷同名而已，实际上是不一样的）。

我们将“关注人”、“工时”等资源限定为工作项的相关资源，名字调整为“工作项关注人”、“工作项工时”，以区分“工单关注人”等资源。

更多更新，欢迎直接查看REST API 官方文档 。