文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 用例关联关系管理/ 查询需求下的用例列表
更新时间：2025-06-26 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询需求下的用例列表

功能介绍

查询需求下的用例列表

调用方法

请参见如何调用API。

URI

POST /v4/{project_id}/issues/{issue_id}/testcases/batch-query

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

issue_id

是

String

需求id

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

page_no

否

Integer

页码

page_size

否

Integer

每页数量

sort_field

否

String

排序字段

sort_type

否

String

排序类型

version_uri

否

String

版本uri

relate_type

否

String

关联关系类型

key_word

否

String

关键字

rank_ids

否

Array of strings

用例等级ID集合

result_codes

否

Array of strings

结果Code集合

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

status

String

success|error

result

ResultValueString object

请求的返回的数据对象

error

ApiError object

失败时的error信息

request_id

String

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

server_address

String

本次请求的受理的服务地址
表4 ResultValueString

参数

参数类型

描述

total

Integer

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

value

String

实际的数据类型：单个对象，集合 或 NULL

reason

String

业务失败的提示内容

page_size

Integer

分页大小

page_no

Integer

分页编码

has_more

Boolean

是否有更多
表5 ApiError

参数

参数类型

描述

code

String

业务失败的错误编码

reason

String

业务失败的提示内容

状态码：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}/v4/projects/f3087a82b44744c29a1bd69ab6ada154/issues/1134703430181982208/testcases/batch-query

{
  "page_no" : 1,
  "page_size" : 100,
  "relate_type" : "bug",
  "sort_type" : "DESC"
}

响应示例

状态码：200

OK

{
  "status" : "success",
  "result" : {
    "value" : {
      "case_status_map" : {
        "完成" : 1
      },
      "new_create" : 0,
      "designing" : 0,
      "finished" : 1,
      "testing" : 0,
      "test_case_num" : 1,
      "testcases" : [ {
        "uri" : "v90410b5o5ce22a7",
        "type" : "TestCase",
        "author" : "sec_admin——nich",
        "name" : "cx_2995",
        "rank" : 2,
        "region" : "roma-dev-2-arm",
        "owner" : "",
        "version_uri" : "v90200010aelu5om",
        "parent_uri" : "v90200010aelu5om",
        "parent_path" : "/407ac57de7ea44d28e47293a2b9cf15c/v90200010aelu5om/",
        "creation_version_uri" : "v90100010b5nubs0",
        "last_modifier" : "sec_admin——nich",
        "last_modified" : "2025-05-29 10:25:40",
        "last_change_time" : "2025-03-21 18:25:43",
        "creation_date" : "2025-03-21 18:25:04",
        "author_id" : "2ce06fffb4634271a377c1cd7c429704",
        "number" : "7417",
        "case_type" : 0,
        "platform_type" : 0,
        "service_type" : 0,
        "test_type" : 1,
        "test_step" : "[\"\"]",
        "expect_output" : "[\"\"]",
        "auto_type" : 0,
        "to_be_auto_exec" : 0,
        "automatically_executed" : 0,
        "is_contract_testcase" : 0,
        "time_cost" : 0,
        "last_exe_author" : "2ce06fffb4634271a377c1cd7c429704",
        "status_code" : "7",
        "result_code" : "1",
        "execute_latest_time" : "2025-05-29 10:25:40",
        "execute_duration" : "00:00:00.000",
        "is_keyword" : 0,
        "project_uuid" : "407ac57de7ea44d28e47293a2b9cf15c",
        "issue_id" : "[\"1134703430181982208\"]",
        "issue_tracker_id" : "[\"3\"]",
        "issue_assign_status" : "[null]",
        "issue_name" : "[\"史蒂文\"]",
        "issue_design_owner" : "[null]",
        "issue_design_owner_d" : "[null]",
        "tracker_name" : "[\"Bug\"]",
        "defect_list" : [ ],
        "result_name" : "失败",
        "status_name" : "完成"
      } ],
      "total_count" : 1
    }
  }
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

相关文档