# 查询用例uri列表 - QueryOnlyTestCaseUris #### 功能介绍 此接口用于根据条件查询指定项目下用例uri集合 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-testman/cloudtest_03_2000.html)。 #### URI POST /v5/{project_id}/testcases/uris 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-testman/cloudtest_03_4003.html) | #### 请求参数 表2请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | keyword | 否 | String | **参数解释**: 关键字查询 **约束限制**: 字符串类型 **取值范围**: 用例名或编号，字符串类型，长度128位以内 **默认取值**: 不涉及 | | exeplatforms | 否 | Array of strings | **参数解释**: 执行平台列表数组 **约束限制**: 不涉及 **取值范围**: 不涉及 **默认取值**: 不涉及 | | own | 否 | Boolean | **参数解释**: 是否是我的 **约束限制**: 不涉及 **取值范围**: - true:是 - false:不是 **默认取值**: 不涉及 | | useOffset | 否 | Boolean | **参数解释**: 是否使用偏移量方式查询 **约束限制**: 不涉及 **取值范围**: - true:使用偏移量方式查询 - false:不使用偏移量方式查询 **默认取值**: 不涉及 | | version_uri | 否 | String | **参数解释**: 版本URI **约束限制**: 11-34位字符 **取值范围**: 字符串类型，11到34位字母或数字 **默认取值**: 不涉及 | | case_uris | 否 | Array of strings | **参数解释**: 用例URI集合 **约束限制**: 不涉及 **取值范围**: 字符串类型，长度为11-34位字母或数字 **默认取值**: 不涉及 | | owner_ids | 否 | Array of strings | **参数解释**: 处理者ID集合 **约束限制**: 不涉及 **取值范围**: 字符串类型，字符长度小于128位 **默认取值**: 不涉及 | | status_codes | 否 | Array of strings | **参数解释**: 状态Code集合 **约束限制**: 不涉及 **取值范围**: 不涉及 **默认取值**: 不涉及 | | rank_ids | 否 | Array of strings | **参数解释**: 用例等级ID集合 **约束限制**: 不涉及 **取值范围**: 字符串类型，值为0,1,2,3,4 **默认取值**: 不涉及 | | module_ids | 否 | Array of strings | **参数解释**: 模块ID集合 **约束限制**: 不涉及 **取值范围**: 0,1,2,3,4 **默认取值**: 不涉及 | | 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" **取值范围**: 不涉及 **默认取值**: 不涉及 | | create_end_time | 否 | String | **参数解释**: 创建结束时间 **约束限制**: 时间格式为"yyyy-MM-dd HH:mm:ss" **取值范围**: 不涉及 **默认取值**: 不涉及 | | associated_issue | 否 | Boolean | **参数解释**: 是否关联需求 **约束限制**: 不涉及 **取值范围**: - null：不限 - true：已关联 -false：未关联 **默认取值**: 不涉及 | | 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集合 **约束限制**: 不涉及 **取值范围**: 字符串类型，元素为长度不超过128位的字符串 **默认取值**: 不涉及 | | execute_start_time | 否 | String | **参数解释**: 执行开始时间 **约束限制**: 时间格式为"yyyy-MM-dd HH:mm:ss" **取值范围**: 不涉及 **默认取值**: 不涉及 | | execute_end_time | 否 | String | **参数解释**: 执行结束时间 **约束限制**: 时间格式为"yyyy-MM-dd HH:mm:ss" **取值范围**: 不涉及 **默认取值**: 不涉及 | | executor_ids | 否 | Array of strings | **参数解释**: 执行者ID集合 **约束限制**: 字符串类型，数组中元素为长度不超过128位的字符串 **取值范围**: 不涉及 **默认取值**: 不涉及 | | test_types | 否 | Array of strings | **参数解释**: 类型 **约束限制**: 不涉及 **取值范围**: 不涉及 **默认取值**: 不涉及 | | is_keyword | 否 | Boolean | **参数解释**: 是否组合关键字 **约束限制**: 不涉及 **取值范围**: - true:组合关键字 - false:不组合关键字 **默认取值**: 不涉及 | | issue_tree_search | 否 | Boolean | **参数解释**: 是否是需求树点击的查询关联用例 **约束限制**: 不涉及 **取值范围**: - true:需求树点击查询 - false:非需求树点击查询 **默认取值**: 不涉及 | | service_type | 否 | Integer | **参数解释**: 服务类型 **约束限制**: 不涉及 **取值范围**: - -1，全量用例。 - 0，手工测试。 - 1，接口自动化。 - 7，功能自动化。 - 8，WebUI自动化。 - 100，自定义自动化(工厂)。 - 11，性能自动化。 **默认取值**: 不涉及 | | service_types | 否 | Array of integers | **参数解释**: 服务类型集合 **约束限制**: 不涉及 **取值范围**: - -1，全量用例。 - 0，手工测试。 - 1，接口自动化。 - 7，功能自动化。 - 8，WebUI自动化。 - 100，自定义自动化(工厂)。 - 11，性能自动化。 **默认取值**: 不涉及 | | stage_type | 否 | Integer | **参数解释**: 阶段过程 **约束限制**: 正整数 **取值范围**: - 2：测试设计 - 3：测试执行， - 4：质量报告 **默认取值**: 不涉及 | | feature_uri | 否 | String | **参数解释**: 目录URI **约束限制**: 字符串类型 **取值范围**: 字符串类型，长度为11-34位的字母或数字 **默认取值**: 不涉及 | | sort_field | 否 | String | **参数解释**: 排序字段 **约束限制**: 不涉及 **取值范围**: name\|testCaseNumber\|status\|result\|createTime\|executeTime\|executeDuration\|module\|iteration **默认取值**: 不涉及 | | sort_type | 否 | String | **参数解释**: 排序方式 **约束限制**: 不涉及 **取值范围**: - ASC，升序。 - DESC，降序。 **默认取值**: 不涉及 | | page_no | 是 | Integer | **参数解释**: 当前页数 **约束限制**: 大于零的整数 **取值范围**: 1-20000 单位：条 **默认取值**: 不涉及 | | page_size | 是 | Integer | **参数解释**: 每页条数 **约束限制**: 大于零的整数 **取值范围**: 1-100 单位：条 **默认取值**: 不涉及 | | case_type | 否 | Integer | 用例类型 **约束限制**: 不涉及 **取值范围**: - 0，手工测试。 - 1，接口自动化。 - 2，性能用例。 **默认取值**: 不涉及 | | custom_field_info | 否 | Array of [QueryCustomFieldsInfo] objects | **参数解释**: 用例自定义字段信息 **约束限制**: 不涉及 **取值范围**: 不涉及 **默认取值**: 不涉及 | | task_uri | 否 | String | **参数解释**: 测试套uri **约束限制**: 字符串类型 **取值范围**: 字符串类型，长度为11-34位的字母或数字 **默认取值**: 不涉及 | | 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 | **参数解释**: 用例评审状态 **取值范围**: - 0，未评审。 - 1，已评审。 | 表3QueryCustomFieldsInfo | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | id | 否 | Integer | **参数解释**: 测试用例自定义字段Id **约束限制**: 不涉及 **取值范围**: 不涉及 **默认取值**: 不涉及 | | values | 否 | Array of strings | **参数解释**: 测试用例自定义字段值 **约束限制**: 不涉及 **取值范围**: 不涉及 **默认取值**: 不涉及 | | field_name | 否 | String | **参数解释**: 自定义字段名 **约束限制**: 不涉及 **取值范围**: 优先取id再取fieldName **默认取值**: 不涉及 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | value | Array of strings | 请求返回的数据 | **状态码：400** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**: 接口调用失败错误码 **取值范围**: 不涉及 | | error_msg | String | **参数解释**: 接口调用失败错误信息 **取值范围**: 不涉及 | **状态码：401** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**: 接口调用失败错误码 **取值范围**: 不涉及 | | error_msg | String | **参数解释**: 接口调用失败错误信息 **取值范围**: 不涉及 | **状态码：404** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**: 接口调用失败错误码 **取值范围**: 不涉及 | | error_msg | String | **参数解释**: 接口调用失败错误信息 **取值范围**: 不涉及 | **状态码：500** 表8响应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, "case_type" : 0, "custom_field_info" : [ { } ], "task_uri" : "taskUri", "associate_issue_detail" : true, "not_assign_task" : true, "test_designs" : [ true ], "review_status" : 0 } ``` #### 响应示例 **状态码：200** OK ``` { "value" : [ "v92s00010hovp2cp" ] } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | | 400 | Bad Request | | 401 | Unauthorized | | 404 | Not Found | | 500 | Internal Server Error | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-testman/ErrorCode.html)。