文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 需求管理/ 查询需求树 - ShowIssueTree
更新时间：2026-10-22 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询需求树 - ShowIssueTree

功能介绍

此接口用于查询需求树状结构,当传入parent_id时会查询父id下的需求,当parent_id为空时,则会查询全部的需求层级结构,对应页面 测试 -> 测试用例 -> 左侧需求数

调用方法

请参见如何调用API。

URI

POST /v4/{project_id}/versions/{version_uri}/issue-tree

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目ID。

version_uri

是

String

版本uri

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

service_type

否

Integer

参数解释:

服务类型，用于筛选指定类型测试用例对应的需求

约束限制:

不涉及

取值范围:

  • -1：全量用例

  • 0：手工测试

  • 1：接口自动化

  • 7：功能自动化

  • 8：WebUI自动化

  • 100：自定义自动化(工厂)

  • 11：性能自动化

默认取值:

不涉及

service_types

否

Array of integers

参数解释

服务类型集合，用于同时筛选多种类型测试用例对应的需求。数组内整数值含义：-1表示全量用例，0表示手工测试，1表示接口自动化，7表示功能自动化，8表示WebUI自动化，100表示自定义自动化(工厂)，11表示性能自动化

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

parent_id

否

String

参数解释

父节点id，用于指定查询的父节点。获取方式：从查询需求树接口的返回字段获取

约束限制

不涉及

取值范围

不超过128位的字母及数字组合

默认取值

不涉及

page_number

否

Integer

参数解释

页码

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

page_size

否

Integer

参数解释

每页数量

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

filter

否

IssueListFilterInfo object

参数解释

过滤条件

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

tracker_id

否

String

参数解释

工作项类型ID，用于按类型筛选需求。获取方式：从查询工作项类型接口的返回字段获取

约束限制

不涉及

取值范围

不超过64位的字母数字组合

默认取值

不涉及

module_id

否

String

参数解释

模块id，用于指定查询的模块范围。获取方式：从查询模块列表接口的返回字段获取

约束限制

不涉及

取值范围

1-32位字母及数字

默认取值

不涉及

task_uri

否

String

参数解释

任务uri，用于指定查询的任务范围。获取方式：从查询测试任务列表接口的返回字段获取

约束限制

不涉及

取值范围

字符串类型，长度为11-34位的字母或数字

默认取值

不涉及

include_sub_issue

否

Boolean

参数解释

是否统计子需求的用例数

约束限制

不涉及

取值范围

true:统计 false:不统计

默认取值

true
表3 IssueListFilterInfo

参数

是否必选

参数类型

描述

iteration_ids

否

Array of strings

参数解释

迭代id列表，用于按迭代筛选需求。数组内每个string为迭代的唯一标识，格式为字母及数字组合

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

pi_sprints

否

Array of IssueListPiFilterInfo objects

参数解释

PI过滤条件列表，用于按PI和迭代筛选需求。数组内每个IssueListPiFilterInfo对象包含pi_id和sprints信息，用于指定PI下的迭代范围

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

subject

否

String

参数解释

需求名

约束限制

不涉及

取值范围

长度不超过128位的字符串

默认取值

不涉及

module_id

否

String

参数解释

模块id，用于指定筛选的模块范围。获取方式：从查询模块列表接口的返回字段获取

约束限制

不涉及

取值范围

32位以内的字母及数字组合

默认取值

不涉及

status_id

否

String

参数解释

需求状态id，用于按状态筛选需求。获取方式：从查询工作项状态接口的返回字段获取

约束限制

不涉及

取值范围

32位以内的字母及数字

默认取值

不涉及
表4 IssueListPiFilterInfo

参数

是否必选

参数类型

描述

sprints

否

Array of strings

参数解释

迭代列表，用于指定PI下的迭代范围。数组内每个string为迭代的唯一标识

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

pi_id

否

String

参数解释

pi的id，层级关系：pi -> 迭代 -> 需求。获取方式：从查询PI列表接口的返回字段获取

约束限制

不涉及

取值范围

长度不超过128位的字符串

默认取值

不涉及

响应参数

状态码：200

表5 响应Body参数

参数

参数类型

描述

total

Integer

参数解释

总数

取值范围

不小于1的正整数

page_no

Integer

参数解释

当前页码

取值范围

大于0且小于100的正整数

page_size

Integer

参数解释

分页大小

取值范围

大于零且小于20000的正整数

value

Array of WorkItemVo objects

参数解释

需求列表，包含查询到的需求工作项信息。数组内每个WorkItemVo对象代表一个需求工作项的详细信息

取值范围

不涉及

has_more

Boolean

参数解释

是否有更多

取值范围

  • true：还有更多数据

  • false：没有更多数据
表6 WorkItemVo

参数

参数类型

描述

name

String

参数解释

工作项名称

取值范围

不涉及

owner

String

参数解释

处理人

取值范围

不涉及

path

String

参数解释

工作项路径

取值范围

不涉及

start_date

String

参数解释

预计开始日期，格式为yyyy-MM-dd

取值范围

不涉及

due_date

String

参数解释

预计结束日期，格式为yyyy-MM-dd

取值范围

不涉及

region

String

参数解释

逻辑region，使用公有云实际区域

取值范围

不涉及

creator

String

参数解释

创建人

取值范围

不涉及

updator

String

参数解释

更新人

取值范围

不涉及

project_uuid

String

参数解释

项目UUID，项目唯一标识

取值范围

不涉及

work_item_id

String

参数解释

工作项编号

取值范围

不涉及

status_id

String

参数解释

状态ID

取值范围

不涉及

status_name

String

参数解释

状态

取值范围

不涉及

tracker_id

String

参数解释

类型ID

取值范围

不涉及

tracker_name

String

参数解释

类型

取值范围

不涉及

iteration_id

String

参数解释

迭代ID

取值范围

不涉及

module_id

String

参数解释

模块ID

取值范围

不涉及

severity_id

String

参数解释

重要程度ID

取值范围

不涉及

severity_name

String

参数解释

重要程度

取值范围

不涉及

parent_workitem_id

String

参数解释

父工作项编号

取值范围

不涉及

board_id

String

参数解释

看板ID

取值范围

不涉及

board_name

String

参数解释

看板名称

取值范围

不涉及

create_time

String

参数解释

创建时间，格式为yyyy-MM-dd HH:mm:ss

取值范围

不涉及

update_time

String

参数解释

更新时间，格式为yyyy-MM-dd HH:mm:ss

取值范围

不涉及

iteration_name

String

参数解释

迭代名

取值范围

不涉及

module_name

String

参数解释

模块名

取值范围

不涉及

module_path

String

参数解释

模块path

取值范围

不涉及

module_path_name

String

参数解释

模块路径名称

取值范围

不涉及

owner_name

String

参数解释

处理人

取值范围

不涉及

have_child_dynamic

Boolean

参数解释

父工作项下是否有子工作项包含动态

取值范围

true:是 false:否

has_child

Boolean

参数解释

父工作项下是否有子工作项

取值范围

true:有子工作项 false:无子工作项

issue_dynamic_count

Integer

参数解释

需求动态数量

取值范围

不涉及

case_count

Integer

参数解释

用例数量

取值范围

不涉及

sequence_id

String

参数解释

xBoard项目工作项序列

取值范围

不涉及

pi_id

String

参数解释

pi的id，层级关系：pi -> 迭代 -> 需求

取值范围

不涉及

pi_name

String

参数解释

pi名称

取值范围

不涉及

状态码：400

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

接口调用失败错误码

取值范围:

不涉及

error_msg

String

参数解释:

接口调用失败错误信息

取值范围:

不涉及

状态码：401

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

接口调用失败错误码

取值范围:

不涉及

error_msg

String

参数解释:

接口调用失败错误信息

取值范围:

不涉及

状态码：404

表9 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

接口调用失败错误码

取值范围:

不涉及

error_msg

String

参数解释:

接口调用失败错误信息

取值范围:

不涉及

状态码：500

表10 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

接口调用失败错误码

取值范围:

不涉及

error_msg

String

参数解释:

接口调用失败错误信息

取值范围:

不涉及

请求示例

post https://{endpoint}/v4/f3087a82b44744c29a1bd69ab6ada154/versions/{version_uri}/issue-tree

{
  "parent_id" : null,
  "page_number" : 1,
  "page_size" : 50
}

响应示例

状态码：200

{
  "value" : [ {
    "name" : "智能手表可语音遥控手机拍照",
    "work_item_id" : "1140302477026828288",
    "tracker_id" : "7",
    "tracker_name" : "IR",
    "have_child_dynamic" : false,
    "has_child" : false,
    "issue_dynamic_count" : 0,
    "case_count" : 0,
    "sequence_id" : "IR20250613536057"
  }, {
    "name" : "智能手表可语音遥控手机拍照",
    "work_item_id" : "1116809374191366145",
    "tracker_id" : "6",
    "tracker_name" : "SF",
    "have_child_dynamic" : false,
    "has_child" : false,
    "issue_dynamic_count" : 0,
    "case_count" : 0,
    "sequence_id" : "SF20250409317534"
  }, {
    "name" : "智能手表能控制iOS 手机播放音乐",
    "work_item_id" : "1116809374187171842",
    "tracker_id" : "6",
    "tracker_name" : "SF",
    "have_child_dynamic" : false,
    "has_child" : false,
    "issue_dynamic_count" : 0,
    "case_count" : 0,
    "sequence_id" : "SF20250409317533"
  }, {
    "name" : "智能手表能控制iOS 手机拍照",
    "work_item_id" : "1116809374187171841",
    "tracker_id" : "6",
    "tracker_name" : "SF",
    "have_child_dynamic" : false,
    "has_child" : false,
    "issue_dynamic_count" : 0,
    "case_count" : 0,
    "sequence_id" : "SF20250409317532"
  }, {
    "name" : "智能手表能同步查看手机的消息通知",
    "work_item_id" : "1116809374187171840",
    "tracker_id" : "6",
    "tracker_name" : "SF",
    "have_child_dynamic" : false,
    "has_child" : false,
    "issue_dynamic_count" : 0,
    "case_count" : 0,
    "sequence_id" : "SF20250409317531"
  }, {
    "name" : "智能手表具有兼容性，能控制老华为手机，非鸿蒙手机拍照",
    "work_item_id" : "1116809374182977538",
    "tracker_id" : "6",
    "tracker_name" : "SF",
    "have_child_dynamic" : false,
    "has_child" : false,
    "issue_dynamic_count" : 0,
    "case_count" : 0,
    "sequence_id" : "SF20250409317530"
  }, {
    "name" : "智能手表可同步手表运动数据至手机",
    "work_item_id" : "1116809374182977537",
    "tracker_id" : "6",
    "tracker_name" : "SF",
    "have_child_dynamic" : false,
    "has_child" : false,
    "issue_dynamic_count" : 0,
    "case_count" : 0,
    "sequence_id" : "SF20250409317529"
  }, {
    "name" : "智能手表可遥控手机接打电话",
    "work_item_id" : "1116809374178783233",
    "tracker_id" : "6",
    "tracker_name" : "SF",
    "have_child_dynamic" : false,
    "has_child" : false,
    "issue_dynamic_count" : 0,
    "case_count" : 0,
    "sequence_id" : "SF20250409317528"
  }, {
    "name" : "智能手表能遥控手机拍照",
    "work_item_id" : "1116809374178783232",
    "tracker_id" : "6",
    "tracker_name" : "SF",
    "have_child_dynamic" : false,
    "has_child" : false,
    "issue_dynamic_count" : 0,
    "case_count" : 0,
    "sequence_id" : "SF20250409317527"
  }, {
    "name" : "智能手表能遥控手机播放音乐",
    "work_item_id" : "1116809374174588929",
    "tracker_id" : "6",
    "tracker_name" : "SF",
    "have_child_dynamic" : false,
    "has_child" : false,
    "issue_dynamic_count" : 0,
    "case_count" : 0,
    "sequence_id" : "SF20250409317526"
  }, {
    "name" : "【支持同步手机备忘录到手表】",
    "work_item_id" : "1116809374086508544",
    "tracker_id" : "7",
    "tracker_name" : "IR",
    "have_child_dynamic" : false,
    "has_child" : false,
    "issue_dynamic_count" : 0,
    "case_count" : 0,
    "sequence_id" : "IR20250409317493"
  }, {
    "name" : "【支持查看手机微信消息】智能手表可同步查看手机微信消息",
    "work_item_id" : "1116809374082314243",
    "tracker_id" : "7",
    "tracker_name" : "IR",
    "have_child_dynamic" : false,
    "has_child" : false,
    "issue_dynamic_count" : 0,
    "case_count" : 0,
    "sequence_id" : "IR20250409317492"
  }, {
    "name" : "智能表遥控拍照支持老华为手机、非鸿蒙手机，与手环体验一致",
    "work_item_id" : "1116809374082314242",
    "tracker_id" : "7",
    "tracker_name" : "IR",
    "have_child_dynamic" : false,
    "has_child" : false,
    "issue_dynamic_count" : 0,
    "case_count" : 0,
    "sequence_id" : "IR20250409317491"
  }, {
    "name" : "智能手表遥控拍照支持iOS手机",
    "work_item_id" : "1116809374082314241",
    "tracker_id" : "7",
    "tracker_name" : "IR",
    "have_child_dynamic" : false,
    "has_child" : false,
    "issue_dynamic_count" : 0,
    "case_count" : 0,
    "sequence_id" : "IR20250409317490"
  }, {
    "name" : "【遥控接听电话】智能手表可遥控手机接听电话",
    "work_item_id" : "1116809374078119938",
    "tracker_id" : "7",
    "tracker_name" : "IR",
    "have_child_dynamic" : false,
    "has_child" : false,
    "issue_dynamic_count" : 0,
    "case_count" : 0,
    "sequence_id" : "IR20250409317489"
  }, {
    "name" : "【遥控播放音乐】智能手表控制手机播放音乐",
    "work_item_id" : "1116809374078119937",
    "tracker_id" : "7",
    "tracker_name" : "IR",
    "have_child_dynamic" : false,
    "has_child" : false,
    "issue_dynamic_count" : 0,
    "case_count" : 0,
    "sequence_id" : "IR20250409317488"
  }, {
    "name" : "【支持同步运动数据到手机】",
    "work_item_id" : "1116809374078119936",
    "tracker_id" : "7",
    "tracker_name" : "IR",
    "have_child_dynamic" : false,
    "has_child" : false,
    "issue_dynamic_count" : 0,
    "case_count" : 0,
    "sequence_id" : "IR20250409317487"
  }, {
    "name" : "【特殊任务场景】消息通知来临时延迟提醒-遥控拍照",
    "work_item_id" : "1116809374073925634",
    "tracker_id" : "7",
    "tracker_name" : "IR",
    "have_child_dynamic" : false,
    "has_child" : false,
    "issue_dynamic_count" : 0,
    "case_count" : 0,
    "sequence_id" : "IR20250409317486"
  }, {
    "name" : "【智慧语音】语音控制手表遥控拍照",
    "work_item_id" : "1116809374073925633",
    "tracker_id" : "7",
    "tracker_name" : "IR",
    "have_child_dynamic" : false,
    "has_child" : false,
    "issue_dynamic_count" : 0,
    "case_count" : 0,
    "sequence_id" : "IR20250409317485"
  }, {
    "name" : "智能手表作为手机相机遥控器，支持拍照功能",
    "work_item_id" : "1116809374065537024",
    "tracker_id" : "7",
    "tracker_name" : "IR",
    "have_child_dynamic" : false,
    "has_child" : false,
    "issue_dynamic_count" : 0,
    "case_count" : 0,
    "sequence_id" : "IR20250409317484"
  } ]
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题： 需求管理

相关文档