更新时间:2024-06-17 GMT+08:00
分享

查询需求树

功能介绍

查询需求树

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

POST /GT3KServer/v4/{project_id}/versions/{version_id}/issue-tree

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,固定长度32位字符(字母和数字)。获取方式请参见获取项目ID

最小长度:32

最大长度:32

version_id

String

版本id

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

最小长度:1

最大长度:100000

表3 请求Body参数

参数

是否必选

参数类型

描述

service_type

Integer

服务类型

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

表4 IssueListFilterInfo

参数

是否必选

参数类型

描述

iteration_ids

Array of strings

迭代id列表

pi_sprints

Array of IssueListPiFilterInfo objects

pi过滤条件

subject

String

需求名

module_id

String

模块id

status_id

String

需求状态id

表5 IssueListPiFilterInfo

参数

是否必选

参数类型

描述

sprints

Array of strings

迭代列表

pi_id

String

pi的id,层级关系:pi -> 迭代 -> 需求

响应参数

状态码: 200

表6 响应Body参数

参数

参数类型

描述

value

Array of WorkItemVo objects

实际的数据类型:单个对象,集合 或 NULL

表7 WorkItemVo

参数

参数类型

描述

name

String

工作项名称

owner

String

处理人

path

String

工作项路径

start_date

String

预计开始日期

due_date

String

预计结束日期

region

String

逻辑region,外部使用公有云实际区域,内部使用默认值

creator

String

创建人

updator

String

更新人

project_uuid

String

项目ID,外部使用项目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

表8 响应Body参数

参数

参数类型

描述

code

String

业务失败的错误码

reason

String

业务失败的提示内容

状态码: 401

表9 响应Body参数

参数

参数类型

描述

code

String

业务失败的错误码

reason

String

业务失败的提示内容

状态码: 404

表10 响应Body参数

参数

参数类型

描述

code

String

业务失败的错误码

reason

String

业务失败的提示内容

状态码: 500

表11 响应Body参数

参数

参数类型

描述

code

String

业务失败的错误码

reason

String

业务失败的提示内容

请求示例

响应示例

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码

分享:

    相关文档

    相关产品