Help Center/ CodeArts Req/ API Reference/ API/ IPD Work Item Management/ Deleting Work Items in Batches
Updated on 2026-10-13 GMT+08:00

Deleting Work Items in Batches

Function

This API is used to delete work items in batches.

Calling Method

For details, see Calling APIs.

Authorization Information

No identity policy-based permission required for calling this API.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

32-character ID of a project, which must be unique. Obtain the value by calling the API for querying the IPD project list. The value of id in the response message body is the project ID.

Constraints

N/A

Range

A string of 32 characters consisting of letters and digits.

Default Value

N/A

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

is_permanent_delete

No

Boolean

Definition

Whether to permanently delete.

Constraints

N/A

Range

  • true: permanently delete a work item (applicable to work items in the recycle bin; permanently deleted work items cannot be restored).

  • false: move the work item to the recycle bin.

Default Value

false

src_project_id

No

String

Definition

ID of the project that proposes the work item when the work item type is RR or Bug. Obtain the value by calling the API for querying the IPD project list. The value of id in the response message body is the project ID.

Constraints

This parameter is optional when the responsible project is the same as the proposing project.

Range

N/A

Default Value

N/A

Request Parameters

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

[items]

Yes

Array of strings

Definition

IDs of the work items to be deleted. Obtain the value from the API for querying work items or querying tree-shaped work items. The value of id in the response body is the work item ID.

Constraints

A maximum of 50 records can be deleted in each batch.

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

result

Array of IssueBatchOperateEntitiesResult objects

Definition

Result of batch editing.

status

String

Definition

Response status.

Range

  • success: The response is successful.

  • error: The response fails.

message

String

Definition

Operation failure cause.

Range

N/A

Table 5 IssueBatchOperateEntitiesResult

Parameter

Type

Description

success

Array of IssueOperateResult objects

Definition

Success result.

failed

Array of IssueOperateResult objects

Definition

Failure result.

undeleted_trees

Array of IssueOperateResult objects

Definition

Work items that fail to be deleted.

Range

N/A

Table 6 IssueOperateResult

Parameter

Type

Description

id

String

Definition

ID of the changed work item.

Range

N/A

operator

String

Definition

ID of the work item changer.

Range

N/A

state

String

Definition

Discard flag of a work item. The options are as follows.

Range

  • In use: work items that can be operated properly

  • Discarded: soft-deleted work items that can be restored from the recycle bin

  • Deleted: permanently deleted work items that cannot be restored

operate_time

String

Definition

Work item change time.

Range

N/A

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

Range

N/A

error_msg

String

Definition

Error description, which is a supplement to error_code.

Range

N/A

Example Requests

This API is used to delete work items in batches.

DELETE https://{endpoint}/v1/ipdprojectservice/projects/8e70d806a8f04d018ea6af6b6ffe7b96/issues/batch

[ "967726620515282944" ]

Example Responses

Status code: 200

{
  "status" : "success",
  "result" : [ {
    "success" : [ {
      "id" : "957355639715045376",
      "operator" : "a360371833bf4c558f796fd707b44daf",
      "state" : "Discarded",
      "operate_time" : "1706607114000"
    } ],
    "failed" : [ ],
    "undeleted_trees" : [ ]
  } ]
}

Status code: 400

{
  "error_code" : "PM.02175202",
  "error_msg" : "The work item is in change review."
}

SDK Sample Code

The SDK sample code is as follows.

Java

This API is used to delete work items in batches.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.projectman.v4.region.ProjectManRegion;
import com.huaweicloud.sdk.projectman.v4.*;
import com.huaweicloud.sdk.projectman.v4.model.*;

import java.util.List;
import java.util.ArrayList;

public class BatchDeleteIpdIssuesSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        ProjectManClient client = ProjectManClient.newBuilder()
                .withCredential(auth)
                .withRegion(ProjectManRegion.valueOf("<YOUR REGION>"))
                .build();
        BatchDeleteIpdIssuesRequest request = new BatchDeleteIpdIssuesRequest();
        request.withProjectId("{project_id}");
        List<String> listbodyBody = new ArrayList<>();
        listbodyBody.add("967726620515282944");
        request.withBody(listbodyBody);
        try {
            BatchDeleteIpdIssuesResponse response = client.batchDeleteIpdIssues(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

Python

This API is used to delete work items in batches.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkprojectman.v4.region.projectman_region import ProjectManRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkprojectman.v4 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]

    credentials = BasicCredentials(ak, sk)

    client = ProjectManClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(ProjectManRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = BatchDeleteIpdIssuesRequest()
        request.project_id = "{project_id}"
        listBodybody = [
            "967726620515282944"
        ]
        request.body = listBodybody
        response = client.batch_delete_ipd_issues(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Go

This API is used to delete work items in batches.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    projectman "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/projectman/v4"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/projectman/v4/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/projectman/v4/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := projectman.ProjectManClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := projectman.NewProjectManClient(hcClient)

    request := &model.BatchDeleteIpdIssuesRequest{}
	request.ProjectId = "{project_id}"
	var listBodybody = []string{
        "967726620515282944",
    }
	request.Body = &listBodybody
	response, err := client.BatchDeleteIpdIssues(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

More

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

OK

400

Error cause.

Error Codes

See Error Codes.