文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 测试报表管理/ 根据查询条件获取测试报告列表
更新时间:2024-11-19 GMT+08:00
分享

根据查询条件获取测试报告列表

功能介绍

根据查询条件获取测试报告列表

URI

GET /testreport/v4/{project_id}/test-reports

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目id,对应"需求管理 CodeArts Req"项目唯一标识,测试计划管理页面地址栏url https://{host}/cloudtestportal/project/{project_id}/testplan中project_id变量的值

约束限制:

不涉及

取值范围:

项目uuid应符合如下规则:长度等于32位,包含大小写字母、数字

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

key_word

String

名称关键词

own

Boolean

是否是我的测试报告

page_no

Integer

页数

page_size

Integer

每页条数

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

status

String

success|error;

result

ResultValueListTestReportVo object

请求的返回的数据对象

error

ApiError object

失败时的error信息

request_id

String

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

server_address

String

本次请求的受理的服务地址

表5 ResultValueListTestReportVo

参数

参数类型

描述

total

Integer

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

value

Array of TestReportVo objects

实际的数据类型:单个对象,集合 或 NULL

reason

String

业务失败的提示内容

page_size

Integer

每页展示条数

page_no

Integer

页码

has_more

Boolean

是否有更多

表6 TestReportVo

参数

参数类型

描述

uri

String

测试报告Uri

name

String

测试报告名称

creator

String

创建人ID

updator

String

修改人ID

version_uri

String

测试计划Uri

branch_uri

String

分支Uri

version_name

String

测试计划名称

branch_name

String

分支名称

test_conclusion

String

测试结论

test_conclusion_details

String

测试结论描述

defect_resolution_rate

String

缺陷解决率

defect_resolution_score

String

缺陷解决分数

case_execution_rate

String

用例执行率

case_execution_score

String

用例执行分数

case_pass_rate

String

用例通过率

case_pass_score

String

用例通过分数

issue_pass_rate

String

需求通过率

issue_pass_score

String

需求通过分数

issue_coverage_rate

String

需求覆盖率

issue_coverage_score

String

需求覆盖分数

project_residual_defect_index

String

项目总遗留DI

iterator_residual_defect_index

String

计划新增DI

case_automation_details

CaseAutomationDetailsVo object

用例自动化率详情

case_validity_ratio

String

用例有效性比例

issue_details

IssuePassDetailsVo object

需求通过情况

case_details

Array of NameAndValueVo objects

用例通过情况

defect_details_by_severity

Array of IdAndNameAndValueVo objects

缺陷严重程度

defect_details_by_module

Array of IdAndNameAndValueVo objects

缺陷按照模块分布情况

case_pass_rate_by_test_type

Array of DetailTestTypeCasePassRateVo objects

每个测试类型的用例通过率

test_report_custom_report_detail

Array of CustomReportListVo objects

测试报告自定义报告详情

create_time

String

创建时间

create_timestamp

Long

创建时间戳

creator_name

String

创建人名

update_time

String

修改时间

update_timestamp

Long

修改时间戳

updator_name

String

修改人名

project_id

String

项目ID

risk_analysis

String

风险分析

表7 CaseAutomationDetailsVo

参数

参数类型

描述

case_automation_rate

String

用例自动化率

service_type_number_list

Array of NameAndValueVo objects

服务类型对应的用例数目

表8 IssuePassDetailsVo

参数

参数类型

描述

testing

Integer

统计测试中的需求

finished

Integer

统计已完成的需求

not_tested

Integer

统计未完成的需求

表9 NameAndValueVo

参数

参数类型

描述

name

String

名称

value

Integer

表10 IdAndNameAndValueVo

参数

参数类型

描述

name

String

名称

value

Integer

id

String

id

表11 DetailTestTypeCasePassRateVo

参数

参数类型

描述

test_type

Integer

测试类型

case_pass_rate

String

用例通过率

表12 CustomReportListVo

参数

参数类型

描述

id

String

报表id

name

String

报表名称

filter

ReportFilter object

过滤条件

workpiece_type

String

工件类型(用例:case,测试套:task)

analysis_dimension

String

分析维度

compare_dimension

String

对比维度

chart_data

Array of ReportChartDataVo objects

报表数据

表13 ReportFilter

参数

参数类型

描述

creatorIds

String

创建人

ownerIds

String

所属人

ranks

String

级别

releaseIds

String

releaseId

status

String

状态

moduleIds

String

级别

results

String

结果

labelIds

String

标签

startTime

String

开始时间

endTime

String

结束时间

isAssociateIssue

String

是否关联需求

表14 ReportChartDataVo

参数

参数类型

描述

id

String

报表id

name

String

报表名称

analyze_dim

ReportDimVo object

对比维度数据

compare_dim

Array of ReportDimVo objects

对比维度数据

表15 ReportDimVo

参数

参数类型

描述

id

String

id

name

String

名称

value

Integer

表16 ApiError

参数

参数类型

描述

code

String

业务失败的错误码

reason

String

业务失败的提示内容

状态码: 400

表17 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码: 401

表18 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码: 404

表19 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码: 500

表20 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

请求示例

根据查询条件获取测试报告列表

get https://{endpoint}/v4/9b26f58ec29943f681804a6628779a23/test-reports?key_word=xxx&own=true&page_no=1&page_size=10

响应示例

状态码: 200

OK

{
  "status" : "success",
  "result" : {
    "total" : 1,
    "value" : [ {
      "uri" : "v91t0000vrn1e27h",
      "name" : "XXX项目第一期测试报告",
      "creator" : "e8d27b5521a64fb28a8fd9c99cd66eb3",
      "version_uri" : "v91i0000vq98suqq",
      "branch_uri" : "v91i0000vq98suq1",
      "version_name" : "样例测试计划",
      "branch_name" : "基线",
      "test_conclusion" : "商用发布",
      "defect_details_by_severity" : [ ],
      "defect_details_by_module" : [ ],
      "create_time" : "2024-09-10 15:23:01",
      "create_timestamp" : 1725952981000,
      "creator_name" : "xxx"
    } ],
    "page_size" : 10,
    "page_no" : 1
  }
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码

相关文档