更新时间:2025-07-28 GMT+08:00
分享

查询Scrum工作项自定义字段

功能介绍

查询Scrum工作项自定义字段的可选列表,符合custom_fields或者names条件的都返回,2个值都不传,返回所有的自定义字段列表。

调用方法

请参见如何调用API

URI

POST /v4/projects/{project_id}/issues/custom-fields

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目的32位uuid,项目唯一标识,通过查询项目列表接口获取,响应消息体中的project_id字段的值就是项目ID。

约束限制

正则表达式,[A-Za-z0-9]{32}。

取值范围:

不涉及。

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中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

参数解释:

自定义字段返回数据

约束限制:

不涉及

表5 IssueCustomField

参数

参数类型

描述

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字符)

select(下拉框,只能包含汉字、英文大小写字母、数字、下划线和连接符,每个选项最大长度40个字符,最多可定义60个选项)

number(数字,取值范围由用户创建自定义字段时设置)

date(日期 精确到年月日,time_date日期精确到时分秒,长整型时间戳)

checkbox(多选框,只能包含汉字、英文大小写字母、数字、下划线和连接符,每个选项最大长度40个字符,最多可定义60个选项)

radio(单选框,只能包含汉字、英文大小写字母、数字、下划线和连接符,每个选项最大长度40个字符,最多可定义60个选项)

状态码:400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

Post https://{endpoint}/v4/projects/0792b7d26cb74bd799cbae80063dc74a/issues/custom-fields

{
  "included_not_in_use" : true,
  "names" : [ "下拉框Demo" ]
}

响应示例

状态码:200

OK

{
  "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

 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
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("<YOUR REGION>"))
                .build();
        ListIssueCustomFieldsRequest request = new ListIssueCustomFieldsRequest();
        request.withProjectId("{project_id}");
        ListIssueCustomFieldsRequestBody body = new ListIssueCustomFieldsRequestBody();
        List<String> 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

 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 = 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

 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
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 := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := projectman.NewProjectManClient(
        projectman.ProjectManClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    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的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

错误码

请参见错误码

相关文档