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

查询用例uri列表

功能介绍

查询用例uri列表

调用方法

请参见如何调用API

URI

POST /v5/{project_id}/testcases/uris

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

keyword

String

参数解释:

关键字查询

约束限制:

不涉及

取值范围:

用例名或编号

默认取值:

不涉及

exeplatforms

Array of strings

参数解释:

执行平台列表数组

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

own

Boolean

参数解释:

是否是我的

约束限制:

不涉及

取值范围:

true:是 false:不是

默认取值:

不涉及

useOffset

Boolean

参数解释:

是否使用偏移量方式查询

约束限制:

不涉及

取值范围:

true:使用偏移量方式查询 false:不使用偏移量方式查询

默认取值:

不涉及

version_uri

String

参数解释:

版本URI

约束限制:

不涉及

取值范围:

11到34位

默认取值:

不涉及

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集合

约束限制:

不涉及

取值范围:

0,1,2,3,4

默认取值:

不涉及

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:查询子需求关联的用例 false:不查询子需求关联的用例

默认取值:

true

include_sub_feature

Boolean

参数解释:

是否查询子目录的用例

约束限制:

不涉及

取值范围:

true:查询子目录关联的用例 false:不查询子目录关联的用例

默认取值:

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

参数解释:

是否组合关键字

约束限制:

不涉及

取值范围:

true:组合关键字 false:不组合关键字

默认取值:

不涉及

issue_tree_search

Boolean

参数解释:

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

约束限制:

不涉及

取值范围:

true:需求树点击查询 false:非需求树点击查询

默认取值:

不涉及

service_type

Integer

参数解释:

服务类型

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

service_types

Array of integers

参数解释:

服务类型集合

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

stage_type

Integer

参数解释:

阶段过程

约束限制:

不涉及

取值范围:

2:测试设计,3:测试执行,4:质量报告

默认取值:

不涉及

feature_uri

String

参数解释:

目录URI

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

sort_field

String

参数解释:

排序字段

约束限制:

不涉及

取值范围:

name|testCaseNumber|status|result|createTime|executeTime|executeDuration|module|iteration

默认取值:

不涉及

sort_type

String

参数解释:

排序方式

约束限制:

不涉及

取值范围:

DESC|ASC|desc|asc

默认取值:

不涉及

page_no

Integer

参数解释:

当前页数

约束限制:

不涉及

取值范围:

1-2000

默认取值:

不涉及

page_size

Integer

参数解释:

每页条数

约束限制:

不涉及

取值范围:

1-100

默认取值:

不涉及

caseType

Integer

参数解释:

用例类型

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

custom_field_info

Array of QueryCustomFieldsInfo objects

参数解释:

用例自定义字段信息

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

task_uri

String

参数解释:

测试套uri

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

associate_issue_detail

Boolean

参数解释:

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

约束限制:

不涉及

取值范围:

true:返回 false:不返回

默认取值:

不涉及

not_assign_task

Boolean

参数解释:

查询全量用例或查询未分配测试套的用例

约束限制:

不涉及

取值范围:

true:查询未分配测试套的用例 false:查询全量用例

默认取值:

不涉及

test_designs

Array of booleans

参数解释:

是否来自测试设计

约束限制:

不涉及

取值范围:

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

默认取值:

不涉及

review_status

Integer

参数解释:

用例评审状态

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表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}/v5/a5eb0d410ea341a192f7c12483568985/testcases/uris

{
  "keyword" : "用例名",
  "exeplatforms" : [ "string" ],
  "own" : true,
  "useOffset" : true,
  "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,
  "caseType" : 0,
  "custom_field_info" : [ { } ],
  "task_uri" : "taskUri",
  "associate_issue_detail" : true,
  "not_assign_task" : true,
  "test_designs" : [ true ],
  "review_status" : 0
}

响应示例

状态码:200

OK

{
  "status" : "success",
  "result" : {
    "total" : 1,
    "value" : [ "v92s00010hovp2cp" ]
  }
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码

相关文档