华为云用户手册

  • 响应示例 状态码: 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}/testcases/{testcase_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目UUID,项目唯一标识,固定长度32位字符(字母和数字)。获取方式请参见获取项目ID。 testcase_id 是 String 用例uri,测试用例唯一标识,长度11-34位字符(字母和数字)。
  • 响应示例 状态码: 201 OK [ { "detail" : [ { "added" : [ { "id" : "ID", "name" : "名称" } ], "deleted" : [ { "id" : "ID", "name" : "名称" } ], "journalized_type" : "plan", "type" : "resource/attribute", "updated" : [ { "attribute_type" : "name", "new_value" : "tester", "old_value" : "test" } ] } ], "operate_time" : "2021-07-10", "operator" : { "id" : "ID", "name" : "名称" }, "plan_id" : "c7c2ddf2ea914164ac6ee76bf11a30ea", "project_id" : "9b26f58ec29943f681804a6628779a23" } ]
  • URI GET /v1/projects/{project_id}/plans/{plan_id}/journals 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id,项目唯一标识,固定长度32位字符,获取方式请参见获取项目ID。 plan_id 是 String 测试计划id,测试计划的唯一标识,长度11-34位字符 表2 Query参数 参数 是否必选 参数类型 描述 offset 是 Long 起始偏移量,表示从此偏移量开始查询, offset大于等于0 最小值:0 最大值:999 缺省值:0 limit 是 Long 每页显示的条目数量,最大支持200条 最小值:1 最大值:200 缺省值:200
  • 响应参数 状态码: 201 表4 响应Body参数 参数 参数类型 描述 [数组元素] Array of TestPlanJournalList objects 项目下查询测试计划操作历史返回结构 表5 TestPlanJournalList 参数 参数类型 描述 detail Array of TestPlanJournalDetail objects 历史记录详情 operate_time String 变更时间 operator NameAndId object 测试计划迭代编号与迭代名称 plan_id String 测试计划id project_id String 项目id,项目唯一标识,固定长度32位字符 表6 TestPlanJournalDetail 参数 参数类型 描述 added Array of NameAndId objects 测试计划资源的添加记录(工作项或者测试用例) deleted Array of NameAndId objects 测试计划资源的移除记录(工作项或者测试用例) journalized_type String 表明该条变更记录的具体变更类型,例如测试用例(testCase),需求(issue) type String 表明该条变更记录属于基础信息变更还是资源(需求添加移除、用例添加移除)变更 updated Array of AttributeChange objects 测试计划基础信息变更,包括计划名称,测试类型,计划处理者、版本号、关联迭代、开始日期、截至日期、描述 表7 NameAndId 参数 参数类型 描述 id String 对象编号 name String 对象名称 表8 AttributeChange 参数 参数类型 描述 attribute_type String 发生变更的测试计划属性 new_value String 变更后的取值 old_value 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 表4 响应Body参数 参数 参数类型 描述 testsuite_id String 生成的测试套的id 最小长度:32 最大长度:32 testcase_ids Array of strings 生成的测试用例uri列表 数组长度:0 - 500 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 最小长度:16 最大长度:16 error_detail Array of CommonResponseDetail objects 接口调用失败的详情信息,非参数校验失败没有该结构 数组长度:0 - 500 error_msg String 接口调用失败错误信息 最小长度:3 最大长度:100 表6 CommonResponseDetail 参数 参数类型 描述 step_name String 记录错误步骤名称 最小长度:3 最大长度:100 testcase_name String 用例名称 最小长度:3 最大长度:128 fail_content String 记录实际错误内容值 最小长度:3 最大长度:128 fail_keys String 记录包含错误的关键字 最小长度:3 最大长度:128 fail_source String 记录错误部位header name等 最小长度:3 最大长度:100 fail_type String 记录错误类型 最小长度:3 最大长度:100 stage String 记录包含错误阶段 最小长度:2 最大长度:50 状态码: 401 表7 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息 状态码: 403 表8 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息 状态码: 404 表9 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息 状态码: 500 表10 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:100000 表3 请求Body参数 参数 是否必选 参数类型 描述 testsuite_name 是 String 要生成的测试套名称 最小长度:3 最大长度:128 repository_id 是 String 仓库id 最小长度:32 最大长度:32 repository_branch 是 String 仓库分支 最小长度:3 最大长度:100 file_path 是 String 仓库中yaml或json文件的相对路径,仅支持swagger 2.0版本的yaml和json文件 最小长度:6 最大长度:128
  • 响应参数 状态码: 201 表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 接口调用失败错误信息
  • 响应示例 状态码: 201 Created { "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" }
  • 请求示例 创建自定义测试服务类型用例 post https://{endpoint}/v1/projects/efdb403066474ab08836b9eeaaa23bca/testcases { "extend_info" : { "assigned_id" : "1111", "description" : "这是一段用例描述信息", "fix_version_id" : "11111", "issue_id" : "11111", "label_list" : [ "标签名称" ], "module_id" : "模块号", "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" : "11111" }, "name" : "testcase", "rank_id" : "2", "service_id" : 13, "testcase_number" : "1234" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 extend_info 否 ExternalServiceCaseInfo object 测试用例其他扩展信息 name 是 String 页面上显示的用例名称,长度为[3-128]位字符 rank_id 否 String 测试用例等级,可选值为[0,1,2,3,4],不填时默认为2 service_id 是 Integer 该值由注册接口返回,取值范围为10-9999 testcase_number 否 String 用例编号,不填该值时会自动生成,长度为[3-128]位字符 表4 ExternalServiceCaseInfo 参数 是否必选 参数类型 描述 assigned_id 否 String 处理者id信息,长度为0-32。 description 否 String 测试用例描述信息,长度为[0-500]位字符 fix_version_id 否 String 迭代号,长度为[0-32]位字符 issue_id 否 String 用例关联的需求id信息,长度为[0-32]位字符 label_list 否 Array of strings 标签名称列表,数组长度小于等于30。单个名称长度不超过25。 module_id 否 String 模块号,长度为0-32。 preparation 否 String 执行该测试用例时需要满足的前置条件,长度为[0-500]位字符 steps 否 Array of ExternalServiceCaseStep objects 测试步骤,数组长度小于10 test_version_id 否 String 测试版本号,长度为1-64。 表5 ExternalServiceCaseStep 参数 是否必选 参数类型 描述 expect_result 否 String 测试用例预期结果信息,长度为[0-500]位字符 test_step 否 String 测试步骤描述信息,长度为[0-500]位字符
  • 响应参数 状态码: 201 表4 响应Body参数 参数 参数类型 描述 [数组元素] Array of TestPlanDetail objects 项目下查询测试计划列表返回结构 表5 TestPlanDetail 参数 参数类型 描述 creator creator object 测试计划创建者信息 current_stage String 当前测试计划所处的阶段 design_stage design_stage object 测试计划设计阶段信息 end_date String 测试计划截止时间 execute_stage execute_stage object 测试计划执行阶段信息 expire_day Integer 获取超期时间,正值表示已超期 finish_date String 测试计划实际完成时间(测试计划实际完成指测试计划下所有测试用例处于完成状态) iteration NameAndId object 测试计划迭代编号与迭代名称 name String 测试计划名称 owner owner object 测试计划处理者信息 plan_id String 测试计划id project_id String 项目id report_stage report_stage object 报告阶统计数据 start_date String 测试计划开始时间 表6 creator 参数 参数类型 描述 id String 测试计划创建者id nick_name String 测试计划创建者的昵称,当用户未设置昵称时不返回该字段 user_name String 测试计划创建者的用户名称 表7 design_stage 参数 参数类型 描述 case_count Integer 用例个数 issue_count Integer 需求个数 issue_covered_count String 已被用例关联的需求个数 表8 execute_stage 参数 参数类型 描述 case_pass_rate String 用例通过率,按用例结果计算 completed_defect_count Integer 已完成缺陷个数 defect_count Integer 缺陷个数 executed_case_count Integer 已执行用例数, 按用例状态统计 表9 NameAndId 参数 参数类型 描述 id String 对象编号 name String 对象名称 表10 owner 参数 参数类型 描述 id String 测试计划处理者id name String 测试计划处理者名称,优先返回nickName,不存在则返回userName nick_name String 测试计划处理者的昵称,当用户未设置昵称时不返回该字段 user_name String 测试计划处理者的用户名称 表11 report_stage 参数 参数类型 描述 case_complete_rate 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 接口调用失败错误信息
  • 响应示例 状态码: 201 OK [ { "creator" : { "id" : "efdb403066474ab08836b9eeaaa23bca", "nick_name" : "测试Tester", "user_name" : "测试Tester" }, "current_stage" : "design", "design_stage" : { "case_count" : 2, "issue_count" : 0, "issue_covered_count" : "0" }, "end_date" : "2021-07-10", "execute_stage" : { "case_pass_rate" : "0.00%", "completed_defect_count" : 0, "defect_count" : 0, "executed_case_count" : 0 }, "expire_day" : -4, "finish_date" : "2021-07-10", "iteration" : { "id" : "ID", "name" : "名称" }, "name" : "测试", "owner" : { "id" : "efdb403066474ab08836b9eeaaa23bca", "name" : "测试Tester", "nick_name" : "测试Tester", "user_name" : "测试Tester" }, "plan_id" : "c7c2ddf2ea914164ac6ee76bf11a30ea", "project_id" : "9b26f58ec29943f681804a6628779a23", "report_stage" : { "case_complete_rate" : "100.00%" }, "start_date" : "2021-07-10" } ]
  • URI GET /v1/projects/{project_id}/plans 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id,项目唯一标识,固定长度32位字符,获取方式请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 name 否 String 模糊查询使用(针对测试计划名称) current_stage 否 String 测试计划所处阶段(create,design,execute,report) offset 是 Integer 偏移量,取值范围为0-2000000 limit 是 Integer 每页显示的条目数量,取值范围为1-100
  • 响应示例 状态码: 200 OK { "values" : [ { "name" : "测试用例", "owner" : { "id" : "id", "name" : "name" }, "status" : { "id" : "id", "name" : "name" }, "result" : { "id" : "id", "name" : "name" }, "module" : { "id" : "id", "name" : "name" }, "iteration" : { "id" : "id", "name" : "name" }, "id" : "001rv8lk4he", "number" : "10010", "description" : "用例描述", "rank_id" : "2", "project_id" : "7672757", "execution_type" : { "id" : "id", "name" : "name" }, "test_type" : { "id" : 1, "name" : "显示值" }, "create_info" : { "time" : "2021-11-06 00:00:01", "timestamp" : 1660617231016, "user_id" : "efdb403066474ab08836b9eeaaa23bca", "user_name" : "测试Tester" }, "execute_info" : { "time" : "2021-11-06 12:00:00", "timestamp" : 1660617231016, "duration" : "00:00:10", "user_id" : "efdb403066474ab08836b9eeaaa23bca", "user_name" : "测试Tester", "execute_times" : 1 }, "associate_issue_info" : { "associate" : true, "issue_id" : "4654022505049243648", "tracker_id" : "1", "board_id" : "443ef10e6c954b00a24ed6ce6864854a", "tracker_name" : "IR" }, "associate_defect_info" : { "associate" : true, "associate_count" : 1 } } ], "total" : 1 }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 values Array of ExternalTestCaseVo objects 用例详情列表 total Integer 用例总数 表5 ExternalTestCaseVo 参数 参数类型 描述 name String 用例名称 owner NameAndIdVo object 处理者信息 status NameAndIdVo object 状态信息 result NameAndIdVo object 结果信息 module NameAndIdVo object 模块信息 iteration NameAndIdVo object 迭代信息 id String 用例ID number String 用例编号 description String 用例描述 rank_id String 用例等级 project_id String 项目ID execution_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 关联缺陷信息 表6 NameAndIdVo 参数 参数类型 描述 id String ID name String 名称 表7 IntegerIdAndNameVo 参数 参数类型 描述 id Integer 数据库存储数字 name String 页面显示值 表8 CreateInfoVo 参数 参数类型 描述 time String 创建时间 timestamp Long 创建时间时间戳 user_id String 用户ID user_name String 用户名称 表9 ExecuteInfoVo 参数 参数类型 描述 time String 执行开始时间 timestamp Long 执行开始时间时间戳 duration String 执行时长 user_id String 用户ID user_name String 用户名称 execute_times Integer 执行次数 表10 AssociateIssueInfoVo 参数 参数类型 描述 associate Boolean 是否已关联 issue_id String 需求ID tracker_id String 需求类型 board_id String 工作项层级ID tracker_name String 需求类型名称 表11 AssociateDefectInfoVo 参数 参数类型 描述 associate Boolean 是否已关联 associate_count Integer 关联缺陷数 状态码: 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 接口调用失败错误信息
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:100000 表3 请求Body参数 参数 是否必选 参数类型 描述 offset 是 Integer 起始偏移量,表示从此偏移量开始查询,offset大于等于0,小于等于100000 最小值:0 最大值:100000 limit 是 Integer 每页显示的条目数量,最大支持200条 最小值:1 最大值:200 execution_type_id 否 Integer 用例测试执行方式ID version_id 否 String 分支/测试计划ID,长度11-34位字符(字母和数字)。 最小长度:11 最大长度:34
  • 请求示例 批量删除自定义测试服务类型用例 post https://{endpoint}/v1/projects/efdb403066474ab08836b9eeaaa23bca/testcases/batch-delete { "service_id" : 13, "testcase_id_list" : [ "97b82412f1ca4628803b918c27ed09de", "97b82412f1ca4628803b918c27ed09de", "97b82412f1ca4628803b918c27ed09de" ] }
  • 响应参数 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息 状态码: 401 表5 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息 状态码: 404 表6 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息 状态码: 500 表7 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 service_id 是 Integer 注册测试类型服务接口返回的服务id,取值范围为10-9999 testcase_id_list 是 Array of strings 测试用例uri唯一标识,数组长度小于50个
  • 响应参数 状态码: 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的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 server_host 是 String server_host是由用户提供的域名。 我们会通过此域名进行接口调用,请以https/http开头,长度小于等于128位字符。 TestHub将会通过此域名下的接口,保证服务数据与用户系统数据的一致性。 service_name 是 String 测试类型名称,用于界面显示,不能使用当前保留名,长度小于等于128。
  • 请求参数 表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 service_id 是 Integer 注册测试类型服务接口返回的服务id 表4 TestCaseExecuteBean 参数 是否必选 参数类型 描述 execute_id 是 String 注册服务执行id,该值不允许重复,不超过32位字符 result_id 是 String 测试用例结果,(0-成功,1-失败,5-执行中,6-停止) start_time 是 Long 用例开始执行的时间戳,在执行开始时该字段必传 testcase_id 是 String 用例uri,测试用例唯一标识,长度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 接口调用失败错误信息
  • 请求示例 批量执行测试用例 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 }
  • 响应示例 状态码: 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" }
  • 响应参数 状态码: 200 表4 响应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 测试用例编号 表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 接口调用失败错误信息
  • URI GET /v1/projects/{project_id}/testcase 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目UUID,项目唯一标识,固定长度32位字符(字母和数字)。获取方式请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 testcase_number 是 String 用例编号,长度为[3-128]位字符
  • 请求示例 批量更新测试用例结果 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 }
  • 响应参数 状态码: 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 接口调用失败错误信息
共100000条