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

根据条件查询用例uri

功能介绍

根据条件查询用例uri

调用方法

请参见如何调用API

URI

POST /v4/testcase-uris/search/used-for-automation

请求参数

表1 请求Body参数

参数

是否必选

参数类型

描述

keyword

String

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

exeplatforms

Array of strings

执行平台

own

Boolean

是否是我的

conditions

Array of SearchCondition objects

搜索条件

queryByDisplayCfg

Boolean

是否表头配置查询,如果为true,则未设置展示的字段不返回

useOffset

Boolean

使用offset分页

project_uuid

String

项目UUID,项目唯一标识,固定长度32位字符(字母和数字)。获取方式请参见获取项目ID

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

用例评审状态

just_return_id

Boolean

部分字段是否仅返回ID,默认为false,为true时部分字段仅返回ID

iterator_uri_condition

String

迭代uri搜索条件

表2 SearchCondition

参数

是否必选

参数类型

描述

field_name

String

字段名

field_value

String

字段值

operator

String

数据库字段操作

sour_value

String

源值

tar_value

String

目标值

field_type

String

字段类型

表3 QueryCustomFieldsInfo

参数

是否必选

参数类型

描述

id

Integer

测试用例自定义字段Id

values

Array of strings

测试用例自定义字段值

field_name

String

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

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

status

String

success|error

result

ResultValueListString object

请求的返回的数据对象

error

ApiError object

错误信息。

request_id

String

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

server_address

String

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

表5 ResultValueListString

参数

参数类型

描述

total

Integer

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

value

Array of strings

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

reason

String

业务失败的提示内容

page_size

Integer

分页大小

page_no

Integer

分页编码

has_more

Boolean

是否有更多

表6 ApiError

参数

参数类型

描述

code

String

响应码

reason

String

业务失败的提示内容

状态码:400

表7 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码:401

表8 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码:404

表9 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码:500

表10 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

请求示例

post https://{endpoint}/v4/testcase-uris/search/used-for-automation

{
  "keyword" : "用例名",
  "exeplatforms" : [ "string" ],
  "own" : true,
  "conditions" : [ { } ],
  "queryByDisplayCfg" : true,
  "useOffset" : true,
  "project_uuid" : "03d55a9eb29643809f4120cd628968fa",
  "version_uri" : "005t8asecn21",
  "case_uris" : [ "001rv9521lf1" ],
  "owner_ids" : [ "efdb403066474ab08836b9eeaaa23bca" ],
  "status_codes" : [ "0", "1" ],
  "rank_ids" : [ "1", "2" ],
  "module_ids" : [ "-2" ],
  "issue_id" : "3917852",
  "creator_ids" : [ "efdb403066474ab08836b9eeaaa23bca" ],
  "result_codes" : [ "0", "1" ],
  "iteration_ids" : [ "2000adec0b854306bf013e84f7b5f9ea" ],
  "create_start_time" : "2021-11-04 00:00:00",
  "create_end_time" : "2021-11-04 23:59:59",
  "associated_issue" : true,
  "associated_defects" : true,
  "include_sub_issue" : false,
  "include_sub_feature" : false,
  "label_ids" : [ "17220c4560ab4e5b913aaa40895183fb" ],
  "execute_start_time" : "2021-11-04 00:00:00",
  "execute_end_time" : "2021-11-04 23:59:59",
  "executor_ids" : [ "efdb403066474ab08836b9eeaaa23bca" ],
  "test_types" : [ "1" ],
  "is_keyword" : false,
  "issue_tree_search" : false,
  "service_type" : 3,
  "service_types" : [ 0, 1, 6 ],
  "stage_type" : 2,
  "feature_uri" : "004s6kfel2q",
  "sort_field" : "testCaseNumber",
  "sort_type" : "ASC",
  "page_no" : 1,
  "page_size" : 10,
  "case_type" : 0,
  "custom_field_info" : [ { } ],
  "task_uri" : "taskUri",
  "associate_issue_detail" : true,
  "not_assign_task" : true,
  "test_designs" : [ true ],
  "review_status" : 0,
  "just_return_id" : true,
  "iterator_uri_condition" : "string"
}

响应示例

状态码:200

OK

{
  "status" : "string",
  "result" : [ "001rv9521lf1" ],
  "error" : { },
  "request_id" : "string",
  "server_address" : "string"
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码

相关文档