Help Center/ CodeArts Req/ API Reference/ API/ Work Items of the Scrum Project/ Deleting Work Items in Batches (V2)
Updated on 2025-09-10 GMT+08:00

Deleting Work Items in Batches (V2)

Function

This API is used to delete work items in batches.

Calling Method

For details, see Calling APIs.

URI

POST /v2/workitem/batch-delete

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition:

User token. Obtain a token by calling the IAM API forobtaining a user token. The value of X-Subject-Token in the response header is the user token.

Constraints:

Mandatory.

Value range:

Minimum length: 10 characters. Maximum length: 32,768 characters.

Default value:

N/A

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

-

No

String

Request body for deleting work items in batches.

project_id

No

String

Definition:

32-character UUID of a project, which uniquely identifies a project. Obtain the value of this parameter from the project_id field in the response body of the Querying the Project List API.

Constraints:

The value must contain 32 characters. Digits and letters are allowed.

Value range:

N/A

Default value:

N/A

issue_ids

No

String

Definition:

Work item ID, which can be obtained from the Performing Advanced Query of Work Items API. The value of the id field in the response message body is the work item ID.

Constraints:

The value must contain 1 to 10 digits.

Value range:

Minimum length: 1 character. Maximum length: 10 characters.

Default value:

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

-

String

Response body for deleting work items in batches.

result

result object

Definition:

Returned result.

Value range:

N/A

status

String

Definition:

Returned status.

Value range:

success: The deletion is successful.

error: The deletion failed.

Table 4 result

Parameter

Type

Description

delete_issue

delete_issue object

Definition:

Deleted work item.

Value range:

N/A

Table 5 delete_issue

Parameter

Type

Description

del_issue_id

Array of integers

Definition:

ID of the work item to be deleted.

Value range:

N/A

del_issue

Array of del_issue objects

Definition:

Details about the deleted work item.

Value range:

N/A

Table 6 del_issue

Parameter

Type

Description

id

Integer

Definition:

Work item ID.

Value range:

N/A

tracker_id

Integer

Definition:

Work item type.

Value range:

2 (task)

3 (bug)

5 (epic)

6 (feature)

7 (story)

subject

String

Definition:

Work item name.

Value range:

N/A

status_id

Integer

Definition:

Work item status ID.

Value range:

N/A

done_ratio

Integer

Definition:

Work item completion rate.

Value range:

N/A

expected_work_hours

Integer

Definition:

Estimated workloads (unit: person-hour).

Value range:

N/A

actual_work_hours

Integer

Definition:

Actual workloads (unit: person-hour).

Value range:

N/A

deleted

Boolean

Definition:

Whether the deletion is complete.

Value range:

0 (not deleted)

1 (deleted)

is_archived

Boolean

Definition:

Archived or not.

Value range:

0 (not archived)

1 (archived)

Example Requests

Request information

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

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

Example Responses

Status code: 200

Returned information.

{
    "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"
}

Status Codes

Status Code

Description

200

Returned information.

Error Codes

See Error Codes.