pingcode logo
功能日记

v5.32.0:REST API 更新凭据权限点,补全特定场景的 API


更新时间:2023年12月4日

更新内容

  1. 更新凭据权限点
  2. 为创建和更新工单、需求、工作项和用例的场景补全 API
  3. 其他更新

更新凭据权限点

我们更改了凭据里的权限点名称和排序规则,让其与文档结构对应。如下图所示:

这样更容易根据实际的需求配置凭据的权限点。

工单场景

为了区别“产品配置中心-工单配置”场景里的 API,我们为工单本身的操作场景单独提供了一些获取基础资源数据的 API,这些 API 放在“工单”目录下,归属“产品管理-工单”的权限点控制,例如:

产品管理-工单:

获取工单类型列表
GET /v1/ship/ticket/types?product_id=
获取工单状态列表
GET /v1/ship/ticket/states?product_id=
获取工单属性列表
GET /v1/ship/ticket/properties?product_id=
获取工单渠道列表
GET /v1/ship/ticket/channels?product_id=
获取工单优先级列表
GET /v1/ship/ticket/priorities?product_id=
获取工单解决方案列表
GET /v1/ship/ticket/solutions?product_id=
获取工单标签列表
/v1/ship/ticket/tags?product_id=

需要注意的是,这些 API 获取的数据都是“引用数据”,例如“获取工单类型列表”的每一条数据都是来自“产品管理-产品配置中心-工单配置”的“工单类型”资源,因此在通过这一条数据的 url 获取这个资源本体时,需要遵循的是“产品管理:产品配置中心”的权限。

需求场景

类似于工单场景,需求下新增的 API:

产品管理-需求:

获取需求状态列表
GET /v1/ship/idea/states?product_id=
获取需求属性列表
GET /v1/ship/idea/properties?product_id=
获取需求模块列表
GET /v1/ship/idea/suites?product_id=
获取需求排期列表
GET /v1/ship/idea/plans?product_id=
获取需求优先级列表
GET /v1/ship/idea/priorities?product_id=

工作项场景

类似于工单场景,工作项下新增的 API:

项目管理-工作项:

获取工作项类型列表
GET /v1/project/work_item/types?project_id=
获取工作项状态列表
GET /v1/project/work_item/states?project_id=&work_item_type_id=
获取工作项属性列表
GET /v1/project/work_item/properties?project_id=&work_item_type_id=
获取工作项优先级列表
GET /v1/project/work_item/priorities?project_id=
获取工作项标签列表
GET /v1/project/work_item/tags?project_id=

用例场景

类似于工单场景,用例下新增的 API:

测试管理-用例:

获取用例模块列表
GET /v1/testhub/case/suites?library_id={library_id}
获取用例属性列表
GET /v1/testhub/case/properties?library_id={library_id}

其他更新

  1. 工单资源开放“预计时间”和“自定义属性”:
工单资源结构定义:
{
    "id",
    "url",
    ...
    "estimated_at": {
        "from": 1701619200,
        "to": 1702742399,
        "granularity": "day"
    },
    ...
    "properties": {
        "prop_a": "prop_a_value",
        "prop_b": "prop_b_value"
    },
    ...
}

2. 工作项列表支持通过开始时间、截止时间、优先级、缺陷类别和所属计划筛选。

3. 支持在测试库添加和移除成员。

4. 修复已知的缺陷。

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