文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 测试计划管理/ 项目下查询测试计划列表v2
更新时间：2024-11-19 GMT+08:00
查看PDF
分享

项目下查询测试计划列表v2

功能介绍

项目下查询测试计划列表v2

URI

GET /v2/projects/{project_id}/plans

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目id，项目唯一标识，固定长度32位字符，获取方式请参见获取项目ID。
表2 Query参数

参数

是否必选

参数类型

描述

offset

是

Integer

起始偏移量，表示从此偏移量开始查询， offset大于等于0

limit

是

Integer

每页显示的条目数量,最大支持200条

name

否

String

模糊查询使用(针对测试计划名称)

current_stage

否

String

测试计划所处阶段（create,design,execute,report）

fix_version_ids

否

String

测试计划关联的迭代。迭代id以逗号间隔

branch_uri

否

String

分支Uri，默认master

query_all_version

否

Boolean

是否查询所有版本下测试计划，默认为false。若值为true, 查询所有版本下测试计划; 若为false, 查询branch_uri指定分支下的测试计划, branch_uri为空时默认为master

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码： 201

表4 响应Body参数

参数

参数类型

描述

[数组元素]

Array of TestPlanDetail objects

项目下查询测试计划列表返回结构
表5 TestPlanDetail

参数

参数类型

描述

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

report_stage

report_stage object

报告阶统计数据

start_date

String

测试计划开始时间
表6 creator

参数

参数类型

描述

id

String

测试计划创建者id

nick_name

String

测试计划创建者的昵称，当用户未设置昵称时不返回该字段

user_name

String

测试计划创建者的用户名称
表7 design_stage

参数

参数类型

描述

case_count

Integer

用例个数

issue_count

Integer

需求个数

issue_covered_count

String

已被用例关联的需求个数
表8 execute_stage

参数

参数类型

描述

case_pass_rate

String

用例通过率,按用例结果计算

completed_defect_count

Integer

已完成缺陷个数

defect_count

Integer

缺陷个数

executed_case_count

Integer

已执行用例数, 按用例状态统计
表9 NameAndId

参数

参数类型

描述

id

String

对象编号

name

String

对象名称
表10 owner

参数

参数类型

描述

id

String

测试计划处理者id

name

String

测试计划处理者名称，优先返回nickName，不存在则返回userName

nick_name

String

测试计划处理者的昵称，当用户未设置昵称时不返回该字段

user_name

String

测试计划处理者的用户名称
表11 report_stage

参数

参数类型

描述

case_complete_rate

String

用例完成率,按状态统计

状态码： 400

表12 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码： 401

表13 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码： 404

表14 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码： 500

表15 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

请求示例

get https://{endpoint}/v2/projects/efdb403066474ab08836b9eeaaa23bca/plans?offset=1&limit=10&name&current_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

错误码

请参见错误码。

父主题： 测试计划管理

相关文档