更新时间:2024-08-06 GMT+08:00
分享

查询用例列表

功能介绍

查询用例列表

URI

POST /GT3KServer/v4/{project_id}/testcases/batch-query

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目id,对应"需求管理 CodeArts Req"项目唯一标识,测试计划管理页面地址栏url https://{host}/cloudtestportal/project/{project_id}/testplan中project_id变量的值

约束限制:

不涉及

取值范围:

项目uuid应符合如下规则:长度等于32位,包含大小写字母、数字

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

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

表3 请求Body参数

参数

是否必选

参数类型

描述

keyword

String

关键字查询,用例名或编号

exeplatforms

Array of strings

执行平台

own

Boolean

是否是我的

useOffset

Boolean

是否使用偏移量方式查询

version_uri

String

版本URI

case_uris

Array of strings

用例URI集合

owner_ids

Array of strings

处理者ID集合

status_codes

Array of strings

状态Code集合

rank_ids

Array of strings

用例等级ID集合

module_ids

Array of strings

模块ID集合

issue_id

String

需求编号

creator_ids

Array of strings

创建者ID集合

result_codes

Array of strings

结果Code集合

iteration_ids

Array of strings

归属迭代ID集合

create_start_time

String

创建开始时间

create_end_time

String

创建结束时间

associated_issue

Boolean

是否关联需求(null:不限,false:未关联,true:已关联)

associated_defects

Boolean

是否关联缺陷(null:不限,false:未关联,true:已关联)

include_sub_issue

Boolean

是否查询子需求关联的用例,默认true

include_sub_feature

Boolean

是否查询子目录的用例,默认true

label_ids

Array of strings

标签ID集合

execute_start_time

String

执行开始时间

execute_end_time

String

执行结束时间

executor_ids

Array of strings

执行者ID集合

test_types

Array of strings

类型

is_keyword

Boolean

是否组合关键字

issue_tree_search

Boolean

是否是需求树点击的查询关联用例

service_type

Integer

服务类型

service_types

Array of integers

服务类型集合

stage_type

Integer

阶段过程(2:测试设计,3:测试执行,4:质量报告)

feature_uri

String

目录URI

sort_field

String

排序字段

sort_type

String

排序方式

page_no

Integer

当前页数

page_size

Integer

每页条数

case_type

Integer

用例类型

custom_field_info

Array of QueryCustomFieldsInfo objects

用例自定义字段信息

task_uri

String

测试套uri

associate_issue_detail

Boolean

是否返回需求具体信息(返回需求名称,需求id)

not_assign_task

Boolean

该字段为false,则查询全量用例,为true表示查询未分配测试套的用例

test_designs

Array of booleans

是否来自测试设计(null或者[true, false]:不限,[true]:来自测试设计,[false]:否来自测试设计)

review_status

Integer

用例评审状态

表4 QueryCustomFieldsInfo

参数

是否必选

参数类型

描述

id

Integer

测试用例自定义字段Id

values

Array of strings

测试用例自定义字段值

field_name

String

自定义字段名,优先取id再取fieldName

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

total

Integer

起始记录数 大于 实际总条数时, 值为0, 分页请求才有此值

value

Array of TestCaseListVo objects

实际的数据类型:单个对象,集合 或 NULL

reason

String

业务失败的提示内容,对内接口才有此值

page_size

Integer

每页展示条数

page_no

Integer

页码

has_more

Boolean

是否有更多

表6 TestCaseListVo

参数

参数类型

描述

uri

String

用例URI

name

String

用例名称

owner

NameAndIdVo object

服务类型信息

status

NameAndIdVo object

服务类型信息

result

NameAndIdVo object

服务类型信息

module

NameAndIdVo object

服务类型信息

iteration

NameAndIdVo object

服务类型信息

exeplatform

String

执行平台,如:apittest,其他三方执行平台

number

String

用例编号

description

String

用例描述

rank_id

String

用例等级

feature_uri

String

目录URI

release_dev

String

版本号

is_keyword

Boolean

是否组合关键字

script_url

String

脚本路径

report_url

String

实时报告地址

project_uuid

String

项目ID

service_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

关联缺陷信息

case_type

Integer

用例类型

labels

String

用例标签名称列表

custom_field_info

Array of CustomFieldVo objects

自定义字段信息

is_test_design

Boolean

是否来自测试设计(null:不限,false:否来自测试设计,true:来自测试设计)

last_modified

Long

最后修改时间(null:不限)

review_status

Integer

用例评审状态(null:0至127)

表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

是否已关联

issue_id

String

需求ID

tracker_id

String

需求类型

board_id

String

工作项层级ID

tracker_name

String

需求类型名称

表12 AssociateDefectInfoVo

参数

参数类型

描述

associate

Boolean

是否已关联

associate_count

Integer

关联缺陷数

表13 CustomFieldVo

参数

参数类型

描述

type

String

字段类型(单行文本text、多行文本textArea、单选框radio、多选框checkBox、日期date、数字number、单选用户user)

value

String

测试用例自定义字段值

custom_field_param

String

项目用例自定义字段入参或者返回参数名称

user_name

String

user类型测试用例自定义字段对应用户名,其它类型字段不返回

状态码: 400

表14 响应Body参数

参数

参数类型

描述

code

String

业务失败的错误码

reason

String

业务失败的提示内容

状态码: 401

表15 响应Body参数

参数

参数类型

描述

code

String

业务失败的错误码

reason

String

业务失败的提示内容

状态码: 404

表16 响应Body参数

参数

参数类型

描述

code

String

业务失败的错误码

reason

String

业务失败的提示内容

状态码: 500

表17 响应Body参数

参数

参数类型

描述

code

String

业务失败的错误码

reason

String

业务失败的提示内容

请求示例

响应示例

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码

相关文档