文档首页/ 需求管理 CodeArts Req/ API参考/ API/ IPD字段管理/ 查询工作项类型字段列表
更新时间:2025-08-21 GMT+08:00
分享

查询工作项类型字段列表

功能介绍

根据工作项类型查询字段列表。

调用方法

请参见如何调用API

URI

GET /v1/ipdprojectservice/projects/{project_id}/categories/{category_id}/field/templates

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

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

约束限制

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

取值范围

不涉及。

默认取值

不涉及。

category_id

String

参数解释:

工作项类型5位id。

约束限制:

正则表达式:"^[\d]{5}"。

取值范围:

IPD-系统设备类:10021(RR);10065(SF);10020(IR);10022(SR);10029(AR);10027(Task);10033(Bug)

IPD-独立软件类:10021(RR);10065(SF);10020(IR);10023(US);10027(Task);10033(Bug)

IPD-自运营软件/云服务类:10001(Epic);10028(FE);10021(RR);10023(US);10027(Task);10033(Bug)

默认取值:

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

page

Integer

参数解释

分页参数,页码。

约束限制

正则表达式,^(100|[1-9][0-9]?|1)。

取值范围

[1,100]

默认取值

不涉及。

size

Integer

参数解释

分页参数,每页查询数据数量。

约束限制

正则表达式,^(1000|[1-9][0-9]{1,2}|10)。

取值范围

[10,1000]

默认取值

不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

必传。

取值范围:

最小长度:10,最大长度:32768。

默认取值:

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

page

PageVO object

参数解释: 分页信息。

result

Array of FieldVO objects

参数解释: 返回数据。

表5 PageVO

参数

参数类型

描述

page

String

参数解释:

当前页

取值范围:

不涉及

size

String

参数解释:

每页条数

取值范围:

不涉及

count

String

参数解释:

数据总数

取值范围:

不涉及

表6 FieldVO

参数

参数类型

描述

display_name

String

参数解释:

字段名称。

取值范围:

不涉及。

created_by

String

参数解释:

添加人。

取值范围:

不涉及。

field_type

String

参数解释:

字段类型。

取值范围:

不涉及。

show_on_card

Boolean

参数解释:

是否显示在新建页。

取值范围:

true:是;false:否。

optional

Boolean

参数解释:

是否必填。

取值范围:

true:必填;false:非必填。

all_options

Array of OptionEntity objects

参数解释:

字段选项。

取值范围:

不涉及。

default_value

String

参数解释:

默认值。

取值范围:

不涉及。

表7 OptionEntity

参数

参数类型

描述

id

String

参数解释:

选项id

取值范围:

不涉及

code

String

参数解释:

选项code值

取值范围:

不涉及

display_value

String

参数解释:

选项名称

取值范围:

不涉及

value

String

参数解释:

选项唯一标识

取值范围:

不涉及

level

Integer

参数解释:

选项层级。用于区分层级字段的层级

取值范围:

层级字段最多4层

sequence

Integer

参数解释:

选项顺序

取值范围:

不涉及

parent_id

String

参数解释:

父选项id

取值范围:

不涉及

请求示例

GEThttps://{endpoint}/v1/ipdprojectservice/projects/05c7d8bcf3db4829bc841e4ba93aaea5/categories/10021/field/templates?page=1&size=10

响应示例

状态码:200

成功响应

{
  "page" : {
    "page" : 1,
    "size" : 10,
    "count" : 15
  },
  "result" : [ {
    "display_name" : "优先级",
    "created_by" : "系统",
    "field_type" : "pick",
    "show_on_card" : false,
    "optional" : true,
    "all_options" : [ {
      "id" : "1135144056192544813",
      "code" : "高",
      "display_value" : "高",
      "value" : "高",
      "level" : 1,
      "sequence" : 1
    } ],
    "default_value" : ""
  } ]
}

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

    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();
        ListIssueFieldsRequest request = new ListIssueFieldsRequest();
        request.withProjectId("{project_id}");
        request.withCategoryId("{category_id}");
        try {
            ListIssueFieldsResponse response = client.listIssueFields(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 = ListIssueFieldsRequest()
        request.project_id = "{project_id}"
        request.category_id = "{category_id}"
        response = client.list_issue_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
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.ListIssueFieldsRequest{}
	request.ProjectId = "{project_id}"
	request.CategoryId = "{category_id}"
	response, err := client.ListIssueFields(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

成功响应

错误码

请参见错误码

相关文档