查询用例uri列表 - QueryOnlyTestCaseUris
功能介绍
此接口用于根据条件查询指定项目下用例uri集合
调用方法
请参见如何调用API。
URI
POST /v5/{project_id}/testcases/uris
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 项目UUID,项目唯一标识,固定长度32位字符(字母和数字)。获取方式请参见获取项目ID |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| keyword | 否 | String | 参数解释: 关键字查询,用于按用例名称或用例编号进行模糊匹配 约束限制: 不涉及 取值范围: 字符串类型,长度不超过128个字符 默认取值: 不涉及 |
| exeplatforms | 否 | Array of strings | 参数解释: 执行平台列表数组 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| own | 否 | Boolean | 参数解释: 是否仅查询当前用户负责的用例 约束限制: 不涉及 取值范围: 默认取值: 不传时默认为false |
| useOffset | 否 | Boolean | 参数解释: 是否使用偏移量方式查询 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| version_uri | 否 | String | 参数解释: 版本URI,用于指定查询用例所属的版本。获取方式请参见查询迭代计划接口 约束限制: 11-34位字符 取值范围: 字符串类型,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集合,用于按模块范围筛选用例 约束限制: 不涉及 |
| issue_id | 否 | String | 参数解释: 需求编号,用于指定查询关联了该需求的用例。获取方式请参见查询需求列表接口 约束限制: 不涉及 |
| creator_ids | 否 | Array of strings | 参数解释: 创建者ID集合,获取方式请参见获取项目关联用户详情列表接口,字符串类型,值为小于128位的字母或数字的集合 约束限制: 不涉及 |
| result_codes | 否 | Array of strings | 参数解释: 结果Code集合,用于按用例执行结果筛选用例 约束限制: 不涉及 |
| iteration_ids | 否 | Array of strings | 参数解释: 归属迭代ID集合,获取方式请参见查询迭代列表接口,字符串类型,11-34位的字母或数字 约束限制: 不涉及 |
| create_start_time | 否 | String | 参数解释: 创建开始时间。时间格式为yyyy-MM-dd HH:mm:ss,例如2024-01-01 00:00:00 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| create_end_time | 否 | String | 参数解释: 创建结束时间。时间格式为yyyy-MM-dd HH:mm:ss,例如2024-12-31 23:59:59 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| associated_issue | 否 | Boolean | 参数解释: 是否关联需求 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| associated_defects | 否 | Boolean | 参数解释: 是否关联缺陷 约束限制: 不涉及 取值范围: 默认取值: 不传时不限制 |
| include_sub_issue | 否 | Boolean | 参数解释: 是否查询子需求关联的用例 约束限制: 不涉及 取值范围: 默认取值: true |
| include_sub_feature | 否 | Boolean | 参数解释: 是否查询子目录的用例 约束限制: 不涉及 取值范围: 默认取值: true |
| label_ids | 否 | Array of strings | 参数解释: 标签ID集合,获取方式请参见查询标签接口,字符串类型,元素为长度不超过128位的字符串 约束限制: 不涉及 |
| execute_start_time | 否 | String | 参数解释: 执行开始时间。时间格式为yyyy-MM-dd HH:mm:ss,例如2024-01-01 00:00:00 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| execute_end_time | 否 | String | 参数解释: 执行结束时间。时间格式为yyyy-MM-dd HH:mm:ss,例如2024-12-31 23:59:59 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| executor_ids | 否 | Array of strings | 参数解释: 执行者ID集合,获取方式请参见获取项目关联用户详情列表接口,字符串类型,数组中元素为长度不超过128位的字符串 约束限制: 不涉及 |
| test_types | 否 | Array of strings | 参数解释: 测试类型集合,用于按测试类型筛选用例 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| is_keyword | 否 | Boolean | 参数解释: 是否组合关键字 约束限制: 不涉及 取值范围: 默认取值: 不传时默认为false |
| issue_tree_search | 否 | Boolean | 参数解释: 是否是需求树点击的查询关联用例 约束限制: 不涉及 取值范围: 默认取值: 不传时默认为false |
| service_type | 否 | Integer | 参数解释: 服务类型,用于筛选指定服务类型的用例 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| service_types | 否 | Array of integers | 参数解释: 服务类型集合,用于同时筛选多种服务类型的用例,与service_type的区别在于可一次指定多个服务类型 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| stage_type | 否 | Integer | 参数解释: 阶段过程 约束限制: 取值为2、3、4 取值范围: 默认取值: 不涉及 |
| feature_uri | 否 | String | 参数解释: 目录URI,用于指定查询的目录范围,获取该目录下的用例。获取方式请参见获取特性树接口 约束限制: 不涉及 取值范围: 字符串类型,长度为11-34位的字母或数字 默认取值: 不涉及 |
| sort_field | 否 | String | 参数解释: 排序字段,用于指定按哪个属性排序 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| sort_type | 否 | String | 参数解释: 排序方式 约束限制: 不涉及 取值范围: 默认取值: 不传时默认为降序(DESC) |
| page_no | 是 | Integer | 参数解释: 当前页码 约束限制: 大于零的整数 取值范围: 1-20000 单位:页 默认取值: 不涉及 |
| page_size | 是 | Integer | 参数解释: 每页条数 约束限制: 大于零的整数 取值范围: 1-100 单位:条 默认取值: 不传时默认为10条 |
| case_type | 否 | Integer | 参数解释: 用例类型 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| custom_field_info | 否 | Array of QueryCustomFieldsInfo objects | 参数解释: 用例自定义字段信息 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| task_uri | 否 | String | 参数解释: 测试套URI,用于指定查询的测试套范围。获取方式请参见查询测试任务列表接口 约束限制: 不涉及 取值范围: 字符串类型,长度为11-34位的字母或数字 默认取值: 不涉及 |
| associate_issue_detail | 否 | Boolean | 参数解释: 是否返回需求具体信息(返回需求名称,需求id) 约束限制: 不涉及 取值范围: 默认取值: 不传时默认为false,不返回需求具体信息 |
| not_assign_task | 否 | Boolean | 参数解释: 查询全量用例或查询未分配测试套的用例 约束限制: 不涉及 取值范围: 默认取值: 不传时默认为false,查询全量用例 |
| test_designs | 否 | Array of booleans | 参数解释: 是否来自测试设计的筛选条件,用于筛选来自测试设计的用例 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| review_status | 否 | Integer | 参数解释: 用例评审状态 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| id | 否 | Integer | 参数解释: 测试用例自定义字段Id,获取方式请参见查询项目测试用例自定义字段接口 约束限制: 不涉及 取值范围: 大于等于0的整数 默认取值: 不涉及 |
| values | 否 | Array of strings | 参数解释: 测试用例自定义字段值,数组中每个元素为字段值,字符串类型 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| field_name | 否 | String | 参数解释: 自定义字段名,当id未传时优先取fieldName作为查询条件 约束限制: 不涉及 取值范围: 由字母、数字和下划线组成,长度不超过64个字符 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| value | Array of strings | 请求返回的数据 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 接口调用失败错误码 取值范围: 不涉及 |
| error_msg | String | 参数解释: 接口调用失败错误信息 取值范围: 不涉及 |
状态码:401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 接口调用失败错误码 取值范围: 不涉及 |
| error_msg | String | 参数解释: 接口调用失败错误信息 取值范围: 不涉及 |
状态码:404
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 接口调用失败错误码 取值范围: 不涉及 |
| error_msg | String | 参数解释: 接口调用失败错误信息 取值范围: 不涉及 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| 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,
"case_type" : 0,
"custom_field_info" : [ { } ],
"task_uri" : "taskUri",
"associate_issue_detail" : true,
"not_assign_task" : true,
"test_designs" : [ true ],
"review_status" : 0
} 响应示例
状态码:200
{
"value" : [ "v92s00010hovp2cp" ]
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 401 | Unauthorized |
| 404 | Not Found |
| 500 | Internal Server Error |
错误码
请参见错误码。