V5质量报告需求测试情况统计 异步 - V5AsyncQueryRequirementsOverview
功能介绍
此接口用于V5版本质量报告需求测试情况统计，支持异步查询
调用方法
请参见如何调用API。
URI
POST /v5/{project_id}/versions/{version_uri}/requirements/overview
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目ID。 |
| version_uri | 是 | String | 参数解释 版本URI |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| fixed_version_id | 否 | String | 参数解释 筛选迭代ID 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及 |
| module_id | 否 | String | 参数解释 模块ID 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及 |
| key_word | 否 | String | 参数解释 关键字 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及 |
| page_size | 否 | Integer | 参数解释 每页数量 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及 |
| page_no | 否 | Integer | 参数解释 页码 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及 |
| pi_filter | 否 | PiFilterInfo object | 参数解释 pi过滤条件 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| pi_sprints | 否 | Array of PiInfo objects | 参数解释 pi迭代筛选条件 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及 |
| all_pi | 否 | Boolean | 参数解释 pi下拉框全选标识 约束限制 不涉及 取值范围 全选时为true 默认取值 不涉及 |
响应参数
状态码：200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| total | Integer | 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 |
| value | RequirementsOverviewVo object | 实际的数据类型：单个对象，集合 或 NULL |
| reason | String | 业务失败的提示内容 |
| page_size | Integer | 每页展示条数 |
| page_no | Integer | 页码 |
| has_more | Boolean | 是否有更多 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| total_number | Integer | 参数解释 质量报告需求测试情况总数 取值范围 不涉及 |
| requirement_overview_list | Array of RequirementOverviewVo objects | 参数解释 质量报告需求测试情况列表 取值范围 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| name | String | 参数解释 需求名称 取值范围 不涉及 |
| workitem_id | String | 参数解释 需求id 取值范围 不涉及 |
| sequence_id | String | 参数解释 需求序列编号 取值范围 不涉及 |
| board_id | String | 参数解释 看板需求id 取值范围 不涉及 |
| tracker_id | String | 参数解释 需求类型id 取值范围 不涉及 |
| tracker_name | String | 参数解释 需求类型 取值范围 不涉及 |
| relate_case_number | Integer | 参数解释 需求关联用例总数 取值范围 不涉及 |
| case_pass_vo | CasePassVo object | 参数解释 用例通过信息 取值范围 不涉及 |
| case_execute_vo | CaseExecuteVo object | 参数解释 用例执行信息 取值范围 不涉及 |
| relate_defect_number | Integer | 参数解释 需求关联缺陷总数 取值范围 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| pass_rate | String | 参数解释 需求关联用例通过率 取值范围 不涉及 |
| result_number_list | Array of NameAndValueVo objects | 参数解释 需求关联用例结果与对应的用例数目列表 取值范围 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| name | String | 参数解释 名称，如缺陷重要程度名称或用例执行结果名称 取值范围 不涉及 |
| value | Integer | 参数解释 对应名称的数目 取值范围 大于等于0 |
| children | Array of children objects | 参数解释 子节点，数组内每个元素包含名称、值和标记值 取值范围 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| name | String | 参数解释 名称 取值范围 不涉及 |
| value | Integer | 参数解释 对应名称的数目 取值范围 大于等于0 |
| tag_value | Integer | 参数解释 标记值，与value的区别在于标识不同维度的统计数值 取值范围 大于等于0 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| execute_rate | String | 参数解释 需求关联用例执行率 取值范围 不涉及 |
| executed_number | Integer | 参数解释 需求关联已执行用例总数 取值范围 不涉及 |
| not_executed_number | Integer | 参数解释 需求关联未执行用例总数 取值范围 不涉及 |
状态码：400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 接口调用失败错误码 取值范围: 不涉及 |
| error_msg | String | 参数解释: 接口调用失败错误信息 取值范围: 不涉及 |
状态码：500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 接口调用失败错误码 取值范围: 不涉及 |
| error_msg | String | 参数解释: 接口调用失败错误信息 取值范围: 不涉及 |
请求示例
V5质量报告需求测试情况统计
POST https://{endpoint}/v5/{project_id}/versions/{version_uri}/requirements/overview
{
"requirement_uris" : [ "RR001" ]
} 响应示例
状态码：200
{
"total" : 1,
"value" : {
"total_number" : 1,
"requirement_overview_list" : [ {
"requirement_uri" : "RR001",
"requirement_name" : "需求A",
"testcase_count" : 50,
"executed_count" : 40,
"passed_count" : 10
} ]
},
"reason" : "",
"page_size" : 50,
"page_no" : 1,
"has_more" : true
} 状态码：400
{
"error_code" : "CLOUDTEST.00000001",
"error_msg" : "返回的错误信息"
} 状态码：500
{
"error_code" : "CLOUDTEST.00000001",
"error_msg" : "返回的错误信息"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 500 | Internal Server Error |
错误码
请参见错误码。
