查询当前工作项已经关联的工作项 - ListAssociatedIssues
功能介绍
查询当前工作项已经关联的工作项。
调用方法
请参见如何调用API。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
URI
GET /v4/projects/{project_id}/issues/{issue_id}/associated-issues
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| issue_id | 是 | Integer | 参数解释: 工作项ID,可通过高级查询工作项接口获取,响应消息体中的id字段的值就是工作项ID。 约束限制: 不涉及。 取值范围: ≥0。 默认取值: 不涉及。 |
| project_id | 是 | String | 参数解释: 项目的32位UUID,项目唯一标识,通过查询项目列表接口获取,响应消息体中的project_id字段的值就是项目ID。 约束限制: 32个字符,由英文字母和数字组成。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| limit | 否 | Integer | 参数解释: 分页大小。 约束限制: 不涉及。 取值范围: 1-1000。 默认取值: 10 |
| offset | 否 | Integer | 参数解释: 分页起始,从0开始,为limit整数倍,默认为0。 约束限制: 不涉及。 取值范围: 0-10000 默认取值: 缺省值:0 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 长度为10~32768个字符。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| issues | Array of AssociateIssueDetail objects | 参数解释: 关联的工作项列表 |
| total | Integer | 参数解释: 关联工作项总数 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| issue_id | Integer | 参数解释: 工作项ID 取值范围: 不涉及 |
| project | SimpleProject object | 参数解释: 项目信息 |
| status | StatusVo object | 参数解释: 工作项状态信息 取值范围: 不涉及 |
| subject | String | 参数解释: 工作项标题 取值范围: 不涉及 |
| user | SimpleUser object | 参数解释: 用户信息 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| project_id | String | 参数解释: 项目的32位UUID,项目唯一标识,通过查询项目列表接口获取,响应消息体中的project_id字段的值就是项目ID。 |
| project_name | String | 参数解释: 项目名称 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| nick_name | String | 参数解释: 用户昵称,可通过获取指定项目的成员用户列表确认特定项目成员的用户nick_name字段 取值范围: 不涉及 |
| user_id | String | 参数解释: 用户UUID,可通过获取指定项目的成员用户列表确认特定项目成员的用户user_id字段 取值范围: 不涉及 |
| user_name | String | 参数解释: 账号名,可通过获取指定项目的成员用户列表确认特定项目成员的用户user_name字段 取值范围: 不涉及 |
| user_num_id | Integer | 参数解释: 用户数字id,可通过获取指定项目的成员用户列表确认特定项目成员的用户user_num_id字段 取值范围: 不涉及 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误描述。 取值范围: 不涉及。 |
状态码:401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误描述。 取值范围: 不涉及。 |
| request_id | String | 参数解释: 请求的ID,系统自动生成。 取值范围: 不涉及。 |
请求示例
GET https://{endpoint}/v4/projects/{project_id}/issues/{issue_id}/associated-issues 响应示例
状态码:200
查询当前工作项已经关联的工作项的返回信息。
{
"issues" : [ {
"subject" : "demo",
"issue_id" : 1234,
"project" : {
"project_name" : "demo",
"project_id" : "58d9050550c847c89885c1797a718b0c"
},
"user" : {
"user_num_id" : 4091,
"user_id" : "a360371833bf4c558f796fd707b44daf",
"user_name" : "demo_user_name_xiongzhitest001",
"nick_name" : "bear"
},
"status" : {
"id" : "1",
"name" : "未开始"
}
} ],
"total" : 12
} SDK代码示例
SDK代码示例如下。
Java
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 | 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 ListAssociatedIssuesSolution { 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(); ListAssociatedIssuesRequest request = new ListAssociatedIssuesRequest(); request.withProjectId("{project_id}"); request.withIssueId({issue_id}); try { ListAssociatedIssuesResponse response = client.listAssociatedIssues(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
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 | # 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 = ListAssociatedIssuesRequest() request.project_id = "{project_id}" request.issue_id = {issue_id} response = client.list_associated_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
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 | 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.ListAssociatedIssuesRequest{} request.ProjectId = "{project_id}" request.IssueId = int32({issue_id}) response, err := client.ListAssociatedIssues(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 查询当前工作项已经关联的工作项的返回信息。 |
| 400 | Bad Request |
| 401 | Unauthorized |
错误码
请参见错误码。