获取IPD项目需求树 - ShowIpdIssuesTree

功能介绍

此接口用于获取IPD项目需求树状结构,与查询项目下需求树类似

调用方法

请参见如何调用API。

URI

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

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

请求参数

表2 请求Body参数
参数	是否必选	参数类型	描述
page_number	否	Integer	页码
page_size	否	Integer	每页数量
filter	否	IpdIssueListFilterInfo object	过滤条件
tracker_id	否	String	trackerId

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

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

响应参数

状态码：200

表5 响应Body参数
参数	参数类型	描述
total	Integer	起始记录数大于实际总条数时，值为0，分页请求才有此值
value	Array of IpdTestIssueVo objects	实际的数据类型：单个对象，集合或 NULL
page_size	Integer	分页大小
page_no	Integer	分页编码

表6 IpdTestIssueVo
参数	参数类型	描述
id	String	id
subject	String	标题
planPi	NameAndIdVo object	PI
severity	NameAndIdVo object	严重程度
status	NameAndIdVo object	状态
tracker	NameAndIdVo object	事件
module	NamePathAndPathVo object	模块
children	Array of IpdTestIssueVo objects	子需求对象
sequence	String	xBoard项目工作项序列号
sequence_id	String	xBoard项目工作项序列号
fixed_version	NameAndIdVo object	迭代
assigned_to	AssignedVo object	负责人
parent_issue_id	String	父需求id
has_child	Boolean	是否有子项

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

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

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

状态码：400

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

状态码：401

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

状态码：404

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

状态码：500

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

请求示例

post https://{endpoint}/v4/projects/f3087a82b44744c29a1bd69ab6ada154/ipd/issues-tree

{
  "tracker_id" : 2231,
  "filter" : {
    "iteration_ids" : [ "112312c3", "xb123124" ]
  }
}

响应示例

状态码：200

{
  "total" : 1,
  "value" : [ {
    "id" : "1177620317764984833",
    "subject" : "用作关联",
    "planPi" : {
      "id" : "",
      "name" : ""
    },
    "severity" : {
      "id" : "1176837742859522051",
      "name" : "提示"
    },
    "status" : {
      "id" : "Analyse",
      "name" : "分析"
    },
    "tracker" : {
      "id" : "",
      "name" : "Bug"
    },
    "module" : {
      "id" : "",
      "name" : ""
    },
    "sequence" : "BUG20250924927686",
    "sequence_id" : "BUG20250924927686",
    "fixed_version" : {
      "id" : "",
      "name" : ""
    },
    "assigned_to" : {
      "assigned_nick_name" : "昵称"
    },
    "has_child" : false
  } ],
  "page_size" : 50,
  "page_no" : 1
}