查询用例列表
功能介绍
查询用例列表
URI
POST /v1/{project_id}/testcases/batch-query
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释 项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目ID。 约束限制 不涉及 取值范围 32个字符组成的字符串 默认取值 不涉及 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 约束限制 不涉及 取值范围 字符串长度不少于1，不超过100000 默认取值 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
offset |
是 |
Integer |
参数解释: 起始偏移量，表示从此偏移量开始查询 约束限制: 不涉及 取值范围: 大于等于0，小于等于100000的数字 默认取值: 不涉及 |
|
limit |
是 |
Integer |
参数解释: 每页显示的条目数量，最大支持200条 约束限制: 不涉及 取值范围: 大于等于0，小于等于200的数字 默认取值: 不涉及 |
|
execution_type_id |
否 |
Integer |
参数解释: 用例测试执行方式ID 约束限制: 不涉及 取值范围: 大于等于0的数字 默认取值: 不涉及 |
|
version_id |
否 |
String |
参数解释: 分支/测试计划ID 约束限制: 不涉及 取值范围: 长度11-34位字符（字母和数字） 默认取值: 不涉及 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
values |
Array of ExternalTestCaseVo objects |
参数解释: 用例详情列表 取值范围: 不涉及 |
|
total |
Integer |
参数解释: 用例总数 取值范围: 不涉及 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
name |
String |
参数解释: 用例名称 取值范围: 不涉及 |
|
owner |
NameAndIdVo object |
参数解释: 处理者信息 取值范围: 不涉及 |
|
status |
NameAndIdVo object |
参数解释: 状态信息 取值范围: 不涉及 |
|
result |
NameAndIdVo object |
参数解释: 结果信息 取值范围: 不涉及 |
|
module |
NameAndIdVo object |
参数解释: 模块信息 取值范围: 不涉及 |
|
iteration |
NameAndIdVo object |
参数解释: 迭代信息 取值范围: 不涉及 |
|
id |
String |
参数解释: 用例ID 取值范围: 不涉及 |
|
number |
String |
参数解释: 用例编号 取值范围: 不涉及 |
|
description |
String |
参数解释: 用例描述 取值范围: 不涉及 |
|
rank_id |
String |
参数解释: 用例等级 取值范围: 不涉及 |
|
project_id |
String |
参数解释: 项目ID 取值范围: 不涉及 |
|
execution_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 |
参数解释: 关联缺陷信息 取值范围: 不涉及 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
Integer |
参数解释: 数据库存储数字 取值范围: 不涉及 |
|
name |
String |
参数解释: 页面显示值 取值范围: 不涉及 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
参数解释: 需求类型名称 取值范围: 不涉及 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
associate |
Boolean |
参数解释: 需求类型名称 取值范围: true:已关联 false:未关联 |
|
associate_count |
Integer |
参数解释: 关联缺陷数 取值范围: 不涉及 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释 接口调用失败错误码 取值范围 不涉及 |
|
error_msg |
String |
参数解释 接口调用失败错误信息 取值范围 不涉及 |
状态码：401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释 接口调用失败错误码 取值范围 不涉及 |
|
error_msg |
String |
参数解释 接口调用失败错误信息 取值范围 不涉及 |
状态码：404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释 接口调用失败错误码 取值范围 不涉及 |
|
error_msg |
String |
参数解释 接口调用失败错误信息 取值范围 不涉及 |
状态码：500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释 接口调用失败错误码 取值范围 不涉及 |
|
error_msg |
String |
参数解释 接口调用失败错误信息 取值范围 不涉及 |
请求示例
查询用例列表
post https://{endpoint}/v1/efdb403066474ab08836b9eeaaa23bca/testcases/batch-query
{
"offset" : 1,
"limit" : 10,
"execution_type_id" : 0,
"version_id" : "005t8asecn21da"
}响应示例
状态码：200
OK
{
"values" : [ {
"name" : "测试用例",
"owner" : {
"id" : "id",
"name" : "name"
},
"status" : {
"id" : "id",
"name" : "name"
},
"result" : {
"id" : "id",
"name" : "name"
},
"module" : {
"id" : "id",
"name" : "name"
},
"iteration" : {
"id" : "id",
"name" : "name"
},
"id" : "001rv8lk4he",
"number" : "10010",
"description" : "用例描述",
"rank_id" : "2",
"project_id" : "7672757",
"execution_type" : {
"id" : "id",
"name" : "name"
},
"test_type" : {
"id" : 1,
"name" : "显示值"
},
"create_info" : {
"time" : "2021-11-06 00:00:01",
"timestamp" : 1660617231016,
"user_id" : "efdb403066474ab08836b9eeaaa23bca",
"user_name" : "测试Tester"
},
"execute_info" : {
"time" : "2021-11-06 12:00:00",
"timestamp" : 1660617231016,
"duration" : "00:00:10",
"user_id" : "efdb403066474ab08836b9eeaaa23bca",
"user_name" : "测试Tester",
"execute_times" : 1
},
"associate_issue_info" : {
"associate" : true,
"issue_id" : "4654022505049243648",
"tracker_id" : "1",
"board_id" : "443ef10e6c954b00a24ed6ce6864854a",
"tracker_name" : "IR"
},
"associate_defect_info" : {
"associate" : true,
"associate_count" : 1
}
} ],
"total" : 1
}状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
500 |
Internal Server Error |
错误码
请参见错误码。
