批量删除工作项 - BatchDeleteIpdIssues
功能介绍
批量删除工作项
调用方法
请参见如何调用API。
URI
DELETE /v1/ipdprojectservice/projects/{project_id}/issues/batch
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目的32位uuid,项目唯一标识,通过查询项目列表接口获取,响应消息体中的project_id字段的值就是项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
is_permanent_delete |
否 |
Boolean |
是否永久删除,可选值为true、false,true表示彻底删除工作项(适用于回收站中的工作项,彻底删除后不可恢复),false表示将工作项移入回收站 |
|
src_project_id |
否 |
String |
当工作项类型为RR或Bug时,工作项的提出项目Id,取值为工作项列表接口中的src_project,归属项目和提出项目一致时可不传 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
[数组元素] |
是 |
Array of strings |
待删除的工作项id,每批最多删除50条。工作项ID可以通过查询工作项列表/查询树状工作项接口获取。 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
result |
Array of IssueBatchOperateEntitiesResult objects |
参数解释: 批量编辑的结果 |
|
status |
String |
参数解释: 返回状态。 取值范围:
|
|
message |
String |
参数解释: 操作失败原因 取值范围: 不涉及 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
success |
Array of IssueOperateResult objects |
参数解释: 成功的结果 |
|
failed |
Array of IssueOperateResult objects |
参数解释: 失败的结果 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
参数解释: 变更的工作项id 取值范围: 不涉及 |
|
operator |
String |
参数解释: 工作项变更人id 取值范围: 不涉及 |
|
state |
String |
参数解释: 工作项的作废标识,枚举类型。 取值范围:
|
|
operate_time |
String |
参数解释: 工作项变更时间 取值范围: 不涉及 |
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释: 错误码。 取值范围: 不涉及。 |
|
error_msg |
String |
参数解释: 错误描述,对error_code的补充解释。 取值范围: 不涉及。 |
请求示例
批量删除工作项
https://{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 |
错误原因 |
错误码
请参见错误码。