华为云用户手册

响应参数 状态码：204 No Content 状态码：400 表3 响应Body参数 参数 参数类型 描述 error_code String 参数解释 接口调用失败错误码 取值范围 不涉及 error_msg String 参数解释 接口调用失败错误信息 取值范围 不涉及 状态码：401 表4 响应Body参数 参数 参数类型 描述 error_code String 参数解释 接口调用失败错误码 取值范围 不涉及 error_msg String 参数解释 接口调用失败错误信息 取值范围 不涉及 状态码：404 表5 响应Body参数 参数 参数类型 描述 error_code String 参数解释 接口调用失败错误码 取值范围 不涉及 error_msg String 参数解释 接口调用失败错误信息 取值范围 不涉及 状态码：500 表6 响应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 表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 参数解释: 接口调用失败错误信息 取值范围: 不涉及

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释 用户Token。通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 约束限制 不涉及 取值范围 字符串长度不少于1，不超过100000 默认取值 不涉及 表3 请求Body参数 参数 是否必选 参数类型 描述 work_item_ids 否 Array of strings 参数解释 需求/缺陷ID列表 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及 project_uuid 否 String 参数解释 项目id，对应"需求管理 CodeArts Req"项目唯一标识，测试计划管理页面地址栏url https://{host}/cloudtestportal/project/{project_id}/testplan中project_id变量的值 约束限制 不涉及 取值范围 项目uuid应符合如下规则：长度等于32位，包含大小写字母、数字 默认取值 不涉及 version_uri 否 String 参数解释 版本uri 约束限制 不涉及 取值范围 11到34位英文或数字 默认取值 不涉及 relate_type 否 String 参数解释 关联关系类型 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及

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

响应示例 状态码：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。 约束限制: 项目唯一标识，固定长度32位 取值范围: 字母、数字 默认取值: 不涉及 plan_id 是 String 参数解释: 测试计划id，测试计划的唯一标识，长度11-34位字符 约束限制: 测试计划唯一标识，长度11-34位 取值范围: 字母、数字 默认取值: 不涉及 表2 Query参数 参数 是否必选 参数类型 描述 offset 是 Long 参数解释: 起始偏移量，表示从此偏移量开始查询， offset大于等于0 参数限制: 大于等于0 取值范围: 0-2000000 默认取值: 不涉及 limit 是 Long 参数解释: 每页显示的条目数量,最大支持200条 参数限制: 大于等于0 取值范围: 1-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 取值范围: 11-34位字符 project_id String 参数解释: 项目id，项目唯一标识，固定长度32位字符 取值范围: 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 参数解释: 接口调用失败错误信息 取值范围: 不涉及

响应示例 状态码：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 参数解释: 需求类型名称 取值范围: true:已关联 false:未关联 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 参数解释: 起始偏移量，表示从此偏移量开始查询 约束限制: 不涉及 取值范围: 大于等于0，小于等于100000的数字 默认取值: 不涉及 limit 是 Integer 参数解释: 每页显示的条目数量，最大支持200条 约束限制: 不涉及 取值范围: 大于等于0，小于等于200的数字 默认取值: 不涉及 execution_type_id 否 Integer 参数解释: 用例测试执行方式ID 约束限制: 不涉及 取值范围: 大于等于0的数字 默认取值: 不涉及 version_id 否 String 参数解释: 分支/测试计划ID 约束限制: 不涉及 取值范围: 长度11-34位字符（字母和数字） 默认取值: 不涉及

响应参数 状态码：200 表5 响应Body参数 参数 参数类型 描述 status String 参数解释 success|error; 取值范围 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的值） 约束限制 不涉及 取值范围 字符串长度不少于1，不超过100000 默认取值 不涉及 表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参数 参数 参数类型 描述 status String 参数解释 success|error; 取值范围 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位，包含大小写字母、数字 默认取值: 不涉及

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 约束限制 不涉及 取值范围 字符串长度不少于1，不超过100000 默认取值 不涉及 表3 请求Body参数 参数 是否必选 参数类型 描述 [数组元素] 是 Array of strings 质量报告看板统计请求体

请求参数 表1 请求Body参数 参数 是否必选 参数类型 描述 project_uuid 否 String 项目id version_uri 否 String 版本uri service_type 否 Integer 服务类型 service_types 否 Array of integers 服务类型集合 parent_id 否 String 父节点id issue_ids 否 Array of strings 需求id task_uri 否 String 任务udi

响应参数 状态码：200 表2 响应Body参数 参数 参数类型 描述 status String success|error result ResultValueListIssueCaseCountVo object 请求的返回的数据对象 error ApiError object 失败时的error信息 request_id String 由接口调用方传入，建议使用UUID保证请求的唯一性。 server_address String 本次请求的受理的服务地址 表3 ResultValueListIssueCaseCountVo 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 value Array of IssueCaseCountVo objects 实际的数据类型：单个对象，集合 或 NULL reason String 业务失败的提示内容 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表4 IssueCaseCountVo 参数 参数类型 描述 issue_id String 特性uri case_count Integer 用例数量 表5 ApiError 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：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 表4 响应Body参数 参数 参数类型 描述 status String success|error; result ResultValueNoAssociationWorkItemQueryVo object 请求的返回的数据对象 error ApiError object 失败时的error信息 request_id String 由接口调用方传入，建议使用UUID保证请求的唯一性。 server_address String 本次请求的受理的服务地址 表5 ResultValueNoAssociationWorkItemQueryVo 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 value NoAssociationWorkItemQueryVo object 实际的数据类型：单个对象，集合 或 NULL reason String 业务失败的提示内容 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表6 NoAssociationWorkItemQueryVo 参数 参数类型 描述 no_associate_list Array of NoAssociateWorkItemVo objects 未关联的需求列表 表7 NoAssociateWorkItemVo 参数 参数类型 描述 issue_id String 需求id issue_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 参数解释: 接口调用失败错误信息 取值范围: 不涉及

请求示例 移除用例前判断是否关联需求 post https://{endpoint}/v4/30649eb093c2479d92c74c75d36ef280/iterators/v91i0000vq98suqq/testcases/issues/batch-query { "project_uuid" : "30649eb093c2479d92c74c75d36ef280", "case_ids" : [ "v91k0000vrnkilvl" ], "iterator_uri" : "v91i0000vq98suqq" }

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

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

响应示例 状态码：200 OK { "status" : "success", "result" : { "total" : 1, "value" : [ { "uri" : "v91t0000vrn1e27h", "name" : "XXX项目第一期测试报告", "creator" : "e8d27b5521a64fb28a8fd9c99cd66eb3", "version_uri" : "v91i0000vq98suqq", "branch_uri" : "v91i0000vq98suq1", "version_name" : "样例测试计划", "branch_name" : "基线", "test_conclusion" : "商用发布", "defect_details_by_severity" : [ ], "defect_details_by_module" : [ ], "create_time" : "2024-09-10 15:23:01", "create_timestamp" : 1725952981000, "creator_name" : "xxx" } ], "page_size" : 10, "page_no" : 1 } }

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 status String success|error; result ResultValueListTestReportVo object 请求的返回的数据对象 error ApiError object 失败时的error信息 request_id String 由接口调用方传入，建议使用UUID保证请求的唯一性。 server_address String 本次请求的受理的服务地址 表5 ResultValueListTestReportVo 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 value Array of TestReportVo objects 实际的数据类型：单个对象，集合 或 NULL reason String 业务失败的提示内容 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表6 TestReportVo 参数 参数类型 描述 uri String 测试报告Uri name String 测试报告名称 creator String 创建人ID updator String 修改人ID version_uri String 测试计划Uri branch_uri String 分支Uri version_name String 测试计划名称 branch_name String 分支名称 test_conclusion String 测试结论 test_conclusion_details String 测试结论描述 defect_resolution_rate String 缺陷解决率 defect_resolution_score String 缺陷解决分数 case_execution_rate String 用例执行率 case_execution_score String 用例执行分数 case_pass_rate String 用例通过率 case_pass_score String 用例通过分数 issue_pass_rate String 需求通过率 issue_pass_score String 需求通过分数 issue_coverage_rate String 需求覆盖率 issue_coverage_score String 需求覆盖分数 project_residual_defect_index String 项目总遗留DI iterator_residual_defect_index String 计划新增DI case_automation_details CaseAutomationDetailsVo object 用例自动化率详情 case_validity_ratio String 用例有效性比例 issue_details IssuePassDetailsVo object 需求通过情况 case_details Array of NameAndValueVo objects 用例通过情况 defect_details_by_severity Array of IdAndNameAndValueVo objects 缺陷严重程度 defect_details_by_module Array of IdAndNameAndValueVo objects 缺陷按照模块分布情况 case_pass_rate_by_test_type Array of DetailTestTypeCasePassRateVo objects 每个测试类型的用例通过率 test_report_custom_report_detail Array of CustomReportListVo objects 测试报告自定义报告详情 create_time String 创建时间 create_timestamp Long 创建时间戳 creator_name String 创建人名 update_time String 修改时间 update_timestamp Long 修改时间戳 updator_name String 修改人名 project_id String 项目ID risk_analysis String 风险分析 表7 CaseAutomationDetailsVo 参数 参数类型 描述 case_automation_rate String 用例自动化率 service_type_number_list Array of NameAndValueVo objects 服务类型对应的用例数目 表8 IssuePassDetailsVo 参数 参数类型 描述 testing Integer 统计测试中的需求 finished Integer 统计已完成的需求 not_tested Integer 统计未完成的需求 表9 NameAndValueVo 参数 参数类型 描述 name String 名称 value Integer 值 表10 IdAndNameAndValueVo 参数 参数类型 描述 name String 名称 value Integer 值 id String id 表11 DetailTestTypeCasePassRateVo 参数 参数类型 描述 test_type Integer 测试类型 case_pass_rate String 用例通过率 表12 CustomReportListVo 参数 参数类型 描述 id String 参数解释: 报表id 取值范围: 不涉及 name String 参数解释: 报表名称 取值范围: 不涉及 filter ReportFilter object 过滤条件 workpiece_type String 工件类型(用例：case,测试套：task) analysis_dimension String 分析维度 compare_dimension String 对比维度 chart_data Array of ReportChartDataVo objects 报表数据 表13 ReportFilter 参数 参数类型 描述 creatorIds String 参数解释: 创建人 取值范围: 不涉及 ownerIds String 参数解释: 所属人 取值范围: 不涉及 ranks String 参数解释: 级别 取值范围: 不涉及 releaseIds String 参数解释: releaseId 取值范围: 不涉及 status String 参数解释: 状态 取值范围: 不涉及 moduleIds String 参数解释: 级别 取值范围: 不涉及 results String 参数解释: 结果 取值范围: 不涉及 labelIds String 参数解释: 标签 取值范围: 不涉及 startTime String 参数解释: 开始时间 取值范围: 不涉及 endTime String 参数解释: 结束时间 取值范围: 不涉及 isAssociateIssue String 参数解释: 是否关联需求 取值范围: 不涉及 表14 ReportChartDataVo 参数 参数类型 描述 id String 报表id name String 报表名称 analyze_dim ReportDimVo object 对比维度数据 compare_dim Array of ReportDimVo objects 对比维度数据 表15 ReportDimVo 参数 参数类型 描述 id String id name String 名称 value Integer 值 表16 ApiError 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：400 表17 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及 状态码：401 表18 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及 状态码：404 表19 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及 状态码：500 表20 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及

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

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

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

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