工作项关联/取消关联 - AssociateIssues
功能介绍
支持动态关联或取消工作项间的父子层级及其他关联关系,用户可以根据不同的参数明确是关联或者取消,也可以根据参数明确关联的类型,比如关联父、子工作项或者关联其他工作项。
调用方法
请参见如何调用API。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
URI
PUT /v2/ipdprojectservice/projects/{project_id}/issues/{issue_id}/associated-item
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目32位ID,项目唯一标识。通过查询IPD项目列表获取,响应消息体中的id字段的值就是项目ID。 约束限制: 不涉及。 取值范围: 32个字符,由英文字母和数字组成。 默认取值: 不涉及。 |
| issue_id | 是 | String | 参数解释: 工作项唯一ID。可以通过查询工作项列表或者查询树状工作项接口获取,响应消息体中的id字段的值就是工作项ID。 约束限制: 不涉及。 取值范围: 18~19个字符的数字字符串。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| dst_domain_id | 是 | String | 参数解释: 目标项目的32位UUID,项目唯一标识。通过查询IPD项目列表获取,响应消息体中的id字段的值就是项目ID。非跨项目场景,与请求路径中的project_id一致。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 10~32768个字符。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| associated_ids | 是 | String | 参数解释: 关联的工作项ID,多个ID使用逗号分割。可以通过查询工作项列表或者查询树状工作项接口获取,响应消息体中的id字段的值就是工作项ID。 约束限制: 当link_field_code=link时,最多支持关联500个工作项ID,其他场景最多支持50个工作项ID。 取值范围: 不涉及。 默认取值: 不涉及。 |
| operation_flag | 是 | Integer | 参数解释: 操作类型标记位。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| associate_issue_type | 是 | String | 参数解释: 关联项类型编码。 约束限制: 不涉及。 取值范围: 支持多种工作项类型,使用英文逗号分隔。 默认取值: 不涉及。 |
| source_issue_type | 是 | String | 参数解释: 当前工作项类型编码。 约束限制: 不涉及。 取值范围: 支持多种工作项类型,使用英文逗号分隔。 默认取值: 不涉及。 |
| is_replace | 否 | Boolean | 参数解释: 是否使用替换模式。默认为false,追加关联项。如果为true,则会删除原有的关联项,替换为本次关联的工作项。 约束限制: 不涉及。 取值范围: 默认取值: false |
| link_field_code | 否 | String | 参数解释: 关联字段的字段编码。 约束限制: 不涉及。 取值范围: 默认取值: link |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| [数组元素] | Array of AssociateIssuesResponseV2 objects | 关联/取消关联响应对象 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| status | String | 参数解释: 响应状态。 取值范围: |
| message | String | 参数解释: 关联失败的原因。 取值范围: 不涉及。 |
| result | Map<String,Array<AssociateRespDetail>> | 参数解释: 关联工作项的响应结果。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| issue_id | String | 参数解释: 关联的工作项ID,多个ID使用逗号分割。 取值范围: 不涉及。 |
| fail_msg | String | 参数解释: 失败原因。 取值范围: 不涉及。 |
| operation_flag | Integer | 参数解释: 操作类型标记位。 取值范围: |
| modified_date | Long | 参数解释: 修改日期。 取值范围: 不涉及。 |
| modified_by | String | 参数解释: 修改人。 取值范围: 不涉及。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误描述,对error_code的补充解释。 取值范围: 不涉及。 |
请求示例
假设项目ID为26f251d688044d6ca53f7b1b8829d168,工作项ID为1211022056590450688,类型为IR,给该工作项关联ID为1210999503448743936的Task类型工作项,示例如下:
PUT https://{endpoint}/v2/ipdprojectservice/projects/26f251d688044d6ca53f7b1b8829d168/issues/1211022056590450688/associated-item?dst_domain_id=26f251d688044d6ca53f7b1b8829d168
{
"associated_ids" : "1210999503448743936",
"operation_flag" : 0,
"associate_issue_type" : "Task",
"source_issue_type" : "IR"
} 响应示例
状态码:200
工作项关联/取消关联成功的响应
{
"status" : "success",
"message" : "",
"result" : {
"fail" : [ ],
"success" : [ {
"issue_id" : "1210999503448743936",
"operation_flag" : 0,
"modified_date" : "1767085429225",
"modified_by" : "a360371833bf4c558f796fd707b44daf"
} ]
}
} 状态码:400
工作项关联/取消关联失败的响应
{
"error_code" : "PM.02176410",
"error_msg" : "关联的工作项已不存在"
} SDK代码示例
SDK代码示例如下。
Java
假设项目ID为26f251d688044d6ca53f7b1b8829d168,工作项ID为1211022056590450688,类型为IR,给该工作项关联ID为1210999503448743936的Task类型工作项,示例如下:
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 53 | 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.*; public class AssociateIssuesSolution { 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(); AssociateIssuesRequest request = new AssociateIssuesRequest(); request.withProjectId("{project_id}"); request.withIssueId("{issue_id}"); IssueAssociateVO body = new IssueAssociateVO(); body.withSourceIssueType("IR"); body.withAssociateIssueType("Task"); body.withOperationFlag(0); body.withAssociatedIds("1210999503448743936"); request.withBody(body); try { AssociateIssuesResponse response = client.associateIssues(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
假设项目ID为26f251d688044d6ca53f7b1b8829d168,工作项ID为1211022056590450688,类型为IR,给该工作项关联ID为1210999503448743936的Task类型工作项,示例如下:
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 | # 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 = AssociateIssuesRequest() request.project_id = "{project_id}" request.issue_id = "{issue_id}" request.body = IssueAssociateVO( source_issue_type="IR", associate_issue_type="Task", operation_flag=0, associated_ids="1210999503448743936" ) response = client.associate_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
假设项目ID为26f251d688044d6ca53f7b1b8829d168,工作项ID为1211022056590450688,类型为IR,给该工作项关联ID为1210999503448743936的Task类型工作项,示例如下:
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 53 54 55 | 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.AssociateIssuesRequest{} request.ProjectId = "{project_id}" request.IssueId = "{issue_id}" request.Body = &model.IssueAssociateVo{ SourceIssueType: "IR", AssociateIssueType: "Task", OperationFlag: int32(0), AssociatedIds: "1210999503448743936", } response, err := client.AssociateIssues(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 工作项关联/取消关联成功的响应 |
| 400 | 工作项关联/取消关联失败的响应 |
错误码
请参见错误码。