查询版本级用例规范检查任务报告
功能介绍
查询版本级用例规范检查任务报告
调用方法
请参见如何调用API。
URI
GET /v4/{project_id}/versions/{version_uri}/rule-check/tasks/{task_uri}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目UUID,项目唯一标识,固定长度32位字符(字母和数字)。获取方式请参见获取项目ID |
|
version_uri |
是 |
String |
分支版本uri |
|
task_uri |
是 |
String |
任务uri |
请求参数
无
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
status |
String |
对外时:success|error; 对内时:ok|failed |
|
result |
请求返回的数据 |
|
|
error |
ApiError object |
错误信息 |
|
request_id |
String |
由接口调用方传入,建议使用UUID保证请求的唯一性。 |
|
server_address |
String |
本次请求的受理的服务地址 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total |
Integer |
起始记录数 大于 实际总条数时, 值为0, 分页请求才有此值 |
|
value |
TestCaseRuleCheckReportVo object |
请求返回的数据 |
|
reason |
String |
业务失败的提示内容,对内接口才有此值 |
|
page_size |
Integer |
分页大小 |
|
page_no |
Integer |
分页编码 |
|
has_more |
Boolean |
是否有更多 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
uri |
String |
主键 |
|
name |
String |
名称 |
|
status |
String |
状态 |
|
creator |
String |
创建人 |
|
creator_name |
String |
创建人 |
|
project_id |
String |
项目UUID,项目唯一标识,固定长度32位字符(字母和数字)。获取方式请参见获取项目ID |
|
branch_uri |
String |
分支uri |
|
create_time |
String |
任务开始时间 |
|
create_timestamp |
Long |
任务开始时间戳 |
|
completion_time |
String |
任务完成时间 |
|
completion_timestamp |
Long |
任务完成时间戳 |
|
total_number |
Integer |
用例总数 |
|
high_quality_number |
Integer |
高质量用例数 |
|
repeated_number |
Integer |
重复用例数 |
|
high_quality_rate |
String |
高质量用例率 |
|
repeated_rate |
String |
重复用例率 |
|
total_score |
Integer |
综合评分 |
|
score1 |
Integer |
问题总数评分 |
|
score2 |
Integer |
高质量用例评分 |
|
score3 |
Integer |
用例重复率评分 |
|
score4 |
Integer |
问题严重程度评分 |
|
suggestions |
Array of TestCaseRuleCheckSuggestionsVo objects |
问题检查报告建议 |
|
quality_access |
Boolean |
门禁是否通过 |
|
defect_index |
Double |
DI值 |
|
violation_case_count |
Integer |
问题总数 |
|
severity_report |
Array of TestCaseRuleCheckSeverityReportVo objects |
严重程度维度报告 |
|
rule_description_report |
Array of TestCaseRuleCheckRuleReportVo objects |
违反规则维度报告(取top10) |
|
violation_type_report |
Array of TestCaseRuleCheckViolationTypeReportVo objects |
问题类型维度报告 |
|
module_id_report |
Array of TestCaseRuleCheckModuleIdReportVo objects |
模块id维度报告 |
|
case_creator_report |
Array of TestCaseRuleCheckCreatorReportVo objects |
用例创建人维度报告 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
severity |
Integer |
严重程度 |
|
count |
Integer |
总数 |
|
severity_name |
String |
严重程度名称 |
|
threshold_description |
String |
阈值描述 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
count |
Integer |
总数 |
|
module_id |
String |
违规用例模块id |
|
module_name |
String |
违规用例模块名称 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
count |
Integer |
总数 |
|
case_creator |
String |
违规用例创建人id |
|
case_creator_name |
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 |
参数解释: 接口调用失败错误信息 取值范围: 不涉及 |
请求示例
get https://{endpoint}/v4/2e8b14eb90d54b6c9bc4c0b5cde1f449/versions/2e8b14eb90/rule-check/tasks/0b5cde1f449
响应示例
状态码:200
OK
{
"status" : "string",
"result" : {
"total" : 1,
"value" : {
"uri" : "iu5e541cw5we",
"name" : "name",
"status" : "running",
"creator" : "754545qwe1w2q13qwe",
"creator_name" : "754545qwe1w2q13qwe",
"project_id" : "754545qwe1w2q13qwe",
"branch_uri" : "45q1w2q13qwe",
"create_time" : "2025-06-20T07:13:13.504Z",
"create_timestamp" : 1660617231016,
"completion_time" : "2025-06-20T07:13:13.504Z",
"completion_timestamp" : 1660617241016,
"total_number" : 100,
"high_quality_number" : 100,
"repeated_number" : 100,
"high_quality_rate" : "10%",
"repeated_rate" : "10%",
"total_score" : 100,
"score1" : 25,
"score2" : 25,
"score3" : 25,
"score4" : 25,
"suggestions" : [ { } ],
"quality_access" : true,
"defect_index" : 3,
"violation_case_count" : 100,
"severity_report" : [ { } ],
"rule_description_report" : [ { } ],
"violation_type_report" : [ { } ],
"module_id_report" : [ { } ],
"case_creator_report" : [ { } ]
},
"reason" : "string",
"page_size" : 1,
"page_no" : 1,
"has_more" : true
},
"error" : { }
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
500 |
Internal Server Error |
错误码
请参见错误码。