质量报告看板统计
功能介绍
质量报告看板统计
调用方法
请参见如何调用API。
URI
POST /v4/projects/{project_id}/report/overview
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目ID |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
version_uri |
否 |
String |
版本URI |
|
module_id |
否 |
String |
模块ID |
|
fixed_version_id |
否 |
String |
筛选迭代ID |
|
owner_id |
否 |
String |
处理人 |
|
pi_filter |
否 |
PiFilterInfo object |
pi筛选条件 |
|
own |
否 |
Boolean |
是否是我的 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
pi_sprints |
否 |
Array of PiInfo objects |
参数解释 pi迭代筛选条件 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及 |
|
all_pi |
否 |
Boolean |
参数解释 pi下拉框全选标识 约束限制 不涉及 取值范围 全选时为true 默认取值 不涉及 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
status |
String |
参数解释 本次请求的处理状态 取值范围 success|error |
|
result |
ResultValueOverviewVo object |
请求返回的数据 |
|
error |
ApiError object |
错误信息 |
|
request_id |
String |
参数解释 请求的唯一id 取值范围 接口调用方传入，建议使用UUID保证请求的唯一性。 |
|
server_address |
String |
参数解释 本次请求的受理的服务地址 取值范围 不涉及 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total |
Integer |
参数解释 符合条件的所有记录数 取值范围 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 |
|
value |
OverviewVo object |
status为failed时，存放只有reason的ApiError对象 |
|
reason |
String |
参数解释 业务失败的提示内容 取值范围 不涉及 |
|
page_size |
Integer |
参数解释 每页展示条数 取值范围 不涉及 |
|
page_no |
Integer |
参数解释 页码 取值范围 不涉及 |
|
has_more |
Boolean |
参数解释 是否有更多 取值范围 true:是 false:否 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
defect |
DefectVo object |
整体缺陷信息 |
|
case_pass_rate |
CasePassRateVo object |
计算用例通过率 |
|
case_completion_rate |
CaseCompletionRateVo object |
计算用例完成率 |
|
risk_rating |
RiskRatingVo object |
测试计划的风险等级和风险描述 |
|
project_type |
String |
参数解释 项目类型 取值范围 不涉及 |
|
issue_cover_rate |
IssueCoverRateVo object |
看板项目的需求覆盖率 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total |
Integer |
缺陷数 |
|
not_solved |
Integer |
未关闭缺陷数 |
|
severity_number_list |
Array of NameAndValueVo objects |
组装缺陷每种重要程度的名称和对应的数目 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
pass_rate |
String |
用例通过率 |
|
result_number_list |
Array of NameAndValueVo objects |
用户自定义结果对应的用例数目 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total |
Integer |
总用例数 |
|
completion_rate |
String |
用例完成率 |
|
status_number_list |
Array of NameAndValueVo objects |
用户自定义状态对应的用例数目 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
epic |
CoverRateVo object |
epic类型需求覆盖率, 仅scrum项目返回 |
|
feature |
CoverRateVo object |
feature类型需求覆盖率, 仅scrum项目返回 |
|
story |
CoverRateVo object |
story类型需求覆盖率, 仅scrum项目返回 |
|
summary |
CoverRateVo object |
需求覆盖率(scrum项目仅返回epic、feature、story。非scrum项目仅返回summary) |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
testing |
Integer |
统计测试中的需求 |
|
finished |
Integer |
统计已完成的需求 |
|
not_tested |
Integer |
统计未测试的需求 |
|
total_number |
Integer |
计算需求总数 |
|
cover_rate |
String |
需求覆盖率 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
参数解释: 业务失败的错误码 取值范围: 不涉及 |
|
reason |
String |
参数解释: 业务失败的提示内容 取值范围: 不涉及 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释: 接口调用失败错误码 取值范围: 不涉及 |
|
error_msg |
String |
参数解释: 接口调用失败错误信息 取值范围: 不涉及 |
状态码：401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释: 接口调用失败错误码 取值范围: 不涉及 |
|
error_msg |
String |
参数解释: 接口调用失败错误信息 取值范围: 不涉及 |
状态码：404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释: 接口调用失败错误码 取值范围: 不涉及 |
|
error_msg |
String |
参数解释: 接口调用失败错误信息 取值范围: 不涉及 |
状态码：500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释: 接口调用失败错误码 取值范围: 不涉及 |
|
error_msg |
String |
参数解释: 接口调用失败错误信息 取值范围: 不涉及 |
请求示例
质量报告看板统计
post https://{endpoint}/v4/projects/26927372bbae40b184fe764e7a0d21f7/report/overview
{
"version_uri" : "v91k0000vgtfg1jk",
"module_id" : "994928222970748929,994928245960912896,994928263572795393,994928294128300032,994928330747584512,-2",
"pi_filter" : {
"all_pi" : true,
"pi_sprints" : [ {
"pi_id" : "1035314883144495104",
"sprints" : [ "" ]
}, {
"pi_id" : "991653518035169281",
"sprints" : [ "991653560740388864", "" ]
}, {
"pi_id" : "",
"sprints" : [ "" ]
} ]
}
}
响应示例
状态码：200
OK
{
"status" : "success",
"result" : {
"value" : {
"defect" : {
"total" : 2,
"not_solved" : 0,
"severity_number_list" : [ {
"name" : "提示",
"value" : 2
} ]
},
"case_pass_rate" : {
"pass_rate" : "0.0%",
"result_number_list" : [ {
"name" : "成功",
"value" : 2
}, {
"name" : "失败",
"value" : 2
}, {
"name" : "执行中",
"value" : 3
}, {
"name" : "停止",
"value" : 1
}, {
"name" : "未执行",
"value" : 19994
} ]
},
"project_type" : "ipd",
"issue_cover_rate" : {
"epic" : {
"testing" : 0,
"finished" : 0,
"not_tested" : 0,
"total_number" : 0,
"cover_rate" : "0.0%"
},
"feature" : {
"testing" : 0,
"finished" : 0,
"not_tested" : 0,
"total_number" : 0,
"cover_rate" : "0.0%"
},
"story" : {
"testing" : 2,
"finished" : 0,
"not_tested" : 4,
"total_number" : 6,
"cover_rate" : "0.0%"
}
}
}
}
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
500 |
Internal Server Error |
错误码
请参见错误码。
