华为云用户手册

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

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 code String 错误码 error CommonResponseErrorOfAPITest object 统一错误返回 reason String 失败原因 result BasicAwRes object 结果 status String 状态 表4 CommonResponseErrorOfAPITest 参数 参数类型 描述 code String 错误码 reason String 错误原因 表5 BasicAwRes 参数 参数类型 描述 aw_code String 关键字代码, hascode字段为1是有效 aw_description String 模板描述 aw_mark Integer 关键字标记 aw_operationid String 关键字操作编号 aw_tags String 关键字tags aw_type Integer 关键字类型 aw_uniqueid String 关键字来源编号 by_order Integer 关键字顺序 create_time String 创建时间 create_time_stamp Long 创建时间戳 create_time_string String 创建时间戳 create_user String 创建人 create_user_id String 创建人ID delete_time String 更新时间 delete_user String 删除人 description String 描述 dft_check_point_list Array of objects 默认检查点列表 dft_custom_header Array of objects 默认请求头参数对象 dft_retry_interval String 重试间隔时间 (ms) 为空表示不等待 dft_retry_times String 重试次数 dft_variable_list Array of objects 默认变量信息 extra_info Object 补充信息 group_name String 分组名 has_code Integer 是否存在代码 id String 编号 import_package Array of strings 导入的包名 interface_label String 接口的x-extend字段说明 is_favorite Integer 是否收藏 method String 方法名 name String 关键字名 nameView String 在页面上显示的名字 origin_project String 源工程信息 param_type_and_dft_value Array of objects 参数类型和参数默认值 project_id String 工程编号 protocol_type String 协议类型 public_aw_lib Object 公共关键字信息 public_aw_lib_id String 公共关键字id region String region信息 return_type String 返回值类型 root_id String 根节点编号 source String 关键字依赖的类源 special_type Integer 特殊关键字类型 tmssCaseNumber String 关键字编号（来自测试管理服务） tmss_case_id String 测试用例id update_time String 更新时间 update_time_stamp Long 更新时间戳 update_time_string String 更新时间戳（字符串格式） update_user String 更新人 warningMsg String 警告信息 yamlName String yaml名称

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 status String success或error result ResultValueInteger object 请求的返回的数据对象 error ApiError object 失败时的error信息 request_id String 由接口调用方传入，建议使用UUID保证请求的唯一性。 server_address String 本次请求的受理的服务地址。 表4 ResultValueInteger 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 value Integer 实际的数据类型：单个对象，集合 或 NULL reason String 业务失败的提示内容 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表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 接口调用失败错误信息

URI GET /v4/{project_id}/resources/{resource_uri}/exist 表1 路径参数 参数 是否必选 参数类型 描述 resource_uri 是 String 需求或缺陷的id project_id 是 String 项目id 表2 Query参数 参数 是否必选 参数类型 描述 version_uri 是 String 测试计划uri type 是 Integer 关联类型(需求：3，缺陷：4)

响应示例 状态码： 200 OK { "status" : "success", "result" : { "value" : [ { "uri" : "v91k0000vrroldin", "name" : "自定义1", "filter" : "{\"moduleIds\":[\"undefined\"]}", "updator" : "efdb403066474ab08836b9eeaaa23bca", "region" : "cn-north-7", "service_type" : -1, "stage_type" : 2, "user_id" : "efdb403066474ab08836b9eeaaa23bca", "creator" : "efdb403066474ab08836b9eeaaa23bca", "create_time" : "2024-09-12 11:25:56", "create_time_timestamp" : 1726111556000, "update_time" : "2024-09-12 11:25:56", "update_time_timestamp" : 1726111556000, "project_uuid" : "3d2378e0fc504c638f48b21377d6add1" } ] } }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 status String success|error result ResultValueHomePageOverviewVo object 请求的返回的数据对象 error ApiError object 失败时的error信息 request_id String 由接口调用方传入，建议使用UUID保证请求的唯一性。 server_address String 本次请求的受理的服务地址。 表4 ResultValueHomePageOverviewVo 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 value HomePageOverviewVo object 实际的数据类型：单个对象，集合 或 NULL reason String 业务失败的提示内容 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表5 HomePageOverviewVo 参数 参数类型 描述 case_completion_rate CaseCompletionRateVo object 计算用例完成率 case_pass_rate CasePassRateVo object 计算用例通过率 defect_status DefectStatusVo object 统计缺陷信息，组装缺陷状态分组信息 defect_severity DefectSeverityVo object 统计缺陷信息，组装缺陷重要程度分组信息 表6 CaseCompletionRateVo 参数 参数类型 描述 total Integer 总用例数 completion_rate String 用例完成率 status_number_list Array of NameAndValueVo objects 用户自定义状态对应的用例数目 表7 CasePassRateVo 参数 参数类型 描述 pass_rate String 用例通过率 result_number_list Array of NameAndValueVo objects 用户自定义结果对应的用例数目 表8 DefectStatusVo 参数 参数类型 描述 total Integer 缺陷数 not_solved Integer 未关闭缺陷数 status_number_list Array of NameAndValueVo objects 每种状态的名称和对应的数目 表9 DefectSeverityVo 参数 参数类型 描述 total Integer 缺陷数 severity_number_list Array of NameAndValueVo objects 每种重要程度的名称和对应的数目 表10 NameAndValueVo 参数 参数类型 描述 name String 名称 value Integer 值 表11 ApiError 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码： 400 表12 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息 状态码： 401 表13 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息 状态码： 404 表14 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息 状态码： 500 表15 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息

请求示例 质量报告看板统计 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 表3 响应Body参数 参数 参数类型 描述 status String success|error result ResultValueOverviewVo object 请求的返回的数据对象 error ApiError object 失败时的error信息 request_id String 由接口调用方传入，建议使用UUID保证请求的唯一性。 server_address String 对内接口才有此属性 表4 ResultValueOverviewVo 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 value OverviewVo object 当接口对内且status为failed时，存放只有reason的ApiError对象 reason String 业务失败的提示内容，对内接口才有此值 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表5 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 看板项目的需求覆盖率 表6 DefectVo 参数 参数类型 描述 total Integer 缺陷数 not_solved Integer 未关闭缺陷数 severity_number_list Array of NameAndValueVo objects 组装缺陷每种重要程度的名称和对应的数目 表7 CasePassRateVo 参数 参数类型 描述 pass_rate String 用例通过率 result_number_list Array of NameAndValueVo objects 用户自定义结果对应的用例数目 表8 CaseCompletionRateVo 参数 参数类型 描述 total Integer 总用例数 completion_rate String 用例完成率 status_number_list Array of NameAndValueVo objects 用户自定义状态对应的用例数目 表9 NameAndValueVo 参数 参数类型 描述 name String 名称 value Integer 值 表10 RiskRatingVo 参数 参数类型 描述 risk_rating Integer 测试计划的风险等级 risk_description String 测试计划的风险描述 表11 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) 表12 CoverRateVo 参数 参数类型 描述 testing Integer 统计测试中的需求 finished Integer 统计已完成的需求 not_tested Integer 统计未测试的需求 total_number Integer 计算需求总数 cover_rate String 需求覆盖率 表13 ApiError 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码： 400 表14 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息 状态码： 401 表15 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息 状态码： 404 表16 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息 状态码： 500 表17 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 work_item_ids 否 Array of strings 需求/缺陷ID列表 project_uuid 否 String 项目id version_uri 否 String 版本uri relate_type 否 String 关联关系类型

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 status String success|error; result ResultValueStringForOk object 请求结果 表5 ResultValueStringForOk 参数 参数类型 描述 value String ok 状态码： 400 表6 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码： 401 表7 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码： 404 表8 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码： 500 表9 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 否 String 报表名称 type 否 Integer 报表类型 1：首页用例库， 2：质量报告 workpiece_type 否 String 工件类型(用例：case,测试套：suite) analysis_dim_row 否 String 分析维度 compare_dim_column 否 String 对比维度 filter 否 ReportFilter object 过滤条件 表4 ReportFilter 参数 是否必选 参数类型 描述 creatorIds 否 String 创建人 ownerIds 否 String 所属人 ranks 否 String 级别 releaseIds 否 String releaseId status 否 String 状态 moduleIds 否 String 级别 results 否 String 结果 labelIds 否 String 标签 startTime 否 String 开始时间 endTime 否 String 结束时间 isAssociateIssue 否 String 是否关联需求

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

URI POST /GT3KServer/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 版本uri

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

请求示例 批量更新测试用例结果 post https://{endpoint}/v1/projects/efdb403066474ab08836b9eeaaa23bca/testcases/result { "execute_list" : [ { "description" : "这是一条备注信息", "duration" : 10, "end_time" : 16659743037899, "execute_id" : "efdb403066474ab08836b9eeaaa23bca", "result_id" : "0", "testcase_id" : "b66aab5469cc4ab39b0dda8e644a42a4" } ], "service_id" : 13 }

URI POST /v1/projects/{project_id}/testcases/result 表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 UpdateTestCaseResultBean objects 测试用例状态信息，数组长度小于等于50 service_id 是 Integer 参数解释: 测试用例类型ID，指定指定对应类型的测试用例ID 约束限制: 需要与execute_list中提供的用例的执行方式一致 取值范围: 大于0整数 默认取值: 不涉及 表4 UpdateTestCaseResultBean 参数 是否必选 参数类型 描述 description 否 String 参数解释: 用于记录该次结果执行的备注信息 约束限制: 不涉及 取值范围: 长度小于2000字符 默认取值: 不涉及 duration 否 Long 参数解释: 执行用例持续时长ms 约束限制: 更新状态时该字段必传 取值范围: 大于0整数，单位ms 默认取值: 不涉及 end_time 是 Long 参数解释: 用例结束执行的时间戳 约束限制: 在执行结束时该字段必传 取值范围: 符合时间戳格式 默认取值: 不涉及 execute_id 是 String 参数解释: 注册服务执行id 约束限制: 该值不允许重复 取值范围: 长度为1-32位字符（字母或数字） 默认取值: 不涉及 result_id 是 String 参数解释: 测试用例结果 约束限制: 不涉及 取值范围: 0-成功，1-失败，5-执行中，6-停止 默认取值: 不涉及 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 表5 响应Body参数 参数 参数类型 描述 code String 错误码 data BasePageInfoReview object 返回体 message String 错误信息 表6 BasePageInfoReview 参数 参数类型 描述 list Array of Review objects 列表 limit Integer 每页显示的条目数量，最大支持200条 offset Integer 起始偏移量，表示从此偏移量开始查询，offset大于等于0，小于等于100000 pages Integer 页数 size Integer 记录数 total Long 总数 表7 Review 参数 参数类型 描述 charger String 名称 create_time String 创建时间 creator String 创建人 deleted String 是否删除 description String 描述 id String id 主键 mindmap_id String 脑图id node_id String 节点id node_value String 节点值 status String 状态 type String 类型 update_time String 更新时间 状态码： 400 表8 响应Body参数 参数 参数类型 描述 code String 接口调用错误码 data String 接口调用返回体 message String 接口调用错误信息 状态码： 401 表9 响应Body参数 参数 参数类型 描述 code String 接口调用错误码 data String 接口调用返回体 message String 接口调用错误信息 状态码： 404 表10 响应Body参数 参数 参数类型 描述 code String 接口调用错误码 data String 接口调用返回体 message String 接口调用错误信息 状态码： 500 表11 响应Body参数 参数 参数类型 描述 code String 接口调用错误码 data String 接口调用返回体 message String 接口调用错误信息

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 params 是 ReviewPageParam object 评审分页参数 表4 ReviewPageParam 参数 是否必选 参数类型 描述 deleted 否 String 是否删除 limit 否 Integer 每页显示的条目数量，最大支持200条 mindmap_id 否 String 脑图ID node_id 否 String 节点ID node_value 否 String 节点内容 offset 否 Integer 起始偏移量，表示从此偏移量开始查询，offset大于等于0，小于等于100000 status 否 String 评审状态 type 否 String 评审类型

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 status String success|error result ResultValueCustomizedFilterVo object 请求的返回的数据对象 error ApiError object 失败时的error信息 request_id String 由接口调用方传入，建议使用UUID保证请求的唯一性。 server_address String 本次请求的受理的服务地址。 表4 ResultValueCustomizedFilterVo 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 value CustomizedFilterVo object 实际的数据类型：单个对象，集合 或 NULL reason String 业务失败的提示内容 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表5 CustomizedFilterVo 参数 参数类型 描述 uri String 自定义过滤器URI name String 自定义过滤器名称 filter String 过滤器内容 type Integer 过滤器类型（1：设计页功能用例，2：设计页接口用例 ，3：执行页功能用例 ，4：执行页接口用例） updator String 更新人 region String 逻辑Region service_type Integer 服务类型 stage_type Integer 阶段过程（2：测试设计，3：测试执行，4：质量报告） user_id String 用户ID creator String 创建人 create_time String 创建时间 create_time_timestamp Long 创建时间时间戳 update_time String 更新时间 update_time_timestamp Long 更新时间时间戳 project_id String 项目ID 表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 OK { "status" : "success", "result" : { "value" : [ { "uri" : "v91k0000vrroldin", "name" : "自定义1", "filter" : "{\"moduleIds\":[\"undefined\"]}", "updator" : "efdb403066474ab08836b9eeaaa23bca", "region" : "cn-north-7", "service_type" : -1, "stage_type" : 2, "user_id" : "efdb403066474ab08836b9eeaaa23bca", "creator" : "efdb403066474ab08836b9eeaaa23bca", "create_time" : "2024-09-12 11:25:56", "create_time_timestamp" : 1726111556000, "update_time" : "2024-09-12 11:25:56", "update_time_timestamp" : 1726111556000, "project_uuid" : "3d2378e0fc504c638f48b21377d6add1" } ] } }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 value TaskListVo object 实际的数据类型：单个对象，集合 或 NULL reason String 业务失败的提示内容 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表5 TaskListVo 参数 参数类型 描述 tasks Array of TaskVo objects 测试任务集合 running_count Integer 正在执行任务数 表6 TaskVo 参数 参数类型 描述 uri String 测试任务URI name String 测试任务名称 stage String 测试阶段 number String 编号 tags String 标签 description String 描述 region String 区域 author_id String 创建人ID author_name String 创建人名称 owner_id String 责任人ID owner_name String 责任人名称 parent_uri String 父任务URI parent_path String 父任务路径 origin_uri String 源任务URI version_uri String 版本URI branch_uri String 分支URI version_name String 版本名称 creation_date String 创建时间 create_date_timestamp Long 创建时间时间戳 update_time String 更新时间 update_time_timestamp Long 更新时间时间戳 relation_change_time String 关联关系修改时时间 relation_change_time_timestamp Long 关联关系修改时间时间戳 test_case_condition String 动态任务用例过滤条件 updator_id String 修改人Id updator_name String 修改人名称 relation_changer_id String 关联关系修改人Id service_type Integer 服务类型ID service_type_name String 服务类型名称 tag_list Array of strings 标签名称集合 module_id String 模块ID module_name String 模块名称 module_path String 模块path module_path_name String 模块路径名称 release_dev String 发布版本号 ext_param String 扩展参数 execute_way Integer 执行方式（1：串行，2：并行） execute_type Integer 执行类型（0：冒烟，1：定时） status_code Integer 生命周期状态Code status_name String 生命周期状态名称 result_code Integer 执行结果Code result_name String 执行状态名称 execute_status_code Integer Echo执行状态Code execute_status_name String Echo执行状态名称 executor_id String 执行人ID executor_name String 执行人名称 execute_latest_time String 最近执行时间 execute_latest_time_timestamp Long 最近执行时间时间戳 execute_duration String 执行时长 execute_times Integer 执行次数 project_uuid String 项目ID case_operation_info CaseOperationVo object 任务关联用例信息 assign_case_num Integer 关联用例数 finish_case_num Integer 已完成用例数量 assign_defect_num Integer 关联缺陷数量 task_assign_msg String 任务关联用例变更提示信息 iterator_version_uri String 测试套所属迭代uri，非迭代下创建的测试套返回null result_number_list Array of NameAndValueAndCodeVo objects 用户自定义结果对应的用例数目 finish_date String 测试套完成时间 finish_date_timestamp Long 测试套完成时间戳 plan_start_date String 计划开始时间 plan_start_timestamp Long 计划开始时间戳 plan_end_date String 计划结束时间 plan_end_timestamp Long 计划结束时间戳 expiration_status Integer 测试套超期状态值，分别为：无状态(null)、未超期(0)、即将超期(1)、已超期(2)、延期完成(3)、按期完成(4) expiration_status_name String 测试套超期状态名称，分别为：无状态(不显示状态)、未超期(Unexpired)、即将超期(About to expire)、已超期(Expired)、延期完成(Delayed completion)、按期完成(On schedule completion) 表7 CaseOperationVo 参数 参数类型 描述 test_cases_info Array of TaskAssignCaseVo objects 用例关联信息 set_up_cases_info Array of TaskAssignCaseVo objects 前置用例关联信息 tear_down_cases_info Array of TaskAssignCaseVo objects 后置用例关联信息 表8 TaskAssignCaseVo 参数 参数类型 描述 sort Integer 排序顺序 case_uri String 用例uri is_available Integer 是否可用 test_case_name String 用例名称 test_case_number String 用例编号 表9 NameAndValueAndCodeVo 参数 参数类型 描述 name String 名称 value Integer 值 code String 编码 状态码： 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 POST /GT3KServer/v4/{project_id}/versions/{version_id}/tasks/batch-query 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: 项目id，对应"需求管理 CodeArts Req"项目唯一标识，测试计划管理页面地址栏url https://{host}/cloudtestportal/project/{project_id}/testplan中project_id变量的值 约束限制: 不涉及 取值范围: 项目uuid应符合如下规则：长度等于32位，包含大小写字母、数字 默认取值: 不涉及 version_id 是 String 版本URI

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 uris 否 Array of strings 测试任务URI集合 keyword 否 String 关键字查询，任务名或编号 tags 否 Array of strings 标签集合 own 否 Boolean 是否是我的 service_type 否 Integer 服务类型 release_dev_list 否 Array of strings 发布版本号集合 result_codes 否 Array of strings 结果Code集合 status_codes 否 Array of strings 状态Code集合 owner_ids 否 Array of strings 责任人ID集合 executor_ids 否 Array of strings 执行者ID集合 creator_ids 否 Array of strings 创建者ID集合 sort_field 否 String 排序字段 sort_type 否 String 排序方式 page_no 否 Integer 当前页数 page_size 否 Integer 每页条数 is_polling_query 否 Boolean 是否轮询查询 is_query_associated_case_list 否 Boolean 是否获取关联用例列表 plan_start_start_timestamp 否 Long 计划开始时间过滤起始时间戳 plan_start_end_timestamp 否 Long 计划开始时间过滤结束时间戳 plan_end_start_timestamp 否 Long 计划结束时间过滤起始时间戳 plan_end_end_timestamp 否 Long 计划结束时间过滤结束时间戳 expiration_status_list 否 Array of integers 测试套超期状态过滤，超期状态值分别为：无状态(null)、未超期(0)、即将超期(1)、已超期(2)、延期完成(3)、按期完成(4)

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 uri String 资源URI type String 资源类型 author String 创建人 name String 名称 rank Integer 级别 version String 待测版本 owner String 处理者ID creator String 创建人ID iterations String 关联迭代 description String 描述 region String 区域 last_modifier String 最后修改人 last_modified String 最后修改时间 last_modified_timestamp Long 修改时间时间戳 last_change_time String 最后变更时间 version_uri String 版本URI origin_uri String 源资源URI parent_uri String 父资源URI parent_path String 父资源路径 creation_version_uri String 创建版本URI creation_date String 创建时间 creation_date_timestamp Long 创建时间时间戳 author_name String 创建人名称 comment String 备注 number String 编号 is_master Integer 是否为Master分支 is_iterator Integer 是否为迭代 plan_start_date String 开始时间 plan_end_date String 结束时间 service_id String 微服务ID service_name String 微服务名 pbi_id String PBI ID pbi_name String PBI信息 plan_id String 计划ID metric_pbi_ids String 度量PBI ID metric_pbi_id_names String 度量PBI名称 last_syn_date String 最后同步时间 is_closed String 版本是否关闭 asyn_git String 是否同步git库 schema_no Integer schema编号 finish_date String 迭代实际完成时间 owner_name String 处理者名称 creator_name String 创建人名称 current_stage String 当前所处阶段 service_types String 服务类型 risk_rating Integer 风险等级 risk_des String 风险描述 project_uuid String 项目ID domain_id String 租户ID pi_id String pi的id 状态码： 400 表6 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码： 401 表7 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码： 404 表8 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码： 500 表9 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容

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

请求示例 更新自定义测试服务类型用例 put https://{endpoint}/v1/projects/efdb403066474ab08836b9eeaaa23bca/testcases/1234 { "extend_info" : { "assigned_id" : "b66aab5469cc416hestdda8e644a42a4", "defect_id_list" : [ { "issueId" : "018fd45b181c4f6aa94afac9f769d625", "title" : "缺陷1" }, { "issueId" : "018fd45b181c4f6aa94afac9f769d625", "title" : "缺陷2" }, { "issueId" : "018fd45b181c4f6aa94afac9f769d625", "title" : "缺陷3" } ], "description" : "这是一条描述信息", "fix_version_id" : "1234", "issue_id" : "b66aab5469cc4ab39b0dda8e644a42a4", "label_list" : [ "标签1" ], "module_id" : "b66aab5469cc4ab39b0dda8e644a42a4", "preparation" : "需要满足的前置条件", "status_id" : "0", "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" : "1.1.0.1" }, "name" : "testcase", "rank_id" : "2", "service_id" : 13, "testcase_number" : "1234" }

响应参数 状态码： 200 表6 响应Body参数 参数 参数类型 描述 assigned_user AssignedUserInfo object 处理者信息 execute_count Integer 测试用例执行次数 extend_info ExtendInfo object 测试用例扩展信息 name String 测试用例名称 project_id String 软开云项目唯一标识 rank_id String 测试用例等级 result_id String 测试用例执行结果 service_id Integer 注册测试类型服务接口返回的服务id status_id String 测试用例状态 testcase_id String 用例uri,测试用例唯一标识,长度11-34位字符（字母和数字）。 testcase_number String 测试用例编号 表7 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 更新者信息 表8 AssignedUserInfo 参数 参数类型 描述 id String id信息 name String 名称信息 表9 ExternalServiceCaseStep 参数 参数类型 描述 expect_result String 测试用例预期结果信息，长度为[0-500]位字符 test_step String 测试步骤描述信息，长度为[0-500]位字符 表10 ExtendAuthorInfo 参数 参数类型 描述 id String id信息 name String 名称信息 time 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 接口调用失败错误信息

URI PUT /v1/projects/{project_id}/testcases/{testcase_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目ID。 testcase_id 是 String 用例uri,测试用例唯一标识,长度11-34位字符（字母和数字）。