文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 测试报表管理/ 质量报告需求测试情况统计
更新时间：2024-11-19 GMT+08:00
查看PDF
分享

质量报告需求测试情况统计

功能介绍

质量报告需求测试情况统计

URI

POST /testreport/v4/{project_id}/versions/{version_id}/requirements/overview

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目id，对应"需求管理 CodeArts Req"项目唯一标识，测试计划管理页面地址栏url https://{host}/cloudtestportal/project/{project_id}/testplan中project_id变量的值

约束限制:

不涉及

取值范围:

项目uuid应符合如下规则：长度等于32位，包含大小写字母、数字

默认取值:

不涉及

version_id

是

String

版本id

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
表3 请求Body参数

参数

是否必选

参数类型

描述

fixed_version_id

否

String

筛选迭代ID

module_id

否

String

模块ID

key_word

否

String

关键字

page_size

否

Integer

每页数量

page_no

否

Integer

页码

pi_filter

否

PiFilterInfo object

pi筛选条件
表4 PiFilterInfo

参数

是否必选

参数类型

描述

pi_sprints

否

Array of PiInfo objects

pi迭代筛选条件

all_pi

否

Boolean

pi下拉框全选标识，全选时为true
表5 PiInfo

参数

是否必选

参数类型

描述

sprints

否

Array of strings

迭代列表

pi_id

否

String

pi的id，层级关系：pi -> 迭代 -> 需求

响应参数

状态码： 200

表6 响应Body参数

参数

参数类型

描述

status

String

success|error;

result

ResultValueRequirementsOverviewVo object

请求的返回的数据对象

error

ApiError object

失败时的error信息
表7 ResultValueRequirementsOverviewVo

参数

参数类型

描述

total

Integer

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

value

RequirementsOverviewVo object

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

reason

String

业务失败的提示内容

page_size

Integer

每页展示条数

page_no

Integer

页码

has_more

Boolean

是否有更多
表8 RequirementsOverviewVo

参数

参数类型

描述

total_number

Integer

质量报告需求测试情况总数

requirement_overview_list

Array of RequirementOverviewVo objects

质量报告需求测试情况列表
表9 RequirementOverviewVo

参数

参数类型

描述

name

String

需求名称

workitem_id

String

需求id

sequence_id

String

需求序列编号

board_id

String

看板需求id

tracker_id

String

需求类型id

tracker_name

String

需求类型

relate_case_number

Integer

需求关联用例总数

case_pass_vo

CasePassVo object

需求关联用例通过情况

case_execute_vo

CaseExecuteVo object

需求关联用例执行率情况

relate_defect_number

Integer

需求关联缺陷总数
表10 CasePassVo

参数

参数类型

描述

pass_rate

String

需求关联用例通过率

result_number_list

Array of NameAndValueVo objects

需求关联用例结果与对应的用例数目列表
表11 NameAndValueVo

参数

参数类型

描述

name

String

名称

value

Integer

值
表12 CaseExecuteVo

参数

参数类型

描述

execute_rate

String

需求关联用例执行率

executed_number

Integer

需求关联已执行用例总数

not_executed_number

Integer

需求关联未执行用例总数
表13 ApiError

参数

参数类型

描述

code

String

业务失败的错误码

reason

String

业务失败的提示内容

状态码： 400

表14 响应Body参数

参数

参数类型

描述

code

String

业务失败的错误码

reason

String

业务失败的提示内容

状态码： 401

表15 响应Body参数

参数

参数类型

描述

code

String

业务失败的错误码

reason

String

业务失败的提示内容

状态码： 404

表16 响应Body参数

参数

参数类型

描述

code

String

业务失败的错误码

reason

String

业务失败的提示内容

状态码： 500

表17 响应Body参数

参数

参数类型

描述

code

String

业务失败的错误码

reason

String

业务失败的提示内容

请求示例

无

响应示例

无

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题： 测试报表管理

相关文档