文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 测试用例检查管理/ 检查用例规范
更新时间：2025-06-26 GMT+08:00
在线调试
CLI示例
查看PDF
分享

检查用例规范

功能介绍

检查用例规范

调用方法

请参见如何调用API。

URI

POST /v4/{project_id}/testcase/check

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

type

否

String

类型

uri

否

String

用例URI

steps

否

Array of TestCaseStepInfo objects

对外测试步骤

name

是

String

名称

preparation

否

String

前置条件

remark

否

String

备注

number

否

String

用例编号

svn_script_path

否

String

脚本路径

feature_uri

否

String

目录Uri

label_names

否

Array of strings

对外用例操作时，标签名列表

release_dev

否

String

测试版本号

version_uri

否

String

版本URI

min_similarity

否

String

用例相似度下限（两位有效小数）
表3 TestCaseStepInfo

参数

是否必选

参数类型

描述

test_step

否

String

测试步骤

expect_result

否

String

预期结果

step_actual

否

String

步骤的实际结果

step_result

否

String

步骤结果

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

status

String

success|error

result

ResultValueString object

请求的返回的数据对象

error

ApiError object

错误信息。

request_id

String

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

server_address

String

本次请求的受理的服务地址
表5 ResultValueString

参数

参数类型

描述

total

Integer

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

value

String

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

reason

String

业务失败的提示内容

page_size

Integer

分页大小

page_no

Integer

分页编码

has_more

Boolean

是否有更多
表6 ApiError

参数

参数类型

描述

code

String

响应码

reason

String

业务失败的提示内容

状态码：400

表7 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码：401

表8 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码：404

表9 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码：500

表10 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

请求示例

post https://{endpoint}/v4/704a12bbe517445ab75b855b77888d68/testcase/check

{
  "release_dev" : "",
  "number" : "101",
  "svn_script_path" : "ApiTest/资源迁移-执行_alpha/src/scripts/user/Case_ede226d1ea754b9fb3c5bece9e1422b1_2.java",
  "name" : "成功1",
  "remark" : " c",
  "label_names" : [ ],
  "steps" : [ {
    "test_step" : "",
    "expect_result" : ""
  } ],
  "feature_uri" : "",
  "preparation" : "",
  "uri" : "v92s000107oicdeu",
  "version_uri" : "v92t000107oi68nt"
}

响应示例

状态码：200

OK

{
  "status" : "success",
  "result" : {
    "value" : {
      "total" : 2,
      "results" : [ {
        "num" : 1,
        "severity" : "严重",
        "field" : "步骤描述",
        "link" : "https://support.huaweicloud.com/usermanual-testman/cloudtest_01_1309.html",
        "suggestions" : "请编写测试步骤1描述",
        "rule_description" : "规则7.1.1 测试步骤、预期结果为必填项。",
        "violation_cause" : "违反规则7.1.1，测试步骤1描述为空"
      }, {
        "num" : 2,
        "severity" : "严重",
        "field" : "预期结果",
        "link" : "https://support.huaweicloud.com/usermanual-testman/cloudtest_01_1309.html",
        "suggestions" : "请编写测试步骤1预期结果",
        "rule_description" : "规则7.1.1 测试步骤、预期结果为必填项。",
        "violation_cause" : "违反规则7.1.1，测试步骤1预期结果为空"
      } ],
      "check_time" : "2025-06-18 17:56:35",
      "check_timestamp" : 1750240595395,
      "version_uri" : "v92t000107oi68nt",
      "version_name" : "基线"
    }
  }
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

相关文档