v5.50.0：REST API 支持工单的配置场景

by sunjingyun

更新内容

  1. 支持配置工单的属性和状态
  2. 开放工单和需求的流转记录资源
  3. 补全一些测试管理场景下的 API

支持配置工单的属性

在“产品配置中心-工单配置”下新增了创建和编辑全局属性的 API，同时支持将这些属性添加到工单属性方案中（对应着 PingCode 页面上的工单属性视图）。

详细 API 如下：

// 创建一个工单属性
POST /v1/ship/ticket_properties
// 部分更新一个工单属性
PATCH /v1/ship/ticket_properties/{property_id}
// 获取全部工单属性列表
GET /v1/ship/ticket_properties
// 获取工单属性方案列表
GET /v1/ship/ticket_property_plans
// 向工单属性方案中添加一个工单属性
POST /v1/ship/ticket_property_plans/{property_plan_id}/ticket_properties
// 获取工单属性方案中的工单属性列表
GET /v1/ship/ticket_property_plans/{property_plan_id}/ticket_properties
// 在工单属性方案中移除一个工单属性
DELETE /v1/ship/ticket_property_plans/{property_plan_id}/ticket_properties/{property_id}

支持配置工单的状态

类似于配置工单的属性，在“产品配置中心-工单配置”下新增了创建和编辑全局状态的 API，通知也支持将这些状态添加到工单状态方案中（对应着 PingCode 页面上的工单工作流）。

详细 API 如下：

// 获取工单状态方案列表
GET /v1/ship/ticket_state_plans
// 向状态方案中添加一个工单状态
POST /v1/ship/ticket_state_plans/{state_plan_id}/ticket_states
// 获取状态方案中的工单状态列表
GET /v1/ship/ticket_state_plans/{state_plan_id}/ticket_states
// 在状态方案中移除一个工单状态
DELETE /v1/ship/ticket_state_plans/{state_plan_id}/ticket_states/{state_id}
// 向状态方案中添加一个工单状态流转
POST /v1/ship/ticket_state_plans/{state_plan_id}/ticket_state_flows
// 获取状态方案中的工单状态流转列表
GET /v1/ship/ticket_state_plans/{state_plan_id}/ticket_state_flows
// 在状态方案中移除一个工单状态流转
DELETE /v1/ship/ticket_state_plans/{state_plan_id}/ticket_state_flows/{state_flow_id}

开放工单和需求的流转记录资源

现在通过单个工单的 id 即可获取到工单的流转记录，需求同理，详细 API 如下：

// 获取工单流转记录列表
GET /v1/ship/tickets/{ticket_id}/transition_histories
// 获取需求流转记录列表
GET /v1/ship/ideas/{idea_id}/transition_histories

补全一些测试管理场景下的 API

补全一些测试管理下的 API：

// 获取用例类型列表
GET /v1/testhub/case/types?library_id={library_id}
// 部分更新一个测试库中的成员
PATCH /v1/testhub/libraries/{library_id}/members/{member_id}
// 在测试库中移除一个用例模块
DELETE /v1/testhub/libraries/{library_id}/suites/{suite_id}
// 创建一个用例属性
POST /v1/testhub/case_properties
// 部分更新一个用例属性
PATCH /v1/testhub/case_properties/{property_id}
// 向属性方案中添加一个用例属性
POST /v1/testhub/case_property_plans/{property_plan_id}/case_properties
// 在属性方案中移除一个用例属性
DELETE /v1/testhub/case_property_plans/{property_plan_id}/case_properties/{property_id}

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