本文导读

功能介绍
调用方法
URI
请求参数
响应参数
请求示例
响应示例
状态码
错误码

展开导读

文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 用例模板管理/ 查询用例模板列表

查询用例模板列表

更新时间：2025-07-25 GMT+08:00

在线调试

CLI示例

查看PDF

功能介绍

查询用例模板列表

调用方法

请参见如何调用API。

URI

POST /v4/{project_id}/case-templates/batch-query

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

请求参数

表2 请求Body参数
参数	是否必选	参数类型	描述
name	否	String	模板名称
industry_type	否	Integer	行业类别
is_default	否	Boolean	是否是内置模板

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
status	String	success\|error
result	ResultValueListTestCaseTemplateVo object	success\|error
error	ApiError object	错误信息。
request_id	String	由接口调用方传入，建议使用UUID保证请求的唯一性。
server_address	String	本次请求的受理的服务地址

表4 ResultValueListTestCaseTemplateVo
参数	参数类型	描述
total	Integer	起始记录数大于实际总条数时，值为0，分页请求才有此值
value	Array of TestCaseTemplateVo objects	实际的数据类型：单个对象，集合或 NULL
reason	String	业务失败的提示内容
page_size	Integer	分页大小
page_no	Integer	分页编码
has_more	Boolean	是否有更多

表5 TestCaseTemplateVo
参数	参数类型	描述
uri	String	模板uri
name	String	模板名称
description	String	模板描述
number	String	用例编号
rank	Integer	用例等级
preparation	String	前置条件
creator	String	创建人
region	String	逻辑Region
updator	String	修改人
template_test_type	Integer	模板测试类型(1：性能，2：安全，3：功能，4：韧性可靠性，5：过载场景)
service_type	Integer	执行类型
test_type	Integer	测试类型
test_step	String	步骤
expect_output	String	预期结果
case_name	String	用例名称
case_description	String	用例描述
label_list	Array of strings	标签列表
script_url	String	脚本路径
creator_name	String	创建人名称
create_time	String	创建时间
tenant_id	String	租户
update_time	String	修改时间
is_default	Boolean	是否为内置模板
is_recommended	Boolean	是否精选模板
industry_type	Integer	行业分类id
is_solution_template	Boolean	是否解决方案模板
solution_template_uri	String	解决方案模板URI
feature_uri	String	目录URI
steps	Array of TestCaseStepVo objects	测试步骤

表6 TestCaseStepVo
参数	参数类型	描述
test_step	String	测试步骤
expect_result	String	预期结果

表7 ApiError
参数	参数类型	描述
code	String	响应码
reason	String	业务失败的提示内容

状态码：400

表8 响应Body参数
参数	参数类型	描述
error_code	String	接口调用失败错误码
error_msg	String	接口调用失败错误信息

状态码：401

表9 响应Body参数
参数	参数类型	描述
error_code	String	接口调用失败错误码
error_msg	String	接口调用失败错误信息

状态码：404

**表10** 响应Body参数
参数	参数类型	描述
error_code	String	接口调用失败错误码
error_msg	String	接口调用失败错误信息

状态码：500

**表11** 响应Body参数
参数	参数类型	描述
error_code	String	接口调用失败错误码
error_msg	String	接口调用失败错误信息

请求示例

post https://{endpoint}/v4/807aed221bf5457c8ccbbc55597d9a38/case-templates/batch-query

{
  "is_default" : true
}

响应示例

状态码：200

{
  "status" : "success",
  "result" : {
    "value" : [ {
      "uri" : "62",
      "name" : "股票停牌卖出撤单测试",
      "description" : "本用例用于股票停牌后，在进行创业板/科创板交易测试",
      "number" : "Finance_Stock_Trading_001",
      "rank" : 2,
      "preparation" : "1、存在创业板/科创板持仓",
      "service_type" : 0,
      "test_type" : 1,
      "test_step" : "[\"<p>15：00之前卖出停牌的股票</p>\",\"<p>15：00之后卖出停牌的股票</p>\",\"<p>15：00之前卖出停牌的股票</p>\",\"<p>15：00之后卖出停牌的股票</p>\"]",
      "expect_output" : "[\"<p>能进行卖出和撤单</p>\",\"<p>不能进行卖出</p>\",\"<p>能进行卖出和撤单</p>\",\"<p>不能进行卖出</p>\"]",
      "case_name" : "股票停牌_卖出_撤单测试",
      "case_description" : "本用例用于股票停牌后，在进行创业板/科创板交易测试",
      "label_list" : [ "金融", "停牌交易", "卖出撤单" ],
      "script_url" : "",
      "create_time" : "2022-06-27 19:50:01",
      "update_time" : "2022-06-27 19:50:00",
      "is_default" : true,
      "is_recommended" : false,
      "industry_type" : 10,
      "is_solution_template" : false,
      "steps" : [ {
        "test_step" : "<p>15：00之前卖出停牌的股票</p>",
        "expect_result" : "<p>能进行卖出和撤单</p>"
      }, {
        "test_step" : "<p>15：00之后卖出停牌的股票</p>",
        "expect_result" : "<p>不能进行卖出</p>"
      }, {
        "test_step" : "<p>15：00之前卖出停牌的股票</p>",
        "expect_result" : "<p>能进行卖出和撤单</p>"
      }, {
        "test_step" : "<p>15：00之后卖出停牌的股票</p>",
        "expect_result" : "<p>不能进行卖出</p>"
      } ]
    } ]
  }
}

状态码


状态码	描述
200	OK
400	Bad Request
401	Unauthorized
404	Not Found
500	Internal Server Error

错误码

请参见错误码。

父主题： 用例模板管理

上一篇：用例模板管理

下一篇：根据解决方案模板实例化资源（目录、用例）

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

盘古Doer提问云社区提问

查询用例模板列表

功能介绍

调用方法

URI

请求参数

响应参数

请求示例

响应示例

状态码

错误码

相关文档

意见反馈

文档内容是否对您有帮助？

文档反馈