文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 外部服务管理/ 外部系统查询项目下迭代列表
更新时间：2025-06-26 GMT+08:00
在线调试
CLI示例
查看PDF
分享

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

功能介绍

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

调用方法

请参见如何调用API。

URI

GET /v4/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

请求参数

无

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

status

String

success|error

error

ApiError object

错误信息

request_id

String

由接口调用方传入，建议使用UUID保证请求的唯一性。

server_address

String

本次请求的受理的服务地址

result

Array of ExternalServiceShowIteratorsVo objects

status为failed时，存放只有reason的ApiError对象
表4 ApiError

参数

参数类型

描述

code

String

参数解释:

业务失败的错误码

取值范围:

不涉及

reason

String

参数解释:

业务失败的提示内容

取值范围:

不涉及
表5 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
表6 NameAndIdVo

参数

参数类型

描述

id

String

参数解释

ID

取值范围

不涉及

name

String

参数解释

名称

取值范围

不涉及
表7 ExternalServiceDesignStageVo

参数

参数类型

描述

case_count

Integer

用例个数

issue_count

Integer

需求个数

issue_covered_count

Integer

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

参数

参数类型

描述

defect_count

Integer

缺陷个数

completed_defect_count

Integer

已完成缺陷个数

case_pass_rate

String

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

executed_case_count

Integer

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

参数

参数类型

描述

case_complete_rate

String

用例完成率,按状态统计

状态码：400

表10 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

接口调用失败错误码

取值范围:

不涉及

error_msg

String

参数解释:

接口调用失败错误信息

取值范围:

不涉及

状态码：401

表11 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

接口调用失败错误码

取值范围:

不涉及

error_msg

String

参数解释:

接口调用失败错误信息

取值范围:

不涉及

状态码：404

表12 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

接口调用失败错误码

取值范围:

不涉及

error_msg

String

参数解释:

接口调用失败错误信息

取值范围:

不涉及

状态码：500

表13 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

接口调用失败错误码

取值范围:

不涉及

error_msg

String

参数解释:

接口调用失败错误信息

取值范围:

不涉及

请求示例

get https://{endpoint}/v4/testhub/projects/{project_id}/iterators?offset=&limit=&name=&current_stage=&branch_uri=

响应示例

状态码：200

OK

{
  "status" : "success",
  "result" : {
    "name" : "迭代名称",
    "owner" : { },
    "creator" : { },
    "iteration" : { },
    "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" : { },
    "execute_stage" : { },
    "report_stage" : { },
    "branch_name" : "string",
    "branch_id" : "string"
  }
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题： 外部服务管理

相关文档