文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 测试用例检查相关管理/ 查询版本级用例规范检查用例列表
更新时间:2025-06-26 GMT+08:00
分享

查询版本级用例规范检查用例列表

功能介绍

查询版本级用例规范检查用例列表

调用方法

请参见如何调用API

URI

POST /v5/{project_id}/versions/{version_uri}/rule-check/tasks/{task_uri}/violation-cases

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

version_uri

String

分支版本uri

task_uri

String

任务uri

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

limit

Integer

相似用例展示数目

page_size

Integer

每页数量

page_no

Integer

页码

severity_list

Array of strings

严重程度(1提示 2一般 3严重)

status_list

Array of integers

问题状态 (0:未解决,1:已解决,2:忽略)

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

status

String

success|error

result

ResultValueTestCaseRuleCheckVo object

请求返回的数据

error

ApiError object

错误信息

request_id

String

由接口调用方传入,建议使用UUID保证请求的唯一性。

server_address

String

本次请求的受理的服务地址

表4 ResultValueTestCaseRuleCheckVo

参数

参数类型

描述

total

Integer

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

value

Array of TestCaseRuleCheckViolationCasesGroupByCaseNameVo objects

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

reason

String

业务失败的提示内容

page_size

Integer

分页大小

page_no

Integer

分页编码

has_more

Boolean

是否有更多

表5 TestCaseRuleCheckViolationCasesGroupByCaseNameVo

参数

参数类型

描述

case_uri

String

违规用例uri

case_name

String

违规用例名称

service_type

String

服务类型

version_uri

String

版本URI

violation_case_list

Array of TestCaseRuleCheckViolationCaseVo objects

版本级用例规范检查违规问题列表

表6 TestCaseRuleCheckViolationCaseVo

参数

参数类型

描述

uri

String

主键

check_task_uri

String

检查任务uri

case_uri

String

违规用例uri

case_name

String

违规用例名称

case_number

String

违规用例编号

module_id

String

违规用例模块id

case_creator

String

违规用例创建人id

severity

Integer

严重程度

severity_name

String

严重程度名称

violation_type

String

问题类型

violation_cause

String

问题原因

field_name

String

违规用例字段名称

rule_link

String

规则链接

rule_description

String

规则描述

status

Integer

问题状态 (0:未解决,1:已解决,2:忽略)

violation_content

String

问题内容

suggestions

String

type

repeated_testcase_count

Integer

相似用例总数

repeated_case_list

Array of TestCaseRuleCheckRepeatedRelationTestCaseVo objects

用例相似用例信息列表

表7 TestCaseRuleCheckRepeatedRelationTestCaseVo

参数

参数类型

描述

name

String

名称

number

String

编号

rank

Integer

级别

service_type

Integer

服务类型

version_uri

String

版本URI

version_name

String

版本名称

similarity

String

用例相似度

表8 ApiError

参数

参数类型

描述

code

String

参数解释:

业务失败的错误码

取值范围:

不涉及

reason

String

参数解释:

业务失败的提示内容

取值范围:

不涉及

状态码:400

表9 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

接口调用失败错误码

取值范围:

不涉及

error_msg

String

参数解释:

接口调用失败错误信息

取值范围:

不涉及

状态码:401

表10 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

接口调用失败错误码

取值范围:

不涉及

error_msg

String

参数解释:

接口调用失败错误信息

取值范围:

不涉及

状态码:404

表11 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

接口调用失败错误码

取值范围:

不涉及

error_msg

String

参数解释:

接口调用失败错误信息

取值范围:

不涉及

状态码:500

表12 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

接口调用失败错误码

取值范围:

不涉及

error_msg

String

参数解释:

接口调用失败错误信息

取值范围:

不涉及

请求示例

post https://{endpoint}/v5/9a5b66157ff44f6f80ce5f0fd1709f21/versions/v92s00010cmov0d6/rule-check/tasks/v93600010id8rk27/violation-cases

{
  "severity_list" : [ ],
  "status_list" : [ ],
  "page_no" : 1,
  "page_size" : 10,
  "limit" : 5
}

响应示例

状态码:200

查询版本级用例规范检查用例列表响应体

{
  "status" : "success",
  "result" : {
    "total" : 16,
    "value" : [ {
      "case_uri" : "v83n00010gigs5q7",
      "case_name" : "脑图生成_1_自动_80万_自动_自动_强制闪光",
      "service_type" : 10023,
      "version_uri" : "v92s00010cmov0d6",
      "violation_case_list" : [ {
        "uri" : "v93610id8rk2vghm",
        "severity" : 1,
        "status" : 0,
        "suggestions" : "请删除用例编号中英文、数字、下划线、点以外的字符:脑图生成",
        "check_task_uri" : "v93600010id8rk27",
        "case_uri" : "v83n00010gigs5q7",
        "case_name" : "脑图生成_1_自动_80万_自动_自动_强制闪光",
        "case_number" : "脑图生成_0008",
        "case_creator" : "cba378b8db4f4b6da3a5f01abd68ebe6",
        "severity_name" : "提示",
        "violation_type" : "用例编号问题",
        "violation_cause" : "违反建议3.1,用例编号包含英文、数字、下划线、点以外的字符:脑图生成",
        "field_name" : "用例编号",
        "rule_link" : "https://support.huaweicloud.com/usermanual-testman/cloudtest_01_1303.html",
        "rule_description" : "建议3.1 用例编号包含产品子特性和使用特性树中的子特性,且需要使用英文名称,不强制要求产品子特性的层级数量,建议和特性树保持一致。",
        "violation_content" : "脑图生成_0008"
      } ]
    }, {
      "case_uri" : "v83n00010gigt4lf",
      "case_name" : "脑图生成_1_自动_80万_自动_自动_强制闪光",
      "service_type" : 10023,
      "version_uri" : "v92s00010cmov0d6",
      "violation_case_list" : [ {
        "uri" : "v93600010id8rk30",
        "severity" : 1,
        "status" : 0,
        "suggestions" : "请删除用例编号中英文、数字、下划线、点以外的字符:脑图生成",
        "check_task_uri" : "v93600010id8rk27",
        "case_uri" : "v83n00010gigt4lf",
        "case_name" : "脑图生成_1_自动_80万_自动_自动_强制闪光",
        "case_number" : "脑图生成_0009",
        "case_creator" : "cba378b8db4f4b6da3a5f01abd68ebe6",
        "severity_name" : "提示",
        "violation_type" : "用例编号问题",
        "violation_cause" : "违反建议3.1,用例编号包含英文、数字、下划线、点以外的字符:脑图生成",
        "field_name" : "用例编号",
        "rule_link" : "https://support.huaweicloud.com/usermanual-testman/cloudtest_01_1303.html",
        "rule_description" : "建议3.1 用例编号包含产品子特性和使用特性树中的子特性,且需要使用英文名称,不强制要求产品子特性的层级数量,建议和特性树保持一致。",
        "violation_content" : "脑图生成_0009"
      } ]
    }, {
      "case_uri" : "v83n00010gih34ol",
      "case_name" : "脑图生成_1_自动_80万_自动_自动_强制闪光",
      "service_type" : 10023,
      "version_uri" : "v92s00010cmov0d6",
      "violation_case_list" : [ {
        "uri" : "v93610id8rk30ghn",
        "severity" : 1,
        "status" : 0,
        "suggestions" : "请删除用例编号中英文、数字、下划线、点以外的字符:脑图生成",
        "check_task_uri" : "v93600010id8rk27",
        "case_uri" : "v83n00010gih34ol",
        "case_name" : "脑图生成_1_自动_80万_自动_自动_强制闪光",
        "case_number" : "脑图生成_0010",
        "case_creator" : "cba378b8db4f4b6da3a5f01abd68ebe6",
        "severity_name" : "提示",
        "violation_type" : "用例编号问题",
        "violation_cause" : "违反建议3.1,用例编号包含英文、数字、下划线、点以外的字符:脑图生成",
        "field_name" : "用例编号",
        "rule_link" : "https://support.huaweicloud.com/usermanual-testman/cloudtest_01_1303.html",
        "rule_description" : "建议3.1 用例编号包含产品子特性和使用特性树中的子特性,且需要使用英文名称,不强制要求产品子特性的层级数量,建议和特性树保持一致。",
        "violation_content" : "脑图生成_0010"
      } ]
    }, {
      "case_uri" : "v83n00010gih8pio",
      "case_name" : "脑图生成_1_自动_80万_自动_自动_强制闪光",
      "service_type" : 10023,
      "version_uri" : "v92s00010cmov0d6",
      "violation_case_list" : [ {
        "uri" : "v93610id8rk30gho",
        "severity" : 1,
        "status" : 0,
        "suggestions" : "请删除用例编号中英文、数字、下划线、点以外的字符:脑图生成",
        "check_task_uri" : "v93600010id8rk27",
        "case_uri" : "v83n00010gih8pio",
        "case_name" : "脑图生成_1_自动_80万_自动_自动_强制闪光",
        "case_number" : "脑图生成_0011",
        "case_creator" : "cba378b8db4f4b6da3a5f01abd68ebe6",
        "severity_name" : "提示",
        "violation_type" : "用例编号问题",
        "violation_cause" : "违反建议3.1,用例编号包含英文、数字、下划线、点以外的字符:脑图生成",
        "field_name" : "用例编号",
        "rule_link" : "https://support.huaweicloud.com/usermanual-testman/cloudtest_01_1303.html",
        "rule_description" : "建议3.1 用例编号包含产品子特性和使用特性树中的子特性,且需要使用英文名称,不强制要求产品子特性的层级数量,建议和特性树保持一致。",
        "violation_content" : "脑图生成_0011"
      } ]
    }, {
      "case_uri" : "v92n00010ebt2tam",
      "case_name" : "大疆用例测试",
      "service_type" : 0,
      "version_uri" : "v92s00010cmov0d6",
      "violation_case_list" : [ {
        "uri" : "v93600010id8rk2r",
        "severity" : 1,
        "status" : 0,
        "suggestions" : "请优化用例编号,建议采取“产品特性_产品子特性_序列号”格式编写",
        "check_task_uri" : "v93600010id8rk27",
        "case_uri" : "v92n00010ebt2tam",
        "case_name" : "大疆用例测试",
        "case_number" : "12345zsdfg",
        "case_creator" : "6a6c782cd85f414ea20652e5f8ac7882",
        "severity_name" : "提示",
        "violation_type" : "用例编号问题",
        "violation_cause" : "违反建议3.2,用例编号不是以数字结尾",
        "field_name" : "用例编号",
        "rule_link" : "https://support.huaweicloud.com/usermanual-testman/cloudtest_01_1303.html",
        "rule_description" : "建议3.2 用例编号可采取“产品特性_产品子特性_序列号”的格式编写。",
        "violation_content" : "12345zsdfg"
      } ]
    }, {
      "case_uri" : "v92n00010ec4l1k2",
      "case_name" : "大疆用例测试233",
      "service_type" : 0,
      "version_uri" : "v92s00010cmov0d6",
      "violation_case_list" : [ {
        "uri" : "v93600010id8rk2s",
        "severity" : 1,
        "status" : 0,
        "suggestions" : "请优化用例编号,建议采取“产品特性_产品子特性_序列号”格式编写",
        "check_task_uri" : "v93600010id8rk27",
        "case_uri" : "v92n00010ec4l1k2",
        "case_name" : "大疆用例测试233",
        "case_number" : "12345zsdfgssdd",
        "case_creator" : "6a6c782cd85f414ea20652e5f8ac7882",
        "severity_name" : "提示",
        "violation_type" : "用例编号问题",
        "violation_cause" : "违反建议3.2,用例编号不是以数字结尾",
        "field_name" : "用例编号",
        "rule_link" : "https://support.huaweicloud.com/usermanual-testman/cloudtest_01_1303.html",
        "rule_description" : "建议3.2 用例编号可采取“产品特性_产品子特性_序列号”的格式编写。",
        "violation_content" : "12345zsdfgssdd"
      } ]
    }, {
      "case_uri" : "v92n00010ec52bfc",
      "case_name" : "大疆用例测试233",
      "service_type" : 0,
      "version_uri" : "v92s00010cmov0d6",
      "violation_case_list" : [ {
        "uri" : "v93610id8rk2tghg",
        "severity" : 3,
        "status" : 0,
        "suggestions" : "请编写测试步骤1描述",
        "check_task_uri" : "v93600010id8rk27",
        "case_uri" : "v92n00010ec52bfc",
        "case_name" : "大疆用例测试233",
        "case_number" : "12345zs",
        "case_creator" : "6a6c782cd85f414ea20652e5f8ac7882",
        "severity_name" : "严重",
        "violation_type" : "步骤描述问题",
        "violation_cause" : "违反规则7.1.1,测试步骤1描述为空",
        "field_name" : "步骤描述",
        "rule_link" : "https://support.huaweicloud.com/usermanual-testman/cloudtest_01_1309.html",
        "rule_description" : "规则7.1.1 测试步骤、预期结果为必填项。",
        "violation_content" : "{\"content\":\"\",\"num\":1}"
      }, {
        "uri" : "v93610id8rk2tghh",
        "severity" : 3,
        "status" : 0,
        "suggestions" : "请编写测试步骤1预期结果",
        "check_task_uri" : "v93600010id8rk27",
        "case_uri" : "v92n00010ec52bfc",
        "case_name" : "大疆用例测试233",
        "case_number" : "12345zs",
        "case_creator" : "6a6c782cd85f414ea20652e5f8ac7882",
        "severity_name" : "严重",
        "violation_type" : "预期结果问题",
        "violation_cause" : "违反规则7.1.1,测试步骤1预期结果为空",
        "field_name" : "预期结果",
        "rule_link" : "https://support.huaweicloud.com/usermanual-testman/cloudtest_01_1309.html",
        "rule_description" : "规则7.1.1 测试步骤、预期结果为必填项。",
        "violation_content" : "{\"content\":\"\",\"num\":1}"
      }, {
        "uri" : "v93600010id8rk2t",
        "severity" : 1,
        "status" : 0,
        "suggestions" : "请优化用例编号,建议采取“产品特性_产品子特性_序列号”格式编写",
        "check_task_uri" : "v93600010id8rk27",
        "case_uri" : "v92n00010ec52bfc",
        "case_name" : "大疆用例测试233",
        "case_number" : "12345zs",
        "case_creator" : "6a6c782cd85f414ea20652e5f8ac7882",
        "severity_name" : "提示",
        "violation_type" : "用例编号问题",
        "violation_cause" : "违反建议3.2,用例编号不是以数字结尾",
        "field_name" : "用例编号",
        "rule_link" : "https://support.huaweicloud.com/usermanual-testman/cloudtest_01_1303.html",
        "rule_description" : "建议3.2 用例编号可采取“产品特性_产品子特性_序列号”的格式编写。",
        "violation_content" : "12345zs"
      } ]
    }, {
      "case_uri" : "v92n00010ec965vn",
      "case_name" : "大疆新",
      "service_type" : 0,
      "version_uri" : "v92s00010cmov0d6",
      "violation_case_list" : [ {
        "uri" : "v93610id8rk2ughl",
        "severity" : 1,
        "status" : 0,
        "suggestions" : "请优化用例编号,建议采取“产品特性_产品子特性_序列号”格式编写",
        "check_task_uri" : "v93600010id8rk27",
        "case_uri" : "v92n00010ec965vn",
        "case_name" : "大疆新",
        "case_number" : "12345ssdd",
        "case_creator" : "6a6c782cd85f414ea20652e5f8ac7882",
        "severity_name" : "提示",
        "violation_type" : "用例编号问题",
        "violation_cause" : "违反建议3.2,用例编号不是以数字结尾",
        "field_name" : "用例编号",
        "rule_link" : "https://support.huaweicloud.com/usermanual-testman/cloudtest_01_1303.html",
        "rule_description" : "建议3.2 用例编号可采取“产品特性_产品子特性_序列号”的格式编写。",
        "violation_content" : "12345ssdd"
      } ]
    } ],
    "page_size" : 10,
    "page_no" : 1
  }
}

状态码

状态码

描述

200

查询版本级用例规范检查用例列表响应体

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码

相关文档