批量删除IPD项目工作项 - BatchDeleteIpdIssue
功能介绍
批量删除IPD项目工作项。删除操作将工作项状态置为"作废",支持一次请求删除多个工作项。返回结果中分别列出成功删除、删除失败的工作项ID列表,以及不可删除的工作项信息。
调用方法
请参见如何调用API。
授权信息
当前API调用无需身份策略权限。
URI
DELETE /v1/ipdprojectservice/projects/{project_id}/issues/batch-delete
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目的32位唯一标识ID,项目唯一标识。 通过查询项目列表获取,响应消息体中的id字段的值就是项目ID。 约束限制: 不涉及。 取值范围: 32个字符。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 10~32768个字符。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| status | String | 参数解释: 接口调用状态。 取值范围: |
| message | String | 参数解释: 接口调用结果描述,失败时携带失败原因。 取值范围: 不涉及。 |
| result | Array of BatchDeleteIssueResult objects | 参数解释: 批量删除的结果列表,包含每个项目的成功、失败、不可删除工作项树信息。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| success | Array of DeletedIssueInfo objects | 参数解释: 删除成功的工作项详情列表。 取值范围: 不涉及。 |
| failed | Array of strings | 参数解释: 删除失败的工作项ID列表。 取值范围: 不涉及。 |
| undeleteIssueTrees | Array of strings | 参数解释: 不可删除的工作项ID列表。这些工作项由于业务规则限制不能直接删除。 取值范围: 不涉及。 |
| success_num | Integer | 参数解释: 删除成功的工作项数量。 取值范围: 0~50 |
| fail_num | Integer | 参数解释: 删除失败的工作项数量。 取值范围: 0~50 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 工作项唯一标识ID。 取值范围: 18~19个字符的数字字符串。 |
| state | String | 参数解释: 工作项当前状态描述。 取值范围: 作废 |
| plan_pi | String | 参数解释: 工作项所属发布计划。 取值范围: 不涉及。 |
| plan_iteration | String | 参数解释: 工作项所属迭代。 取值范围: 不涉及。 |
| modified_by | String | 参数解释: 最后修改人ID。 取值范围: 32个字符的字符串。 |
| modified_date | String | 参数解释: 工作项最后修改时间,使用UTC时区的时间戳格式。 取值范围: 不涉及。 |
| sum_workload_man_day | String | 参数解释: 工作项总工作量(人天)。 取值范围: 不涉及。 |
| cascade_delete | String | 参数解释: 级联删除方式。 取值范围: |
| operation_id | String | 参数解释: 操作流水号,每次删除操作的唯一标识。 取值范围: 36个字符的UUID字符串。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误描述,对error_code的补充解释。 取值范围: 不涉及。 |
请求示例
删除项目8a5cc89982a44f53bdd55a050dfffa6f里面的工作项ID为1304481492646006784的工作项
DELETE https://{endpoint}/v1/ipdprojectservice/projects/8a5cc89982a44f53bdd55a050dfffa6f/issues/batch-delete
[ "1304481492646006784" ] 响应示例
状态码:200
{
"status" : "success",
"message" : "success",
"result" : [ {
"success" : [ {
"sum_workload_man_day" : "",
"plan_pi" : "",
"cascade_delete" : "none",
"modified_by" : "a360371833bf4c558f796fd707b44daf",
"operation_id" : "ca01c19b-37e1-4717-80c4-c0c7a1cbccc0",
"state" : "作废",
"id" : "1304481492646006784",
"modified_date" : "1788942748392",
"plan_iteration" : ""
} ],
"failed" : [ ],
"undeleteIssueTrees" : [ ],
"success_num" : 1,
"fail_num" : 0
} ]
} 状态码:400
{
"error_code" : "PM.02174103",
"error_msg" : "无操作权限"
} SDK代码示例
SDK代码示例如下。
Java
删除项目8a5cc89982a44f53bdd55a050dfffa6f里面的工作项ID为1304481492646006784的工作项
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 BatchDeleteIpdIssueSolution { 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(); BatchDeleteIpdIssueRequest request = new BatchDeleteIpdIssueRequest(); request.withProjectId("{project_id}"); List<String> listbodyBody = new ArrayList<>(); listbodyBody.add("1304481492646006784"); request.withBody(listbodyBody); try { BatchDeleteIpdIssueResponse response = client.batchDeleteIpdIssue(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
删除项目8a5cc89982a44f53bdd55a050dfffa6f里面的工作项ID为1304481492646006784的工作项
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 = BatchDeleteIpdIssueRequest() request.project_id = "{project_id}" listBodybody = [ "1304481492646006784" ] request.body = listBodybody response = client.batch_delete_ipd_issue(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
删除项目8a5cc89982a44f53bdd55a050dfffa6f里面的工作项ID为1304481492646006784的工作项
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.BatchDeleteIpdIssueRequest{} request.ProjectId = "{project_id}" var listBodybody = []string{ "1304481492646006784", } request.Body = &listBodybody response, err := client.BatchDeleteIpdIssue(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 批量删除工作项成功。 |
| 400 | 请求失败的响应。例如无操作权限、项目不存在。 |
错误码
请参见错误码。