查询用例信息列表 - QueryTestCaseUriInfos

功能介绍

此接口用于查询项目下的用例信息列表,返回用例名称和用例uri列表

调用方法

URI

POST /v5/{project_id}/testcases/uris/batch-query

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目ID。

请求参数

表2 请求Body参数
参数	是否必选	参数类型	描述
keyword	否	String	关键字查询，用例名或编号
useOffset	否	Boolean	使用offset分页
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	参数解释: 服务类型约束限制: 不涉及取值范围: -1，全量用例。 0，手工测试。 1，接口自动化。 7，功能自动化。 8，WebUI自动化。 100，自定义自动化(工厂)。 11，性能自动化。默认取值: 不涉及
service_types	否	Array of integers	服务类型集合
stage_type	否	Integer	阶段过程（2：测试设计，3：测试执行，4：质量报告）
feature_uri	否	String	目录URI
sort_field	否	String	排序字段
sort_type	否	String	参数解释: 排序方式约束限制: 不涉及取值范围: ASC，升序。 DESC，降序。默认取值: 不涉及
page_no	否	Integer	当前页数
page_size	否	Integer	每页条数，取值1~50
case_type	否	Integer	用例类型约束限制: 不涉及取值范围: 0，手工测试。 1，接口自动化。 2，性能用例。默认取值: 不涉及
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	参数解释: 评审状态约束限制: 不涉及取值范围: 0，未评审。 1，已评审。默认取值: 不涉及
just_return_id	否	Boolean	该字段为true,则部分字段（状态/模块/迭代/结果/测试类型/服务类型等）仅返回ID，为false则返回ID和名称

表3 QueryCustomFieldsInfo
参数	是否必选	参数类型	描述
id	否	Integer	测试用例自定义字段Id
values	否	Array of strings	测试用例自定义字段值
field_name	否	String	自定义字段名，优先取id再取fieldName

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
value	Array of SimpleTestCaseInfoVo objects	实际的数据类型：单个对象，集合或 NULL

表5 SimpleTestCaseInfoVo
参数	参数类型	描述
id	String	测试用例URI
name	String	名称
type	String	参数解释: 测试类型取值范围: 1，功能性测试。 2，兼容性测试。 4，性能测试。 15，易用性测试。 22，可靠性测试。 14，安全性测试。 21，可服务性测试。
issue_id	String	需求URI
feature_uri	String	特性目录URI

状态码：400

表6 响应Body参数
参数	参数类型	描述
error_code	String	参数解释接口调用失败错误码取值范围不涉及
error_msg	String	参数解释接口调用失败错误信息取值范围不涉及

状态码：401

表7 响应Body参数
参数	参数类型	描述
error_code	String	参数解释接口调用失败错误码取值范围不涉及
error_msg	String	参数解释接口调用失败错误信息取值范围不涉及

状态码：404

表8 响应Body参数
参数	参数类型	描述
error_code	String	参数解释接口调用失败错误码取值范围不涉及
error_msg	String	参数解释接口调用失败错误信息取值范围不涉及

状态码：500

表9 响应Body参数
参数	参数类型	描述
error_code	String	参数解释接口调用失败错误码取值范围不涉及
error_msg	String	参数解释接口调用失败错误信息取值范围不涉及

请求示例

post https://{endpoint}/v5/{project_id}/testcases/uris/batch-query

{
  "keyword" : "用例名",
  "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,
  "just_return_id" : false
}

响应示例

状态码：200

{
  "value" : [ {
    "name" : "hahaha19c",
    "id" : "v90100010u2ik1ok",
    "type" : "1"
  }, {
    "name" : "CaseEdi1t",
    "id" : "v90100010u2djroq",
    "type" : "100",
    "confidentiality_code" : "1097813590397042688"
  }, {
    "name" : "用例1",
    "id" : "v90100010u2dh5pq",
    "type" : "10026"
  }, {
    "name" : "新建的测试用例",
    "id" : "v90200010u24lgqb",
    "type" : "0",
    "confidentiality_code" : "1097813590397042688"
  }, {
    "name" : "修改级别",
    "id" : "v90200010u015bfh",
    "type" : "0",
    "confidentiality_code" : "1097813590397042688"
  }, {
    "name" : "TestCase",
    "id" : "v90100010u00hl8p",
    "type" : "1",
    "confidentiality_code" : "1097813590397042688"
  }, {
    "name" : "TICC公开",
    "id" : "v90100010tl1gof5",
    "type" : "100",
    "confidentiality_code" : "1097813590397042688",
    "feature_uri" : "v90200010u02fk65"
  }, {
    "name" : "API受控",
    "id" : "v90200010tl1fojl",
    "type" : "1",
    "confidentiality_code" : "1097813590397042689"
  }, {
    "name" : "受控",
    "id" : "v90200010tl1djdm",
    "type" : "0",
    "confidentiality_code" : "1097813590397042689",
    "feature_uri" : "v90200010u02fk65"
  }, {
    "name" : "样例功能用例",
    "id" : "v90100010tl1ajlv",
    "type" : "0"
  }, {
    "name" : "样例接口用例",
    "id" : "v90200010tl1aj9s",
    "type" : "1"
  } ]
}