项目下查询测试计划列表v2
功能介绍
项目下查询测试计划列表v2
URI
GET /v2/projects/{project_id}/plans
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释 项目id，对应"需求管理 CodeArts Req"项目唯一标识，测试计划管理页面地址栏url https://{host}/cloudtestportal/project/{project_id}/testplan中project_id变量的值 约束限制 不涉及 取值范围 项目uuid应符合如下规则：长度等于32位，包含大小写字母、数字 默认取值 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
offset |
是 |
Integer |
参数解释 起始偏移量，表示从此偏移量开始查询 约束限制 不涉及 取值范围 大于等于0 默认取值 不涉及 |
|
limit |
是 |
Integer |
参数解释 每页显示的条目数量,最大支持100条，表示从此偏移量开始查询 约束限制 不涉及 取值范围 0-100 默认取值 不涉及 |
|
name |
否 |
String |
参数解释 模糊查询使用(针对测试计划名称) 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及 |
|
current_stage |
否 |
String |
参数解释 测试计划所处阶段 约束限制 不涉及 取值范围 create,design,execute,report 默认取值 不涉及 |
|
fix_version_ids |
否 |
String |
参数解释 测试计划关联的迭代 约束限制 不涉及 取值范围 迭代id以逗号间隔 默认取值 不涉及 |
|
branch_uri |
否 |
String |
参数解释 分支Uri 约束限制 不涉及 取值范围 不涉及 默认取值 master |
|
query_all_version |
否 |
Boolean |
参数解释 是否查询所有版本下测试计划 约束限制 不涉及 取值范围 fase:查询branch_uri指定分支下的测试计划,branch_uri为空时默认为master true:查询所有版本下测试计划 默认取值 false |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 约束限制 不涉及 取值范围 字符串长度不少于1，不超过100000 默认取值 不涉及 |
响应参数
状态码：201
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
[数组元素] |
Array of TestPlanDetail objects |
项目下查询测试计划列表返回结构 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
creator |
creator object |
参数解释: 测试计划创建者信息 取值范围: 不涉及 |
|
current_stage |
String |
参数解释: 当前测试计划所处的阶段 取值范围: 不涉及 |
|
design_stage |
design_stage object |
参数解释: 测试计划设计阶段信息 取值范围: 不涉及 |
|
end_date |
String |
参数解释: 测试计划截止时间 取值范围: 不涉及 |
|
execute_stage |
execute_stage object |
参数解释: 测试计划执行阶段信息 取值范围: 不涉及 |
|
expire_day |
Integer |
参数解释: 获取超期时间,正值表示已超期 取值范围: 不涉及 |
|
finish_date |
String |
参数解释: 测试计划实际完成时间（测试计划实际完成指测试计划下所有测试用例处于完成状态） 取值范围: 不涉及 |
|
iteration |
NameAndId object |
参数解释: 测试计划迭代编号与迭代名称 取值范围: 不涉及 |
|
name |
String |
参数解释: 测试计划名称 取值范围: 不涉及 |
|
owner |
owner object |
参数解释: 测试计划处理者信息 取值范围: 不涉及 |
|
plan_id |
String |
参数解释: 测试计划id 取值范围: 不涉及 |
|
project_id |
String |
参数解释: 项目id，对应"需求管理 CodeArts Req"项目唯一标识，测试计划管理页面地址栏url https://{host}/cloudtestportal/project/{project_id}/testplan中project_id变量的值 约束限制: 不涉及 取值范围: 项目uuid应符合如下规则：长度等于32位，包含大小写字母、数字 默认取值: 不涉及 |
|
report_stage |
report_stage object |
参数解释: 报告阶统计数据 取值范围: 不涉及 |
|
start_date |
String |
参数解释: 测试计划开始时间 取值范围: 不涉及 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
参数解释: 测试计划创建者id 取值范围: 不涉及 |
|
nick_name |
String |
参数解释: 测试计划创建者的昵称 取值范围: 当用户未设置昵称时不返回该字段 |
|
user_name |
String |
参数解释: 测试计划创建者的用户名称 取值范围: 不涉及 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
case_count |
Integer |
参数解释: 用例个数 取值范围: 不涉及 |
|
issue_count |
Integer |
参数解释: 需求个数 取值范围: 不涉及 |
|
issue_covered_count |
String |
参数解释: 已被用例关联的需求个数 取值范围: 不涉及 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
case_pass_rate |
String |
参数解释: 用例通过率,按用例结果计算 取值范围: 不涉及 |
|
completed_defect_count |
Integer |
参数解释: 已完成缺陷个数 取值范围: 不涉及 |
|
defect_count |
Integer |
参数解释: 缺陷个数 取值范围: 不涉及 |
|
executed_case_count |
Integer |
参数解释: 已执行用例数, 按用例状态统计 取值范围: 不涉及 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
参数解释: 测试计划处理者id 取值范围: 不涉及 |
|
name |
String |
参数解释: 测试计划处理者名称，优先返回nickName，不存在则返回userName 取值范围: 不涉及 |
|
nick_name |
String |
参数解释: 测试计划处理者的昵称，当用户未设置昵称时不返回该字段 取值范围: 不涉及 |
|
user_name |
String |
参数解释: 测试计划处理者的用户名称 取值范围: 不涉及 |
状态码：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 |
参数解释: 接口调用失败错误信息 取值范围: 不涉及 |
请求示例
get https://{endpoint}/v2/projects/efdb403066474ab08836b9eeaaa23bca/plans?offset=1&limit=10&name¤t_stage响应示例
状态码：201
OK
[ {
"creator" : {
"id" : "efdb403066474ab08836b9eeaaa23bca",
"nick_name" : "测试Tester",
"user_name" : "测试Tester"
},
"current_stage" : "design",
"design_stage" : {
"case_count" : 2,
"issue_count" : 0,
"issue_covered_count" : "0"
},
"end_date" : "2021-07-10",
"execute_stage" : {
"case_pass_rate" : "0.00%",
"completed_defect_count" : 0,
"defect_count" : 0,
"executed_case_count" : 0
},
"expire_day" : -4,
"finish_date" : "2021-07-10",
"iteration" : {
"id" : "ID",
"name" : "名称"
},
"name" : "测试",
"owner" : {
"id" : "efdb403066474ab08836b9eeaaa23bca",
"name" : "测试Tester",
"nick_name" : "测试Tester",
"user_name" : "测试Tester"
},
"plan_id" : "c7c2ddf2ea914164ac6ee76bf11a30ea",
"project_id" : "9b26f58ec29943f681804a6628779a23",
"report_stage" : {
"case_complete_rate" : "100.00%"
},
"start_date" : "2021-07-10"
} ]状态码
|
状态码 |
描述 |
|---|---|
|
201 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
500 |
Internal Server Error |
错误码
请参见错误码。
