外部系统查询用例列表 - ShowExternalTestCasesFive

功能介绍

查询用例列表

调用方法

请参见如何调用API。

URI

POST /v5/testhub/projects/{project_id}/testcases/batch-query

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

请求参数

表2 请求Body参数
参数	是否必选	参数类型	描述
offset	是	Integer	当前页数
limit	是	Integer	每页限制
useOffset	否	Boolean	是否使用偏移量
version_id	否	String	分支/测试计划ID
execution_type_id	否	Integer	用例测试执行方式id
page_number	否	Integer	当前页数
page_size	否	Integer	每页条数

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
status	String	参数解释: 调用此接口的响应状态。取值范围: success，表示接口调用成功。 error，表示接口调用失败。
error	ApiError object	错误信息
request_id	String	由接口调用方传入，建议使用UUID保证请求的唯一性。
server_address	String	本次请求的受理的服务地址
result	ExternalTestCaseListVoForV5 object	status为failed时，存放只有reason的ApiError对象

表4 ApiError
参数	参数类型	描述
code	String	参数解释: 业务失败的错误码取值范围: 不涉及
reason	String	参数解释: 业务失败的提示内容取值范围: 不涉及

表5 ExternalTestCaseListVoForV5
参数	参数类型	描述
values	Array of ExternalTestCaseVoForV5 objects	用例详情列表
total	Integer	用例总数

表6 ExternalTestCaseVoForV5
参数	参数类型	描述
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	项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目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	参数解释: 关联缺陷信息取值范围: 不涉及

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

表8 IntegerIdAndNameVo
参数	参数类型	描述
id	Integer	参数解释数据库存储数字取值范围不涉及
name	String	参数解释页面显示值取值范围不涉及

表9 CreateInfoVo
参数	参数类型	描述
time	String	参数解释: 创建时间取值范围: 不涉及
timestamp	Long	参数解释: 创建时间时间戳取值范围: 不涉及
user_id	String	参数解释: 用户ID 取值范围: 不涉及
user_name	String	参数解释: 用户名称取值范围: 不涉及

**表10** ExecuteInfoVo
参数	参数类型	描述
time	String	参数解释: 执行开始时间取值范围: 不涉及
timestamp	Long	参数解释: 执行开始时间时间戳取值范围: 不涉及
duration	String	参数解释: 执行时长取值范围: 不涉及
user_id	String	参数解释: 用户ID 取值范围: 不涉及
user_name	String	参数解释: 用户名称取值范围: 不涉及
execute_times	Integer	参数解释: 执行次数取值范围: 不涉及

**表11** AssociateIssueInfoVo
参数	参数类型	描述
associate	Boolean	参数解释: 是否已关联取值范围: true: 已关联 false:未关联
issue_id	String	参数解释: 需求ID 取值范围: 不涉及
tracker_id	String	参数解释: 需求类型取值范围: 不涉及
board_id	String	参数解释: 工作项层级ID 取值范围: 不涉及
tracker_name	String	参数解释: 需求类型名称取值范围: 不涉及

**表12** AssociateDefectInfoVo
参数	参数类型	描述
associate	Boolean	参数解释: 是否已关联取值范围: true:已关联 false:未关联
associate_count	Integer	参数解释: 关联缺陷数取值范围: 不涉及

状态码：400

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

状态码：401

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

状态码：404

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

状态码：500

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

请求示例

post https://{endpoint}/v5/testhub/projects/{project_id}/testcases/batch-query

{
  "offset" : 1,
  "limit" : 10,
  "useOffset" : true,
  "version_id" : "005t8asecn21",
  "execution_type_id" : 3,
  "page_number" : 1,
  "page_size" : 10
}

响应示例

状态码：200

{
  "status" : "success",
  "result" : {
    "total" : 1,
    "values" : [ {
      "name" : "测试用例",
      "owner" : { },
      "status" : { },
      "result" : { },
      "module" : { },
      "iteration" : { },
      "id" : "001rv8lk4he",
      "number" : "10010",
      "description" : "用例描述",
      "rank_id" : "2",
      "project_id" : "bcfb102f3bef45ab87f0f9ea6fc4f49c",
      "execution_type" : { },
      "test_type" : { },
      "create_info" : { },
      "execute_info" : { },
      "associate_issue_info" : { },
      "associate_defect_info" : { }
    } ]
  }
}