更新时间:2025-09-10 GMT+08:00

批量删除工作项V2

功能介绍

批量删除工作项。

调用方法

请参见如何调用API

URI

POST /v2/workitem/batch-delete

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

必传。

取值范围:

最小长度:10,最大长度:32768。

默认取值:

不涉及。

表2 请求Body参数

参数

是否必选

参数类型

描述

-

String

批量删除工作项请求体。

project_id

String

参数解释

项目的32位uuid,项目唯一标识,通过查询项目列表接口获取,响应消息体中的project_id字段的值就是项目ID。

约束限制

32位的数字和字母组成的字符串。

取值范围

不涉及。

默认取值

不涉及。

issue_ids

String

参数解释:

工作项id,可通过高级查询工作项接口获取,响应消息体中的id字段的值就是工作项id。

约束限制:

长度在1位到10位之间的纯数字。

取值范围:

最小长度:1,最大长度:10。

默认取值:

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

-

String

批量删除工作项返回体信息。

result

result object

参数解释:

返回结果。

取值范围:

不涉及。

status

String

参数解释:

返回状态。

取值范围:

success:删除成功。

error:删除失败。

表4 result

参数

参数类型

描述

delete_issue

delete_issue object

参数解释:

删除的工作项。

取值范围:

不涉及。

表5 delete_issue

参数

参数类型

描述

del_issue_id

Array of integers

参数解释:

删除的工作项id。

取值范围:

不涉及。

del_issue

Array of del_issue objects

参数解释:

删除的工作项详情。

取值范围:

不涉及。

表6 del_issue

参数

参数类型

描述

id

Integer

参数解释:

工作项id。

取值范围:

不涉及。

tracker_id

Integer

参数解释:

工作项类型。

取值范围:

2(任务/Task)

3(缺陷/Bug)

5(Epic)

6(Feature)

7(Story)

subject

String

参数解释:

工作项名称 。

取值范围:

不涉及。

status_id

Integer

参数解释:

工作项状态id 。

取值范围:

不涉及。

done_ratio

Integer

参数解释:

工作项完成度。

取值范围:

不涉及。

expected_work_hours

Integer

参数解释:

预计工时(单位:人时)。

取值范围:

不涉及。

actual_work_hours

Integer

参数解释:

实际工时(单位:人时)。

取值范围:

不涉及。

deleted

Boolean

参数解释:

是否完成删除。

取值范围:

0(未删除)

1(已删除)

is_archived

Boolean

参数解释:

是否归档。

取值范围:

0(未归档)

1(已归档)

请求示例

请求信息

{endpoint}/v2/workitem/batch-delete?_=1753261560409

{
  "project_id" : "5192de5eb435430c8cd41c6ae6028848",
  "issue_ids" : "9190894,9179013"
}

响应示例

状态码:200

批量删除工作项接口成功的响应。

{
    "result": {
        "delete_issue": {
            "del_issue_id": [
                9190894
            ],
            "del_issue": [
                {
                    "id": 9190894,
                    "tracker_id": 7,
                    "subject": "123",
                    "status_id": 1,
                    "done_ratio": 0,
                    "expected_work_hours": 0.0,
                    "actual_work_hours": 0.0,
                    "deleted": false,
                    "is_archived": false
                }
            ]
        },
    },
    "status": "success"
}

状态码

状态码

描述

200

批量删除工作项接口成功的响应。

错误码

请参见错误码