文档首页/ 需求管理 CodeArts Req/ API参考/ API/ Scrum项目的设置/ 查询模板字段配置 - ListFieldTemplate
更新时间:2026-09-15 GMT+08:00
分享

查询模板字段配置 - ListFieldTemplate

功能介绍

查询项目下模板字段配置列表,可指定tracker_id筛选特定工作项类型的模板。

调用方法

请参见如何调用API

授权信息

当前API调用无需身份策略权限。

URI

GET /v2/projects/{project_id}/field-templates

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

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

约束限制

32位的数字和字母组成的字符串。

取值范围

不涉及。

默认取值

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

tracker_id

Integer

参数解释

工作项类型ID,用于筛选特定工作项类型的模板。

约束限制

不涉及。

取值范围

  • 2:任务/Task

  • 3:缺陷/Bug

  • 5:Epic

  • 6:Feature

  • 7:Story

默认取值

不涉及(返回所有类型的模板)。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

不涉及。

取值范围:

长度为10~32768个字符。

默认取值:

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

result

result object

参数解释

返回结果,包含模板字段配置信息。

取值范围

不涉及。

status

String

参数解释

请求结果。

取值范围

  • success:查询模板字段配置成功。

  • failed:查询模板字段配置失败。

表5 result

参数

参数类型

描述

templates

Array of templates objects

参数解释

模板列表,包含多个模板的配置信息。

取值范围

不涉及。

表6 templates

参数

参数类型

描述

template_id

String

参数解释

模板ID,模板的唯一标识。

取值范围

不涉及。

tracker_id

Integer

参数解释

工作项类型ID,标识该模板所属的工作项类型。

取值范围

  • 2:任务/Task

  • 3:缺陷/Bug

  • 5:Epic

  • 6:Feature

  • 7:Story

tracker_name

String

参数解释

工作项类型名称,对应tracker_id的中文/英文名称。

取值范围

不涉及。

description

String

参数解释

模板描述,说明模板的用途或功能。

取值范围

不涉及。

fields

Array of fields objects

参数解释

字段配置列表,包含该模板下所有字段的配置信息。

取值范围

不涉及。

表7 fields

参数

参数类型

描述

custom

Boolean

参数解释

是否为自定义字段。

取值范围

  • true:自定义字段

  • false:系统内置字段

field

String

参数解释

字段标识,用于唯一标识一个字段。

取值范围

不涉及。

field_type

String

参数解释

字段类型,描述字段的数据类型或展示形式。

取值范围

  • select:下拉选择类型

  • text:文本类型

  • date:日期类型

  • number:数字类型

  • radio:单选列表

  • checkbox:多选列表

  • user:单选用户

  • multiChoiceUsers:多选用户

type_options

String

参数解释

字段类型选项,描述该字段类型的可选配置。

取值范围

不涉及。

default_value

String

参数解释

字段默认值,创建工作项时该字段的初始值。

取值范围

不涉及。

default_option

default_option object

参数解释

默认选项,当字段类型为下拉选择时的默认选项。

取值范围

不涉及。

is_visible

Boolean

参数解释

字段是否显示。

取值范围

  • true:显示

  • false:隐藏

position

Integer

参数解释

字段显示顺序位置,数值越小排序越靠前。

取值范围

大于0的整数。

is_required

Integer

参数解释

字段是否为必填。

取值范围

  • 0:非必填

  • 1:必填

last

Boolean

参数解释

是否为分组中的最后一个字段。

取值范围

  • true:是最后一个字段

  • false:不是最后一个字段

option

Array of option objects

参数解释

字段的可选项列表,当字段类型为下拉选择时有效。

取值范围

不涉及。

field_name

String

参数解释

字段中文名称,用于展示给用户的字段名称。

取值范围

不涉及。

表8 default_option

参数

参数类型

描述

id

String

参数解释

选项ID。

取值范围

不涉及。

name

String

参数解释

选项名称。

取值范围

不涉及。

表9 option

参数

参数类型

描述

id

String

参数解释

选项ID。

取值范围

不涉及。

name

String

参数解释

选项名称。

取值范围

不涉及。

状态码:400

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

查询项目下所有模板及其字段配置

GET https://{endpoint}/v2/projects/a6a33eca679b435b85574bd2fde46ce7/field-templates?tracker_id=7

响应示例

状态码:200

{
  "result" : {
    "templates" : [ {
      "id" : 384006,
      "name" : "12345",
      "description" : "",
      "tracker_id" : 7,
      "field_configs" : [ {
        "field" : "module_id",
        "name" : "模块",
        "field_type" : "select",
        "is_required" : 0,
        "is_visible" : true,
        "position" : 3
      }, {
        "field" : "fixed_version_id",
        "name" : "迭代",
        "field_type" : "select",
        "is_required" : 0,
        "is_visible" : true,
        "position" : 4
      } ]
    } ]
  },
  "status" : "success"
}

状态码

状态码

描述

200

查询项目下模板字段配置列表接口成功的响应。

400

接口请求失败的响应。

错误码

请参见错误码

相关文档