本文导读

展开导读

文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 自定义测试服务用例管理/ 查询用例列表

查询用例列表

更新时间：2025-04-29 GMT+08:00

查看PDF

功能介绍

查询用例列表

URI

POST /v4/{project_id}/testcases/batch-list

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID

请求参数

表2 请求Body参数
参数	是否必选	参数类型	描述
keyword	否	String	关键字查询，用例名或编号
exeplatforms	否	Array of strings	执行平台
own	否	Boolean	是否是我的
useOffset	否	Boolean	是否使用offset分页
queryByDisplayCfg	否	Boolean	是否表头配置查询，如果为true,则未设置展示的字段不返回
version_uri	否	String	版本URI
case_uris	否	Array of strings	用例URI集合
owner_ids	否	Array of strings	处理者ID集合
status_codes	否	Array of strings	状态Code集合
rank_ids	否	Array of strings	用例等级ID集合
module_ids	否	Array of strings	模块ID集合
issue_id	否	String	需求编号
creator_ids	否	Array of strings	创建者ID集合
result_codes	否	Array of strings	结果Code集合
iteration_ids	否	Array of strings	归属迭代ID集合
create_start_time	否	String	创建开始时间
create_end_time	否	String	创建结束时间
associated_issue	否	Boolean	是否关联需求（null：不限，false：未关联，true：已关联）
associated_defects	否	Boolean	是否关联缺陷（null：不限，false：未关联，true：已关联）
include_sub_issue	否	Boolean	是否查询子需求关联的用例，默认true
include_sub_feature	否	Boolean	是否查询子目录的用例，默认true
label_ids	否	Array of strings	标签ID集合
execute_start_time	否	String	执行开始时间
execute_end_time	否	String	执行结束时间
executor_ids	否	Array of strings	执行者ID集合
test_types	否	Array of strings	类型
is_keyword	否	Boolean	是否组合关键字
issue_tree_search	否	Boolean	是否是需求树点击的查询关联用例
service_type	否	Integer	服务类型
service_types	否	Array of integers	服务类型集合
stage_type	否	Integer	阶段过程（2：测试设计，3：测试执行，4：质量报告）
feature_uri	否	String	目录URI
sort_field	否	String	排序字段
sort_type	否	String	排序方式
page_no	否	Integer	当前页数
page_size	否	Integer	每页条数
case_type	否	Integer	用例类型
custom_field_info	否	Array of QueryCustomFieldsInfo objects	用例自定义字段信息
task_uri	否	String	测试套uri
associate_issue_detail	否	Boolean	是否返回需求具体信息（返回需求名称，需求id）
not_assign_task	否	Boolean	该字段为false,则查询全量用例，为true表示查询未分配测试套的用例
test_designs	否	Array of booleans	是否来自测试设计（null或者[true, false]：不限，[true]：来自测试设计，[false]：否来自测试设计）
review_status	否	Integer	用例评审状态
just_return_id	否	Boolean	部分字段是否仅返回ID，默认为false，为true时部分字段仅返回ID

表3 QueryCustomFieldsInfo
参数	是否必选	参数类型	描述
id	否	Integer	参数解释: 测试用例自定义字段Id 约束限制: 不涉及取值范围: 不涉及默认取值: 不涉及
values	否	Array of strings	参数解释: 测试用例自定义字段值约束限制: 不涉及取值范围: 不涉及默认取值: 不涉及
field_name	否	String	参数解释: 自定义字段名约束限制: 不涉及取值范围: 优先取id再取fieldName 默认取值: 不涉及

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
status	String	success\|error
result	ResultValueListTestCaseListVo object	参数解释: 查询用例列表返回的数据对象取值范围: true: 有更多 false: 无更多
error	ApiError object	失败时的error信息
request_id	String	由接口调用方传入，建议使用UUID保证请求的唯一性。
server_address	String	本次请求的受理的服务地址

表5 ResultValueListTestCaseListVo
参数	参数类型	描述
total	Integer	参数解释: 符合条件的所有记录数取值范围: 起始记录数大于实际总条数时，值为0，分页请求才有此值
value	Array of TestCaseListVo objects	参数解释: 实际的数据类型：单个对象，集合或 NULL 取值范围: 不涉及
reason	String	参数解释: 业务失败的提示内容取值范围: 不涉及
page_size	Integer	参数解释: 每页展示条数取值范围: 不涉及
page_no	Integer	参数解释: 页码取值范围: 不涉及
has_more	Boolean	参数解释: 是否有更多取值范围: true: 有更多 false: 无更多

表6 TestCaseListVo
参数	参数类型	描述
uri	String	参数解释: 用例URI 取值范围: 不涉及
name	String	参数解释: 用例名称取值范围: 不涉及
owner	NameAndIdVo object	参数解释: 处理者取值范围: 不涉及
status	NameAndIdVo object	参数解释: 状态取值范围: 不涉及
result	NameAndIdVo object	参数解释: 结果取值范围: 不涉及
module	NameAndIdVo object	参数解释: 模块取值范围: 不涉及
iteration	NameAndIdVo object	参数解释: 迭代取值范围: 不涉及
exeplatform	String	参数解释: 执行平台取值范围: apittest,其他三方执行平台
number	String	参数解释: 用例编号取值范围: 不涉及
description	String	参数解释: 用例描述取值范围: 不涉及
rank_id	String	参数解释: 用例描述取值范围: 0\|1\|2\|3\|4
feature_uri	String	参数解释: 目录URI 取值范围: 不涉及
release_dev	String	参数解释: 版本号取值范围: 不涉及
is_keyword	Boolean	参数解释: 是否组合关键字取值范围: true: 组合关键字 false:不组合关键字
script_url	String	参数解释: 脚本路径取值范围: 不涉及
report_url	String	参数解释: 实时报告地址取值范围: 不涉及
project_uuid	String	参数解释: 项目id，对应"需求管理 CodeArts Req"项目唯一标识，测试计划管理页面地址栏url https://{host}/cloudtestportal/project/{project_id}/testplan中project_id变量的值取值范围: 项目uuid应符合如下规则：长度等于32位，包含大小写字母、数字
service_type	NameAndIdVo object	参数解释: 服务类型信息取值范围: 不涉及
test_type	IntegerIdAndNameVo object	参数解释: 测试类型信息取值范围: 不涉及
create_info	CreateInfoVo object	参数解释: 创建信息取值范围: 不涉及
execute_info	ExecuteInfoVo object	参数解释: 执行信息取值范围: 不涉及
associate_issue_info	AssociateIssueInfoVo object	参数解释: 关联需求信息取值范围: 不涉及
associate_defect_info	AssociateDefectInfoVo object	参数解释: 关联缺陷信息取值范围: 不涉及
case_type	Integer	参数解释: 用例类型取值范围: 不涉及
labels	String	参数解释: 用例标签名称列表取值范围: 不涉及
custom_field_info	Array of CustomFieldVo objects	参数解释: 自定义字段信息取值范围: 不涉及
is_test_design	Boolean	参数解释: 是否来自测试设计取值范围: null：不限，false：否来自测试设计，true：来自测试设计
last_modified	Long	参数解释: 最后修改时间取值范围: null：不限
review_status	Integer	参数解释: 用例评审状态取值范围: null：0至127

表7 NameAndIdVo
参数	参数类型	描述
id	String	参数解释 ID 取值范围不涉及
name	String	参数解释名称取值范围不涉及

表8 IntegerIdAndNameVo
参数	参数类型	描述
id	Integer	参数解释数据库存储数字取值范围不涉及
name	String	参数解释页面显示值取值范围不涉及

表9 CreateInfoVo
参数	参数类型	描述
time	String	参数解释: 创建时间取值范围: 不涉及
timestamp	Long	参数解释: 创建时间时间戳取值范围: 不涉及
user_id	String	参数解释: 用户ID 取值范围: 不涉及
user_name	String	参数解释: 用户名称取值范围: 不涉及

**表10** ExecuteInfoVo
参数	参数类型	描述
time	String	参数解释: 执行开始时间取值范围: 不涉及
timestamp	Long	参数解释: 执行开始时间时间戳取值范围: 不涉及
duration	String	参数解释: 执行时长取值范围: 不涉及
user_id	String	参数解释: 用户ID 取值范围: 不涉及
user_name	String	参数解释: 用户名称取值范围: 不涉及
execute_times	Integer	参数解释: 执行次数取值范围: 不涉及

**表11** AssociateIssueInfoVo
参数	参数类型	描述
associate	Boolean	参数解释: 是否已关联取值范围: true: 已关联 false:未关联
issue_id	String	参数解释: 需求ID 取值范围: 不涉及
tracker_id	String	参数解释: 需求类型取值范围: 不涉及
board_id	String	参数解释: 工作项层级ID 取值范围: 不涉及
tracker_name	String	参数解释: 需求类型名称取值范围: 不涉及

**表12** AssociateDefectInfoVo
参数	参数类型	描述
associate	Boolean	参数解释: 是否已关联取值范围: true:已关联 false:未关联
associate_count	Integer	参数解释: 关联缺陷数取值范围: 不涉及

**表13** CustomFieldVo
参数	参数类型	描述
type	String	参数解释: 字段类型取值范围: 单行文本text、多行文本textArea、单选框radio、多选框checkBox、日期date、数字number、单选用户user
value	String	参数解释: 测试用例自定义字段值取值范围: 不涉及
custom_field_param	String	参数解释: 项目用例自定义字段入参或者返回参数名称取值范围: 不涉及
user_name	String	参数解释: 用户名取值范围: user类型测试用例自定义字段对应用户名，其它类型字段不返回

**表14** ApiError
参数	参数类型	描述
code	String	参数解释: 业务失败的错误码取值范围: 不涉及
reason	String	参数解释: 业务失败的提示内容取值范围: 不涉及

状态码：400

**表15** 响应Body参数
参数	参数类型	描述
error_code	String	参数解释: 接口调用失败错误码取值范围: 不涉及
error_msg	String	参数解释: 接口调用失败错误信息取值范围: 不涉及

状态码：401

**表16** 响应Body参数
参数	参数类型	描述
error_code	String	参数解释: 接口调用失败错误码取值范围: 不涉及
error_msg	String	参数解释: 接口调用失败错误信息取值范围: 不涉及

状态码：404

**表17** 响应Body参数
参数	参数类型	描述
error_code	String	参数解释: 接口调用失败错误码取值范围: 不涉及
error_msg	String	参数解释: 接口调用失败错误信息取值范围: 不涉及

状态码：500

**表18** 响应Body参数
参数	参数类型	描述
error_code	String	参数解释: 接口调用失败错误码取值范围: 不涉及
error_msg	String	参数解释: 接口调用失败错误信息取值范围: 不涉及

请求示例

{
  "page_no" : 1,
  "page_size" : 15,
  "feature_uri" : "42f27e960b6a41b89c093cbdc657a07d",
  "service_type" : -1,
  "stage_type" : "3",
  "custom_field_info" : [ ],
  "version_uri" : "v9020001099p8qk4",
  "just_return_id" : true
}

响应示例

状态码：200

{
  "status" : "success",
  "result" : {
    "total" : 7,
    "value" : [ {
      "uri" : "v902000109klpan2",
      "name" : "dddd",
      "owner" : { },
      "status" : {
        "id" : "0",
        "name" : "新建"
      },
      "result" : { },
      "module" : {
        "id" : "",
        "name" : ""
      },
      "iteration" : { },
      "number" : "编号ABC编号ABC25",
      "rank_id" : "2",
      "is_keyword" : false,
      "script_url" : "dadasdas",
      "report_url" : "",
      "project_uuid" : "42f27e960b6a41b89c093cbdc657a07d",
      "service_type" : {
        "id" : "100",
        "name" : "自定义自动化(工厂)"
      },
      "test_type" : {
        "id" : 1,
        "name" : "功能性测试"
      },
      "create_info" : {
        "time" : "2025-03-02 17:00:43",
        "timestamp" : 1740906043000,
        "user_id" : "a17801c5d15f46e28112eec8a880683d",
        "user_name" : "wangluodan66663377"
      },
      "execute_info" : { },
      "associate_issue_info" : {
        "associate" : false
      },
      "associate_defect_info" : {
        "associate" : false
      },
      "case_type" : 0,
      "labels" : [ ],
      "custom_field_info" : [ {
        "type" : "text",
        "value" : "dasdas",
        "custom_field_param" : "custom_field_20"
      } ],
      "is_test_design" : false,
      "last_modified" : 1740906043000,
      "review_status" : 0
    }, {
      "uri" : "v902000109jvajk8",
      "name" : "1213",
      "owner" : { },
      "status" : {
        "id" : "0",
        "name" : "新建"
      },
      "result" : { },
      "module" : {
        "id" : "",
        "name" : ""
      },
      "iteration" : { },
      "number" : "编号ABC编号ABC24",
      "rank_id" : "2",
      "is_keyword" : false,
      "report_url" : "",
      "project_uuid" : "42f27e960b6a41b89c093cbdc657a07d",
      "service_type" : {
        "id" : "0",
        "name" : "手工测试"
      },
      "test_type" : {
        "id" : 1,
        "name" : "功能性测试"
      },
      "create_info" : {
        "time" : "2025-03-02 10:28:12",
        "timestamp" : 1740882492000,
        "user_id" : "a17801c5d15f46e28112eec8a880683d",
        "user_name" : "wangluodan66663377"
      },
      "execute_info" : { },
      "associate_issue_info" : {
        "associate" : false
      },
      "associate_defect_info" : {
        "associate" : false
      },
      "case_type" : 0,
      "labels" : [ ],
      "custom_field_info" : [ {
        "type" : "text",
        "value" : "1",
        "custom_field_param" : "custom_field_20"
      } ],
      "is_test_design" : false,
      "last_modified" : 1740882492000,
      "review_status" : 0
    }, {
      "uri" : "v901000109jvajjm",
      "name" : "1213",
      "owner" : { },
      "status" : {
        "id" : "0",
        "name" : "新建"
      },
      "result" : { },
      "module" : {
        "id" : "",
        "name" : ""
      },
      "iteration" : { },
      "number" : "编号ABC编号ABC23",
      "rank_id" : "2",
      "is_keyword" : false,
      "report_url" : "",
      "project_uuid" : "42f27e960b6a41b89c093cbdc657a07d",
      "service_type" : {
        "id" : "0",
        "name" : "手工测试"
      },
      "test_type" : {
        "id" : 1,
        "name" : "功能性测试"
      },
      "create_info" : {
        "time" : "2025-03-02 10:28:12",
        "timestamp" : 1740882492000,
        "user_id" : "a17801c5d15f46e28112eec8a880683d",
        "user_name" : "wangluodan66663377"
      },
      "execute_info" : { },
      "associate_issue_info" : {
        "associate" : false
      },
      "associate_defect_info" : {
        "associate" : false
      },
      "case_type" : 0,
      "labels" : [ ],
      "custom_field_info" : [ {
        "type" : "text",
        "value" : "1",
        "custom_field_param" : "custom_field_20"
      } ],
      "is_test_design" : false,
      "last_modified" : 1740882492000,
      "review_status" : 0
    }, {
      "uri" : "v901000109hc7mrn",
      "name" : "1213",
      "owner" : { },
      "status" : {
        "id" : "0",
        "name" : "新建"
      },
      "result" : { },
      "module" : {
        "id" : "",
        "name" : ""
      },
      "iteration" : { },
      "number" : "编号ABC编号ABC22",
      "rank_id" : "2",
      "is_keyword" : false,
      "report_url" : "",
      "project_uuid" : "42f27e960b6a41b89c093cbdc657a07d",
      "service_type" : {
        "id" : "0",
        "name" : "手工测试"
      },
      "test_type" : {
        "id" : 1,
        "name" : "功能性测试"
      },
      "create_info" : {
        "time" : "2025-03-01 10:16:05",
        "timestamp" : 1740795365000,
        "user_id" : "a17801c5d15f46e28112eec8a880683d",
        "user_name" : "wangluodan66663377"
      },
      "execute_info" : { },
      "associate_issue_info" : {
        "associate" : false
      },
      "associate_defect_info" : {
        "associate" : false
      },
      "case_type" : 0,
      "labels" : [ ],
      "custom_field_info" : [ {
        "type" : "text",
        "value" : "1",
        "custom_field_param" : "custom_field_20"
      } ],
      "is_test_design" : false,
      "last_modified" : 1740795365000,
      "review_status" : 0
    }, {
      "uri" : "v901000109abas5q",
      "name" : "Case002",
      "owner" : { },
      "status" : {
        "id" : "7",
        "name" : "完成"
      },
      "result" : {
        "id" : "0",
        "name" : "成功"
      },
      "module" : {
        "id" : "",
        "name" : ""
      },
      "iteration" : { },
      "number" : "编号ABC编号ABC14",
      "rank_id" : "2",
      "is_keyword" : false,
      "report_url" : "",
      "project_uuid" : "42f27e960b6a41b89c093cbdc657a07d",
      "service_type" : {
        "id" : "0",
        "name" : "手工测试"
      },
      "test_type" : { },
      "create_info" : {
        "time" : "2025-02-26 16:45:39",
        "timestamp" : 1740559539000,
        "user_id" : "a17801c5d15f46e28112eec8a880683d",
        "user_name" : "wangluodan66663377"
      },
      "execute_info" : {
        "time" : "2025-02-26 16:46:40",
        "timestamp" : 1740559600000,
        "duration" : "00:00:00.000",
        "user_id" : "a17801c5d15f46e28112eec8a880683d",
        "user_name" : "wangluodan66663377",
        "execute_times" : 5
      },
      "associate_issue_info" : {
        "associate" : false
      },
      "associate_defect_info" : {
        "associate" : false
      },
      "case_type" : 0,
      "labels" : [ ],
      "is_test_design" : false,
      "last_modified" : 1740559600000,
      "review_status" : 0
    }, {
      "uri" : "v901000109abamth",
      "name" : "Case001",
      "owner" : { },
      "status" : {
        "id" : "7",
        "name" : "完成"
      },
      "result" : {
        "id" : "0",
        "name" : "成功"
      },
      "module" : {
        "id" : "",
        "name" : ""
      },
      "iteration" : { },
      "number" : "编号ABC编号ABC13",
      "rank_id" : "2",
      "is_keyword" : false,
      "report_url" : "",
      "project_uuid" : "42f27e960b6a41b89c093cbdc657a07d",
      "service_type" : {
        "id" : "0",
        "name" : "手工测试"
      },
      "test_type" : { },
      "create_info" : {
        "time" : "2025-02-26 16:45:34",
        "timestamp" : 1740559534000,
        "user_id" : "a17801c5d15f46e28112eec8a880683d",
        "user_name" : "wangluodan66663377"
      },
      "execute_info" : {
        "time" : "2025-02-26 16:47:18",
        "timestamp" : 1740559638000,
        "duration" : "00:00:00.000",
        "user_id" : "a17801c5d15f46e28112eec8a880683d",
        "user_name" : "wangluodan66663377",
        "execute_times" : 2
      },
      "associate_issue_info" : {
        "associate" : false
      },
      "associate_defect_info" : {
        "associate" : false
      },
      "case_type" : 0,
      "labels" : [ ],
      "is_test_design" : false,
      "last_modified" : 1740559638000,
      "review_status" : 0
    }, {
      "uri" : "v903000109ab6re7",
      "name" : "示例A-登录华为云主页_使用华为账号_验证登录成功",
      "owner" : {
        "id" : ""
      },
      "status" : {
        "id" : "0",
        "name" : "新建"
      },
      "result" : { },
      "module" : {
        "id" : "",
        "name" : ""
      },
      "iteration" : { },
      "number" : "Login_HuaweiID_zh_A001",
      "rank_id" : "2",
      "is_keyword" : false,
      "report_url" : "",
      "project_uuid" : "42f27e960b6a41b89c093cbdc657a07d",
      "service_type" : {
        "id" : "7",
        "name" : "功能自动化"
      },
      "test_type" : {
        "id" : 1,
        "name" : "功能性测试"
      },
      "create_info" : {
        "time" : "2025-02-26 16:43:27",
        "timestamp" : 1740559407000,
        "user_id" : "a17801c5d15f46e28112eec8a880683d",
        "user_name" : "wangluodan66663377"
      },
      "execute_info" : { },
      "associate_issue_info" : {
        "associate" : false
      },
      "associate_defect_info" : {
        "associate" : false
      },
      "case_type" : 0,
      "labels" : [ ],
      "is_test_design" : false,
      "last_modified" : 1740559407000,
      "review_status" : 0
    } ],
    "page_size" : 15,
    "page_no" : 1
  }
}

状态码


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

错误码

请参见错误码。

父主题： 自定义测试服务用例管理

上一篇：查询用例、测试套版本号

下一篇：查询用户自定义配置

意见反馈

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

有帮助没帮助

提供反馈

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

系统繁忙，请稍后重试

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

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

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

字符长度不能超过500

直接提交取消

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

智能客服提问云社区提问

查询用例列表

功能介绍

URI

请求参数

响应参数

请求示例

响应示例

状态码

错误码

相关文档

意见反馈

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

文档反馈