# 查询Scrum工作项自定义字段 - ListIssueCustomFields #### 功能介绍 查询Scrum工作项自定义字段的可选列表,符合custom_fields或者names条件的都返回，2个值都不传，返回所有的自定义字段列表。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-projectman/projectman_api_1002.html)。 #### 授权信息 账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见[权限和授权项](https://support.huaweicloud.com/api-projectman/projectman_03_Permission.html)。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | codeartsreq:custom:list | List | - | - codeartsreq:Model - codeartsreq:ProjectId | - | - | #### URI POST /v4/projects/{project_id}/issues/custom-fields 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 项目的32位UUID，项目唯一标识，通过[查询项目列表接口](https://support.huaweicloud.com/api-projectman/ListProjectsV4.html)获取，响应消息体中的**project_id**字段的值就是项目ID。 **约束限制**： 32个字符，由英文字母和数字组成。 **取值范围：** 不涉及。 **默认取值**： 不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取（响应消息头中X-Subject-Token的值）。 **约束限制：** 不涉及。 **取值范围：** 长度为10\~32768个字符。 **默认取值：** 不涉及。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | custom_fields | 否 | Array of strings | **参数解释：** 自定义字段 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | included_not_in_use | 否 | Boolean | **参数解释：** 查询结果是否包括未使用的自定义字段，默认仅查询使用中的自定义字段 **约束限制：** false（不包括） true（包括） **取值范围：** 不涉及 **默认取值：** 不涉及 | | names | 否 | Array of strings | **参数解释：** 自定义字段页面显示的含义 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | datas | Array of [IssueCustomField] objects | **参数解释：** 自定义字段返回数据 | 表5IssueCustomField | 参数 | 参数类型 | 描述 | |:---|:---|:---| | create_time | String | **参数解释：** 自定义字段创建时间 **取值范围：** 不涉及 | | custom_field | String | **参数解释：** 自定义字段 **取值范围：** 不涉及 | | name | String | **参数解释：** 自定义字段显示含义 **取值范围：** 不涉及 | | options | String | **参数解释：** 自定义字段的可选值，多个值以英文逗号区分 **取值范围：** 不涉及 | | tracker_ids | Array of integers | **参数解释：** 自定义字段被哪些工作项类型使用。 **取值范围：** - 2（任务/Task） - 3（缺陷/Bug） - 5（Epic） - 6（Feature） - 7（Story） - 空数组（表示当前自定义字段未被任何工作项类型使用） | | type | String | **参数解释：** 自定义字段类型 **取值范围：** - textArea：多行文本，只能包含汉字、英文大小写字母、数字、下划线和连接符，不能超过500字符 - text：单行文本，只能包含汉字、英文大小写字母、数字、下划线和连接符，不能超过500字符 - number：数字，取值范围由用户创建自定义字段时设置 - time_date：日期 精确到年月日，time_date日期精确到时分秒，长整型时间戳 - checkbox：多选框，只能包含汉字、英文大小写字母、数字、下划线和连接符，每个选项最大长度40个字符，最多可定义60个选项 - radio：单选框，只能包含汉字、英文大小写字母、数字、下划线和连接符，每个选项最大长度40个字符，最多可定义60个选项 - user：单选用户，取值为项目内成员 - multiChoiceUsers：多选用户，取值为项目内成员 | **状态码：400** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。 **取值范围**： 不涉及。 | | error_msg | String | **参数解释**： 错误描述。 **取值范围**： 不涉及。 | **状态码：401** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。 **取值范围**： 不涉及。 | | error_msg | String | **参数解释**： 错误描述。 **取值范围**： 不涉及。 | | request_id | String | **参数解释**： 请求的ID，系统自动生成。 **取值范围**： 不涉及。 | #### 请求示例 ``` POST https://{endpoint}/v4/projects/0792b7d26cb74bd799cbae80063dc74a/issues/custom-fields { "included_not_in_use" : true, "names" : [ "下拉框Demo" ] } ``` #### 响应示例 **状态码：200** ``` { "datas" : [ { "name" : "selectName", "custom_field" : "custom_field16", "options" : "selectName1,selectName2", "type" : "ratio", "tracker_ids" : [ 7 ], "create_time" : "2023-05-17T09:50:04+08:00" } ] } ``` #### SDK代码示例 SDK代码示例如下。 #### Java ``` 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 ListIssueCustomFieldsSolution { 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("")) .build(); ListIssueCustomFieldsRequest request = new ListIssueCustomFieldsRequest(); request.withProjectId("{project_id}"); ListIssueCustomFieldsRequestBody body = new ListIssueCustomFieldsRequestBody(); List listbodyNames = new ArrayList<>(); listbodyNames.add("下拉框Demo"); body.withIncludedNotInUse(true); body.withNames(listbodyNames); request.withBody(body); try { ListIssueCustomFieldsResponse response = client.listIssueCustomFields(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 ``` # 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("")) \ .build() try: request = ListIssueCustomFieldsRequest() request.project_id = "{project_id}" listNamesbody = [ "下拉框Demo" ] request.body = ListIssueCustomFieldsRequestBody( included_not_in_use=True, names=listNamesbody ) response = client.list_issue_custom_fields(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 ``` 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("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := projectman.NewProjectManClient(hcClient) request := &model.ListIssueCustomFieldsRequest{} request.ProjectId = "{project_id}" var listNamesbody = []string{ "下拉框Demo", } includedNotInUseListIssueCustomFieldsRequestBody:= true request.Body = &model.ListIssueCustomFieldsRequestBody{ IncludedNotInUse: &includedNotInUseListIssueCustomFieldsRequestBody, Names: &listNamesbody, } response, err := client.ListIssueCustomFields(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` #### 更多 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/ProjectMan/sdk?api=ListIssueCustomFields)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | | 400 | Bad Request | | 401 | Unauthorized | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-projectman/ErrorCode.html)。