华为云用户手册

响应示例 状态码： 200 OK { "status" : "success", "result" : { "total" : 2, "value" : [ { "uri" : "v9210000vrmhplil", "author" : "e8d27b5521a64fb28a8fd9c99cd66eb3", "region" : "cn-north-7", "changes" : [ { "field_name" : "defectId", "old_key" : "", "new_key" : "8444611", "new_object_value" : [ "用例3新建" ], "new_object_key" : [ "8444611" ], "new_tracker_names" : [ "Bug" ], "new_board_info" : [ ], "new_display_ids" : [ "8444611" ] } ], "resource_uri" : "v91j0000vq997opk", "resource_type" : "TestCase", "version_uri" : "v91i0000vq98suq1", "creation_date" : "2024-09-10 10:49:43", "create_date_timestamp" : 1725936583000, "author_name" : "xxx" }, { "uri" : "v91i0000vrmh72fb", "author" : "e8d27b5521a64fb28a8fd9c99cd66eb3", "region" : "cn-north-7", "changes" : [ { "field_name" : "svnScriptPath", "new_value" : "fail1.py" } ], "resource_uri" : "v91j0000vq997opk", "resource_type" : "TestCase", "version_uri" : "v91i0000vq98suq1", "creation_date" : "2024-09-10 10:39:34", "create_date_timestamp" : 1725935974000, "author_name" : "xxx" } ], "page_size" : 10, "page_no" : 1 } }

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 status String success|error; result ResultValueListResourceHistoryVo object 请求的返回的数据对象 error ApiError object 失败时的error信息 request_id String 由接口调用方传入，建议使用UUID保证请求的唯一性。 server_address String 本次请求的受理的服务地址 表6 ResultValueListResourceHistoryVo 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 value Array of ResourceHistoryVo objects 实际的数据类型：单个对象，集合 或 NULL reason String 错误信息 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表7 ResourceHistoryVo 参数 参数类型 描述 uri String 资源历史记录Uri author String 资源历史记录创建人 region String 逻辑region changes Array of ResourceChangeVo objects 资源历史记录字段变更列表 resource_uri String 资源uri resource_type String 资源类型 version_uri String 分支/迭代uri creation_date String 创建时间 create_date_timestamp Long 创建时间时间戳 author_name String 创建人名称 not_empty Boolean 非空 project_id String 项目id 表8 ResourceChangeVo 参数 参数类型 描述 only_new_value Boolean 只展示新值 field_name String 变更字段 old_value String 旧值 old_tracker_name String 旧工作项类型 new_tracker_name String 新工作项类型 new_value String 新值 old_key String 原key new_key String 新key old_object_value Object 旧对象值 new_object_value Object 新对象值 old_object_key Object 新object key new_object_key Object 新object key old_tracker_names Object 旧tracker_names new_tracker_names Object 新旧tracker_names old_board_info Array of JSONObject objects 变更前归属看板信息，用例关联工作项信息使用 new_board_info Array of JSONObject objects 变更后归属看板信息，用例关联工作项信息使用 old_display_ids Array of strings 老值，用于前端展示。IPD和Xboard项目的需求和缺陷sequenceId列表，非IPD和Xboard项目的需求和缺陷Id列表。由于需求只能关联一个，所以需求取第一个值 new_display_ids Array of strings 新值，用于前端展示。IPD和Xboard项目的需求和缺陷sequenceId列表，非IPD和Xboard项目的需求和缺陷Id列表。由于需求只能关联一个，所以需求取第一个值 old_test_item_path_name String 变更前路径（目录名称路径） new_test_item_path_name String 变更后路径（目录名称路径） custom_field_type String 测试用例自定义字段类型 表9 JSONObject 参数 参数类型 描述 empty Boolean 是否为空 additionalProperties Object 变更后归属看板信息，用例关联工作项信息使用 表10 ApiError 参数 参数类型 描述 code String 业务失败的错误码 reason 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 接口调用失败错误信息

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 conditions 否 Array of SearchCondition objects 搜索条件 type 否 String 资源类型 useOffset 否 Boolean 是否使用offset分页 project_id 否 String 项目ID version_uri 否 String 分支/迭代uri page_no 否 Integer 页码 page_size 否 Integer 每页展示条数 表4 SearchCondition 参数 是否必选 参数类型 描述 field_name 否 String 字段名 field_value 否 String 字段值 operator 否 String 数据库字段操作 sour_value 否 String 源值 tar_value 否 String 目标值 field_type 否 String 字段类型

响应示例 状态码： 200 SUC CES S { "status" : "success", "result" : { "page_no" : 1, "page_size" : 1, "total_page" : 1, "total_size" : 1, "page_list" : [ { "id" : "10f9bbc251754dfe9a778e16ec58accb", "type" : "String", "name" : "hostURL", "property" : "127.0.0.1:8080", "description" : null, "locked" : null, "groupId" : "f56886074692465d8b3a50c74c136b53", "category" : "Static", "isSensitiveInfo" : false, "isSensitiveModified" : false, "sourceId" : null, "variableType" : 0, "functionParams" : "127.0.0.1:8080", "dynamicParamFlag" : false, "sensitiveInfoSetterUser" : null, "sensitiveInfoSetterTime" : null, "currentPermission" : null, "region" : "cn-north-7", "create_time_string" : "2024-04-29 15:43:05 GMT+08:00", "update_time_string" : "2024-04-29 15:43:05 GMT+08:00", "create_time_stamp" : 1714376585000, "update_time_stamp" : 1714376585000, "create_user" : "devcloud_devcloud_s00314720_01", "create_time" : "2024-04-29T03:43:05+0800", "update_user" : "devcloud_devcloud_s00314720_01", "update_time" : "2024-04-29T03:43:05+0800", "parent_id" : "26927372bbae40b184fe764e7a0d21f7", "node_type" : null, "node_id" : null, "parent_node_id" : null, "by_order" : 1 } ] }, "reason" : null, "error" : null, "code" : null }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 code String 错误码 error CommonResponseErrorOfAPITest object 统一错误返回 reason String 失败原因 result PageResults object 结果 status String 状态 表5 CommonResponseErrorOfAPITest 参数 参数类型 描述 code String 错误码 reason String 错误原因 表6 PageResults 参数 参数类型 描述 page_list Array of VariableRes objects 全局变量列表 page_no Integer 当前分页 page_size Integer 分页大小 total_page Integer 全部分页 total_size Long 全局变量总数 表7 VariableRes 参数 参数类型 描述 by_order Integer 节点顺序 category String 节点所在目录 create_time String 创建时间 create_time_stamp Long 创建时间（时间戳格式） create_time_string String 创建时间（字符串格式） create_user String 创建人 currentPermission String 当前用户权限 description String 备注信息 dynamicParamFlag Boolean 是否为动态变量 functionParams String 变量参数 groupId String 分组信息 id String 变量编号 isSensitiveInfo Boolean 是否为敏感变量 isSensitiveModified Boolean 敏感字段是否被修改 locked Integer 是否被锁定 name String 变量名 node_id String 节点编号 node_type Integer 节点类型 parent_id String 所属父节点编号 parent_node_id String 父节点编号 property String 变量值 region String 所在region sensitiveInfoSetterTime String 敏感变量设置时间 sensitiveInfoSetterUser String 敏感变量设置者 sourceId String 复制的全局变量的源id type String 变量类型 update_time String 更新时间 update_time_stamp Long 更新时间（时间戳格式） update_time_string String 更新时间（字符串格式） update_user String 更新人 variableType Integer 变量类型

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

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

请求参数 表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]位字符

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 relations 否 Array of RelationInfo objects 关联关系 tracker_id 否 String 工作项类型id version_uri 否 String 版本uri task_uri 否 String 测试套id add_to_iterator 否 Boolean 是否将需求添加到迭代 project_uuid 否 String 项目id 表4 RelationInfo 参数 是否必选 参数类型 描述 dr_number 是 String 需求id test_case_uri 否 String 用例uri relate_type 是 String 资源类型 resource_type 否 String 资源类型 source_system 否 String 来源系统 association_number 否 String 关联资源编号 region 否 String 逻辑region，外部使用公有云实际区域，内部使用默认值

响应示例 状态码： 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的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 offset 是 Integer 起始偏移量，表示从此偏移量开始查询，offset大于等于0，小于等于100000 limit 是 Integer 每页显示的条目数量，最大支持200条 execution_type_id 否 Integer 用例测试执行方式ID version_id 否 String 分支/测试计划ID，长度11-34位字符（字母和数字）。

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

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 workitem_list 是 Array of WorkItemInfo objects 关联需求 is_delete_case 否 Boolean 是否删除需求关联的用例 表4 WorkItemInfo 参数 是否必选 参数类型 描述 work_item_id 是 String 工作项编号 has_child 是 Boolean 是否有子需求 is_open 是 Boolean 是否展开 child_list 否 Array of WorkItemInfo objects 子需求

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 page_no Integer 当前页 page_size Integer 每页大小 total_page Integer 总页数 total_size Integer 总条数 page_list Array of AlarmTemplateInfo objects 查询到的告警模板 表5 AlarmTemplateInfo 参数 参数类型 描述 create_time String 创建时间 create_user String 创建者 id String UUID remarks String 备注 test_service_id String 服务id update_time String 修改时间 update_user String 修改者 name String 模板名称 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误编码 error_msg String 错误原因 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误编码 error_msg String 错误原因 状态码： 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误编码 error_msg String 错误原因

响应参数 状态码： 200 表7 响应Body参数 参数 参数类型 描述 id String CTS 需要返回资源id name String CTS需要返回资源name success_list Array of strings 成功批量更新用例的id列表 failed_list Array of strings 没有批量更新用例的id列表 状态码： 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的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 steps 否 Array of TestCaseStepInfo objects 测试步骤 attachments 否 Array of TestCaseAttachmentInfo objects 附件 author 否 String 创建人 name 是 String 名称 rank 否 Integer 用例等级 owner 否 String 处理人 preparation 否 String 前置条件 remark 否 String 备注 stage 否 String 测试阶段 activity 否 String 测试类型 keywords 否 String 关键词 market 否 String apitest标记是否代码已提交 designer 否 String 设计者 tags 否 String 标签 region 否 String 逻辑region，外部使用公有云实际区域，内部使用默认值 relate_type 否 String 关联资源类型 service_type 否 Integer 服务类型 only_change_script 否 String 更新接口用例的java脚本路径标识 add_to_iterator 否 String 需求添加到迭代标识 need_update_relation 否 String 是否修改关联关系 creation_version_uri 否 String 创建版本Uri number 否 String 用例编号 case_type 否 Integer 用例类型 platform_type 否 Integer 执行平台类型 test_type 否 Integer 测试类型 design_note 否 String 设计描述 test_step 否 String 测试步骤 expect_output 否 String 期望结果 env_type 否 String 测试环境类型 exe_platform 否 String 执行平台 testcase_project 否 String 测试工程 svn_script_path 否 String 脚本路径 map_restrict 否 String 约束条件 network_script_name 否 String 网络脚本名 auto_type 否 Integer 自动化类型，非自动化:0, 是自动化:1 to_be_auto_exec 否 Integer 被自动化执行 last_result 否 String 最后一次结果 last_result_uri 否 String 最后一次结果Uri feature_uri 否 String 目录Uri interface_name 否 String 测试接口名 snp_no 否 String 网络问题ID dr_relation_id 否 String 关联需求编号 test_base_num 否 String 测试基数 automatically_executed 否 Integer 是否被自动化执行 first_execute_time 否 String 第一次执行时间 detect_type 否 String 检测类型 execute_param 否 String 执行参数 test_feature 否 String 分析领域 is_contract_testcase 否 Integer 是否是契约用例，0:表示非契约用例, 1：表示契约用例 time_cost 否 Double 总共耗时 custom_field_1 否 String 自定义字段1 custom_field_2 否 String 自定义字段2 custom_field_3 否 String 自定义字段3 custom_field_4 否 String 自定义字段4 custom_field_5 否 String 自定义字段5 custom_field_6 否 String 自定义字段6 custom_field_7 否 String 自定义字段7 custom_field_8 否 String 自定义字段8 custom_field_9 否 String 自定义字段9 custom_field_10 否 String 自定义字段10 custom_field_11 否 String 自定义字段11 custom_field_12 否 String 自定义字段12 custom_field_13 否 String 自定义字段13 custom_field_14 否 String 自定义字段14 custom_field_15 否 String 自定义字段15 custom_field_16 否 String 自定义字段16 custom_field_17 否 String 自定义字段17 custom_field_18 否 String 自定义字段18 custom_field_19 否 String 自定义字段19 custom_field_20 否 String 自定义字段20 custom_field_21 否 String 自定义字段21 custom_field_22 否 String 自定义字段22 custom_field_23 否 String 自定义字段23 custom_field_24 否 String 自定义字段24 custom_field_25 否 String 自定义字段25 be_auto_type_time 否 String 记录用例由非自动化变为自动化类型的时间 compare_number 否 String 配对用例编号 scene_flag 否 String 场景标识 base_flag 否 String 场景标识 para_validator 否 String 区别是否从yaml中生成的用例，默认false knet_node_id 否 String knet节点id last_exe_author 否 String 最后一次执行用户 cloud_carrier 否 String 运营商 market_place 否 String 应用市场 test_mind_id 否 String 脑图id test_mind_url 否 String 脑图url commit_url 否 String git提交url test_pattern_number 否 String 测试模式编号 test_factor_number 否 String 测试因子编号 status_code 否 String 状态Code result_code 否 String 结果Code release_id 否 String 迭代ID label_id 否 String 标签ID label_names 否 Array of strings 用例操作时，标签名列表 module_id 否 String 模块ID execute_latest_time 否 String 最后执行时间 execute_duration 否 String 执行时长 is_keyword 否 Integer 是否关键用例 release_dev 否 String 测试版本号 new_created 否 Integer 是否用户新增用例 execute_parameter 否 String 执行参数 project_uuid 否 String 项目ID，外部使用项目ID，内部使用默认值 version_uri 否 String 分支或者迭代uri case_list 否 Array of CaseInfo objects 更新用例信息列表 case_id_list 否 Array of strings 批量更新用例id列表 表4 TestCaseStepInfo 参数 是否必选 参数类型 描述 test_step 否 String 测试步骤 expect_result 否 String 预期结果 step_actual 否 String 步骤的实际结果 step_result 否 String 步骤结果 表5 TestCaseAttachmentInfo 参数 是否必选 参数类型 描述 override 否 Boolean 附件是否要被覆盖 doc_id 否 String 文档id file_name 否 String 文件名 file_path 否 String 文件路径 file_type 否 String 文件类型 file_size 否 String 文件大小 override_id 否 String 重复用例ID related_type 否 String 相关类型 store_file_name 否 String 保存文件名 system_type 否 String 系统区分 storage_system 否 String 区分文件存储系统 表6 CaseInfo 参数 是否必选 参数类型 描述 case_id 否 String 用例id script_url 否 String 脚本路径

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

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 relations 否 Array of RelationInfo objects 关联关系 tracker_id 否 String 工作项类型id version_uri 否 String 版本uri task_uri 否 String 测试套id add_to_iterator 否 Boolean 是否将需求添加到迭代 project_uuid 否 String 项目id 表4 RelationInfo 参数 是否必选 参数类型 描述 dr_number 是 String 需求id test_case_uri 否 String 用例uri relate_type 是 String 资源类型 resource_type 否 String 资源类型 source_system 否 String 来源系统 association_number 否 String 关联资源编号 region 否 String 逻辑region，外部使用公有云实际区域，内部使用默认值

响应参数 状态码： 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 业务失败的提示内容

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

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

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

URI GET /v2/projects/{project_id}/plans 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id，项目唯一标识，固定长度32位字符，获取方式请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 是 Integer 起始偏移量，表示从此偏移量开始查询， offset大于等于0 limit 是 Integer 每页显示的条目数量,最大支持200条 name 否 String 模糊查询使用(针对测试计划名称) current_stage 否 String 测试计划所处阶段（create,design,execute,report） fix_version_ids 否 String 测试计划关联的迭代。迭代id以逗号间隔 branch_uri 否 String 分支Uri，默认master query_all_version 否 Boolean 是否查询所有版本下测试计划，默认为false。若值为true, 查询所有版本下测试计划; 若为false, 查询branch_uri指定分支下的测试计划, branch_uri为空时默认为master

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 error CommonResponseErrorOfobject object 统一错误返回 reason String 错误原因 result Object 结果 status String 状态值，如success、error 表4 CommonResponseErrorOfobject 参数 参数类型 描述 code String 错误码 reason String 错误原因

响应示例 状态码： 200 SUCCESS { "status" : "success", "result" : { "paramNames" : [ { "dynamicParamFlag" : false, "isSensitive" : false, "name" : "hostURL", "category" : "Static" } ] }, "reason" : null, "error" : null }