华为云用户手册

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释 用户Token。通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 约束限制 不涉及 取值范围 字符串长度不少于1，不超过100000 默认取值 不涉及 表3 请求Body参数 参数 是否必选 参数类型 描述 project_uuid 否 String 项目ID iterator_uri 否 String 迭代uri case_ids 否 Array of strings 用例uri列表

响应示例 状态码：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 表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 /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 每页条数

响应示例 状态码：200 OK { "total" : 1, "project_id" : "1f22e3511dd348e38131b4066afbd0b4", "values" : [ { "id" : "001s16gt6q5", "type" : "TestVersion", "author" : "efdb403066474ab08836b9eeaaa23bca", "name" : "名称", "region" : "cn-north-7", "last_modifier" : "张三", "last_modified" : "2023-07-20 02:17:01", "last_modified_timestamp" : 1660617231016, "creation_date" : "2023-07-20 02:17:01", "creation_date_timestamp" : 1660617231016, "author_name" : "tester", "is_base_branch" : 0 } ] }

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 total Integer 参数解释: 符合条件的所有记录数 取值范围: 起始记录数大于实际总条数时值为0,分页请求才有此值 project_id String 参数解释: 项目ID 取值范围: 项目uuid应符合如下规则：长度等于32位，包含大小写字母、数字 values Array of ExternalBranchInfoVo objects 实际的数据类型：单个对象，集合 或 NULL 表5 ExternalBranchInfoVo 参数 参数类型 描述 id String 参数解释: 分支ID 取值范围: 项目分支id长度大于11位小于34位 type String 参数解释: 类型 取值范围: 不涉及 author String 参数解释: 创建人 取值范围: 不涉及 name String 参数解释: 名称 取值范围: 不涉及 region String 参数解释: 区域 取值范围: 不涉及 last_modifier String 参数解释: 最后修改人 取值范围: 不涉及 last_modified String 参数解释: 最后修改时间 取值范围: 不涉及 last_modified_timestamp Long 参数解释: 修改时间时间戳 取值范围: 不涉及 creation_date String 参数解释: 创建时间 取值范围: 不涉及 creation_date_timestamp Long 参数解释: 创建时间时间戳 取值范围: 不涉及 author_name String 参数解释: 创建人名称 取值范围: 不涉及 is_base_branch Integer 参数解释: 是否为基线分支 取值范围: 0:不是基线分支，1:是基线分支 状态码：400 表6 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及 状态码：401 表7 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及 状态码：404 表8 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及 状态码：500 表9 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及

URI GET /v1/{project_id}/branches 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: 项目id，对应"需求管理 CodeArts Req"项目唯一标识，测试计划管理页面地址栏url https://{host}/cloudtestportal/project/{project_id}/testplan中project_id变量的值 约束限制: 不涉及 取值范围: 项目uuid应符合如下规则：长度等于32位，包含大小写字母、数字 默认取值: 不涉及 表2 Query参数 参数 是否必选 参数类型 描述 sort_field 否 String 参数解释: 排序字段 约束限制: 不涉及 取值范围: NAME,CREATIONDATE 默认取值: 不涉及 sort_type 否 String 参数解释: 排序方式 约束限制: 不涉及 取值范围: DESC,ASC 默认取值: 不涉及 offset 是 Integer 参数解释: 起始偏移量，表示从此偏移量开始查询 约束限制: 不涉及 取值范围: 0-20000 默认取值: 不涉及 limit 是 Integer 参数解释: 每页显示的条目数量 约束限制: 不涉及 取值范围: 0-200 默认取值: 不涉及

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 约束限制 不涉及 取值范围 字符串长度不少于1，不超过100000 默认取值 不涉及 表3 请求Body参数 参数 是否必选 参数类型 描述 project_uuid 否 String 项目id version_uri 否 String 分支uri case_ids 是 Array of strings 用例id列表

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 value String 参数解释 resultObject 取值范围 不涉及 状态码：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 参数解释: 业务失败的提示内容 取值范围: 不涉及

响应示例 状态码：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 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}/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 }

响应参数 状态码：204 No Content 状态码：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参数 参数 是否必选 参数类型 描述 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位字符（字母和数字） 默认取值: 不涉及

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 values Array of ExternalTestCaseHistoryVo objects 实际的数据类型：单个对象，集合 或 NULL 表5 ExternalTestCaseHistoryVo 参数 参数类型 描述 author String 资源历史记录创建人ID region String 逻辑region changes Array of ResourceChangeExternalVo objects 历史记录字段变更列表 id String 历史记录id testcase_id String 用例uri，长度11-34位字符（字母和数字）。 creation_date String 创建时间 create_date_timestamp Long 创建时间时间戳 author_name String 创建人名称 project_id String 项目id 表6 ResourceChangeExternalVo 参数 参数类型 描述 field_name String 变更字段 custom_field_type String 测试用例自定义字段类型 old_change_info ElementResourceChangeExternalVo object 变更前的数据信息 new_change_info ElementResourceChangeExternalVo object 变更后的数据信息 表7 ElementResourceChangeExternalVo 参数 参数类型 描述 tracker_name String 工作项类型 value String 值 key String key object_value Object 对象值 object_key Object 对象key tracker_names Object 缺陷类型 board_info Array of objects 归属看板信息，用例关联工作项信息使用 状态码：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 参数解释 接口调用失败错误信息 取值范围 不涉及

状态码 状态码 描述 200 查询成功。示例1：获取用例历史记录基础示例。示例2：获取用例历史记录，目录(cataName)、状态(statusName)、等级(rank)、处理人(owner)、迭代(versionName)、模块(moduleName)、版本号(releaseDev)、缺陷(defectId)、需求(issueId)、测试步骤(steps)、描述(description)、预置条件(preparation)均有变更的返回示例。 400 Bad Request 401 Unauthorized 404 Not Found 500 Internal Server Error

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 约束限制 不涉及 取值范围 字符串长度不少于1，不超过100000 默认取值 不涉及 表3 请求Body参数 参数 是否必选 参数类型 描述 offset 是 Integer 起始偏移量，表示从此偏移量开始查询，offset大于等于0，小于等于20000 limit 是 Integer 每页显示的条目数量,最大支持200条 version_id 是 String 版本ID（分支ID或测试计划ID），长度11-34位字符（字母和数字）。

URI POST /v1/{project_id}/testcases/{testcase_id}/histories/batch-query 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释 项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目ID。 约束限制 不涉及 取值范围 32个字符组成的字符串 默认取值 不涉及 testcase_id 是 String 用例uri,测试用例唯一标识,长度11-34位字符（字母和数字）。。

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 status String 参数解释: 本次请求的处理状态 取值范围: success|error result ResultValueString object 参数解释: 请求结果 取值范围: 非必返 error ApiError object 参数解释: 错误信息 取值范围: 非必返 request_id String 参数解释: 请求的唯一id 取值范围: 非必返 address String 参数解释: 本次请求的受理的服务地址。 取值范围: 非必返 表4 ResultValueString 参数 参数类型 描述 value String 参数解释 resultObject 取值范围 不涉及 表5 ApiError 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：400 表6 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及 状态码：401 表7 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及 状态码：404 表8 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及 状态码：500 表9 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 service_id Integer 参数解释 接口调用成功返回的服务id 取值范围 不涉及 service_name 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的值） 约束限制 不涉及 取值范围 字符串长度不少于1，不超过100000 默认取值 不涉及 表3 请求Body参数 参数 是否必选 参数类型 描述 server_host 是 String 参数解释: server_host是由用户提供的 域名 。我们会通过此域名进行接口调用，测试计划将会通过此域名下的接口，保证服务数据与用户系统数据的一致性。 约束限制: 不涉及 取值范围: 以https/http开头 长度小于等于128位字符。 默认取值: 不涉及 service_name 是 String 参数解释: 测试类型名称，用于界面显示，不能使用当前已有测试类型名称，长度小于等于128。 约束限制: 不涉及 取值范围: 长度小于等于128。 默认取值: 不涉及

响应示例 状态码：200 OK { "assigned_user" : { "id" : "ID", "name" : "名称" }, "execute_count" : 4, "extend_info" : { "author" : { "id" : "1111", "name" : "名称", "time" : "2000-01-01 00:00:00" }, "defect_list" : [ { "id" : "ID", "name" : "名称" } ], "description" : "描述信息", "domain" : { "id" : "ID", "name" : "名称" }, "fixed_version" : { "id" : "ID", "name" : "名称" }, "issue" : { "id" : "ID", "name" : "名称" }, "label_list" : [ { "id" : "ID", "name" : "名称" } ], "module" : { "id" : "ID", "name" : "名称" }, "preparation" : "前置条件", "steps" : [ { "expect_result" : "[\"\\u003cp\\u003e预期结果1\\u003c/p\\u003e\",\"\\u003cp\\u003e预期结果2\\u003c/p\\u003e\"]", "test_step" : "[\"\\u003cp\\u003e步骤描述1\\u003c/p\\u003e\",\"\\u003cp\\u003e步骤描述2\\u003c/p\\u003e\"]" } ], "test_version_id" : "97b82412f1", "updator" : { "id" : "1111", "name" : "名称", "time" : "2000-01-01 00:00:00" } }, "name" : "某个测试用例", "project_id" : "2394921", "rank_id" : "2", "result_id" : "0", "service_id" : 13, "status_id" : "1", "testcase_id" : "97b82412f1ca4628803b918c27ed09de", "testcase_number" : "1234" }

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

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 assigned_user AssignedUserInfo object 参数解释: 处理者信息 取值范围: 不涉及 execute_count Integer 参数解释: 测试用例执行次数 取值范围: 不涉及 extend_info ExtendInfo object 参数解释: 测试用例扩展信息 取值范围: 不涉及 name String 参数解释: 测试用例名称 取值范围: 不涉及 project_id String 参数解释: 软开云项目唯一标识 取值范围: 不涉及 rank_id String 参数解释: 测试用例等级 取值范围: 0|1|2|3|4 result_id String 参数解释: 测试用例执行结果 取值范围: 不涉及 service_id Integer 参数解释: 注册测试类型服务接口返回的服务id 取值范围: 不涉及 status_id String 参数解释: 测试用例状态 取值范围: 不涉及 testcase_id String 参数解释: 用例uri,测试用例唯一标识 取值范围: 11-34位字符（字母和数字） testcase_number String 参数解释: 测试用例编号 取值范围: 不涉及 表5 ExtendInfo 参数 参数类型 描述 author ExtendAuthorInfo object 参数解释: 创建者信息 取值范围: 不涉及 defect_list Array of AssignedUserInfo objects 参数解释: 缺陷信息 取值范围: 不涉及 description String 参数解释: 描述信息 取值范围: 不涉及 domain AssignedUserInfo object 参数解释: 租户信息 取值范围: 不涉及 fixed_version AssignedUserInfo object 参数解释: 迭代信息 取值范围: 不涉及 issue AssignedUserInfo object 参数解释: 需求信息 取值范围: 不涉及 label_list Array of AssignedUserInfo objects 参数解释: 标签信息 取值范围: 不涉及 module AssignedUserInfo object 参数解释: 模块信息 取值范围: 不涉及 preparation String 参数解释: 前置条件 取值范围: 不涉及 steps Array of ExternalServiceCaseStep objects 参数解释: 测试步骤 取值范围: 数组长度小于10 test_version_id String 参数解释: 测试版本号 取值范围: 不涉及 updator ExtendAuthorInfo object 参数解释: 更新者信息 取值范围: 不涉及 表6 AssignedUserInfo 参数 参数类型 描述 id String 参数解释: id信息 取值范围: 不涉及 name String 参数解释: 名称信息 取值范围: 不涉及 表7 ExternalServiceCaseStep 参数 参数类型 描述 expect_result String 参数解释: 测试用例预期结果信息 约束限制: 不涉及 取值范围: 0-500位字符 默认取值: 不涉及 test_step String 参数解释: 测试步骤描述信息 约束限制: 不涉及 取值范围: 0-500位字符 默认取值: 不涉及 表8 ExtendAuthorInfo 参数 参数类型 描述 id String 参数解释: id信息 取值范围: 不涉及 name String 参数解释: 名称信息 取值范围: 不涉及 time 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 参数解释 接口调用失败错误信息 取值范围 不涉及

响应参数 状态码：201 表5 响应Body参数 参数 参数类型 描述 plan_id String 参数解释: 接口调用成功返回的计划id 取值范围: 不涉及 error_code String 参数解释: 接口调用成功不返回，调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用成功不返回，调用失败错误信息 取值范围: 不涉及 状态码：400 表6 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及 状态码：401 表7 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及 状态码：404 表8 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及 状态码：500 表9 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 assigned_id 否 String 参数解释: 处理者id，不填时默认使用当前用户 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 name 是 String 参数解释: 计划名称 约束限制: 长度128位字符 取值范围: 不涉及 默认取值: 不涉及 plan_cycle 是 PlanCycle object 计划周期 service_id_list 是 Array of integers 参数解释: 计划下包含的用例类型，数组长度小于10个 约束限制: 最大长度10 取值范围: 不涉及 默认取值: 不涉及 表4 PlanCycle 参数 是否必选 参数类型 描述 end_date 是 String 参数解释: 计划结束时间，要求用UTC时间表示。如2020-03-31 约束限制: UTC时间表示 取值范围: 不涉及 默认取值: 不涉及 start_date 是 String 参数解释: 计划开始时间，要求用UTC时间表示。如2020-03-04 约束限制: UTC时间表示 取值范围: 不涉及 默认取值: 不涉及

请求示例 项目下创建计划 post https://{endpoint}/v1/projects/efdb403066474ab08836b9eeaaa23bca/plans { "assigned_id" : "efdb403066474ab08836b9eeaaa23bca", "name" : "这是一个测试计划名称", "plan_cycle" : { "end_date" : "2020-03-31", "start_date" : "2020-03-04" }, "service_id_list" : [ 13, 24 ] }