pingcode logo
功能日记

v4.188.0:REST API 合并创建工作项,合并更新工作项


更新时间:2023年9月4日

更新内容

  1. 合并创建工作项、合并更新工作项
  2. 工作项关注人和项目成员支持团队
  3. 需求和客户支持写入
  4. 支持批量创建发布

合并创建工作项、合并更新工作项

我们将原来的“创建一个史诗”、“创建一个特性” …… “创建一个自定义类型的工作项”等 API 合并为“创建一个工作项”。

// 原创建地址将继续支持一段时间

POST /v1/project/work_items

对于不同类型工作项,需要通过 "type_id" 进行区分,"type_id" 包括 6 中固定类型和自定义类型(自定义类型包括您自己创建的工作项类型和系统中内置的 5 种自定义类型)。其他的创建参数,详见“请求参数”的说明。

更新工作项同理,我们将“部分更新一个史诗”、“部分更新一个特性” …… “部分更新一个自定义类型的工作项” 等 API 合并为 “部分更新一个工作项”。

// 原创建地址将继续支持一段时间

PATCH /v1/project/work_items/{work_item_id}

更新工作项时不需要指定 “type_id”,其他的更新参数,详见“请求参数”的说明。

工作项关注人和项目成员支持团队

工作项的关注人和项目成员已支持团队,您可以通过 type 区分成员和团队类型:

成员类型
{
   ...
   "type": "user",
   "user": {
        "id": "a0417f68e846aae315c85d24643678a9",
        "url": "https://rest_api_root/v1/directory/users/a0417f68e846aae315c85d24643678a9",
        "name": "john",
        "display_name": "John",
        "avatar": "https://s3.amazonaws.com/bucket/b46ef40c-e22e-4ecf-a599-cace9fba839a_160x160.png"
   }
   ...
}
团队类型
{
   ...
   "type": "user_group",
   "user_group": {
        "id": "63c8fb32729dee3334d96af7",
        "url": "https://rest_api_root/v1/directory/users/63c8fb32729dee3334d96af7",
        "name": "Open Team"
   }
   ...
}

需求和客户支持写入

创建一个需求
POST /v1/ship/ideas
部分更新一个需求
PATCH /v1/ship/ideas/{idea_id}
创建一个产品客户
POST /v1/ship/products/{product_id}/customers
部分更新一个产品客户
PATCH /v1/ship/products/{product_id}/customers/{customer_id}

支持批量创建发布

POST /v1/project/versions/bulk

除此之外,REST API 还对一些资源属性进行了优化,补全了需求关联工作项、工单场景,更多功能请查看REST API 官方文档