# 批量删除工作项 - BatchDeleteIpdIssues #### 功能介绍 批量删除工作项 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-projectman/projectman_api_1002.html)。 #### 授权信息 当前API调用无需身份策略权限。 #### URI DELETE /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个字符，由英文字母和数字组成。 **默认取值**： 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | is_permanent_delete | 否 | Boolean | **参数解释**： 是否永久删除。 **约束限制**： 不涉及。 **取值范围**： - true：彻底删除工作项（适用于回收站中的工作项，彻底删除后不可恢复）。 - false：将工作项移入回收站。 **默认取值**： false。 | | src_project_id | 否 | String | **参数解释**： 当工作项类型为RR或Bug时，工作项的提出项目ID。通过[查询IPD项目列表](https://support.huaweicloud.com/api-projectman/ShowIpdProjectList.html)获取，响应消息体中的**id**字段的值就是项目ID。 **约束限制**： 归属项目和提出项目一致时可不传。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | #### 请求参数 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | \[数组元素\] | 是 | Array of strings | **参数解释**： 待删除的工作项ID列表。工作项ID可以通过[查询工作项列表](https://support.huaweicloud.com/api-projectman/ListIpdProjectIssues.html)或者[查询树状工作项](https://support.huaweicloud.com/api-projectman/ShowIpdIssueTree.html)接口获取，响应消息体中的**id**字段的值就是工作项ID。 **约束限制**： 每批最多删除50条。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | result | Array of [IssueBatchOperateEntitiesResult] objects | **参数解释**： 批量编辑的结果。 | | status | String | **参数解释**： 返回状态。 **取值范围**： - success：响应成功 - error：响应失败 | | message | String | **参数解释**： 操作失败原因。 **取值范围**： 不涉及 | 表5IssueBatchOperateEntitiesResult | 参数 | 参数类型 | 描述 | |:---|:---|:---| | success | Array of [IssueOperateResult] objects | **参数解释**： 成功的结果。 | | failed | Array of [IssueOperateResult] objects | **参数解释**： 失败的结果。 | | undeleted_trees | Array of [IssueOperateResult] objects | **参数解释**： 删除失败的工作项。 **取值范围**： 不涉及 | 表6IssueOperateResult | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**： 变更的工作项ID。 **取值范围**： 不涉及 | | operator | String | **参数解释**： 工作项变更人ID。 **取值范围**： 不涉及 | | state | String | **参数解释**： 工作项的作废标识，枚举类型。 **取值范围**： - 正在工作：可正常操作的工作项 - 作废：软删除后的工作项，可在回收站恢复 - 删除：彻底删除后的工作项，无法恢复 | | operate_time | String | **参数解释**： 工作项变更时间。 **取值范围**： 不涉及 | **状态码：400** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。 **取值范围**： 不涉及。 | | error_msg | String | **参数解释**： 错误描述，对error_code的补充解释。 **取值范围**： 不涉及。 | #### 请求示例 批量删除工作项 ``` DELETE https://{endpoint}/v1/ipdprojectservice/projects/8e70d806a8f04d018ea6af6b6ffe7b96/issues/batch [ "967726620515282944" ] ``` #### 响应示例 **状态码：200** OK ``` { "status" : "success", "result" : [ { "success" : [ { "id" : "957355639715045376", "operator" : "a360371833bf4c558f796fd707b44daf", "state" : "作废", "operate_time" : "1706607114000" } ], "failed" : [ ], "undeleted_trees" : [ ] } ] } ``` **状态码：400** 错误原因 ``` { "error_code" : "PM.02175202", "error_msg" : "工作项在变更评审中" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | | 400 | 错误原因 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-projectman/ErrorCode.html)。