文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 需求管理/ 获取IPD项目需求树
更新时间：2025-07-24 GMT+08:00
在线调试
CLI示例
查看PDF
分享

获取IPD项目需求树

功能介绍

获取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参数

参数

参数类型

描述

status

String

success|error

result

ResultValueListIpdTestIssueVo object

获取IPD项目需求树返回数据

error

ApiError object

错误信息

request_id

String

由接口调用方传入，建议使用UUID保证请求的唯一性。

server_address

String

本次请求的受理的服务地址
表6 ResultValueListIpdTestIssueVo

参数

参数类型

描述

total

Integer

起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值

value

Array of IpdTestIssueVo objects

实际的数据类型：单个对象，集合 或 NULL

reason

String

业务失败的提示内容

page_size

Integer

分页大小

page_no

Integer

分页编码

has_more

Boolean

是否有更多
表7 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

是否有子项
表8 NamePathAndPathVo

参数

参数类型

描述

id

String

ID

name

String

名称

path

String

路径id

path_name

String

模块路径名称
表9 NameAndIdVo

参数

参数类型

描述

id

String

参数解释:

ID

取值范围:

不涉及

name

String

参数解释:

名称

取值范围:

不涉及
表10 AssignedVo

参数

参数类型

描述

name

String

名称

id

String

id

identifier

String

标识符

first_name

String

名

last_name

String

姓

assigned_nick_name

String

昵称

assigned_remark_name

String

备注名
表11 ApiError

参数

参数类型

描述

code

String

参数解释

错误编码

取值范围

不涉及

reason

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/f3087a82b44744c29a1bd69ab6ada154/ipd/issues-tree

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

响应示例

状态码：200

获取IPD项目需求树返回体

{
  "status" : "success",
  "result" : {
    "value" : {
      "module" : {
        "name" : "test01",
        "id" : "123"
      },
      "has_child" : false
    }
  }
}

状态码

状态码

描述

200

获取IPD项目需求树返回体

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题： 需求管理

相关文档