文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 报告与看板管理/ V5质量报告需求测试情况统计 异步 - V5AsyncQueryRequirementsOverview
更新时间:2026-06-12 GMT+08:00
分享

V5质量报告需求测试情况统计 异步 - V5AsyncQueryRequirementsOverview

功能介绍

此接口用于V5版本质量报告需求测试情况统计,支持异步查询

调用方法

请参见如何调用API

URI

POST /v5/{project_id}/versions/{version_uri}/requirements/overview

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

version_uri

String

参数解释

版本URI

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

version_uri

String

版本URI

requirement_uris

Array of strings

需求URI列表

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

total

Integer

符合条件的所有记录数

value

RequirementsOverviewVo object

需求测试情况统计

reason

String

错误信息

page_size

Integer

每页展示条数

page_no

Integer

页码

has_more

Boolean

是否有更多

表4 RequirementsOverviewVo

参数

参数类型

描述

total_number

Integer

质量报告需求测试情况总数

requirement_overview_list

Array of RequirementOverviewVo objects

质量报告需求测试情况列表

表5 RequirementOverviewVo

参数

参数类型

描述

requirement_uri

String

需求URI

requirement_name

String

需求名称

testcase_count

Integer

关联用例数量

executed_count

Integer

已执行用例数量

passed_count

Integer

已通过用例数量

状态码:400

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

接口调用失败错误码

取值范围

不涉及

error_msg

String

参数解释

接口调用失败错误信息

取值范围

不涉及

状态码:500

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

接口调用失败错误码

取值范围

不涉及

error_msg

String

参数解释

接口调用失败错误信息

取值范围

不涉及

请求示例

V5质量报告需求测试情况统计

POST https://{endpoint}/v5/{project_id}/versions/{version_uri}/requirements/overview

{
  "requirement_uris" : [ "RR001" ]
}

响应示例

状态码:200

OK

{
  "total" : 1,
  "value" : [ {
    "requirement_uri" : "RR001",
    "requirement_name" : "需求A",
    "total_testcases" : 50,
    "passed" : 40,
    "failed" : 5,
    "blocked" : 3,
    "not_executed" : 2,
    "pass_rate" : "80%"
  } ],
  "reason" : ""
}

状态码:400

Bad Request

{
  "error_code" : "CLOUDTEST.00000001",
  "error_msg" : "返回的错误信息"
}

状态码:500

Internal Server Error

{
  "error_code" : "CLOUDTEST.00000001",
  "error_msg" : "返回的错误信息"
}

状态码

状态码

描述

200

OK

400

Bad Request

500

Internal Server Error

错误码

请参见错误码

相关文档