响应示例 状态码：200 OK { "result" : { "total" : 1, "value" : [ { "uri" : "v909000109fcnbvj", "name" : "测试报告1", "creator" : "dfc5347b9b16491e942ce55ce7f79dbc", "version_uri" : "v902000109eon3g9", "branch_uri" : "v902000108vdtjkp", "version_name" : "计划1", "branch_name" : "基线", "test_conclusion" : "商用发布", "test_conclusion_details" : "6666666", "defect_details_by_severity" : [ ], "defect_details_by_module" : [ ], "create_time" : "2025-02-28 15:46:10", "create_timestamp" : 1740728770000, "creator_name" : "TMSS01" } ], "page_size" : 10, "page_no" : 1 } }

响应参数 状态码：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 参数解释: 接口调用失败错误信息 取值范围: 不涉及

URI GET /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 每页条数

请求示例 实时计算单个自定义报表 post https://{endpoint}/v4/projects/f3087a82b44744c29a1bd69ab6ada154/home/overview/severity { "owner_id" : "ffb8caecd62b41c7929121c181d11064", "version_uri" : "v92s000100lum5pi" }

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 - String 看板统计数据 状态码：400 表5 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息 状态码：401 表6 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息 状态码：404 表7 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息 状态码：500 表8 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 version_uri 否 String 参数解释: 版本或迭代URI 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 module_id 否 String 参数解释: 模块ID，模块的唯一标识，需从需求管理获取 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 fixed_version_id 否 String 参数解释: 计划迭代ID，模块的唯一标识，需从需求管理获取 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 owner_id 否 String 参数解释: 用户ID，用户的唯一标识 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及

请求示例 质量报告看板统计 post https://{endpoint}/v4/projects/26927372bbae40b184fe764e7a0d21f7/report/overview { "version_uri" : "v91k0000vgtfg1jk", "module_id" : "994928222970748929,994928245960912896,994928263572795393,994928294128300032,994928330747584512,-2", "pi_filter" : { "all_pi" : true, "pi_sprints" : [ { "pi_id" : "1035314883144495104", "sprints" : [ "" ] }, { "pi_id" : "991653518035169281", "sprints" : [ "991653560740388864", "" ] }, { "pi_id" : "", "sprints" : [ "" ] } ] } }

响应示例 状态码：200 OK { "status" : "success", "result" : { "value" : { "defect" : { "total" : 2, "not_solved" : 0, "severity_number_list" : [ { "name" : "提示", "value" : 2 } ] }, "case_pass_rate" : { "pass_rate" : "0.0%", "result_number_list" : [ { "name" : "成功", "value" : 2 }, { "name" : "失败", "value" : 2 }, { "name" : "执行中", "value" : 3 }, { "name" : "停止", "value" : 1 }, { "name" : "未执行", "value" : 19994 } ] }, "project_type" : "ipd", "issue_cover_rate" : { "epic" : { "testing" : 0, "finished" : 0, "not_tested" : 0, "total_number" : 0, "cover_rate" : "0.0%" }, "feature" : { "testing" : 0, "finished" : 0, "not_tested" : 0, "total_number" : 0, "cover_rate" : "0.0%" }, "story" : { "testing" : 2, "finished" : 0, "not_tested" : 4, "total_number" : 6, "cover_rate" : "0.0%" } } } } }

响应参数 状态码：200 表5 响应Body参数 参数 参数类型 描述 status String success|error result ResultValueOverviewVo object 请求的返回的数据对象 error ApiError object 失败时的error信息 request_id String 由接口调用方传入，建议使用UUID保证请求的唯一性。 server_address String 本次请求的受理的服务地址 表6 ResultValueOverviewVo 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 value OverviewVo object status为failed时，存放只有reason的ApiError对象 reason String 业务失败的提示内容 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表7 OverviewVo 参数 参数类型 描述 defect DefectVo object 整体缺陷信息 case_pass_rate CasePassRateVo object 计算用例通过率 case_completion_rate CaseCompletionRateVo object 计算用例完成率 risk_rating RiskRatingVo object 测试计划的风险等级和风险描述 project_type String 项目类型 issue_cover_rate IssueCoverRateVo object 看板项目的需求覆盖率 表8 DefectVo 参数 参数类型 描述 total Integer 缺陷数 not_solved Integer 未关闭缺陷数 severity_number_list Array of NameAndValueVo objects 组装缺陷每种重要程度的名称和对应的数目 表9 CasePassRateVo 参数 参数类型 描述 pass_rate String 用例通过率 result_number_list Array of NameAndValueVo objects 用户自定义结果对应的用例数目 表10 CaseCompletionRateVo 参数 参数类型 描述 total Integer 总用例数 completion_rate String 用例完成率 status_number_list Array of NameAndValueVo objects 用户自定义状态对应的用例数目 表11 NameAndValueVo 参数 参数类型 描述 name String 名称 value Integer 值 表12 RiskRatingVo 参数 参数类型 描述 risk_rating Integer 测试计划的风险等级 risk_description String 测试计划的风险描述 表13 IssueCoverRateVo 参数 参数类型 描述 epic CoverRateVo object epic类型需求覆盖率, 仅scrum项目返回 feature CoverRateVo object feature类型需求覆盖率, 仅scrum项目返回 story CoverRateVo object story类型需求覆盖率, 仅scrum项目返回 summary CoverRateVo object 需求覆盖率(scrum项目仅返回epic、feature、story。非scrum项目仅返回summary) 表14 CoverRateVo 参数 参数类型 描述 testing Integer 统计测试中的需求 finished Integer 统计已完成的需求 not_tested Integer 统计未测试的需求 total_number Integer 计算需求总数 cover_rate String 需求覆盖率 表15 ApiError 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：400 表16 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及 状态码：401 表17 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及 状态码：404 表18 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及 状态码：500 表19 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及

请求示例 查询时段内用例的执行情况 post https://{endpoint}/v1/efdb403066474ab08836b9eeaaa23bca/testcases/execute-info/statistic-by-user { "offset" : 0, "limit" : 10, "execute_start_time" : "2023-01-01T00:00:00+08:00", "execute_end_time" : "2023-01-01T23:59:59+08:00" }

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 total Integer 参数解释: 符合条件的所有记录数 取值范围: 起始记录数大于实际总条数时，值为0 values Array of ExternalUserExecuteInfo objects 参数解释: 时段内用例的执行情况 取值范围: 不涉及 表5 ExternalUserExecuteInfo 参数 参数类型 描述 executor NameAndIdVo object 参数解释: 执行人信息 取值范围: 不涉及 execute_count Integer 参数解释: 执行用例数 取值范围: 不涉及 表6 NameAndIdVo 参数 参数类型 描述 id String 参数解释: ID 取值范围: 不涉及 name String 参数解释: 名称 取值范围: 不涉及 状态码：400 表7 响应Body参数 参数 参数类型 描述 error_code String 参数解释 接口调用失败错误码 取值范围 不涉及 error_msg String 参数解释 接口调用失败错误信息 取值范围 不涉及 状态码：401 表8 响应Body参数 参数 参数类型 描述 error_code String 参数解释 接口调用失败错误码 取值范围 不涉及 error_msg String 参数解释 接口调用失败错误信息 取值范围 不涉及 状态码：404 表9 响应Body参数 参数 参数类型 描述 error_code String 参数解释 接口调用失败错误码 取值范围 不涉及 error_msg String 参数解释 接口调用失败错误信息 取值范围 不涉及 状态码：500 表10 响应Body参数 参数 参数类型 描述 error_code String 参数解释 接口调用失败错误码 取值范围 不涉及 error_msg String 参数解释 接口调用失败错误信息 取值范围 不涉及

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 约束限制 不涉及 取值范围 字符串长度不少于1，不超过100000 默认取值 不涉及 表3 请求Body参数 参数 是否必选 参数类型 描述 offset 是 Integer 参数解释: 起始偏移量,表示从此偏移量开始查询 约束限制: 不涉及 取值范围: 0-20000 默认取值: 不涉及 limit 是 Integer 参数解释: 每页显示的条目数量 约束限制: 不涉及 取值范围: 0-100 默认取值: 不涉及 execute_start_time 是 String 参数解释: 用例执行时间段开始 约束限制: 不涉及 取值范围: 0-100 默认取值: 不涉及 execute_end_time 是 String 参数解释: 用例执行时间段截止 约束限制: 不涉及 取值范围: 0-100 默认取值: 不涉及

请求示例 质量报告看板统计 post https://{{endpoint}}/testreport/v4/testhub/projects/875ab809ae454c808b8565bd8695692d/data-dashboard/overview { "plan_id" : "vx785d2300op22kb6c", "branch_id" : "v9050000uop22kb6", "module_id" : "889109272257798144,-2", "fixed_version_id" : "884537509955936256,884770598208577537,-2" }

响应示例 状态码：200 OK { "defect" : { "total" : 3, "not_solved" : 3, "severity_number_list" : [ { "name" : "提示", "value" : 3 } ] }, "case_pass_rate" : { "pass_rate" : "99.5%", "result_number_list" : [ { "name" : "成功", "value" : 3000 }, { "name" : "未执行", "value" : 15 } ] }, "project_type" : "ipd", "issue_cover_rate" : { "summary" : { "testing" : 0, "finished" : 0, "not_tested" : 17, "total_number" : 17, "cover_rate" : "0.0%" } } }

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 defect DefectVo object 缺陷统计信息 case_pass_rate CasePassRateVo object 用例通过率信息 case_completion_rate CaseCompletionRateVo object 用例通过率信息 project_type String 参数解释: 项目类型 取值范围: 不涉及 issue_cover_rate IssueCoverRateVo object 参数解释: 需求覆盖率信息 取值范围: 不涉及 表5 DefectVo 参数 参数类型 描述 total Integer 参数解释: 缺陷数 取值范围: 不涉及 not_solved Integer 参数解释: 未关闭缺陷数 取值范围: 不涉及 severity_number_list Array of NameAndValueVo objects 参数解释: 组装缺陷每种重要程度的名称和对应的数目 取值范围: 不涉及 表6 CasePassRateVo 参数 参数类型 描述 pass_rate String 参数解释: 用例通过率 取值范围: 0%-100% result_number_list Array of NameAndValueVo objects 参数解释: 用户自定义结果对应的用例数目 取值范围: 不涉及 表7 CaseCompletionRateVo 参数 参数类型 描述 total Integer 参数解释: 总用例数 取值范围: 不涉及 completion_rate String 参数解释: 用例完成率 取值范围: 0%-100% status_number_list Array of NameAndValueVo objects 参数解释: 用户自定义状态对应的用例数目 取值范围: 不涉及 表8 NameAndValueVo 参数 参数类型 描述 name String 参数解释: 名称 取值范围: 不涉及 value Integer 参数解释: 值 取值范围: 不涉及 表9 IssueCoverRateVo 参数 参数类型 描述 epic CoverRateVo object 参数解释: epic类型需求覆盖率, 仅scrum项目返回 取值范围: 不涉及 feature CoverRateVo object 参数解释: feature类型需求覆盖率, 仅scrum项目返回 取值范围: 不涉及 story CoverRateVo object 参数解释: story类型需求覆盖率, 仅scrum项目返回 取值范围: 不涉及 summary CoverRateVo object 参数解释: summary类型需求覆盖率, 仅scrum项目返回 取值范围: 不涉及 表10 CoverRateVo 参数 参数类型 描述 testing Integer 统计测试中的需求 finished Integer 统计已完成的需求 not_tested Integer 统计未测试的需求 total_number Integer 计算需求总数 cover_rate String 需求覆盖率 状态码：400 表11 响应Body参数 参数 参数类型 描述 error_code String 参数解释 接口调用失败错误码 取值范围 不涉及 error_msg String 参数解释 接口调用失败错误信息 取值范围 不涉及 状态码：401 表12 响应Body参数 参数 参数类型 描述 error_code String 参数解释 接口调用失败错误码 取值范围 不涉及 error_msg String 参数解释 接口调用失败错误信息 取值范围 不涉及 状态码：404 表13 响应Body参数 参数 参数类型 描述 error_code String 参数解释 接口调用失败错误码 取值范围 不涉及 error_msg String 参数解释 接口调用失败错误信息 取值范围 不涉及 状态码：500 表14 响应Body参数 参数 参数类型 描述 error_code String 参数解释 接口调用失败错误码 取值范围 不涉及 error_msg String 参数解释 接口调用失败错误信息 取值范围 不涉及