# 批量更新工作项 - BatchUpdateIpdIssues #### 功能介绍 批量更新工作项，单次最多支持50个工作项。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-projectman/projectman_api_1002.html)。 #### 授权信息 账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见[权限和授权项](https://support.huaweicloud.com/api-projectman/projectman_03_Permission.html)。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | codeartsreq:workitem:update | Write | - | - codeartsreq:Model - codeartsreq:ProjectId | - | - | #### URI PUT /v1/ipdprojectservice/projects/{project_id}/issues/batch 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 项目32位ID，项目唯一标识。通过[查询IPD项目列表](https://support.huaweicloud.com/api-projectman/ShowIpdProjectList.html)获取，响应消息体中的**id**字段的值就是项目ID。 **约束限制**： 不涉及。 **取值范围**： 32个字符，由英文字母和数字组成。 **默认取值**： 不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释**： 用户Token。通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取（响应消息头中X-Subject-Token的值）。 **约束限制**： 不涉及。 **取值范围**： 10\~32768个字符。 **默认取值**： 不涉及。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | id | 是 | Array of strings | **参数解释**： 需要更新的工作项ID数组，可通过[高级查询工作项](https://support.huaweicloud.com/api-projectman/ListIssuesV4.html)接口获取，响应消息体中的**id**字段的值就是工作项ID。 **约束限制**： 18\~19位的数字字符串(工作项的**id**字段对应的字符串)。 | | attribute | 是 | [IssueUpdateAttribute] object | **参数解释**： 更新的工作项内容。 **约束限制**： 不涉及。 | 表4IssueUpdateAttribute | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | description | 否 | String | **参数解释**： 工作项描述字段，可通过[查询树状工作项](https://support.huaweicloud.com/api-projectman/ShowIpdIssueTree.html)接口获取，响应消息体中的**description**字段的值就是工作项描述字段。 **约束限制**： 不涉及。 **取值范围**： 1\~500000个字符。 **默认取值**： 不涉及。 | | parent_id | 否 | String | **参数解释**： 父工作项ID，可通过[查询树状工作项](https://support.huaweicloud.com/api-projectman/ShowIpdIssueTree.html)接口获取，响应消息体中的**parent_id**字段的值就是父工作项ID。 **约束限制**： 不涉及。 **取值范围**： 18\~19个字符的数字字符串。 **默认取值**： 不涉及。 | | status | 否 | String | **参数解释**： 工作项状态code。可通过[查询工作项状态](https://support.huaweicloud.com/api-projectman/ListIssueStatues.html)接口获取，响应消息体中的**code**字段的值就是工作项状态code。 **约束限制**： 不涉及。 **取值范围**： 2\~32个字符。 **默认取值**： 不涉及。 | | assignee | 否 | [UserUpdateAttribute] object | **参数解释**： 工作项责任人。 **约束限制**： 不涉及。 | | assigned_cc | 否 | Array of [UserUpdateAttribute] objects | **参数解释**： 工作项抄送人，支持多个抄送人。数组元素为UserUpdateAttribute对象。 **约束限制**： 同一工作项最多支持50个抄送人。 | | plan_end_date | 否 | String | **参数解释**： 工作项计划结束日期，unix时间戳，单位：毫秒。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | plan_dev_end_date | 否 | String | **参数解释**： 工作项计划开发结束日期，unix时间戳，单位：毫秒。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | workload | 否 | String | **参数解释**： 工作项计划工时。 **约束限制**： 保留一位小数。 **取值范围**： 0\~999999999.9。 **默认取值**： 不涉及。 | | link | 否 | String | **参数解释**： 工作项关联项ID。 **约束限制**： 多个关联项用英文逗号分隔，同一工作项最多支持50个关联项。 **取值范围**： 0\~2048个字符。 **默认取值**： 不涉及。 | | labels | 否 | Array of [LabelEntity] objects | **参数解释**： 工作项标签。数组元素为LabelEntity对象。 **约束限制**： 不涉及。 **取值范围**： 0\~50个元素，每个元素为LabelEntity对象。 **默认取值**： 不涉及。 | | custom_fields | 否 | Array of [FieldCodeValuePair] objects | **参数解释**： 工作项自定义字段映射，用户添加的系统字段也在此列，格式为{"code":"字段code","value":"字段值"}。数组元素为FieldCodeValuePair对象。 **约束限制**： 不涉及。 **取值范围**： 0\~200个元素，每个元素为FieldCodeValuePair对象。 **默认取值**： 不涉及。 | | ir2feature | 否 | String | **参数解释**： IR和SF的关联字段。 **约束限制**： IR可以填写该字段。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | need_break | 否 | String | **参数解释**： 工作项是否需要分解。 **约束限制**： 仅可以分解的工作项类型有此字段。 **取值范围**： - yes：需要分解 - no：不需要分解 **默认取值**： 不涉及。 | | baseline | 否 | String | **参数解释**： 工作项基线状态。 **约束限制**： 不涉及。 **取值范围**： - null：未基线 - baselined：已基线 - baseline-reviewing：基线评审中 **默认取值**： 不涉及。 | | priority | 否 | String | **参数解释**： 工作项优先级，部分工作项有此字段。 **约束限制**： 不涉及。 **取值范围**： - 低：低优先级。 - 中：中优先级。 - 高：高优先级。 **默认取值**： 不涉及。 | | related_network_security | 否 | String | **参数解释**： 是否涉及网络安全。 **约束限制**： 预设字段中，仅研发需求类型的工作项有此字段。 **取值范围**： - yes：涉及网络安全。 - no：不涉及网络安全。 **默认取值**： 不涉及。 | | business_domain | 否 | String | **参数解释**： 领域字段。 **约束限制**： 不涉及。 **取值范围**： - software - soft-hardware - hardware - 性能 - 功能 - 运维 - 运营 - 用户体验 - 隐私保护 - 合规 - 韧性(可靠性/可用性) - 韧性(危险检测与相应恢复) - 透明 - 无害 - 安全 - API - 成本 - 可维护性 - 其他DFX - 可用性 - others **默认取值**： 不涉及。 | | plan_pi | 否 | String | **参数解释**： 工作项发布计划ID，在Bug中为修复发布计划ID。通过[发布/迭代计划列表查询](https://support.huaweicloud.com/api-projectman/ListPlan.html)接口查询计划列表，返回参数中PlanVO里面的category=PI的对象的**id**字段就是迭代计划的ID。 **约束限制**： 不涉及。 **取值范围**： 18\~19个字符的数字字符串。 **默认取值**： 不涉及。 | | plan_iteration | 否 | String | **参数解释**： 工作项完成的迭代计划ID，在Bug中为修复迭代计划ID。通过[发布/迭代计划列表查询](https://support.huaweicloud.com/api-projectman/ListPlan.html)接口查询计划列表，返回参数中PlanVO里面的category=Iteration的对象的**id**字段就是迭代计划的ID。 **约束限制**： 18\~19个字符的数字字符串。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | no_break_reason | 否 | String | **参数解释**： 无需分解原因。 **约束限制**： need_break字段值为"no"时有此字段。 **取值范围**： 0\~512个字符。 **默认取值**： 不涉及。 | | submitted_by | 否 | Array of [UserUpdateAttribute] objects | **参数解释**： 工作项提出人。数组元素为UserUpdateAttribute对象。 **约束限制**： 不涉及。 | | ir2rr | 否 | String | **参数解释**： IR关联的RR ID，可以通过[查询工作项列表](https://support.huaweicloud.com/api-projectman/ListIpdProjectIssues.html)或者[查询树状工作项](https://support.huaweicloud.com/api-projectman/ShowIpdIssueTree.html)接口获取，响应消息体中的**id**字段的值就是工作项ID。 **约束限制**： 多个关联项ID使用英文逗号分隔。 **取值范围**： 0\~1024个字符。 **默认取值**： 不涉及。 | | feature_set | 否 | String | **参数解释**： 所属特性集ID，可以通过[查询特性集](https://support.huaweicloud.com/api-projectman/ShowBaselineSnapshots.html)接口获取，响应消息体中的**id**字段的值就是特性集ID。 **约束限制**： 不涉及。 **取值范围**： 18\~19个字符的数字字符串。 **默认取值**： 不涉及。 | | expected_repair_date | 否 | String | **参数解释**： 期望修复时间。预设字段中，仅Bug有此字段，unix时间戳，单位：毫秒。 **约束限制**： 不涉及。 **取值范围**： 11\~19个字符。 **默认取值**： 不涉及。 | | found_pi | 否 | String | **参数解释**： 缺陷发现发布计划ID，预设字段中，仅Bug有此字段。通过[发布/迭代计划列表查询](https://support.huaweicloud.com/api-projectman/ListPlan.html)接口查询计划列表，返回参数中PlanVO里面的category=PI的对象的**id**字段就是迭代计划的ID。 **约束限制**： 不涉及。 **取值范围**： 18\~19个字符的数字字符串。 **默认取值**： 不涉及。 | | found_iteration | 否 | String | **参数解释**： 缺陷发现迭代计划ID，预设字段中，仅Bug有此字段。通过[发布/迭代计划列表查询](https://support.huaweicloud.com/api-projectman/ListPlan.html)接口查询计划列表，返回参数中PlanVO里面的category=Iteration的对象的**id**字段就是迭代计划的ID。 **约束限制**： 不涉及。 **取值范围**： 18\~19个字符的数字字符串。 **默认取值**： 不涉及。 | | reason_analysis | 否 | String | **参数解释**： 分析原因。 **约束限制**： 预设字段中，仅Bug有此字段。 **取值范围**： 0\~50000个字符。 **默认取值**： 不涉及。 | | repair_solution | 否 | String | **参数解释**： 修复方案。预设字段中，仅Bug有此字段。 **约束限制**： 不涉及。 **取值范围**： 0\~50000个字符。 **默认取值**： 不涉及。 | | test_report | 否 | String | **参数解释**： 测试报告。预设字段中，仅Bug有此字段。 **约束限制**： 不涉及。 **取值范围**： 0\~50000个字符。 **默认取值**： 不涉及。 | | sys_no_repair_reason | 否 | String | **参数解释**： 无需修复原因。预设字段中，仅Bug有此字段。 **约束限制**： 不涉及。 **取值范围**： 0\~50000个字符。 **默认取值**： 不涉及。 | | sys_activation_reason | 否 | String | **参数解释**： 激活原因。预设字段中，仅Bug有此字段。 **约束限制**： 不涉及。 **取值范围**： 0\~50000个字符。 **默认取值**： 不涉及。 | | sys_return_reason | 否 | String | **参数解释**： 退回原因。预设字段中，仅Bug有此字段。 **约束限制**： 不涉及。 **取值范围**： 0\~50000个字符。 **默认取值**： 不涉及。 | | test_failures_times | 否 | Integer | **参数解释**： 回归不通过次数。预设字段中，仅Bug有此字段。 **约束限制**： 不涉及。 **取值范围**： 0\~999999。 **默认取值**： 不涉及。 | | close_type | 否 | String | **参数解释**： 关闭类型。 **约束限制**： 不涉及。 **取值范围**： - problem_solved：问题解决关闭 - problem_to_requirement：问题转需求关闭 - duplicate_problem：重复问题关闭 - not_a_problem：非问题关闭 **默认取值**： 不涉及。 | | plan_owner | 否 | [UserUpdateAttribute] object | **参数解释**： 工作项规划责任人。负责工作项的规划和计划制定。 **约束限制**： 不涉及。 | | doing_owner | 否 | [UserUpdateAttribute] object | **参数解释**： 工作项实现责任人。负责工作项的具体实现和执行。 **约束限制**： 不涉及。 | | delivered_owner | 否 | [UserUpdateAttribute] object | **参数解释**： 工作项交付责任人。负责工作项的交付和发布。 **约束限制**： 不涉及。 | | checking_owner | 否 | [UserUpdateAttribute] object | **参数解释**： 工作项验收责任人。负责工作项的最终验收确认。 **约束限制**： 不涉及。 | | test_owner | 否 | [UserUpdateAttribute] object | **参数解释**： 工作项测试责任人。负责工作项的测试验证。 **约束限制**： 不涉及。 | | develop_owner | 否 | [UserUpdateAttribute] object | **参数解释**： 工作项开发责任人。负责工作项的开发实现。 **约束限制**： 不涉及。 | | processing_owner | 否 | [UserUpdateAttribute] object | **参数解释**： 工作项处理中责任人。负责工作项的当前处理阶段。 **约束限制**： 不涉及。 | | fixed_owner | 否 | [UserUpdateAttribute] object | **参数解释**： 工作项修复责任人。负责工作项的问题修复。 **约束限制**： 不涉及。 | | researchanddevelop_owner | 否 | [UserUpdateAttribute] object | **参数解释**： 工作项研发责任人。负责工作项的研发工作。 **约束限制**： 不涉及。 | | analyse_owner | 否 | [UserUpdateAttribute] object | **参数解释**： 工作项分析责任人。负责工作项的需求分析和技术分析。 **约束限制**： 不涉及。 | | plan_start_date | 否 | String | **参数解释**： 计划开始时间。工作项的计划启动日期，用于项目进度管理和排期。 **约束限制**： 不涉及。 **取值范围**： 11\~19个字符的时间戳字符串，单位为毫秒（ms）。 **默认取值**： 不涉及。 | | expect_delivery_time | 否 | String | **参数解释**： 期望完成时间。工作项的预期交付日期，用于跟踪工作项是否按期完成。 **约束限制**： 不涉及。 **取值范围**： 11\~19个字符的时间戳字符串，单位为毫秒（ms）。 **默认取值**： 不涉及。 | | plan_test_end_date | 否 | String | **参数解释**： 计划测试结束时间。Bug类型工作项的计划测试完成日期，用于跟踪Bug修复后的测试进度。 **约束限制**： 仅对Bug类型工作项生效，非Bug类型忽略此字段。 **取值范围**： 11\~19个字符的时间戳字符串，单位为毫秒（ms）。 **默认取值**： 不涉及。 | | severity | 否 | String | **参数解释**： 严重程度。Bug类型工作项的严重级别，用于评估Bug的影响范围和修复优先级。 **约束限制**： 仅对Bug类型工作项生效，非Bug类型忽略此字段。 **取值范围**： - 致命：系统崩溃、数据丢失等严重影响 - 严重：主要功能无法使用 - 一般：次要功能异常，有替代方案 - 提示：界面优化、建议性问题 **默认取值**： 不涉及。 | | promised | 否 | String | **参数解释**： 是否承诺。RR（原始需求）类型工作项的承诺状态标识，用于标记需求是否已承诺交付。 **约束限制**： 仅对RR类型工作项生效，非RR类型忽略此字段。 **取值范围**： - yes：已承诺 - no：未承诺 **默认取值**： 不涉及。 | | recipient | 否 | Array of [UserUpdateAttribute] objects | **参数解释**： 承接人。RR（原始需求）类型工作项的需求承接责任人，负责需求的分析和转化。 **约束限制**： 仅对RR类型工作项生效，非RR类型忽略此字段。 | | sys_no_develop_reason | 否 | String | **参数解释**： 无需研发原因。RR（原始需求）类型工作项不需要进行研发的原因说明。 **约束限制**： 仅对RR类型工作项生效，非RR类型忽略此字段。 **取值范围**： 0\~50000个字符。 **默认取值**： 不涉及。 | | val_feature | 否 | String | **参数解释**： 价值特性。SF/FE类型工作项对应的业务价值特性描述，用于关联业务价值和技术实现。 **约束限制**： 仅对SF/FE类型工作项生效，其他类型忽略此字段。 **取值范围**： - yes：是 - no：否 **默认取值**： 不涉及。 | | function_scene | 否 | String | **参数解释**： 功能场景。SF/FE类型工作项的功能应用场景描述，用于说明特性的使用场景和用户故事。 **约束限制**： 仅对SF/FE类型工作项生效，其他类型忽略此字段。 **取值范围**： 0\~512个字符。 **默认取值**： 不涉及。 | 表5LabelEntity | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | id | 否 | String | **参数解释**： 标签ID，可通过[查询标签列表](https://support.huaweicloud.com/api-projectman/ListIpdLabels.html)接口获取，响应消息体中的**id**字段的值就是标签ID。 **约束限制**： 不涉及。 **取值范围**： 18\~19个字符的数字字符串。 **默认取值**： 不涉及。 | | category_types | 否 | Array of strings | **参数解释**： 标签所属工作项类型编码。 **约束限制**： 不涉及。 **默认取值**： 不涉及。 | | label_type | 否 | String | **参数解释**： 标签所属工作项类型，对应工作项的type字段，枚举类型。 **约束限制**： 不涉及。 **取值范围**： - raw requirement：原始需求 - feature：系统特性 - requirement：研发需求 - task：任务 - bug：缺陷 **默认取值**： 不涉及。 | | color | 否 | String | **参数解释**： 标签颜色RGB。 **约束限制**： 0\~16个字符。 **取值范围**： 可选颜色代码与对应中文描述如下： - #86CAFF：浅蓝色 - #6DDEBB：青绿色 - #A6DD82：黄绿色 - #FAC20A：金黄色 - #FA9841：橙色 - #F66F6A：珊瑚红 - #F3689A：粉红色 - #A97AF8：淡紫色 - #71757F：中性灰 - #5E7CE0：宝蓝色 - #207AB3：深蓝色 - #169E6C：翠绿色 - #6CA83B：草绿色 - #B58200：棕黄色 - #B54E04：赭石色 - #B02121：朱红色 - #AD215B：玫红色 - #572DB3：深紫色 - #4F4F4F：深灰色 - #3C51A6：靛蓝色 **默认取值**： 不涉及。 | | title | 否 | String | **参数解释**： 标签标题。 **约束限制**： 1\~30个字符。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | 表6FieldCodeValuePair | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | code | 否 | String | **参数解释**： 工作项自定义字段code值。可选值可以通过[查询字段模板列表](https://support.huaweicloud.com/api-projectman/ListIssueFields.html)接口获取，响应体中的**code**就是字段唯一标识。 **约束限制**： 0\~32个字符。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | value | 否 | String | **参数解释**： 工作项自定义字段值。 **约束限制**： 为多选时用英文逗号分隔。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | 表7UserUpdateAttribute | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | id | 否 | String | **参数解释**： 用户ID，可通过[查询项目成员列表](https://support.huaweicloud.com/api-projectman/ListProjectUsers.html)接口获取，响应消息体中的**id**字段的值就是用户ID。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | name | 否 | String | **参数解释**： 用户名称。 **约束限制**： 当**id** 属性有值时，优先使用**id** 和项目成员进行匹配，匹配失败再按**name**匹配。 **取值范围**： 2\~64个字符。 **默认取值**： 不涉及。 | | nick_name | 否 | String | **参数解释**： 用户昵称。 **约束限制**： 当**id** ，**name** 属性有值时，优先使用**id** ，**name** 和项目成员进行匹配，匹配失败再按**nick_name**匹配。 **取值范围**： 2\~30个字符。 **默认取值**： 不涉及。 | #### 响应参数 **状态码：200** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | result | Array of [IssueBatchOperateEntitiesResult] objects | **参数解释**： 批量编辑的结果。 | | status | String | **参数解释**： 返回状态。 **取值范围**： - success：响应成功 - error：响应失败 | | message | String | **参数解释**： 操作失败原因。 **取值范围**： 不涉及 | 表9IssueBatchOperateEntitiesResult | 参数 | 参数类型 | 描述 | |:---|:---|:---| | success | Array of [IssueOperateResult] objects | **参数解释**： 成功的结果。 | | failed | Array of [IssueOperateResult] objects | **参数解释**： 失败的结果。 | | undeleted_trees | Array of [IssueOperateResult] objects | **参数解释**： 删除失败的工作项。 **取值范围**： 不涉及 | 表10IssueOperateResult | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**： 变更的工作项ID。 **取值范围**： 不涉及 | | operator | String | **参数解释**： 工作项变更人ID。 **取值范围**： 不涉及 | | state | String | **参数解释**： 工作项的作废标识，枚举类型。 **取值范围**： - 正在工作：可正常操作的工作项 - 作废：软删除后的工作项，可在回收站恢复 - 删除：彻底删除后的工作项，无法恢复 | | operate_time | String | **参数解释**： 工作项变更时间。 **取值范围**： 不涉及 | **状态码：400** 表11响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。 **取值范围**： 不涉及。 | | error_msg | String | **参数解释**： 错误描述，对error_code的补充解释。 **取值范围**： 不涉及。 | #### 请求示例 批量更新研发需求 ``` PUT https://{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" : "1706607114000" }, { "id" : "957315051394478080", "operator" : "a360371833bf4c558f796fd707b44daf", "operate_time" : "1706607114000" } ], "failed" : [ ] } ] } ``` **状态码：400** 错误原因 ``` { "error_code" : "PM.02175202", "error_msg" : "工作项在变更评审中" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | | 400 | 错误原因 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-projectman/ErrorCode.html)。