文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 测试用例检查管理/ 查询版本级用例规范检查任务报告 - ShowVersionCheckTaskReport
更新时间：2025-12-27 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询版本级用例规范检查任务报告 - ShowVersionCheckTaskReport

功能介绍

查询版本级用例规范检查任务报告

调用方法

请参见如何调用API。

URI

GET /v4/{project_id}/versions/{version_uri}/rule-check/tasks/{task_uri}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目ID

version_uri

是

String

分支版本uri

task_uri

是

String

任务uri

请求参数

无

响应参数

状态码：200

表2 响应Body参数

参数

参数类型

描述

total

Integer

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

value

TestCaseRuleCheckReportVo object

请求返回的数据

reason

String

业务失败的提示内容，对内接口才有此值

page_size

Integer

分页大小

page_no

Integer

分页编码

has_more

Boolean

是否有更多
表3 TestCaseRuleCheckReportVo

参数

参数类型

描述

uri

String

主键

name

String

名称

status

String

参数解释:

规范检查状态

取值范围:

  • init，初始化。

  • running，运行中。

  • success，成功。

  • failed，失败。

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

用例创建人维度报告
表4 TestCaseRuleCheckSuggestionsVo

参数

参数类型

描述

num

Integer

编号

suggestion

String

建议
表5 TestCaseRuleCheckSeverityReportVo

参数

参数类型

描述

severity

Integer

严重程度

count

Integer

总数

severity_name

String

严重程度名称

threshold_description

String

阈值描述
表6 TestCaseRuleCheckRuleReportVo

参数

参数类型

描述

count

Integer

总数

rule_description

String

规则描述
表7 TestCaseRuleCheckViolationTypeReportVo

参数

参数类型

描述

count

Integer

总数

violation_type

String

参数解释:

问题类型

取值范围:

  • 用例重复问题。

  • 用例名称问题。

  • 用例编号问题。

  • 用例描述问题。

  • 前置条件问题。

  • 测试步骤问题。

  • 步骤描述问题。

  • 预期结果问题。

  • 归属目录问题。

  • 用例标签问题。

  • 测试版本号问题。

  • 脚本路径问题
表8 TestCaseRuleCheckModuleIdReportVo

参数

参数类型

描述

count

Integer

总数

module_id

String

违规用例模块id

module_name

String

违规用例模块名称
表9 TestCaseRuleCheckCreatorReportVo

参数

参数类型

描述

count

Integer

总数

case_creator

String

违规用例创建人id

case_creator_name

String

创建人

状态码：400

表10 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

接口调用失败错误码

取值范围:

不涉及

error_msg

String

参数解释:

接口调用失败错误信息

取值范围:

不涉及

状态码：401

表11 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

接口调用失败错误码

取值范围:

不涉及

error_msg

String

参数解释:

接口调用失败错误信息

取值范围:

不涉及

状态码：404

表12 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

接口调用失败错误码

取值范围:

不涉及

error_msg

String

参数解释:

接口调用失败错误信息

取值范围:

不涉及

状态码：500

表13 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

接口调用失败错误码

取值范围:

不涉及

error_msg

String

参数解释:

接口调用失败错误信息

取值范围:

不涉及

请求示例

get https://{endpoint}/v4/2e8b14eb90d54b6c9bc4c0b5cde1f449/versions/2e8b14eb90/rule-check/tasks/0b5cde1f449

响应示例

状态码：200

OK

{
  "value" : {
    "total_number" : 2,
    "completion_time" : "2025-10-17 13:59:46",
    "score2" : 0,
    "score3" : 25,
    "high_quality_number" : 0,
    "score4" : 15,
    "severity_report" : [ {
      "severity" : 3,
      "count" : 4,
      "threshold_description" : "严重问题 <= 1",
      "severity_name" : "严重"
    }, {
      "severity" : 2,
      "count" : 0,
      "threshold_description" : "一般问题 < 10",
      "severity_name" : "一般"
    }, {
      "severity" : 1,
      "count" : 0,
      "threshold_description" : "提示问题 < 500",
      "severity_name" : "提示"
    } ],
    "high_quality_rate" : "0.0%",
    "repeated_rate" : "0.0%",
    "create_timestamp" : 1760680785000,
    "case_creator_report" : [ {
      "case_creator_name" : "wangluodan1",
      "count" : 4,
      "case_creator" : "a17801c5d15f46e28112eec8a880683d"
    } ],
    "total_score" : 65,
    "quality_access" : false,
    "project_uuid" : "1b7179edc79a431f9711434124ac9f28",
    "creator" : "a17801c5d15f46e28112eec8a880683d",
    "completion_timestamp" : 1760680786000,
    "repeated_number" : 0,
    "branch_uri" : "v90200010s1h6476",
    "create_time" : "2025-10-17 13:59:45",
    "defect_index" : 12,
    "uri" : "v90800010s20eia5",
    "rule_description_report" : [ {
      "count" : 4,
      "rule_description" : "规则7.1.1 测试步骤、预期结果为必填项。"
    } ],
    "module_id_report" : [ {
      "module_id" : "未设置",
      "count" : 4,
      "module_name" : "未设置"
    } ],
    "name" : "基线_20251017135945",
    "suggestions" : [ {
      "num" : 1,
      "suggestion" : "当前版本问题总数较少，请继续保持。"
    }, {
      "num" : 2,
      "suggestion" : "不规范的用例主要集中在未设置模块，请注意及时修订。"
    }, {
      "num" : 3,
      "suggestion" : "步骤描述问题是项目中最常见的问题。"
    } ],
    "score1" : 25,
    "violation_case_count" : 4,
    "status" : "success",
    "violation_type_report" : [ {
      "violation_type" : "步骤描述问题",
      "count" : 2
    }, {
      "violation_type" : "预期结果问题",
      "count" : 2
    } ]
  }
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

相关文档