查询用例列表 - ListAllTestCasesv4

功能介绍

查询用例列表

调用方法

URI

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

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释: 项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目ID 约束限制: 不涉及取值范围: 项目uuid应符合如下规则：长度等于32位，包含大小写字母、数字默认取值: 不涉及

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	参数解释：用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。约束限制：必传。取值范围：字符串长度不少于1，不超过10万。默认取值：不涉及。

表3 请求Body参数
参数	是否必选	参数类型	描述
keyword	否	String	参数解释: 关键字查询约束限制: 不涉及取值范围: 用例名或编号默认取值: 不涉及
exeplatforms	否	Array of strings	参数解释: 执行平台列表数组约束限制: 不涉及取值范围: 不涉及默认取值: 不涉及
own	否	Boolean	参数解释: 是否是我的约束限制: 不涉及取值范围: true:是 false:不是默认取值: 不涉及
useOffset	否	Boolean	参数解释: 是否使用偏移量方式查询约束限制: 不涉及取值范围: true:使用偏移量方式查询 false:不使用偏移量方式查询默认取值: 不涉及
version_uri	否	String	参数解释: 版本URI 约束限制: 不涉及取值范围: 11到34位默认取值: 不涉及
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集合约束限制: 不涉及取值范围: 0,1,2,3,4 默认取值: 不涉及
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:查询子需求关联的用例 false:不查询子需求关联的用例默认取值: true
include_sub_feature	否	Boolean	参数解释: 是否查询子目录的用例约束限制: 不涉及取值范围: true:查询子目录关联的用例 false:不查询子目录关联的用例默认取值: 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	参数解释: 是否组合关键字约束限制: 不涉及取值范围: true:组合关键字 false:不组合关键字默认取值: 不涉及
issue_tree_search	否	Boolean	参数解释: 是否是需求树单击的查询关联用例约束限制: 不涉及取值范围: true:需求树单击查询 false:非需求树单击查询默认取值: 不涉及
service_type	否	Integer	参数解释: 服务类型约束限制: 不涉及取值范围: -1，全量用例。 0，手工测试。 1，接口自动化。 7，功能自动化。 8，WebUI自动化。 100，自定义自动化(工厂)。 11，性能自动化。默认取值: 不涉及
service_types	否	Array of integers	参数解释: 服务类型集合约束限制: 不涉及取值范围: 不涉及默认取值: 不涉及
stage_type	否	Integer	参数解释: 阶段过程约束限制: 不涉及取值范围: 2：测试设计，3：测试执行，4：质量报告默认取值: 不涉及
feature_uri	否	String	参数解释: 目录URI 约束限制: 不涉及取值范围: 不涉及默认取值: 不涉及
sort_field	否	String	参数解释: 排序字段约束限制: 不涉及取值范围: name\|testCaseNumber\|status\|result\|createTime\|executeTime\|executeDuration\|module\|iteration 默认取值: 不涉及
sort_type	否	String	参数解释: 排序方式约束限制: 不涉及取值范围: ASC，升序。 DESC，降序。默认取值: 不涉及
page_no	是	Integer	参数解释: 当前页数约束限制: 不涉及取值范围: 1-2000 默认取值: 不涉及
page_size	是	Integer	参数解释: 每页条数约束限制: 不涉及取值范围: 1-100 默认取值: 不涉及
case_type	否	Integer	用例类型约束限制: 不涉及取值范围: 0，手工测试。 1，接口自动化。 2，性能用例。默认取值: 不涉及
custom_field_info	否	Array of QueryCustomFieldsInfo objects	参数解释: 用例自定义字段信息约束限制: 不涉及取值范围: 不涉及默认取值: 不涉及
task_uri	否	String	参数解释: 测试套uri 约束限制: 不涉及取值范围: 不涉及默认取值: 不涉及
associate_issue_detail	否	Boolean	参数解释: 是否返回需求具体信息（返回需求名称，需求id）约束限制: 不涉及取值范围: true:返回 false:不返回默认取值: 不涉及
not_assign_task	否	Boolean	参数解释: 查询全量用例或查询未分配测试套的用例约束限制: 不涉及取值范围: true:查询未分配测试套的用例 false:查询全量用例默认取值: 不涉及
test_designs	否	Array of booleans	参数解释: 是否来自测试设计约束限制: 不涉及取值范围: null或者[true, false]：不限，[true]：来自测试设计，[false]：否来自测试设计默认取值: 不涉及
review_status	否	Integer	参数解释: 用例评审状态取值范围: 0，未评审。 1，已评审。

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

响应参数

状态码：200

表5 响应Body参数
参数	参数类型	描述
total	Integer	参数解释总数取值范围不涉及
page_no	String	参数解释分页编码取值范围不涉及
page_size	String	参数解释分页大小取值范围不涉及
value	Array of TestCaseListVo objects	参数解释: 实际的数据类型：单个对象，集合或 NULL 取值范围: 不涉及

表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	参数解释: 项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目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	参数解释: 用例类型约束限制: 不涉及取值范围: 0，手工测试。 1，接口自动化。 2，性能用例。
labels	String	参数解释: 用例标签名称列表取值范围: 不涉及
custom_field_info	Array of CustomFieldVo objects	参数解释: 自定义字段信息取值范围: 不涉及
is_test_design	Boolean	参数解释: 是否来自测试设计取值范围: null：不限，false：否来自测试设计，true：来自测试设计
last_modified	Long	参数解释: 最后修改时间取值范围: null：不限
review_status	Integer	用例评审状态取值范围: 0，未评审。 1，已评审。
confidentiality_code	String	参数解释资源密级等级编码，只有在涉密开关打开时，且资源设置了密级等级，才会返回约束限制不涉及取值范围不涉及默认取值不涉及

表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类型测试用例自定义字段对应用户名，其它类型字段不返回

状态码：400

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

状态码：401

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

状态码：404

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

状态码：500

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

请求示例

查询用例列表

post https://{endpoint}/v4/db186d87a311475f9fb926f0b27c495f/testcases/batch-query

{
  "page_no" : 1,
  "page_size" : 15,
  "feature_uri" : "db186d87a311475f9fb926f0b27c495f",
  "service_type" : -1,
  "stage_type" : "3",
  "custom_field_info" : [ ],
  "version_uri" : "v92t00010e47vi9c"
}

响应示例

状态码：200

{
  "total" : 7,
  "value" : [ {
    "uri" : "v90200010sa1snjj",
    "name" : "添加的用例_3050_0431_0435",
    "owner" : {
      "id" : ""
    },
    "status" : {
      "id" : "0",
      "name" : "新建"
    },
    "result" : { },
    "module" : {
      "id" : "",
      "name" : ""
    },
    "iteration" : { },
    "number" : "106",
    "rank_id" : "2",
    "is_keyword" : false,
    "report_url" : "",
    "project_uuid" : "3c913532482340e69b9b724f6732c67c",
    "service_type" : {
      "id" : "0",
      "name" : "手工测试"
    },
    "test_type" : {
      "id" : 1,
      "name" : "功能性测试"
    },
    "create_info" : {
      "time" : "2025-10-20 16:58:53",
      "timestamp" : 1760950733000,
      "user_id" : "c6a01bc6f2984a2098b423ce0ab1fdeb",
      "user_name" : "TMSS001_ShylaChen"
    },
    "execute_info" : { },
    "associate_issue_info" : {
      "associate" : false
    },
    "associate_defect_info" : {
      "associate" : false
    },
    "case_type" : 0,
    "labels" : [ ],
    "is_test_design" : false,
    "last_modified" : 1760950733000,
    "review_status" : 0,
    "case_create_date" : 1760950733000
  }, {
    "uri" : "v90100010sa1sj6t",
    "name" : "添加的用例_3050_0431",
    "owner" : {
      "id" : ""
    },
    "status" : {
      "id" : "0",
      "name" : "新建"
    },
    "result" : { },
    "module" : {
      "id" : "",
      "name" : ""
    },
    "iteration" : { },
    "number" : "105",
    "rank_id" : "2",
    "is_keyword" : false,
    "report_url" : "",
    "project_uuid" : "3c913532482340e69b9b724f6732c67c",
    "service_type" : {
      "id" : "0",
      "name" : "手工测试"
    },
    "test_type" : {
      "id" : 1,
      "name" : "功能性测试"
    },
    "create_info" : {
      "time" : "2025-10-20 16:58:48",
      "timestamp" : 1760950728000,
      "user_id" : "c6a01bc6f2984a2098b423ce0ab1fdeb",
      "user_name" : "TMSS001_ShylaChen"
    },
    "execute_info" : { },
    "associate_issue_info" : {
      "associate" : false
    },
    "associate_defect_info" : {
      "associate" : false
    },
    "case_type" : 0,
    "labels" : [ ],
    "is_test_design" : false,
    "last_modified" : 1760950728000,
    "review_status" : 0,
    "case_create_date" : 1760950728000
  }, {
    "uri" : "v90200010s9vut4n",
    "name" : "添加的用例_3050",
    "owner" : {
      "id" : ""
    },
    "status" : {
      "id" : "0",
      "name" : "新建"
    },
    "result" : { },
    "module" : {
      "id" : "",
      "name" : ""
    },
    "iteration" : { },
    "number" : "104",
    "rank_id" : "2",
    "is_keyword" : false,
    "report_url" : "",
    "project_uuid" : "3c913532482340e69b9b724f6732c67c",
    "service_type" : {
      "id" : "0",
      "name" : "手工测试"
    },
    "test_type" : {
      "id" : 1,
      "name" : "功能性测试"
    },
    "create_info" : {
      "time" : "2025-10-20 16:25:07",
      "timestamp" : 1760948707000,
      "user_id" : "c6a01bc6f2984a2098b423ce0ab1fdeb",
      "user_name" : "TMSS001_ShylaChen"
    },
    "execute_info" : { },
    "associate_issue_info" : {
      "associate" : false
    },
    "associate_defect_info" : {
      "associate" : false
    },
    "case_type" : 0,
    "labels" : [ ],
    "is_test_design" : false,
    "last_modified" : 1760948707000,
    "review_status" : 0,
    "case_create_date" : 1760948707000
  }, {
    "uri" : "v90100010s46cu6q",
    "name" : "新建三方类型的",
    "owner" : {
      "id" : ""
    },
    "status" : {
      "id" : "0",
      "name" : "新建"
    },
    "result" : { },
    "module" : {
      "id" : "",
      "name" : ""
    },
    "iteration" : { },
    "number" : "102",
    "rank_id" : "2",
    "is_keyword" : false,
    "report_url" : "",
    "project_uuid" : "3c913532482340e69b9b724f6732c67c",
    "service_type" : {
      "id" : "10004",
      "name" : "新建三方"
    },
    "test_type" : {
      "id" : 1,
      "name" : "功能性测试"
    },
    "create_info" : {
      "time" : "2025-10-18 10:22:12",
      "timestamp" : 1760754132000,
      "user_id" : "c6a01bc6f2984a2098b423ce0ab1fdeb",
      "user_name" : "TMSS001_ShylaChen"
    },
    "execute_info" : { },
    "associate_issue_info" : {
      "associate" : false
    },
    "associate_defect_info" : {
      "associate" : false
    },
    "case_type" : 0,
    "labels" : [ ],
    "is_test_design" : false,
    "last_modified" : 1760754132000,
    "review_status" : 0,
    "case_create_date" : 1760754132000
  }, {
    "uri" : "v90100010s45qt1e",
    "name" : "添加的用例",
    "owner" : {
      "id" : ""
    },
    "status" : {
      "id" : "0",
      "name" : "新建"
    },
    "result" : { },
    "module" : {
      "id" : "",
      "name" : ""
    },
    "iteration" : { },
    "number" : "101",
    "rank_id" : "2",
    "is_keyword" : false,
    "report_url" : "",
    "project_uuid" : "3c913532482340e69b9b724f6732c67c",
    "service_type" : {
      "id" : "0",
      "name" : "手工测试"
    },
    "test_type" : {
      "id" : 1,
      "name" : "功能性测试"
    },
    "create_info" : {
      "time" : "2025-10-18 10:12:21",
      "timestamp" : 1760753541000,
      "user_id" : "c6a01bc6f2984a2098b423ce0ab1fdeb",
      "user_name" : "TMSS001_ShylaChen"
    },
    "execute_info" : { },
    "associate_issue_info" : {
      "associate" : false
    },
    "associate_defect_info" : {
      "associate" : false
    },
    "case_type" : 0,
    "labels" : [ ],
    "is_test_design" : false,
    "last_modified" : 1760753541000,
    "review_status" : 0,
    "case_create_date" : 1760753541000
  }, {
    "uri" : "v90200010rvln3tf",
    "name" : "样例功能用例",
    "owner" : { },
    "status" : {
      "id" : "7",
      "name" : "完成"
    },
    "result" : {
      "id" : "0",
      "name" : "成功"
    },
    "module" : {
      "id" : "",
      "name" : ""
    },
    "iteration" : { },
    "number" : "008",
    "rank_id" : "2",
    "is_keyword" : false,
    "report_url" : "",
    "project_uuid" : "3c913532482340e69b9b724f6732c67c",
    "service_type" : {
      "id" : "0",
      "name" : "手工测试"
    },
    "test_type" : {
      "id" : 1,
      "name" : "功能性测试"
    },
    "create_info" : {
      "time" : "2025-10-16 16:13:42",
      "timestamp" : 1760602422000,
      "user_id" : "c6a01bc6f2984a2098b423ce0ab1fdeb",
      "user_name" : "TMSS001_ShylaChen"
    },
    "execute_info" : {
      "time" : "2025-10-16 16:13:44",
      "timestamp" : 1760602424000,
      "user_id" : "c6a01bc6f2984a2098b423ce0ab1fdeb",
      "user_name" : "TMSS001_ShylaChen",
      "execute_times" : 1
    },
    "associate_issue_info" : {
      "associate" : false
    },
    "associate_defect_info" : {
      "associate" : false
    },
    "case_type" : 0,
    "labels" : [ ],
    "is_test_design" : false,
    "last_modified" : 1760602423000,
    "review_status" : 0,
    "case_create_date" : 1760602422000
  }, {
    "uri" : "v90100010rvln2a5",
    "name" : "样例接口用例",
    "owner" : { },
    "status" : {
      "id" : "0",
      "name" : "新建"
    },
    "result" : { },
    "module" : {
      "id" : "",
      "name" : ""
    },
    "iteration" : { },
    "number" : "10010",
    "rank_id" : "2",
    "is_keyword" : false,
    "script_url" : "ApiTest/Scrum_alpha/src/scripts/user/Case_24ed2904867e4325befbf016ef4d8048_1.java",
    "report_url" : "",
    "project_uuid" : "3c913532482340e69b9b724f6732c67c",
    "service_type" : {
      "id" : "1",
      "name" : "接口自动化"
    },
    "test_type" : {
      "id" : 1,
      "name" : "功能性测试"
    },
    "create_info" : {
      "time" : "2025-10-16 16:13:40",
      "timestamp" : 1760602420000,
      "user_id" : "c6a01bc6f2984a2098b423ce0ab1fdeb",
      "user_name" : "TMSS001_ShylaChen"
    },
    "execute_info" : { },
    "associate_issue_info" : {
      "associate" : false
    },
    "associate_defect_info" : {
      "associate" : false
    },
    "case_type" : 0,
    "labels" : [ ],
    "is_test_design" : false,
    "last_modified" : 1760602420000,
    "review_status" : 0,
    "case_create_date" : 1760602420000
  } ],
  "page_size" : 10,
  "page_no" : 1
}