更新时间:2025-08-25 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" : ""
  } ]
}

状态码

状态码

描述

200

成功响应

错误码

请参见错误码