外部系统查询项目下迭代列表 - ShowIteratorsExternal

功能介绍

外部系统查询项目下迭代列表

调用方法

URI

GET /v5/testhub/projects/{project_id}/iterators

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目ID

表2 Query参数
参数	是否必选	参数类型	描述
offset	是	Integer	当前页数
limit	是	Integer	每页条数
name	否	String	查询迭代名
current_stage	否	String	计划所处阶段
branch_uri	否	String	分支Uri，默认master
fix_version_ids	否	String	测试计划关联迭代id
query_all_version	否	Boolean	是否查询所有版本下测试计划，此值为false，若传入了branch_uri，则按照branch_uri查询，不传默认查询基线，为true时查询所有版本下测试计划,branch_uri将参数无法生效

请求参数

无

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
[数组元素]	Array of ExternalServiceShowIteratorsVo objects	status为failed时，存放只有reason的ApiError对象

表4 ExternalServiceShowIteratorsVo
参数	参数类型	描述
name	String	迭代名称
owner	NameAndIdVo object	处理者
creator	NameAndIdVo object	创建者
iteration	NameAndIdVo object	迭代
plan_id	String	迭代uri
project_id	String	项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目ID
current_stage	String	迭代计划所处节点
expire_day	Long	超期天数
start_date	String	开始时间
end_date	String	结束时间
finish_date	String	实际完成时间
design_stage	ExternalServiceDesignStageVo object	设计阶段统计数据
execute_stage	ExternalServiceExecuteStageVo object	执行阶段统计数据
report_stage	ExternalServiceReportStageVo object	报告阶段统计数据
branch_name	String	分支版本名称
branch_id	String	分支版本id

表5 NameAndIdVo
参数	参数类型	描述
id	String	参数解释 ID 取值范围不涉及
name	String	参数解释名称取值范围不涉及

表6 ExternalServiceDesignStageVo
参数	参数类型	描述
case_count	Integer	用例个数
issue_count	Integer	需求个数
issue_covered_count	Integer	已被用例关联的需求个数

表7 ExternalServiceExecuteStageVo
参数	参数类型	描述
defect_count	Integer	缺陷个数
completed_defect_count	Integer	已完成缺陷个数
case_pass_rate	String	用例通过率,按用例结果计算
executed_case_count	Integer	已执行用例数, 按用例状态统计

表8 ExternalServiceReportStageVo
参数	参数类型	描述
case_complete_rate	String	用例完成率,按状态统计

状态码：400

表9 响应Body参数
参数	参数类型	描述
error_code	String	参数解释: 接口调用失败错误码取值范围: 不涉及
error_msg	String	参数解释: 接口调用失败错误信息取值范围: 不涉及

状态码：401

**表10** 响应Body参数
参数	参数类型	描述
error_code	String	参数解释: 接口调用失败错误码取值范围: 不涉及
error_msg	String	参数解释: 接口调用失败错误信息取值范围: 不涉及

状态码：404

**表11** 响应Body参数
参数	参数类型	描述
error_code	String	参数解释: 接口调用失败错误码取值范围: 不涉及
error_msg	String	参数解释: 接口调用失败错误信息取值范围: 不涉及

状态码：500

**表12** 响应Body参数
参数	参数类型	描述
error_code	String	参数解释: 接口调用失败错误码取值范围: 不涉及
error_msg	String	参数解释: 接口调用失败错误信息取值范围: 不涉及

请求示例

get https://{endpoint}/v5/testhub/projects/f3087a82b44744c29a1bd69ab6ada154}/iterators?offset=1&limit=5

响应示例

状态码：200

[ {
  "name" : "迭代名称",
  "owner" : {
    "id" : "id",
    "name" : "name"
  },
  "creator" : {
    "id" : "id",
    "name" : "name"
  },
  "iteration" : {
    "id" : "id",
    "name" : "name"
  },
  "plan_id" : "001t955o46t",
  "project_id" : "1f22e3511dd348e38131b4066afbd0b4",
  "current_stage" : "create",
  "expire_day" : 0,
  "start_date" : "2021-01-01 00:00:00",
  "end_date" : "2021-01-02 00:00:00",
  "finish_date" : "2021-01-02 00:00:00",
  "design_stage" : {
    "case_count" : 1,
    "issue_count" : 2,
    "issue_covered_count" : 3
  },
  "execute_stage" : {
    "defect_count" : 1,
    "completed_defect_count" : 2,
    "case_pass_rate" : "20%",
    "executed_case_count" : 4
  },
  "report_stage" : {
    "case_complete_rate" : "10%"
  },
  "branch_name" : "string",
  "branch_id" : "string"
} ]