Help Center/ CodeArts Req/ API Reference/ API/ Scrum Project Statuses/ Plans of a Scrum Project/ Deleting Work Items in the Current Plan in Batches
Updated on 2025-09-10 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Deleting Work Items in the Current Plan in Batches

Function

This API is used to delete work items in the current plan in batches.

Calling Method

For details, see Calling APIs.

URI

DELETE /v3/plan/{project_id}/{plan_id}/issue

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

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:

Regular expression: [A-Za-z0-9]{32}

Options:

N/A

Default value:

N/A

plan_id

Yes

String

Definition:

Unique ID of a release or sprint. You can obtain the release/sprint ID using the Querying the Release/Sprint List API. The value of the id field in the response message body is the release/sprint ID.

Constraints:

N/A

Options:

N/A

Default value:

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

status

String

Definition:

Status of the response body.

Value range:

success: successful

error: failed

Example Requests

{endpoint}/v3/plan/5192de5eb435430c8cd41c6ae6028848/f29c3f16d5f54cbab5e167ef9eed3baf/issue

Example Responses

Status code: 200

Response body.

{
  "status" : "success"
}

Status Codes

Status Code

Description

200

Response body.

Error Codes

See Error Codes.

Parent topic: Plans of a Scrum Project