查询用例列表
功能介绍
查询用例列表
URI
POST /GT3KServer/v4/{project_id}/testcases/batch-query
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目id,对应"需求管理 CodeArts Req"项目唯一标识,测试计划管理页面地址栏url https://{host}/cloudtestportal/project/{project_id}/testplan中project_id变量的值 约束限制: 不涉及 取值范围: 项目uuid应符合如下规则:长度等于32位,包含大小写字母、数字 默认取值: 不涉及 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
keyword |
否 |
String |
关键字查询,用例名或编号 |
exeplatforms |
否 |
Array of strings |
执行平台 |
own |
否 |
Boolean |
是否是我的 |
useOffset |
否 |
Boolean |
是否使用偏移量方式查询 |
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 |
用例评审状态 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
total |
Integer |
起始记录数 大于 实际总条数时, 值为0, 分页请求才有此值 |
value |
Array of TestCaseListVo objects |
实际的数据类型:单个对象,集合 或 NULL |
reason |
String |
业务失败的提示内容,对内接口才有此值 |
page_size |
Integer |
每页展示条数 |
page_no |
Integer |
页码 |
has_more |
Boolean |
是否有更多 |
参数 |
参数类型 |
描述 |
---|---|---|
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 |
用例等级 |
feature_uri |
String |
目录URI |
release_dev |
String |
版本号 |
is_keyword |
Boolean |
是否组合关键字 |
script_url |
String |
脚本路径 |
report_url |
String |
实时报告地址 |
project_uuid |
String |
项目ID |
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) |
参数 |
参数类型 |
描述 |
---|---|---|
time |
String |
创建时间 |
timestamp |
Long |
创建时间时间戳 |
user_id |
String |
用户ID |
user_name |
String |
用户名称 |
参数 |
参数类型 |
描述 |
---|---|---|
time |
String |
执行开始时间 |
timestamp |
Long |
执行开始时间时间戳 |
duration |
String |
执行时长 |
user_id |
String |
用户ID |
user_name |
String |
用户名称 |
execute_times |
Integer |
执行次数 |
参数 |
参数类型 |
描述 |
---|---|---|
associate |
Boolean |
是否已关联 |
issue_id |
String |
需求ID |
tracker_id |
String |
需求类型 |
board_id |
String |
工作项层级ID |
tracker_name |
String |
需求类型名称 |
参数 |
参数类型 |
描述 |
---|---|---|
type |
String |
字段类型(单行文本text、多行文本textArea、单选框radio、多选框checkBox、日期date、数字number、单选用户user) |
value |
String |
测试用例自定义字段值 |
custom_field_param |
String |
项目用例自定义字段入参或者返回参数名称 |
user_name |
String |
user类型测试用例自定义字段对应用户名,其它类型字段不返回 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
code |
String |
业务失败的错误码 |
reason |
String |
业务失败的提示内容 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
code |
String |
业务失败的错误码 |
reason |
String |
业务失败的提示内容 |
状态码: 404
参数 |
参数类型 |
描述 |
---|---|---|
code |
String |
业务失败的错误码 |
reason |
String |
业务失败的提示内容 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
code |
String |
业务失败的错误码 |
reason |
String |
业务失败的提示内容 |
请求示例
无
响应示例
无
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
404 |
Not Found |
500 |
Internal Server Error |
错误码
请参见错误码。