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

批量删除工作项

功能介绍

批量删除工作项

调试

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目id
表2 Query参数

参数

是否必选

参数类型

描述

is_permanent_delete

否

Boolean

是否永久删除，可选值为true、false，true表示彻底删除工作项（适用于回收站中的工作项，彻底删除后不可恢复），false表示将工作项移入回收站

src_project_id

否

String

当工作项类型为RR或Bug时，工作项的提出项目Id，取值为工作项列表接口中的src_project，归属项目和提出项目一致时可不传

请求参数

表3 请求Body参数

参数

是否必选

参数类型

描述

[数组元素]

是

Array of strings

待删除的工作项id，每批最多删除50条

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

result

Array of IssueBatchOperateEntitiesResult objects

批量编辑的结果

status

String

操作状态

message

String

操作失败原因
表5 IssueBatchOperateEntitiesResult

参数

参数类型

描述

success

Array of IssueOperateResult objects

成功的结果

failed

Array of IssueOperateResult objects

失败的结果
表6 IssueOperateResult

参数

参数类型

描述

id

String

变更的工作项id

operator

String

工作项变更人id

state

String

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

operate_time

String

工作项变更时间

状态码： 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

批量删除工作项

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

[ "967726620515282944" ]

响应示例

状态码： 200

OK

{
  "status" : "success",
  "result" : [ {
    "success" : [ {
      "id" : "957355639715045376",
      "operator" : "a360371833bf4c558f796fd707b44daf",
      "state" : "作废",
      "operate_time" : "2024-01-29T21:19:18Z"
    } ],
    "failed" : [ ],
    "undeleted_trees" : [ ]
  } ]
}

状态码： 400

错误原因

{
  "error_code" : "PM.02175202",
  "error_msg" : "工作项在变更评审中"
}

状态码

状态码

描述

200

OK

400

错误原因

错误码

请参见错误码。

父主题： IPD工作项管理

相关文档