文档首页/ 需求管理 CodeArts Req/ API参考/ API/ IPD工作项管理/ 批量更新工作项
更新时间：2024-11-30 GMT+08:00
查看PDF
分享

批量更新工作项

功能介绍

批量更新工作项

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

PUT /v1/ipdprojectservice/projects/{project_id}/issues/batch

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目id

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

id

是

Array of strings

需要更新的工作项ID数组

attribute

否

IssueEntity object

更新的工作项内容
表3 IssueEntity

参数

是否必选

参数类型

描述

id

否

String

工作项id

title

否

String

工作项标题

description

否

String

工作项描述字段

type

否

String

工作项大分类定义

requirement(研发需求)、bug(缺陷)、task(任务)、feature(特性)、raw_requirement(原始需求)

number

否

String

工作项编号

category

否

String

工作项类型，系统设备类项目可选值为:RR/SF/IR/SR/AR/Task/Bug，独立软件类项目可选值为:RR/SF/IR/US/Task/Bug，云服务类项目可选值为:RR/Epic/FE/US/Task/Bug。

编辑工作项时，此字段必填、值为当前工作项正确的工作项类型，但不会更新此字段

parent_id

否

String

父工作项id

project_id

否

String

工作项所属的项目id

status

否

String

工作项状态code

assignee

否

UserEntity object

工作项责任人

assigned_cc

否

Array of UserEntity objects

工作项抄送人，支持多个抄送人。同一工作项最多支持50个抄送人

created_by

否

UserEntity object

工作项创建人

created_time

否

String

工作项创建时间

modified_by

否

UserEntity object

工作项最近更新人

modified_time

否

String

工作项最近更新时间

plan_end_date

否

String

工作项计划结束日期，时间戳

close_time

否

String

工作项关闭时间

workload

否

String

工作项计划工时，保留一位小数，取值范围为0~999999999.9

link

否

String

工作项关联项id，多个关联项用英文逗号分隔，同一工作项最多支持50个关联项

suspended

否

Boolean

工作项是否已挂起

status_modified_time

否

String

工作项状态改变时间，可用于计算工作项在当前状态停留天数

labels

否

Array of LabelEntity objects

工作项标签

custom_fields

否

Array of FieldCodeValuePair objects

工作项自定义字段映射，用户添加的系统字段也在此列

{

"code":"字段code",

"value":"字段值"

}

children

否

Array of IssueEntity objects

工作项的子工作项集合

ir2feature

否

String

IR和FE的关联字段，工作项类型为IR时，有此字段

need_break

否

String

工作项是否需要分解,仅可以分解的工作项类型有此字段

break_status

否

String

分解状态

已分解—decomposed

未分解—undecomposed

不涉及— --

baseline

否

String

工作项基线状态

未基线 —— null

已基线 —— baselined

基线评审中——baseline-reviewing

priority

否

String

工作项优先级，部分工作项有此字段

related_network_security

否

String

是否涉及网络安全。预设字段中，仅研发需求有此字段

collaboratives

否

String

研发需求协同信息，协同任务id

business_domain

否

String

领域字段

plan_pi

否

String

工作项发布(老版本名为PI) id

plan_iteration

否

String

工作项完成的迭代，在Bug中为修复迭代

change_status

否

String

工作项变更状态

变更评审中——change-reviewing

已变更——changed

未变更-unchange或null

no_break_reason

否

String

无需分解原因，need_break=no时有此字段

submitted_by

否

Array of UserEntity objects

工作项提出人

ir2rr

否

String

IR关联的RR id，多选时用英文逗号分隔

feature_set

否

String

特性集id

expected_repair_date

否

String

期望修复时间。预设字段中，仅Bug有此字段

found_pi

否

String

缺陷发现发布。预设字段中，仅Bug有此字段

found_iteration

否

String

缺陷发现迭代。预设字段中，仅Bug有此字段

reason_analysis

否

String

分析原因。预设字段中，仅Bug有此字段

repair_solution

否

String

修复方案。预设字段中，仅Bug有此字段

test_report

否

String

测试报告。预设字段中，仅Bug有此字段

sys_no_repair_reason

否

String

无需修复原因。预设字段中，仅Bug有此字段

sys_activation_reason

否

String

激活原因。预设字段中，仅Bug有此字段

sys_return_reason

否

String

退回原因。预设字段中，仅Bug有此字段

test_failures_times

否

Integer

回归不通过次数。预设字段中，仅Bug有此字段

close_type

否

String

关闭类型。预设字段中，仅Bug有此字段;可选值为 问题解决关闭,问题转需求关闭,重复问题关闭,非问题关闭
表4 UserEntity

参数

是否必选

参数类型

描述

id

否

String

用户Id

name

否

String

用户名称

nick_name

否

String

用户昵称
表5 LabelEntity

参数

是否必选

参数类型

描述

id

否

String

标签id

label_type

否

String

标签所属工作项类型，对应工作项的type字段

color

否

String

标签颜色RGB

title

否

String

标签标题
表6 FieldCodeValuePair

参数

是否必选

参数类型

描述

code

否

String

工作项字段code值

value

否

String

工作项自定义字段值，为多选时用英文逗号分隔

响应参数

状态码： 200

表7 响应Body参数

参数

参数类型

描述

result

Array of IssueBatchOperateEntitiesResult objects

批量编辑的结果

status

String

操作状态

message

String

操作失败原因
表8 IssueBatchOperateEntitiesResult

参数

参数类型

描述

success

Array of IssueOperateResult objects

成功的结果

failed

Array of IssueOperateResult objects

失败的结果
表9 IssueOperateResult

参数

参数类型

描述

id

String

变更的工作项id

operator

String

工作项变更人id

state

String

工作项变更后生命周期状态

operate_time

String

工作项变更时间

状态码： 400

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

批量更新研发需求

{endpoint}/v1/ipdprojectservice/projects/8e70d806a8f04d018ea6af6b6ffe7b96/issues/batch

{
  "id" : [ "957294446158852096", "957315051394478080" ],
  "attribute" : {
    "category" : "IR",
    "priority" : "低",
    "submitted_by" : [ {
      "id" : "a360371833bf4c558f796fd707b44daf"
    } ],
    "labels" : [ {
      "id" : "956308025419804673"
    }, {
      "id" : "956308025419804673"
    } ],
    "custom_fields" : [ {
      "code" : "c7073388365101674496",
      "value" : "881467547473321986,881467547473321987"
    }, {
      "code" : "c7148504958125613056",
      "value" : "我是一个项目自定义字段"
    }, {
      "code" : "module",
      "value" : "956584293264568320"
    }, {
      "code" : "c7148512434669625344",
      "value" : "956591616891461634"
    } ]
  }
}

响应示例

状态码： 200

OK

{
  "status" : "success",
  "result" : [ {
    "success" : [ {
      "id" : "957294446158852096",
      "operator" : "a360371833bf4c558f796fd707b44daf",
      "operate_time" : "2024-01-29T21:26:11Z"
    }, {
      "id" : "957315051394478080",
      "operator" : "a360371833bf4c558f796fd707b44daf",
      "operate_time" : "2024-01-29T21:26:11Z"
    } ],
    "failed" : [ ]
  } ]
}

状态码： 400

错误原因

{
  "error_code" : "PM.02175000",
  "error_msg" : "系统繁忙，请稍后再试"
}

状态码

状态码

描述

200

OK

400

错误原因

错误码

请参见错误码。

父主题： IPD工作项管理

相关文档