华为云用户手册

  • 请求示例 { "page_no" : 1, "page_size" : 15, "feature_uri" : "42f27e960b6a41b89c093cbdc657a07d", "service_type" : -1, "stage_type" : "3", "custom_field_info" : [ ], "version_uri" : "v9020001099p8qk4", "just_return_id" : true }
  • 响应参数 状态码:200 表4 响应Body参数 参数 参数类型 描述 status String success|error result ResultValueListTestCaseListVo object 参数解释: 查询用例列表返回的数据对象 取值范围: true: 有更多 false: 无更多 error ApiError object 失败时的error信息 request_id String 由接口调用方传入,建议使用UUID保证请求的唯一性。 server_address String 本次请求的受理的服务地址 表5 ResultValueListTestCaseListVo 参数 参数类型 描述 total Integer 参数解释: 符合条件的所有记录数 取值范围: 起始记录数 大于 实际总条数时, 值为0, 分页请求才有此值 value Array of TestCaseListVo objects 参数解释: 实际的数据类型:单个对象,集合 或 NULL 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 page_size Integer 参数解释: 每页展示条数 取值范围: 不涉及 page_no Integer 参数解释: 页码 取值范围: 不涉及 has_more Boolean 参数解释: 是否有更多 取值范围: true: 有更多 false: 无更多 表6 TestCaseListVo 参数 参数类型 描述 uri String 参数解释: 用例URI 取值范围: 不涉及 name String 参数解释: 用例名称 取值范围: 不涉及 owner NameAndIdVo object 参数解释: 处理者 取值范围: 不涉及 status NameAndIdVo object 参数解释: 状态 取值范围: 不涉及 result NameAndIdVo object 参数解释: 结果 取值范围: 不涉及 module NameAndIdVo object 参数解释: 模块 取值范围: 不涉及 iteration NameAndIdVo object 参数解释: 迭代 取值范围: 不涉及 exeplatform String 参数解释: 执行平台 取值范围: apittest,其他三方执行平台 number String 参数解释: 用例编号 取值范围: 不涉及 description String 参数解释: 用例描述 取值范围: 不涉及 rank_id String 参数解释: 用例描述 取值范围: 0|1|2|3|4 feature_uri String 参数解释: 目录URI 取值范围: 不涉及 release_dev String 参数解释: 版本号 取值范围: 不涉及 is_keyword Boolean 参数解释: 是否组合关键字 取值范围: true: 组合关键字 false:不组合关键字 script_url String 参数解释: 脚本路径 取值范围: 不涉及 report_url String 参数解释: 实时报告地址 取值范围: 不涉及 project_uuid String 参数解释: 项目id,对应"需求管理 CodeArts Req"项目唯一标识,测试计划管理页面地址栏url https://{host}/cloudtestportal/project/{project_id}/testplan中project_id变量的值 取值范围: 项目uuid应符合如下规则:长度等于32位,包含大小写字母、数字 service_type NameAndIdVo object 参数解释: 服务类型信息 取值范围: 不涉及 test_type IntegerIdAndNameVo object 参数解释: 测试类型信息 取值范围: 不涉及 create_info CreateInfoVo object 参数解释: 创建信息 取值范围: 不涉及 execute_info ExecuteInfoVo object 参数解释: 执行信息 取值范围: 不涉及 associate_issue_info AssociateIssueInfoVo object 参数解释: 关联需求信息 取值范围: 不涉及 associate_defect_info AssociateDefectInfoVo object 参数解释: 关联缺陷信息 取值范围: 不涉及 case_type Integer 参数解释: 用例类型 取值范围: 不涉及 labels String 参数解释: 用例标签名称列表 取值范围: 不涉及 custom_field_info Array of CustomFieldVo objects 参数解释: 自定义字段信息 取值范围: 不涉及 is_test_design Boolean 参数解释: 是否来自测试设计 取值范围: null:不限,false:否来自测试设计,true:来自测试设计 last_modified Long 参数解释: 最后修改时间 取值范围: null:不限 review_status Integer 参数解释: 用例评审状态 取值范围: null:0至127 表7 NameAndIdVo 参数 参数类型 描述 id String 参数解释 ID 取值范围 不涉及 name String 参数解释 名称 取值范围 不涉及 表8 IntegerIdAndNameVo 参数 参数类型 描述 id Integer 参数解释 数据库存储数字 取值范围 不涉及 name String 参数解释 页面显示值 取值范围 不涉及 表9 CreateInfoVo 参数 参数类型 描述 time String 参数解释: 创建时间 取值范围: 不涉及 timestamp Long 参数解释: 创建时间时间戳 取值范围: 不涉及 user_id String 参数解释: 用户ID 取值范围: 不涉及 user_name String 参数解释: 用户名称 取值范围: 不涉及 表10 ExecuteInfoVo 参数 参数类型 描述 time String 参数解释: 执行开始时间 取值范围: 不涉及 timestamp Long 参数解释: 执行开始时间时间戳 取值范围: 不涉及 duration String 参数解释: 执行时长 取值范围: 不涉及 user_id String 参数解释: 用户ID 取值范围: 不涉及 user_name String 参数解释: 用户名称 取值范围: 不涉及 execute_times Integer 参数解释: 执行次数 取值范围: 不涉及 表11 AssociateIssueInfoVo 参数 参数类型 描述 associate Boolean 参数解释: 是否已关联 取值范围: true: 已关联 false:未关联 issue_id String 参数解释: 需求ID 取值范围: 不涉及 tracker_id String 参数解释: 需求类型 取值范围: 不涉及 board_id String 参数解释: 工作项层级ID 取值范围: 不涉及 tracker_name String 参数解释: 需求类型名称 取值范围: 不涉及 表12 AssociateDefectInfoVo 参数 参数类型 描述 associate Boolean 参数解释: 是否已关联 取值范围: true:已关联 false:未关联 associate_count Integer 参数解释: 关联缺陷数 取值范围: 不涉及 表13 CustomFieldVo 参数 参数类型 描述 type String 参数解释: 字段类型 取值范围: 单行文本text、多行文本textArea、单选框radio、多选框checkBox、日期date、数字number、单选用户user value String 参数解释: 测试用例自定义字段值 取值范围: 不涉及 custom_field_param String 参数解释: 项目用例自定义字段入参或者返回参数名称 取值范围: 不涉及 user_name String 参数解释: 用户名 取值范围: user类型测试用例自定义字段对应用户名,其它类型字段不返回 表14 ApiError 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码:400 表15 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及 状态码:401 表16 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及 状态码:404 表17 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及 状态码:500 表18 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及
  • 请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 keyword 否 String 关键字查询,用例名或编号 exeplatforms 否 Array of strings 执行平台 own 否 Boolean 是否是我的 useOffset 否 Boolean 是否使用offset分页 queryByDisplayCfg 否 Boolean 是否表头配置查询,如果为true,则未设置展示的字段不返回 version_uri 否 String 版本URI case_uris 否 Array of strings 用例URI集合 owner_ids 否 Array of strings 处理者ID集合 status_codes 否 Array of strings 状态Code集合 rank_ids 否 Array of strings 用例等级ID集合 module_ids 否 Array of strings 模块ID集合 issue_id 否 String 需求编号 creator_ids 否 Array of strings 创建者ID集合 result_codes 否 Array of strings 结果Code集合 iteration_ids 否 Array of strings 归属迭代ID集合 create_start_time 否 String 创建开始时间 create_end_time 否 String 创建结束时间 associated_issue 否 Boolean 是否关联需求(null:不限,false:未关联,true:已关联) associated_defects 否 Boolean 是否关联缺陷(null:不限,false:未关联,true:已关联) include_sub_issue 否 Boolean 是否查询子需求关联的用例,默认true include_sub_feature 否 Boolean 是否查询子目录的用例,默认true label_ids 否 Array of strings 标签ID集合 execute_start_time 否 String 执行开始时间 execute_end_time 否 String 执行结束时间 executor_ids 否 Array of strings 执行者ID集合 test_types 否 Array of strings 类型 is_keyword 否 Boolean 是否组合关键字 issue_tree_search 否 Boolean 是否是需求树点击的查询关联用例 service_type 否 Integer 服务类型 service_types 否 Array of integers 服务类型集合 stage_type 否 Integer 阶段过程(2:测试设计,3:测试执行,4:质量报告) feature_uri 否 String 目录URI sort_field 否 String 排序字段 sort_type 否 String 排序方式 page_no 否 Integer 当前页数 page_size 否 Integer 每页条数 case_type 否 Integer 用例类型 custom_field_info 否 Array of QueryCustomFieldsInfo objects 用例自定义字段信息 task_uri 否 String 测试套uri associate_issue_detail 否 Boolean 是否返回需求具体信息(返回需求名称,需求id) not_assign_task 否 Boolean 该字段为false,则查询全量用例,为true表示查询未分配测试套的用例 test_designs 否 Array of booleans 是否来自测试设计(null或者[true, false]:不限,[true]:来自测试设计,[false]:否来自测试设计) review_status 否 Integer 用例评审状态 just_return_id 否 Boolean 部分字段是否仅返回ID,默认为false,为true时部分字段仅返回ID 表3 QueryCustomFieldsInfo 参数 是否必选 参数类型 描述 id 否 Integer 参数解释: 测试用例自定义字段Id 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 values 否 Array of strings 参数解释: 测试用例自定义字段值 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 field_name 否 String 参数解释: 自定义字段名 约束限制: 不涉及 取值范围: 优先取id再取fieldName 默认取值: 不涉及
  • URI POST /GT3KServer/v4/{project_id}/resource-uri 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: 项目id,对应"需求管理 CodeArts Req"项目唯一标识,测试计划管理页面地址栏url https://{host}/cloudtestportal/project/{project_id}/testplan中project_id变量的值 约束限制: 不涉及 取值范围: 项目uuid应符合如下规则:长度等于32位,包含大小写字母、数字 默认取值: 不涉及
  • 响应参数 状态码:200 表3 响应Body参数 参数 参数类型 描述 value String 参数解释 resultObject 取值范围 不涉及 状态码:400 表4 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码:401 表5 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码:404 表6 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码:500 表7 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及
  • 响应参数 状态码:200 表2 响应Body参数 参数 参数类型 描述 value String 参数解释 resultObject 取值范围 不涉及 状态码:400 表3 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码:401 表4 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码:404 表5 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码:500 表6 响应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" }, { "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_uuid 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 参数解释: 接口调用失败错误信息 取值范围: 不涉及
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释 用户Token。通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 约束限制 不涉及 取值范围 字符串长度不少于1,不超过100000 默认取值 不涉及 表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 排序类型
  • 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
  • 请求示例 质量报告按服务类型统计 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 表5 响应Body参数 参数 参数类型 描述 status String success|error result ResultValueListTestTypeOverviewVo object 请求的返回的数据对象 error ApiError object 失败时的error信息 request_id String 由接口调用方传入,建议使用UUID保证请求的唯一性。 server_address String 本次请求的受理的服务地址 表6 ResultValueListTestTypeOverviewVo 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时, 值为0, 分页请求才有此值 value Array of TestTypeOverviewVo objects 实际的数据类型:单个对象,集合 或 NULL reason String 业务失败的提示内容 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表7 TestTypeOverviewVo 参数 参数类型 描述 service_type String 当前已经注册的用例类型,按照从小到大排序 issue_cover_rate String 需求覆盖率 case_pass_rate String 用例通过率 case_completion_rate String 用例完成率 defect_number Integer 缺陷数 表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 参数解释: 接口调用失败错误信息 取值范围: 不涉及
  • 响应示例 状态码:200 OK { "status" : "success", "result" : { "value" : { "uri" : "v9220000vrphnggd", "name" : "样例测试计划 Result2024-09-11", "author" : "e8d27b5521a64fb28a8fd9c99cd66eb3", "round" : 0, "region" : "cn-north-7", "parent_uri" : "v91k0000vrphmjbp", "test_case_uri" : "v91k0000vrphmjbk", "time_cost" : 0, "release_dev" : "", "version_uri" : "v91j0000vldleodb" } } }
  • 响应参数 状态码:200 表4 响应Body参数 参数 参数类型 描述 status String success|error; result ResultValueTestResultVo object 请求的返回的数据对象 error ApiError object 失败时的error信息 request_id String 由接口调用方传入,建议使用UUID保证请求的唯一性。 server_address String 本次请求的受理的服务地址 表5 ResultValueTestResultVo 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时, 值为0, 分页请求才有此值 value TestResultVo object 实际的数据类型:单个对象,集合 或 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_uuid 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 参数解释: 接口调用失败错误信息 取值范围: 不涉及
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 约束限制 不涉及 取值范围 字符串长度不少于1,不超过100000 默认取值 不涉及 表3 请求Body参数 参数 是否必选 参数类型 描述 release_dev 否 String 版本号
  • URI POST /v4/{project_id}/versions/{version_uri}/testcases/{case_uri}/results/init 表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
  • 响应参数 状态码:200 表2 响应Body参数 参数 参数类型 描述 value Boolean 实际的数据类型:单个对象,集合 或 NULL 状态码:400 表3 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码:401 表4 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码:404 表5 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码:500 表6 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及
  • URI GET /v4/{project_id}/tasks/{task_uri}/results/{result_uri} 表1 路径参数 参数 是否必选 参数类型 描述 task_uri 是 String 任务URI result_uri 是 String 测试任务结果URI project_id 是 String 参数解释: 项目id,对应"需求管理 CodeArts Req"项目唯一标识,测试计划管理页面地址栏url https://{host}/cloudtestportal/project/{project_id}/testplan中project_id变量的值 约束限制: 不涉及 取值范围: 项目uuid应符合如下规则:长度等于32位,包含大小写字母、数字 默认取值: 不涉及 表2 Query参数 参数 是否必选 参数类型 描述 page_no 否 Integer 页码 page_size 否 Integer 页大小 result 否 String 结果过滤条件
  • 响应示例 状态码:200 OK { "status" : "success", "result" : { "total" : 1, "value" : { "owner" : "xxx", "total" : 1, "case_result_statics" : { "未执行" : 1 }, "task_result" : { "uri" : "v9220000vrphja3d", "name" : "手工测试", "description" : "", "creator" : "e8d27b5521a64fb28a8fd9c99cd66eb3", "updator" : "e8d27b5521a64fb28a8fd9c99cd66eb3", "task_uri" : "v91k0000vrphio4t", "version_uri" : "v91j0000vldleodb", "creator_name" : "xxx", "create_time" : "2024-09-11 14:43:58", "create_time_timestamp" : 1726037038000, "update_time" : "2024-09-11 14:44:30", "update_time_timestamp" : 1726037070000, "start_time" : "2024-09-11 14:43:58", "start_time_timestamp" : 1726037038000, "end_time" : "2024-09-11 14:43:58", "end_time_timestamp" : 1726037038000, "result_code" : 0, "result_name" : "成功", "finish_flg" : 0 }, "test_result_list" : [ { "steps" : [ ], "test_case_uri" : "v91k0000vrph3iv9", "test_case_name" : "testcase01", "result_name" : "未执行", "time_cost" : 0, "test_case_number" : "42099" } ], "finish_count" : 0 }, "page_size" : 10, "page_no" : 1 } }
  • 响应示例 状态码:200 OK { "total" : 5, "value" : [ { "uri" : "v902000108vdtlr9", "sort" : 1, "stage" : 1, "project_uuid" : "90f8dc52eb7b4c47b853c661152ca62d", "task_uri" : "v902000108vdtlnm", "update_time" : "2025-03-04 14:11:55", "updator_name" : "TMSS01", "updator" : "dfc5347b9b16491e942ce55ce7f79dbc", "case_uri" : "v902000108vdtlme", "is_available" : 1, "test_case_name" : "样例功能用例", "test_case_number" : "008", "status_code" : "7", "status_name" : "完成", "result_code" : "1", "result_name" : "失败", "is_keyword" : 0, "rank_id" : 2 }, { "uri" : "v902000109nhgqtv", "sort" : 2, "stage" : 1, "project_uuid" : "90f8dc52eb7b4c47b853c661152ca62d", "task_uri" : "v902000108vdtlnm", "update_time" : "2025-03-04 14:11:51", "updator_name" : "TMSS01", "updator" : "dfc5347b9b16491e942ce55ce7f79dbc", "case_uri" : "v901000109n3a3mt", "is_available" : 1, "test_case_name" : "用例和备注1", "test_case_number" : "108", "status_code" : "7", "status_name" : "完成", "result_code" : "0", "result_name" : "成功", "is_keyword" : 0, "rank_id" : 2 } ], "page_size" : 2, "page_no" : 1 }
  • URI POST /GT3KServer/v4/{project_id}/tasks/{task_id}/testcases/batch-query 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: 项目id,对应"需求管理 CodeArts Req"项目唯一标识,测试计划管理页面地址栏url https://{host}/cloudtestportal/project/{project_id}/testplan中project_id变量的值 约束限制: 不涉及 取值范围: 项目uuid应符合如下规则:长度等于32位,包含大小写字母、数字 默认取值: 不涉及 task_id 是 String 任务uri
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 约束限制 不涉及 取值范围 字符串长度不少于1,不超过100000 默认取值 不涉及 表3 请求Body参数 参数 是否必选 参数类型 描述 stage 否 Integer 测试用例在任务中的阶段 owners 否 Array of strings 处理人过滤数组 page_no 否 Integer 页码 page_size 否 Integer 页数量 results 否 Array of strings 结果过滤 status 否 Array of strings 状态过滤 version_uri 否 String 分支/迭代uri release_dev 否 String 任务版本过滤条件,影响关联任务的结果查询,查询当前任务版本下的用例最新结果 sort_field 否 String 排序字段 sort_type 否 String 排序方法 feature_uri 否 String 特性目录URI task_result_uri 否 String 测试套结果uri rank_ids 否 Array of integers 用例等级ID集合 key_word 否 String 关键字 issue_id 否 String 需求id associated_issue 否 Boolean 是否关联需求(null:不限,false:未关联,true:已关联) select_all_pages 否 Boolean 是否全选所有页(null:不全选,false:不全选,true:全选),用于任务批量执行结果功能,只返回用例uri,不返回其他信息 is_available 否 Boolean 用例是否可用 is_script_exist 否 Boolean 用例脚本字段是否有值
  • 响应参数 状态码:200 表4 响应Body参数 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时, 值为0, 分页请求才有此值 value Array of TaskAssignCaseDetailVo objects 实际的数据类型:单个对象,集合 或 NULL reason String 业务失败的提示内容 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表5 TaskAssignCaseDetailVo 参数 参数类型 描述 uri String 关联关系uri sort Integer 排序顺序 owner String 责任人id stage Integer 测试阶段 project_uuid String 项目id task_uri String 任务uri update_time String 更新时间 updator_name String 更新人 updator String 更新人id case_uri String 用例uri is_available Integer 是否可用 test_case_name String 用例名称 feature_uri String 用例目录Uri test_case_number String 用例编号 svn_script_path String 脚本路径 status_code String 状态 status_name String 状态名称 result_code String 结果id result_name String 结果名称 owner_name String 责任人名称 execute_latest_time String 最新执行时间 execute_duration String 执行时长 is_keyword Integer 是否是关键用例 net_work_script_name String 脚本名称 rank_id Integer 用例等级 状态码: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 参数解释: 业务失败的提示内容 取值范围: 不涉及
  • 请求示例 POST https://{endpoint}/GT3KServer/v4/features/{feature_id}/children { "project_uuid" : "b318f1f3fcef44dd8d549c3624ea8955", "version_uri" : "v90j0001004q3pfj", "contain_total" : true, "sort_type" : "asc" }
  • 响应示例 状态码:200 OK { "result" : { "value" : [ { "uri" : "v90100010b7rs990", "type" : "TestItem", "author" : "85f7cd3cd8784307a5bb194321bef3c1", "name" : "新增子目录(1)", "last_modifier" : "85f7cd3cd8784307a5bb194321bef3c1", "last_modified" : "2025-03-22 14:08:27", "last_modified_timestamp" : 1742623707424, "last_change_time" : "2025-03-22 14:08:27", "version_uri" : "v901000106dij34m", "parent_uri" : "v901000107pbs1bc", "parent_path" : "/761e569574894180b3ecadc9d9df52b6/v901000106dij34m/v901000107pbs1bc/", "creation_version_uri" : "v901000106dij34m", "creation_date" : "2025-03-22 14:08:27", "creation_date_timestamp" : 1742623707424, "is_feature" : "0", "relate_htsm" : "0", "project_uuid" : "761e569574894180b3ecadc9d9df52b6", "case_total" : 1, "execd_total" : 0, "is_direct_relation" : true, "has_child" : false } ] } }
  • 响应参数 状态码:200 表4 响应Body参数 参数 参数类型 描述 status String success|error result ResultValueListTestItemVo object 请求的返回的数据对象 error ApiError object 失败时的error信息 request_id String 由接口调用方传入,建议使用UUID保证请求的唯一性。 server_address String 本次请求的受理的服务地址。 表5 ResultValueListTestItemVo 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时, 值为0, 分页请求才有此值 value Array of TestItemVo objects 实际的数据类型:单个对象,集合 或 NULL reason String 业务失败的提示内容 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表6 TestItemVo 参数 参数类型 描述 uri String 资源URI type String 资源类型 author String 创建人 name String 名称 rank Integer 级别 owner String 责任人 frequence String frequence值 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_feature String 是否特性 relate_htsm String 是否关联特性 aw_unique_id String aw id test_mind_id String 脑图id test_mind_url String 脑图url project_uuid String 项目id case_total Integer 用例总数 execd_total Integer 执行总数 is_direct_relation Boolean is_direct_relation has_child Boolean 是否有子特性 表7 ApiError 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码:400 表8 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码:401 表9 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码:404 表10 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码:500 表11 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 约束限制 不涉及 取值范围 字符串长度不少于1,不超过100000 默认取值 不涉及 表3 请求Body参数 参数 是否必选 参数类型 描述 owner 否 String 责任人 stage 否 String 阶段 activity 否 String 活动 version_uri 否 String 版本URI task_uri 否 String 任务uri service_type 否 String 用例服务类型 contain_total 否 Boolean 是否包含用例数 project_uuid 否 String 项目id sort_type 否 String 排序类型 page_number 否 Integer 页码 page_size 否 Integer 每页数量
  • 响应参数 状态码:200 表2 响应Body参数 参数 参数类型 描述 status String success|error; ok|failed result ResultValueTestItemVo object 请求的返回的数据对象 error ApiError object 失败时的error信息 request_id String 由接口调用方传入,建议使用UUID保证请求的唯一性。 server_address String 本次请求的受理的服务地址 表3 ResultValueTestItemVo 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时, 值为0, 分页请求才有此值 value TestItemVo object 实际的数据类型:单个对象,集合 或 NULL reason String 业务失败的提示内容 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表4 TestItemVo 参数 参数类型 描述 uri String 资源URI type String 资源类型 author String 创建人 name String 名称 rank Integer 级别 owner String 责任人 frequence String frequence值 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_feature String 是否特性 relate_htsm String 是否关联特性 aw_unique_id String aw id test_mind_id String 脑图id test_mind_url String 脑图url project_uuid String 项目id case_total Integer 用例总数 execd_total Integer 执行总数 is_direct_relation Boolean is_direct_relation has_child 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 参数解释: 接口调用失败错误信息 取值范围: 不涉及
  • 请求示例 POST https://{endpoint}/GT3KServer/v4/features { "name" : "新增子目录(3)", "version_uri" : "v9080000v2teq999", "parent_uri" : "v9080000v2teq999", "project_uuid" : "ffecfceca51d419cbfc2a28e90c93761", "number" : "" }
共100000条
提示

您即将访问非华为云网站,请注意账号财产安全