文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 测试用例检查管理/ 检查用例规范 - CheckTestCaseFour

更新时间：2026-10-22 GMT+08:00

查看PDF

检查用例规范 - CheckTestCaseFour

功能介绍

此接口用于对单个用例进行规范性检查

测试 -> 测试用例 -> 点击用例进入用例详情 -> 右上角用例规范检查

调用方法

请参见如何调用API。

URI

POST /v4/{project_id}/testcase/check

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目ID

请求参数

表2 请求Body参数
参数	是否必选	参数类型	描述
case_uri	否	String	参数解释用例的唯一标识URI，用于定位和更新指定用例约束限制长度限制32字符取值范围不涉及默认取值不涉及
attachments	否	Array of TestCaseAttachmentInfo objects	参数解释: 对外附件信息列表，每个元素为TestCaseAttachmentInfo对象，包含附件的文件名、路径、类型等信息约束限制: 不涉及取值范围: 不涉及默认取值: 不涉及
steps	否	Array of TestCaseStepInfo objects	参数解释: 测试步骤信息列表，每个元素为TestCaseStepInfo对象，包含测试步骤和预期结果等信息约束限制: 数组元素数量范围为0~100
author	否	String	参数解释创建人约束限制 1-32个英文或者数字取值范围不涉及默认取值不涉及
name	是	String	参数解释测试用例的名称约束限制长度限制128字符取值范围不涉及默认取值不涉及
rank	是	Integer	参数解释用例等级约束限制不涉及取值范围 0：Priority 0 1：Priority 1 2：Priority 2 3：Priority 3 4：Priority 4 默认取值不涉及
owner	否	String	参数解释处理人约束限制不涉及取值范围不涉及默认取值不涉及
preparation	否	String	参数解释前置条件约束限制长度限制3000字符取值范围不涉及默认取值不涉及
remark	否	String	参数解释备注约束限制不涉及取值范围不超过20000字符默认取值不涉及
stage	否	String	参数解释测试阶段约束限制长度限制50字符取值范围不涉及默认取值不涉及
activity	否	String	参数解释测试类型约束限制长度限制64字符取值范围不涉及默认取值不涉及
keywords	否	String	参数解释关键词约束限制长度限制512字符取值范围不涉及默认取值不涉及
market	否	String	参数解释 apitest标记是否代码已提交约束限制长度限制1024字符取值范围不涉及默认取值不涉及
designer	否	String	参数解释设计者约束限制长度限制64字符取值范围不涉及默认取值不涉及
tags	否	String	参数解释标签约束限制长度限制512字符取值范围不涉及默认取值不涉及
region	否	String	参数解释逻辑region，外部使用公有云实际区域，内部使用默认值约束限制长度限制32字符取值范围不涉及默认取值外部使用公有云实际区域，内部使用默认值
relate_type	否	String	参数解释: 关联关系类型约束限制: 不涉及取值范围: bug：缺陷 requirement：需求默认取值: 不涉及
service_type	是	Integer	参数解释: 服务类型约束限制: 不涉及取值范围: -1：全量用例 0：手工测试 1：接口自动化 7：功能自动化 8：WebUI自动化 100：自定义自动化(工厂) 11：性能自动化默认取值: 不涉及
only_change_script	否	String	参数解释更新接口用例的java脚本路径标识约束限制长度限制32字符取值范围不涉及默认取值不涉及
add_to_iterator	否	String	参数解释需求添加到迭代标识约束限制长度限制5字符取值范围不涉及默认取值不涉及
need_update_relation	否	String	参数解释是否修改关联关系约束限制长度限制5字符取值范围不涉及默认取值不涉及
creation_version_uri	否	String	参数解释创建版本Uri，用于指定用例的创建版本。获取方式请参见获取版本URI接口约束限制 11到34位英文或数字取值范围不涉及默认取值不涉及
number	否	String	参数解释用例编号约束限制不涉及取值范围不涉及默认取值不涉及
case_type	否	Integer	参数解释: 用例类型约束限制: 不涉及取值范围: 0：手工测试 1：接口自动化 2：性能用例默认取值: 不涉及
platform_type	否	Integer	参数解释执行平台类型约束限制不涉及取值范围取值范围：-128-127 默认取值不涉及
test_type	否	Integer	参数解释: 测试类型取值范围: 1：功能性测试 2：兼容性测试 4：性能测试 15：易用性测试 22：可靠性测试 14：安全性测试 21：可服务性测试
design_note	否	String	参数解释设计描述约束限制长度限制65535字符取值范围不涉及默认取值不涉及
test_step	否	String	参数解释以文本形式描述的测试步骤内容约束限制长度限制250000字符取值范围不涉及默认取值不涉及
expect_output	否	String	参数解释期望结果约束限制长度限制250000字符取值范围不涉及默认取值不涉及
env_type	否	String	参数解释测试环境类型约束限制长度限制512字符取值范围不涉及默认取值不涉及
exe_platform	否	String	参数解释执行平台约束限制长度限制200字符取值范围不涉及默认取值不涉及
testcase_project	否	String	参数解释测试工程约束限制长度限制1024字符取值范围不涉及默认取值不涉及
svn_script_path	否	String	参数解释脚本路径约束限制长度限制65535字符取值范围不涉及默认取值不涉及
map_restrict	否	String	参数解释约束条件约束限制长度限制65535字符取值范围不涉及默认取值不涉及
network_script_name	否	String	参数解释网络脚本名约束限制长度限制500字符取值范围不涉及默认取值不涉及
auto_type	否	Integer	参数解释: 自动化类型约束限制: 不涉及取值范围: 0：非自动化 1：是自动化默认取值: 不涉及
to_be_auto_exec	否	Integer	参数解释被自动化执行约束限制不涉及取值范围 0：不被自动化 1：被自动化默认取值不涉及
last_result	否	String	参数解释最后一次结果约束限制长度限制16字符取值范围不涉及默认取值不涉及
last_result_uri	否	String	参数解释最后一次结果Uri 约束限制不涉及取值范围 11-34位数字或英文默认取值不涉及
feature_uri	否	String	参数解释目录Uri，用于指定用例所属的目录。获取方式请参见获取特性树接口约束限制不涉及取值范围 11-34位数字或英文默认取值不涉及
interface_name	否	String	参数解释测试接口名约束限制长度限制200字符取值范围不涉及默认取值不涉及
snp_no	否	String	参数解释网络问题ID 约束限制长度限制500字符取值范围不涉及默认取值不涉及
dr_relation_id	否	String	参数解释关联需求编号。获取方式请参见查询需求列表接口约束限制不涉及取值范围 1-32位数字默认取值不涉及
test_base_num	否	String	参数解释测试基数约束限制长度限制200字符取值范围不涉及默认取值不涉及
automatically_executed	否	Integer	参数解释是否已被自动化执行约束限制不涉及取值范围 0：未被自动化执行 1：已被自动化执行默认取值不涉及
first_execute_time	否	String	参数解释第一次执行时间，格式为yyyy-MM-dd HH:mm:ss，例如2024-01-01 12:00:00 约束限制不涉及
detect_type	否	String	参数解释检测类型约束限制长度限制100字符取值范围不涉及默认取值不涉及
execute_param	否	String	参数解释执行参数约束限制长度限制65535字符取值范围不涉及默认取值不涉及
test_feature	否	String	参数解释分析领域约束限制长度限制65535字符取值范围不涉及默认取值不涉及
is_contract_testcase	否	Integer	参数解释是否是契约用例，0:表示非契约用例, 1：表示契约用例约束限制不涉及取值范围 0,1 默认取值不涉及
time_cost	否	Double	参数解释总共耗时，单位为毫秒约束限制不涉及取值范围 2147483648.44-2147483647.44 默认取值不涉及
custom_field_1	否	String	参数解释自定义字段1 约束限制长度限制65535字符取值范围不涉及默认取值不涉及
custom_field_2	否	String	参数解释自定义字段2 约束限制长度限制65535字符取值范围不涉及默认取值不涉及
custom_field_3	否	String	参数解释自定义字段3 约束限制长度限制65535字符取值范围不涉及默认取值不涉及
custom_field_4	否	String	参数解释自定义字段4 约束限制长度限制65535字符取值范围不涉及默认取值不涉及
custom_field_5	否	String	参数解释自定义字段5 约束限制长度限制65535字符取值范围不涉及默认取值不涉及
custom_field_6	否	String	参数解释自定义字段6 约束限制长度限制65535字符取值范围不涉及默认取值不涉及
custom_field_7	否	String	参数解释自定义字段7 约束限制长度限制65535字符取值范围不涉及默认取值不涉及
custom_field_8	否	String	参数解释自定义字段8 约束限制长度限制65535字符取值范围不涉及默认取值不涉及
custom_field_9	否	String	参数解释自定义字段9 约束限制长度限制65535字符取值范围不涉及默认取值不涉及
custom_field_10	否	String	参数解释自定义字段10 约束限制长度限制65535字符取值范围不涉及默认取值不涉及
custom_field_11	否	String	参数解释自定义字段11 约束限制长度限制65535字符取值范围不涉及默认取值不涉及
custom_field_12	否	String	参数解释自定义字段12 约束限制长度限制65535字符取值范围不涉及默认取值不涉及
custom_field_13	否	String	参数解释自定义字段13 约束限制长度限制65535字符取值范围不涉及默认取值不涉及
custom_field_14	否	String	参数解释自定义字段14 约束限制长度限制65535字符取值范围不涉及默认取值不涉及
custom_field_15	否	String	参数解释自定义字段15 约束限制长度限制65535字符取值范围不涉及默认取值不涉及
custom_field_16	否	String	参数解释自定义字段16 约束限制长度限制65535字符取值范围不涉及默认取值不涉及
custom_field_17	否	String	参数解释自定义字段17 约束限制长度限制65535字符取值范围不涉及默认取值不涉及
custom_field_18	否	String	参数解释自定义字段18 约束限制长度限制65535字符取值范围不涉及默认取值不涉及
custom_field_19	否	String	参数解释自定义字段19 约束限制长度限制65535字符取值范围不涉及默认取值不涉及
custom_field_20	否	String	参数解释自定义字段20 约束限制长度限制65535字符取值范围不涉及默认取值不涉及
custom_field_21	否	String	参数解释自定义字段21 约束限制长度限制65535字符取值范围不涉及默认取值不涉及
custom_field_22	否	String	参数解释自定义字段22 约束限制长度限制65535字符取值范围不涉及默认取值不涉及
custom_field_23	否	String	参数解释自定义字段23 约束限制长度限制65535字符取值范围不涉及默认取值不涉及
custom_field_24	否	String	参数解释自定义字段24 约束限制长度限制65535字符取值范围不涉及默认取值不涉及
custom_field_25	否	String	参数解释自定义字段25 约束限制长度限制65535字符取值范围不涉及默认取值不涉及
be_auto_type_time	否	String	参数解释记录用例由非自动化变为自动化类型的时间，格式为yyyy-MM-dd HH:mm:ss，例如2024-01-01 12:00:00 约束限制不涉及取值范围不涉及默认取值不涉及
compare_number	否	String	参数解释配对用例编号约束限制长度限制100字符取值范围不涉及默认取值不涉及
scene_flag	否	String	参数解释场景标识约束限制长度限制50字符取值范围不涉及默认取值不涉及
base_flag	否	String	参数解释基准标识约束限制长度限制50字符取值范围不涉及默认取值不涉及
para_validator	否	String	参数解释标识用例是否从yaml文件生成约束限制长度限制50字符取值范围不涉及默认取值 false
knet_node_id	否	String	参数解释 knet节点id 约束限制长度限制50字符取值范围不涉及默认取值不涉及
last_exe_author	否	String	参数解释最后一次执行用户约束限制长度限制50字符取值范围不涉及默认取值不涉及
cloud_carrier	否	String	参数解释运营商约束限制长度限制100字符取值范围不涉及默认取值不涉及
market_place	否	String	参数解释应用市场约束限制长度限制1024字符取值范围不涉及默认取值不涉及
test_mind_id	否	String	参数解释脑图id 约束限制长度限制256字符取值范围不涉及默认取值不涉及
test_mind_url	否	String	参数解释脑图url 约束限制长度限制1024字符取值范围不涉及默认取值不涉及
commit_url	否	String	参数解释 git提交url 约束限制长度限制65535字符取值范围不涉及默认取值不涉及
test_pattern_number	否	String	参数解释测试模式编号约束限制长度限制65535字符取值范围不涉及默认取值不涉及
test_factor_number	否	String	参数解释测试因子编号约束限制长度限制65535字符取值范围不涉及默认取值不涉及
status_code	否	String	参数解释状态Code，格式为[-]?[0-9]{1,5} 约束限制不涉及取值范围不涉及默认取值不涉及
result_code	否	String	参数解释用例的最新执行结果编码约束限制不涉及取值范围不涉及默认取值不涉及
release_id	否	String	参数解释迭代ID 约束限制不涉及取值范围不涉及默认取值不涉及
label_id	否	String	参数解释标签ID，获取方式请参见查询标签接口约束限制不涉及取值范围不涉及默认取值不涉及
label_names	否	Array of strings	参数解释用例操作时的标签名列表，数组中每个元素为一个标签名称字符串约束限制不涉及取值范围不涉及默认取值不涉及
module_id	否	String	参数解释模块ID 约束限制不涉及取值范围不涉及默认取值不涉及
execute_latest_time	否	String	参数解释最后执行时间，格式为yyyy-MM-dd HH:mm:ss 约束限制不涉及
execute_duration	否	String	参数解释执行时长，格式为HH:mm:ss（时:分:秒）约束限制不涉及取值范围不涉及默认取值不涉及
is_keyword	否	Integer	参数解释是否关键用例约束限制不涉及取值范围 0：非关键用例 1：关键用例默认取值不涉及
release_dev	否	String	参数解释测试版本号约束限制不涉及取值范围不涉及默认取值不涉及
new_created	否	Integer	参数解释是否用户新增用例约束限制不涉及取值范围 0：非用户新增 1：用户新增默认取值不涉及
execute_parameter	否	String	参数解释执行参数约束限制不涉及取值范围不涉及默认取值不涉及
project_uuid	是	String	参数解释项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目ID 约束限制不涉及取值范围不涉及默认取值不涉及
version_uri	否	String	参数解释分支或者迭代uri。获取方式：从GET /v4/projects/{project_id}/iterator-infos的返回字段获取约束限制不涉及取值范围不涉及默认取值不涉及

表3 TestCaseAttachmentInfo
参数	是否必选	参数类型	描述
override	否	Boolean	参数解释附件是否要被覆盖约束限制不涉及取值范围 true：附件将被覆盖 false：附件不被覆盖默认取值不涉及
doc_id	否	String	参数解释文档id，获取方式请参见上传附件接口约束限制不涉及取值范围不涉及默认取值不涉及
file_name	是	String	参数解释文件名约束限制不涉及取值范围不涉及默认取值不涉及
file_path	否	String	参数解释文件路径约束限制不涉及取值范围不涉及默认取值不涉及
file_type	否	String	参数解释: 文件类型约束限制: 根据文件后缀扩展名填入取值范围: 不涉及默认取值: 不涉及
file_size	否	String	参数解释文件大小，单位是字节（Byte）约束限制不涉及取值范围不涉及默认取值不涉及
override_id	否	String	参数解释要覆盖的旧附件记录ID。获取方式请参见上传附件接口约束限制不涉及取值范围不涉及默认取值不涉及
related_type	否	String	参数解释: 相关类型约束限制: 不涉及取值范围: 0：本地上传 1：关联文档默认取值: 不涉及
store_file_name	否	String	参数解释保存文件名约束限制不涉及取值范围不涉及默认取值不涉及
system_type	否	String	参数解释: 系统类型约束限制: 根据系统类型传入对应的值取值范围: docman：docman系统 testman：testman系统默认取值: 不涉及
storage_system	否	String	参数解释区分文件存储系统约束限制不涉及取值范围不涉及默认取值不涉及

表4 TestCaseStepInfo
参数	是否必选	参数类型	描述
test_step	否	String	参数解释测试步骤约束限制不涉及取值范围不涉及默认取值不涉及
expect_result	否	String	参数解释预期结果约束限制不涉及取值范围不涉及默认取值不涉及
step_actual	否	String	参数解释步骤的实际结果约束限制不涉及取值范围不涉及默认取值不涉及
step_result	否	String	参数解释步骤结果约束限制不涉及取值范围不涉及默认取值不涉及

响应参数

状态码：200

表5 响应Body参数
参数	参数类型	描述
value	TestCaseCheckResultVo object	请求返回的数据

表6 TestCaseCheckResultVo
参数	参数类型	描述
total	Integer	总数
check_time	String	检查时间
check_timestamp	Long	检查时间时间戳
version_uri	String	版本URI
version_name	String	版本名称
results	Array of TestCaseCheckVo objects	检查结果

表7 TestCaseCheckVo
参数	参数类型	描述
num	Integer	序号
severity	String	严重程度
rule_description	String	规则描述
field	String	字段名称
link	String	规则链接
violation_cause	String	违规描述
suggestions	String	修改建议
hit_words	Array of strings	命中词
repeated_test_cases	Array of TestCaseRuleCheckRepeatedTestCaseVo objects	重复用例信息列表

表8 TestCaseRuleCheckRepeatedTestCaseVo
参数	参数类型	描述
uri	String	用例Uri
name	String	名称
number	String	用例编号
rank	Integer	用例等级
service_type	Integer	服务类型
preparation	String	前置前置条件
steps	TestCaseStepVo object	测试步骤
feature_uri	String	目录Uri
feature_name	String	目录名称
version_uri	String	版本URI
version_name	String	版本名称
similarity	String	用例相似度
name_similarity	String	用例名称相似度
preparation_similarity	String	用例前置条件相似度
step_similarity	String	用例步骤描述相似度
expected_result_similarity	String	用例预期结果相似度
test_steps_similarity	String	用例测试步骤相似度

表9 TestCaseStepVo
参数	参数类型	描述
test_step	String	参数解释测试步骤取值范围不涉及
expect_result	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	参数解释: 接口调用失败错误信息取值范围: 不涉及

请求示例

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

{
  "value" : {
    "total" : 2,
    "results" : [ {
      "num" : 1,
      "severity" : "严重",
      "field" : "步骤描述",
      "link" : "{url}",
      "suggestions" : "请编写测试步骤1描述",
      "rule_description" : "规则7.1.1 测试步骤、预期结果为必填项。",
      "violation_cause" : "违反规则7.1.1，测试步骤1描述为空"
    }, {
      "num" : 2,
      "severity" : "严重",
      "field" : "预期结果",
      "link" : "{url}",
      "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

错误码

请参见错误码。

父主题： 测试用例检查管理

上一篇：测试用例检查管理

下一篇：修改违规问题 - UpdateViolationCase

检查用例规范 - CheckTestCaseFour

功能介绍

调用方法

URI

请求参数

响应参数

请求示例

响应示例

状态码

错误码

相关文档

您对此文档页面的整体评价？