查询需求树 - 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	服务类型集合
parent_id	否	String	父节点id
page_number	否	Integer	页码
page_size	否	Integer	每页数量
filter	否	IssueListFilterInfo object	过滤条件
tracker_id	否	String	trackerId
module_id	否	String	模块id
task_uri	否	String	任务udi
include_sub_issue	否	Boolean	是否统计子需求的用例数，默认true

表3 IssueListFilterInfo
参数	是否必选	参数类型	描述
iteration_ids	否	Array of strings	迭代id列表
pi_sprints	否	Array of IssueListPiFilterInfo objects	pi过滤条件
subject	否	String	需求名
module_id	否	String	模块id
status_id	否	String	需求状态id

表4 IssueListPiFilterInfo
参数	是否必选	参数类型	描述
sprints	否	Array of strings	迭代列表
pi_id	否	String	pi的id，层级关系：pi -> 迭代 -> 需求

响应参数

状态码：200

表5 响应Body参数
参数	参数类型	描述
value	Array of WorkItemVo objects	实际的数据类型：单个对象，集合或 NULL

表6 WorkItemVo
参数	参数类型	描述
name	String	工作项名称
owner	String	处理人
path	String	工作项路径
start_date	String	预计开始日期
due_date	String	预计结束日期
region	String	逻辑region，外部使用公有云实际区域，内部使用默认值
creator	String	创建人
updator	String	更新人
project_uuid	String	项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目ID。
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	创建时间
update_time	String	更新时间
iteration_name	String	迭代名
module_name	String	模块名
module_path	String	模块path
module_path_name	String	模块路径名称
owner_name	String	处理人
have_child_dynamic	Boolean	父工作项下是否有子工作项包含动态
has_child	Boolean	父工作项下是否有子工作项
issue_dynamic_count	Integer	需求动态数量
case_count	Integer	用例数量
sequence_id	String	xBoard项目工作项序列号
pi_id	String	pi的id，层级关系：pi -> 迭代 -> 需求
pi_name	String	迭代ID

状态码：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"
  } ]
}