查询项目下的工作项模板V2 - ListTemplatesV2

功能介绍

查询项目下的工作项模板。

调用方法

请参见如何调用API。

授权信息

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

URI

GET /v2/template/config

表1 Query参数
参数	是否必选	参数类型	描述
projectUUId	是	String	参数解释：项目的32位uuid，项目唯一标识，通过查询项目列表接口获取，响应消息体中的project_id字段的值就是项目ID。约束限制： 32位的数字和字母组成的字符串。取值范围：不涉及。默认取值：不涉及。
trackerId	是	String	参数解释：工作项类型id。约束限制：不涉及。取值范围： 2（任务/Task） 3（缺陷/Bug） 5（Epic） 6（Feature） 7（Story）默认取值：不涉及。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	参数解释：用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。约束限制：必传。取值范围：最小长度：10，最大长度：32768。默认取值：不涉及。

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
-	String	查询项目下的工作项模板的返回参数。
result	result object	参数解释：返回结果。取值范围：不涉及。
status	String	参数解释：返回状态。取值范围： success：返回成功。 error：返回失败。

表4 result
参数	参数类型	描述
templates	Templates object	参数解释：工作项的模板信息。取值范围：不涉及。

表5 Templates
参数	参数类型	描述
id	Integer	参数解释：工作项模板id。约束限制：不涉及。
project_id	Integer	参数解释：项目数字id。约束限制：不涉及。
tracker_id	String	参数解释：工作项类型id。约束限制： 2（任务/Task） 3（缺陷/Bug） 5（Epic） 6（Feature） 7（Story）
description	String	参数解释：工作项的描述取值范围：不涉及。
creator_id	Integer	参数解释：创建者id。取值范围：不涉及。
created_on	String	参数解释：创建时间。时间戳格式（示例：1839340800000）。取值范围：不涉及。
updated_on	String	参数解释：更新时间。时间戳格式（示例：1839340800000）。取值范围：不涉及。
project_uuid	String	参数解释：项目32位id 取值范围：不涉及。
issue_field_configs	Array of IssueFieldConfig objects	参数解释：工作项字段配置信息。取值范围：不涉及。
tracker_id2	Integer	参数解释：工作项类型id。约束限制： 2（任务/Task） 3（缺陷/Bug） 5（Epic） 6（Feature） 7（Story）

表6 IssueFieldConfig
参数	参数类型	描述
custom	Boolean	参数解释：是否自定义状态。取值范围： true（是自定义状态） false（不是自定义状态）
default_option	Array of OptionVOV2 objects	参数解释：默认配置。
default_options	Array of OptionVOV2 objects	参数解释：默认配置。
default_value	String	参数解释：字段的默认值。取值范围：不涉及。
field	String	参数解释：字段。取值范围：不涉及。
field_type	String	参数解释：字段值设置类型。取值范围： textArea（多行文本，只能包含汉字、英文大小写字母、数字、下划线和连接符，不能超过500字符） text（单行文本，只能包含汉字、英文大小写字母、数字、下划线和连接符，不能超过500字符） select（下拉框，只能包含汉字、英文大小写字母、数字、下划线和连接符，每个选项最大长度40个字符，最多可定义60个选项） number（数字，取值范围由用户创建自定义字段时设置） date（日期，精确到年月日） time_date，时间戳格式（示例：1839340800000）（日期精确到时分秒，长整型时间戳） checkbox（多选框，只能包含汉字、英文大小写字母、数字、下划线和连接符，每个选项最大长度40个字符，最多可定义60个选项） radio（单选框，只能包含汉字、英文大小写字母、数字、下划线和连接符，每个选项最大长度40个字符，最多可定义60个选项）
is_required	Integer	参数解释：状态是否必选状态。取值范围： 0（不是必选状态） 1（是必选状态）
is_visible	Boolean	参数解释：状态是否可见。取值范围： true（可见） false（不可见）
last	Boolean	参数解释：状态是否处于最后位置。取值范围： true（最后） false（不是最后）
name	String	参数解释：字段名称。取值范围：不涉及。
option	Array of OptionVOV2 objects	参数解释：配置。
options	String	参数解释：字段配置。取值范围：不涉及。
position	Integer	参数解释：状态在页面的位置id 取值范围：不涉及。
project_id	String	参数解释：项目32位id，项目唯一标识，通过查询项目列表接口获取，响应消息体中的project_id字段的值就是项目ID。取值范围：不涉及。
tracker_list	Array of integers	参数解释：工作项类型列表。
type_options	String	参数解释：字段值设置类型。取值范围： select（可选值） fixed_value（固定值）

表7 OptionVOV2
参数	参数类型	描述
id	String	参数解释：选项Id。取值范围：不涉及。
name	String	参数解释：选项名称。取值范围：不涉及。

请求示例

{endpoint}/v2/template/config?projectUUId=a6a33eca679b435b85574bd2fde46ce7&trackerId=7

响应示例

状态码：200

查询项目下的工作项模板接口成功的响应。

{
  "result" : {
    "templates" : [ {
      "id" : 3275278,
      "project_id" : 35138974,
      "tracker_id" : 7,
      "description" : "TEST",
      "tracker_id2" : 7,
      "issue_field_configs" : [ {
        "custom" : false,
        "field" : "module_id",
        "name" : "模块",
        "field_type" : "select",
        "type_options" : "select,fixed_value",
        "default_value" : "",
        "is_visible" : true,
        "position" : 3,
        "is_required" : 0,
        "last" : true,
        "tracker_list" : [ ]
      }, {
        "custom" : false,
        "field" : "fixed_version_id",
        "name" : "迭代",
        "field_type" : "select",
        "type_options" : "select,fixed_value",
        "default_value" : "",
        "is_visible" : true,
        "position" : 4,
        "is_required" : 0,
        "last" : true,
        "option" : [ {
          "id" : "current",
          "name" : "当前迭代"
        } ],
        "tracker_list" : [ ]
      }, {
        "custom" : false,
        "field" : "parent_issue_id",
        "name" : "父工作项",
        "field_type" : "select",
        "type_options" : "select,fixed_value",
        "default_value" : "",
        "is_visible" : true,
        "position" : 16,
        "is_required" : 0,
        "last" : false,
        "tracker_list" : [ ]
      }, {
        "custom" : false,
        "field" : "domain_id",
        "name" : "领域",
        "field_type" : "select",
        "type_options" : "select,fixed_value",
        "default_value" : "",
        "is_visible" : true,
        "position" : 17,
        "is_required" : 0,
        "last" : true,
        "tracker_list" : [ ]
      }, {
        "custom" : false,
        "field" : "more",
        "name" : "以下为查看更多的内容",
        "field_type" : "",
        "type_options" : "",
        "default_value" : "",
        "is_visible" : true,
        "position" : 18,
        "is_required" : 0,
        "last" : false,
        "tracker_list" : [ ]
      }, {
        "custom" : false,
        "field" : "releaseDev",
        "name" : "发布版本号",
        "field_type" : "text",
        "type_options" : "fixed_value",
        "default_value" : "",
        "is_visible" : true,
        "position" : 19,
        "is_required" : 0,
        "last" : false,
        "tracker_list" : [ ]
      } ]
    } ]
  },
  "status" : "success"
}