华为云用户手册

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 value String testbird key 状态码： 400 表5 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码： 401 表6 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码： 404 表7 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码： 500 表8 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容

请求示例 根据查询条件获取测试报告列表 post https://{endpoint}/v4/30649eb093c2479d92c74c75d36ef280/versions/v91i0000vq98suq1/testcases/v91j0000vq997opk/results/batch-query { "project_uuid" : "30649eb093c2479d92c74c75d36ef280", "case_uri" : "v91j0000vq997opk", "page_no" : 1, "page_size" : 15, "version_uri" : "v91i0000vq98suq1" }

响应示例 状态码： 200 OK { "status" : "success", "result" : { "total" : 2, "value" : [ { "uri" : "v9220000vqtdi7go", "name" : "基线 Result2024-08-31", "author" : "xxx", "result" : 0, "region" : "cn-north-7", "steps" : [ { "result" : "0", "test_step" : "", "expect_result" : "", "actual_result" : "", "result_name" : "成功" } ], "begin_time" : "2024-08-31 16:34:24", "begin_time_timestamp" : 1725093264000, "end_time" : "2024-08-31 16:34:34", "end_time_timestamp" : 1725093274000, "last_modified" : "2024-09-10 10:58:55", "last_modified_timestamp" : 1725937135000, "last_change_time" : "2024-08-31 16:34:44", "last_change_time_timestamp" : 1725093284000, "failure_cause" : "12345678", "parent_uri" : "v91j0000vq997opk", "test_case_uri" : "v91j0000vq997opk", "test_case_name" : "用例3", "result_name" : "成功", "task_id" : "1806594740082704384", "time_cost" : 10000, "step_txt" : "[\"\"]", "step_expect" : "[\"\"]", "step_actual" : "[\"\"]", "step_result" : "[\"0\"]", "creation_version_uri" : "v91i0000vq98suq1", "version_uri" : "v91i0000vq98suq1", "reason" : "--", "reasonTypeName" : "版本缺陷" }, { "uri" : "v91o0000vqr7jopj", "name" : "基线 Result2024-08-30", "author" : "xxx", "result" : 1, "region" : "cn-north-7", "steps" : [ { "result" : "1", "test_step" : "", "expect_result" : "", "actual_result" : "", "result_name" : "失败" } ], "begin_time" : "2024-08-30 20:11:54", "begin_time_timestamp" : 1725019914000, "end_time" : "2024-08-30 20:12:04", "end_time_timestamp" : 1725019924000, "last_modified" : "2024-08-30 20:12:14", "last_modified_timestamp" : 1725019934000, "last_change_time" : "2024-08-30 20:12:14", "last_change_time_timestamp" : 1725019934000, "failure_cause" : "unknown failure", "parent_uri" : "v91j0000vq997opk", "test_case_uri" : "v91j0000vq997opk", "test_case_name" : "用例3", "result_name" : "失败", "task_id" : "1804076583577190400", "time_cost" : 10000, "step_txt" : "[\"\"]", "step_expect" : "[\"\"]", "step_actual" : "[\"\"]", "step_result" : "[\"1\"]", "creation_version_uri" : "v91i0000vq98suq1", "version_uri" : "v91i0000vq98suq1" } ], "page_size" : 15, "page_no" : 1 } }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 status String success|error; result ResultValueListTestResultVo object 请求的返回的数据对象 error ApiError object 失败时的error信息 request_id String 由接口调用方传入，建议使用UUID保证请求的唯一性。 server_address String 本次请求的受理的服务地址 表5 ResultValueListTestResultVo 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 value Array of TestResultVo objects 实际的数据类型：单个对象，集合 或 NULL reason String 业务失败的提示内容 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表6 TestResultVo 参数 参数类型 描述 uri String 结果URI name String 用例结果名称 author String 创建人ID rank Integer 级别 result Integer 测试结果Code round Integer 执行批次 preparation String 前置条件 description String 描述 region String 逻辑Region steps Array of ResultStepVo objects 测试步骤信息 number String 用例结果编号 author_name String 创建人名称 begin_time String 执行开始时间 begin_time_timestamp Long 执行开始时间时间戳 end_time String 执行结束时间 end_time_timestamp Long 执行结束时间时间戳 creation_date String 创建时间 creation_date_timestamp Long 创建时间时间戳 last_modified String 最后修改时间 last_modified_timestamp Long 最后修改时间 last_change_time String 最后变更时间 last_change_time_timestamp Long 最后变更时间 dfx_test_result String DFX测试结果 failure_cause String 失败原因 parent_uri String 父节点URI(分支用例URI或迭代用例URI) test_case_uri String 分支用例URI test_case_name String 用例名称 task_uri String 测试任务URI result_name String 测试结果 test_result_ae String 是否自动化执行 executor_id String 执行人ID executor_name String 执行人名称 task_id String 执行机任务ID execute_id String 执行ID time_cost Integer 执行耗时 step_txt String 测试步骤 step_expect String 测试步骤期望结果 step_actual String 测试步骤实际结果 step_result String 测试步骤结果 release_dev String 版本号 creation_version_uri String 创建版本URI version_uri String 版本URI project_id String 项目ID report_url String 第三方过来的执行结果，返回跳转到第三方的url test_case_number String 测试用例编号 service_type String 测试类型 表7 ResultStepVo 参数 参数类型 描述 result String 结果 test_step String 测试步骤 expect_result String 预期结果 actual_result String 实际结果 result_name String 测试结果名称 表8 ApiError 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码： 400 表9 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息 状态码： 401 表10 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息 状态码： 404 表11 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息 状态码： 500 表12 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息

URI POST /v4/{project_id}/versions/{version_uri}/testcases/{case_uri}/results/batch-query 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: 项目id，对应"需求管理 CodeArts Req"项目唯一标识，测试计划管理页面地址栏url https://{host}/cloudtestportal/project/{project_id}/testplan中project_id变量的值 约束限制: 不涉及 取值范围: 项目uuid应符合如下规则：长度等于32位，包含大小写字母、数字 默认取值: 不涉及 version_uri 是 String 版本URI case_uri 是 String 用例uri

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 uri 否 String 结果URI task_uri 否 String 测试任务URI task_id 否 String 执行id release_dev 否 String 版本号 execute_id 否 String 测试套当次执行id，同一个测试套每次执行的id唯一 case_uris 否 Array of strings 测试套中用例的uri page_no 否 Integer 当前页数 page_size 否 Integer 每页条数 sort_field 否 String 排序字段 sort_type 否 String 排序类型

响应参数 状态码： 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 每页条数

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求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集合

URI POST /testrelation/v4/{project_id}/issues/{issue_id}/testcases/batch-query 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: 项目id，对应"需求管理 CodeArts Req"项目唯一标识，测试计划管理页面地址栏url https://{host}/cloudtestportal/project/{project_id}/testplan中project_id变量的值 约束限制: 不涉及 取值范围: 项目uuid应符合如下规则：长度等于32位，包含大小写字母、数字 默认取值: 不涉及 issue_id 是 String 需求id

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 code String 接口调用错误码 data String 接口调用返回体 message String 接口调用错误信息 状态码： 400 表4 响应Body参数 参数 参数类型 描述 code String 接口调用错误码 data String 接口调用返回体 message String 接口调用错误信息 状态码： 401 表5 响应Body参数 参数 参数类型 描述 code String 接口调用错误码 data String 接口调用返回体 message String 接口调用错误信息 状态码： 404 表6 响应Body参数 参数 参数类型 描述 code String 接口调用错误码 data String 接口调用返回体 message String 接口调用错误信息 状态码： 500 表7 响应Body参数 参数 参数类型 描述 code String 接口调用错误码 data String 接口调用返回体 message String 接口调用错误信息

响应示例 状态码： 200 OK { "code" : "success", "data" : { "saveTemplate" : true, "deleteMindmapById" : true, "editMindmap" : true, "mindmapBackupBackUpMindmap" : true }, "message" : null }

响应示例 状态码： 200 OK { "status" : "success", "result" : { "id" : "37df588351464f45944580b288556d37", "warningMsg" : null, "name" : "baidu1", "source" : null, "method" : "getwww_baidu_com", "description" : "自定义URL请求", "nameView" : null, "tmssCaseNumber" : null, "region" : "cn-north-7", "yamlName" : null, "create_time_string" : "2024-06-21 15:46:18 GMT+08:00", "update_time_string" : "2024-06-21 15:46:18 GMT+08:00", "create_time_stamp" : 1718955978000, "update_time_stamp" : 1718955978000, "create_user" : "devcloud_devcloud_s00314720_01", "create_time" : "2024-06-21T03:46:18+0800", "update_user" : "devcloud_devcloud_s00314720_01", "update_time" : "2024-06-21T03:46:18+0800", "param_type_and_dft_value" : [ ], "dft_custom_header" : null, "dft_check_point_list" : [ ], "dft_variable_list" : [ ], "keyword_variable_value" : null, "dft_retry_times" : null, "dft_retry_interval" : null, "return_type" : "[{\"returnCode\":200}]", "aw_type" : 1, "aw_ins_list" : null, "project_id" : "09645c1f3f954a8d9ab29174857cffc5", "public_aw_lib_id" : null, "special_type" : 90, "has_code" : 1, "aw_code" : "", "group_name" : "dfaba6a51f024c1f95229c1059ca34e0", "protocol_type" : "http/https", "by_order" : 1, "aw_mark" : 1, "output_param_list" : null, "is_favorite" : null, "tmss_case_id" : null, "create_user_id" : null, "aw_description" : null, "origin_project" : null, "aw_uniqueid" : null, "aw_tags" : null, "aw_operationid" : null, "interface_label" : null, "import_package" : null, "public_aw_lib" : null, "root_id" : null, "custom_aw_libs" : null, "delete_time" : null, "delete_user" : null, "extra_info" : { "http_method" : "get", "http_url" : "http://www.baidu.com" } }, "reason" : null, "error" : null, "code" : null }

请求示例 post https://{endpoint}/v1/09645c1f3f954a8d9ab29174857cffc5/basic-aw { "name" : "baidu2", "group_name" : "dfaba6a51f024c1f95229c1059ca34e0", "description" : "自定义URL请求", "extra_info" : { "http_url" : "http://www.baidu.com", "http_method" : "get" }, "param_type_and_dft_value" : [ ], "dft_check_point_list" : [ ], "dft_variable_list" : [ ] }

响应参数 状态码： 200 表14 响应Body参数 参数 参数类型 描述 code String 错误码 error CommonResponseErrorObject object 统一错误返回 reason String 失败原因 result Object 结果 status String 状态 表15 CommonResponseErrorObject 参数 参数类型 描述 code String 错误码 reason String 错误原因

响应示例 状态码： 200 OK { "status" : "success", "result" : { "value" : { "display" : [ { "id" : "B", "name" : "名称" }, { "id" : "A", "name" : "编号" }, { "id" : "I", "name" : "结果" }, { "id" : "D", "name" : "级别" }, { "id" : "S", "name" : "执行者" }, { "id" : "U", "name" : "执行方式" } ], "hidden" : [ { "id" : "G", "name" : "状态" }, { "id" : "C", "name" : "处理者" }, { "id" : "J", "name" : "关联需求" }, { "id" : "N", "name" : "缺陷" }, { "id" : "H", "name" : "执行次数" }, { "id" : "Q", "name" : "执行时间" }, { "id" : "R", "name" : "执行时长" }, { "id" : "F", "name" : "迭代" }, { "id" : "L", "name" : "创建时间" }, { "id" : "O", "name" : "模块" }, { "id" : "K", "name" : "创建者" }, { "id" : "T", "name" : "类型" }, { "id" : "X", "name" : "标签" }, { "id" : "E", "name" : "是否来自测试设计" }, { "id" : "Y", "name" : "评审状态" } ] } } }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 status String success|error; result ResultValueCustomizedColumnDisplayConfigVo object 请求的返回的数据对象 error ApiError object 失败时的error信息 request_id String 由接口调用方传入，建议使用UUID保证请求的唯一性。 server_address String 本次请求的受理的服务地址 表5 ResultValueCustomizedColumnDisplayConfigVo 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 value CustomizedColumnDisplayConfigVo object 实际的数据类型：单个对象，集合 或 NULL reason String 业务失败的提示内容 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表6 CustomizedColumnDisplayConfigVo 参数 参数类型 描述 display Array of ColumnVo objects 展示的表格列集合 hidden Array of ColumnVo objects 隐藏的表格列集合 表7 ColumnVo 参数 参数类型 描述 id String 表格列ID name String 表格列名称 custom_field_param String 项目用例自定义字段入参或者返回参数名称 表8 ApiError 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码： 400 表9 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息 状态码： 401 表10 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息 状态码： 404 表11 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息 状态码： 500 表12 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息

URI GET /v4/projects/{project_id}/customized-columns 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: 项目id，对应"需求管理 CodeArts Req"项目唯一标识，测试计划管理页面地址栏url https://{host}/cloudtestportal/project/{project_id}/testplan中project_id变量的值 约束限制: 不涉及 取值范围: 项目uuid应符合如下规则：长度等于32位，包含大小写字母、数字 默认取值: 不涉及 表2 Query参数 参数 是否必选 参数类型 描述 service_type 是 Integer 服务类型 stage_type 是 Integer 阶段过程（2：测试设计，3：测试执行，4：质量报告，5：测试套执行）

请求示例 质量报告按服务类型统计 post https://{endpoint}/v4/projects/26927372bbae40b184fe764e7a0d21f7/service-types/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" : [ { "service_type" : "0", "issue_cover_rate" : "0.0%", "case_pass_rate" : "0.0%", "defect_number" : 0 }, { "service_type" : "1", "issue_cover_rate" : "0.0%", "case_pass_rate" : "0.0%", "defect_number" : 0 }, { "service_type" : "6", "issue_cover_rate" : "0.0%", "case_pass_rate" : "0.0%", "defect_number" : 0 }, { "service_type" : "7", "issue_cover_rate" : "0.0%", "case_pass_rate" : "0.0%", "defect_number" : 0 }, { "service_type" : "8", "issue_cover_rate" : "0.0%", "case_pass_rate" : "0.0%", "defect_number" : 0 }, { "service_type" : "11", "issue_cover_rate" : "0.0%", "case_pass_rate" : "0.0%", "defect_number" : 0 }, { "service_type" : "32", "issue_cover_rate" : "0.0%", "case_pass_rate" : "0.0%", "defect_number" : 0 }, { "service_type" : "14352", "issue_cover_rate" : "0.0%", "case_pass_rate" : "0.0%", "defect_number" : 2 } ] } }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 status String success|error result ResultValueListTestTypeOverviewVo object 请求的返回的数据对象 error ApiError object 失败时的error信息 request_id String 由接口调用方传入，建议使用UUID保证请求的唯一性。 server_address String 对内接口才有此属性 表4 ResultValueListTestTypeOverviewVo 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 value Array of TestTypeOverviewVo objects 实际的数据类型：单个对象，集合 或 NULL reason String 业务失败的提示内容，对内接口才有此值 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表5 TestTypeOverviewVo 参数 参数类型 描述 service_type String 当前已经注册的用例类型，按照从小到大排序 issue_cover_rate String 需求覆盖率 case_pass_rate String 用例通过率 case_completion_rate String 用例完成率 defect_number Integer 缺陷数 表6 ApiError 参数 参数类型 描述 code String 业务失败的错误码 reason 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 接口调用失败错误信息

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 status String success|error result ResultValueListCustomReportListVo object 请求的返回的数据对象 表5 ResultValueListCustomReportListVo 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 value Array of CustomReportListVo objects 实际的数据类型：单个对象，集合 或 NULL reason String 业务失败的提示内容 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表6 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 报表数据 表7 ReportFilter 参数 参数类型 描述 creatorIds String 创建人 ownerIds String 所属人 ranks String 级别 releaseIds String releaseId status String 状态 moduleIds String 级别 results String 结果 labelIds String 标签 startTime String 开始时间 endTime String 结束时间 isAssociateIssue String 是否关联需求 表8 ReportChartDataVo 参数 参数类型 描述 id String 报表id name String 报表名称 analyze_dim ReportDimVo object 对比维度数据 compare_dim Array of ReportDimVo objects 对比维度数据 表9 ReportDimVo 参数 参数类型 描述 id String id name String 名称 value Integer 值 状态码： 400 表10 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码： 401 表11 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码： 404 表12 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码： 500 表13 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容

URI GET /testreport/v4/{project_id}/versions/{version_id}/custom-reports 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: 项目id，对应"需求管理 CodeArts Req"项目唯一标识，测试计划管理页面地址栏url https://{host}/cloudtestportal/project/{project_id}/testplan中project_id变量的值 约束限制: 不涉及 取值范围: 项目uuid应符合如下规则：长度等于32位，包含大小写字母、数字 默认取值: 不涉及 version_id 是 String 版本id 表2 Query参数 参数 是否必选 参数类型 描述 page_size 是 Long 每页显示的条目数量,最大支持200条 offset 是 Long 页数，page_no大于等于1 type 是 Integer 报表类型 1：首页用例库， 2：质量报告

请求示例 批量执行测试用例 post https://{endpoint}/v1/projects/efdb403066474ab08836b9eeaaa23bca/testcases/execution { "execute_list" : [ { "execute_id" : "10000", "result_id" : "0", "start_time" : 16659743037899, "testcase_id" : "b66aab5469cc4ab39b0dda8e644a42a4" } ], "plan_id" : "b66aab5469cc4ab39b0dda8e644a42a4", "service_id" : 13 }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 execute_list 是 Array of TestCaseExecuteBean objects 测试用例执行信息，数组长度小于等于50 plan_id 否 String 参数解释: 测试计划id或测试版本ID，对应测试计划管理页面创建的测试计划对象以及版本管理中创建的版本对象，测试用例列表页面地址栏url https://{host}/cloudtestportal/project/{project_id}/testcase?branch_id={branch_id}&testplan_id={testplan_id}中变量branch_id/testplan_id的值 约束限制: 不涉及 取值范围: 长度11-34位字符（字母和数字） 默认取值: 不涉及 service_id 是 Integer 参数解释: 测试用例类型ID，指定指定对应类型的测试用例ID 约束限制: 需要与execute_list中提供的用例的执行方式一致 取值范围: 大于0整数 默认取值: 不涉及 表4 TestCaseExecuteBean 参数 是否必选 参数类型 描述 execute_id 是 String 参数解释: 注册服务执行id，该值不允许重复，不超过32位字符 约束限制: 不涉及 取值范围: 不超过32位字符 默认取值: 不涉及 result_id 是 String 参数解释: 测试用例结果，指定此次执行的用例结果（0-成功，1-失败，5-执行中，6-停止） 约束限制: 不涉及 取值范围: 0-成功，1-失败，5-执行中，6-停止 默认取值: 不涉及 start_time 是 Long 参数解释: 用例开始执行的时间戳， 约束限制: 在执行开始时该字段必传 取值范围: 符合时间戳格式 默认取值: 不涉及 testcase_id 是 String 参数解释: 用例uri，测试用例唯一标识，测试用例详情页面地址栏url https://{host}/cloudtestportal/project/{project_id}/testcase?branch_id={branch_id}&case_id={case_id}&detail=base中case_id变量的值 约束限制: 不涉及 取值范围: 长度11-34位字符（字母和数字） 默认取值: 不涉及

响应参数 状态码： 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 接口调用失败错误信息

URI POST /v1/projects/{project_id}/testcases/execution 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: 项目id，对应"需求管理 CodeArts Req"项目唯一标识，测试计划管理页面地址栏url https://{host}/cloudtestportal/project/{project_id}/testplan中project_id变量的值 约束限制: 不涉及 取值范围: 项目uuid应符合如下规则：长度等于32位，包含大小写字母、数字 默认取值: 不涉及

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 params 是 ListFactorParam object 因子查询参数 表4 ListFactorParam 参数 是否必选 参数类型 描述 offset 否 Integer 起始偏移量，表示从此偏移量开始查询，offset大于等于0，小于等于100000 limit 否 Integer 每页显示的条目数量，最大支持200条 type 否 String 因子类型 name 否 String 因子名称 parent_node_ids 否 Array of strings 父ID集合 asset_id 否 String 因子库ID creator_num 否 String 创建人ID mindmap_id 否 String 脑图ID testpoint_id 否 String 测试点ID mindmap_node_id 否 String 脑图节点ID

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 code String 错误码 data Object 返回体 message String 错误信息 状态码： 400 表6 响应Body参数 参数 参数类型 描述 code String 接口调用错误码 data String 接口调用返回体 message String 接口调用错误信息 状态码： 401 表7 响应Body参数 参数 参数类型 描述 code String 接口调用错误码 data String 接口调用返回体 message String 接口调用错误信息 状态码： 404 表8 响应Body参数 参数 参数类型 描述 code String 接口调用错误码 data String 接口调用返回体 message String 接口调用错误信息 状态码： 500 表9 响应Body参数 参数 参数类型 描述 code String 接口调用错误码 data String 接口调用返回体 message String 接口调用错误信息

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 status String success|error; result ResultValueListLabelVo object 请求的返回的数据对象 error ApiError object 失败时的error信息 request_id String 由接口调用方传入，建议使用UUID保证请求的唯一性。 server_address String 本次请求的受理的服务地址 表5 ResultValueListLabelVo 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 value Array of LabelVo objects 实际的数据类型：单个对象，集合 或 NULL reason String 业务失败的提示内容 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表6 LabelVo 参数 参数类型 描述 uri String uri主键 region String 逻辑region label_name String 标签名称 service_type String 服务类型 resource_type String 所属资源类型（TestCase：用例，Task：测试套） project_uuid String 项目ID 表7 ApiError 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码： 400 表8 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息 状态码： 401 表9 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息 状态码： 404 表10 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息 状态码： 500 表11 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息