获取项目需求树 - ShowIssuesTreeNew

功能介绍

此接口用于查询项目下的需求树状结构,当传入parent_id时会查询父id下的需求,当parent_id为空时,则会查询全部的需求层级结构.

调用方法

请参见如何调用API。

URI

POST /v4/projects/{project_id}/issues-tree

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目ID。

请求参数

表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参数
参数	参数类型	描述
total	Integer	起始记录数大于实际总条数时，值为0，分页请求才有此值
value	Array of TestIssueVo objects	实际的数据类型：单个对象，集合或 NULL
reason	String	业务失败的提示内容
page_size	Integer	分页大小
page_no	Integer	分页编码
has_more	Boolean	是否有更多

表6 TestIssueVo
参数	参数类型	描述
author	AuthorVo object	作者
domain	NameAndIdVo object	租户
module	NamePathAndPathVo object	模块
tracker	NameAndIdVo object	tracker
status	NameAndIdVo object	状态
priority	NameAndIdVo object	优先级
severity	NameAndIdVo object	严重程度
project	ProjectVo object	项目
id	String	id
subject	String	标题
token	String	token
board	NameAndIdVo object	看板
relation	String	需求层级关系
assigned_to	AssignedVo object	负责人
sequence	String	xBoard项目工作项序列号
sequence_id	String	xBoard项目工作项序列号
created_on	String	创建时间
start_date	String	创建日期
fixed_version	NameAndIdVo object	版本
plan_pi	NameAndIdVo object	pi
assign_status	String	参数解释: 分配状态。取值范围: 0，设计待分配。 1，设计中。 2，设计完成（待分配）。 3，测试中。 4，已测试。
design_owner_id	String	设计责任人id
design_owner	String	设计责任人名称
case_success_num	Integer	用例成功个数
case_failure_num	Integer	用例失败个数
case_disabled_num	Integer	用例不可用个数
case_wait_verification_num	Integer	用例待核查个数
case_blocking_num	Integer	用例阻塞个数
case_wait_execute_num	Integer	待执行的用例个数
case_total_num	Integer	用例总数
domain_name	String	租户名
domain_id	String	租户id
new_create_num	Integer	新建个数
designing_num	Integer	设计中个数
testing_num	Integer	测试中个数
finished_num	Integer	完成个数
issue_dynamic_count	Integer	需求动态数量
defect_num	Integer	需求对应缺陷个数
find_release_dev	String	发现版本号
case_status_map	Map<String,Integer>	用例状态map
parent_issue_id	String	父需求id
root_id	String	根节点id
due_date	String	结束数据
is_parent	Boolean	是否为父节点
have_child_dynamic	Boolean	父工作项下是否有子工作项包含动态
tracker_id	String	事件id

表7 AuthorVo
参数	参数类型	描述
name	String	名称
id	String	id
identifier	String	标识符
first_name	String	名
last_name	String	姓
author_nick_name	String	作者昵称
author_remark_name	String	作者备注名

表8 NamePathAndPathVo
参数	参数类型	描述
id	String	ID
name	String	名称
path	String	路径id
path_name	String	模块路径名称

表9 ProjectVo
参数	参数类型	描述
id	String	ID
name	String	名称
identifier	String	标识符
type	String	参数解释: 项目类型取值范围: normal，普通项目。 scrum，scrum项目。 xboard，xboard项目。 ipd，ipd项目。

**表10** AssignedVo
参数	参数类型	描述
name	String	名称
id	String	id
identifier	String	标识符
first_name	String	名
last_name	String	姓
assigned_nick_name	String	昵称
assigned_remark_name	String	备注名

**表11** NameAndIdVo
参数	参数类型	描述
id	String	参数解释: ID 取值范围: 不涉及
name	String	参数解释: 名称取值范围: 不涉及

状态码：400

**表12** 响应Body参数
参数	参数类型	描述
error_code	String	参数解释接口调用失败错误码取值范围不涉及
error_msg	String	参数解释接口调用失败错误信息取值范围不涉及

状态码：401

**表13** 响应Body参数
参数	参数类型	描述
error_code	String	参数解释接口调用失败错误码取值范围不涉及
error_msg	String	参数解释接口调用失败错误信息取值范围不涉及

状态码：404

**表14** 响应Body参数
参数	参数类型	描述
error_code	String	参数解释接口调用失败错误码取值范围不涉及
error_msg	String	参数解释接口调用失败错误信息取值范围不涉及

状态码：500

**表15** 响应Body参数
参数	参数类型	描述
error_code	String	参数解释接口调用失败错误码取值范围不涉及
error_msg	String	参数解释接口调用失败错误信息取值范围不涉及

请求示例

post https://{endpoint}/v4/projects/75681cbb7c324e15a9eb8ee74a96a474/issues-tree

{
  "service_type" : 1,
  "parent_id" : "21321sadsa21",
  "task_uri" : "728100"
}

响应示例

状态码：200

{
  "total" : 1,
  "value" : [ {
    "module" : {
      "id" : "",
      "name" : ""
    },
    "tracker" : {
      "id" : "7",
      "name" : "IR"
    },
    "status" : {
      "id" : "13",
      "name" : "初始"
    },
    "priority" : {
      "id" : "2",
      "name" : "中"
    },
    "severity" : {
      "id" : "",
      "name" : ""
    },
    "id" : "1186322840050868225",
    "subject" : "1",
    "assigned_to" : {
      "name" : "echotest_dl",
      "id" : "8700",
      "assigned_nick_name" : "昵称echotest_dl"
    },
    "sequence" : "IR20251018975242",
    "sequence_id" : "IR20251018975242",
    "fixed_version" : {
      "id" : "",
      "name" : ""
    },
    "plan_pi" : {
      "id" : "",
      "name" : ""
    },
    "case_success_num" : 0,
    "case_failure_num" : 0,
    "case_disabled_num" : 0,
    "case_wait_verification_num" : 0,
    "case_blocking_num" : 0,
    "case_wait_execute_num" : 0,
    "case_total_num" : 0,
    "new_create_num" : 0,
    "designing_num" : 0,
    "testing_num" : 0,
    "finished_num" : 0,
    "issue_dynamic_count" : 0,
    "defect_num" : 0,
    "is_parent" : false,
    "have_child_dynamic" : false,
    "tracker_id" : "7"
  } ],
  "page_size" : 50,
  "page_no" : 1
}