华为云用户手册

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 status String success|error; result ResultValueListTaskResultVo object 请求的返回的数据对象 error ApiError object 失败时的error信息 request_id String 由接口调用方传入，建议使用UUID保证请求的唯一性。 server_address String 本次请求的受理的服务地址 表5 ResultValueListTaskResultVo 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 value Array of TaskResultVo objects 实际的数据类型：单个对象，集合 或 NULL reason String 业务失败的提示内容 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表6 TaskResultVo 参数 参数类型 描述 uri String URI name String 测试套名称 description String 描述 owner String 责任人 creator String 创建人id updator String 更新人 task_uri String 任务uri owner_name String 责任人名称 release_dev String 发布版本号 version_uri String 分支/迭代uri creator_name String 创建人名称 create_time String 创建时间 create_time_timestamp Long 创建时间时间戳 updator_name String 更新人名称 update_time String 更新时间 update_time_timestamp Long 更新时间时间戳 start_time String 开始时间 start_time_timestamp Long 开始时间时间戳 end_time String 结束时间 end_time_timestamp Long 开始时间时间戳 result_code Integer 执行结果Code result_name String 测试结果名称 finish_flg Integer 测试任务是否执行完成（0：未完成，1：已完成） project_id String 项目id 表7 ApiError 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码： 400 表8 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息 状态码： 401 表9 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息 状态码： 404 表10 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息 状态码： 500 表11 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息

URI GET /v4/{project_id}/tasks/{task_uri}/results 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: 项目id，对应"需求管理 CodeArts Req"项目唯一标识，测试计划管理页面地址栏url https://{host}/cloudtestportal/project/{project_id}/testplan中project_id变量的值 约束限制: 不涉及 取值范围: 项目uuid应符合如下规则：长度等于32位，包含大小写字母、数字 默认取值: 不涉及 task_uri 是 String 任务uri 表2 Query参数 参数 是否必选 参数类型 描述 page_no 是 Integer 页码 page_size 是 Integer 页大小 iterator_uri 否 String 测试计划id release_dev 否 String 发布版本

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 aw_type 否 String AW类型1-普通aw,2-组合aw,3-导入aw cata_type 否 Integer 目录层级 current_project_id 否 String 工程ID is_positive_order 否 Boolean 是否按名称正序排序 page_no 否 Integer 当前页数 page_size 否 Integer 每页多少记录 parent_id 否 String aw目录父编号 search_type 否 String 过滤类型 search_value 否 String 过滤条件

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

响应示例 状态码： 200 SUC CES S { "status" : "success", "result" : { "page_no" : 1, "page_size" : 0, "total_page" : 0, "total_size" : 0, "page_list" : [ ] }, "reason" : null, "error" : null }

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 value Array of IteratorVersionSummaryVo objects 实际的数据类型：单个对象，集合 或 NULL reason String 业务失败的提示内容 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表6 IteratorVersionSummaryVo 参数 参数类型 描述 uri String 资源URI type String 资源类型 author String 创建人 name String 名称 rank Integer 级别 version String 待测版本 owner String 处理者ID creator String 创建人ID iterations String 关联迭代 description String 描述 region String 区域 last_modifier String 最后修改人 last_modified String 最后修改时间 last_modified_timestamp Long 修改时间时间戳 last_change_time String 最后变更时间 version_uri String 版本URI origin_uri String 源资源URI parent_uri String 父资源URI parent_path String 父资源路径 creation_version_uri String 创建版本URI creation_date String 创建时间 creation_date_timestamp Long 创建时间时间戳 author_name String 创建人名称 comment String 备注 number String 编号 is_master Integer 是否为Master分支 is_iterator Integer 是否为迭代 plan_start_date String 开始时间 plan_end_date String 结束时间 service_id String 微服务ID service_name String 微服务名 pbi_id String PBI ID pbi_name String PBI信息 plan_id String 计划ID metric_pbi_ids String 度量PBI ID metric_pbi_id_names String 度量PBI名称 last_syn_date String 最后同步时间 is_closed String 版本是否关闭 asyn_git String 是否同步git库 schema_no Integer schema编号 finish_date String 迭代实际完成时间 owner_name String 处理者名称 creator_name String 创建人名称 current_stage String 当前所处阶段 service_types String 服务类型 risk_rating Integer 风险等级 risk_des String 风险描述 project_uuid String 项目ID domain_id String 租户ID pi_id String pi的id start_date String 计划开始时间 start_date_timestamp Long 计划开始时间时间戳 end_date String 计划结束时间 end_date_timestamp Long 计划结束时间时间戳 actual_start_date String 实际开始时间 actual_start_date_timestamp Long 实际开始时间时间戳 actual_end_date String 实际完成时间 actual_end_date_timestamp Long 实际开始时间时间戳 is_expired String 是否超期 expired_info String 计划过期信息,空代表不超期，否则给出具体超期信息 stages Array of strings 迭代计划，默认包含design,execute,report design DesignSummaryVo object 设计阶段信息汇总 execute ExecuteSummaryVo object 执行阶段信息汇总 report ReportSummaryVo object 报告阶段信息汇总 branch_uri String 所属分支URI branch_name String 所属分支名称 表7 DesignSummaryVo 参数 参数类型 描述 issue_num Integer 需求总数 issue_cover_num Integer 已覆盖需求数 case_num Integer 用例数 表8 ExecuteSummaryVo 参数 参数类型 描述 execute_case_num Integer 已执行用例数 defect_num Integer 缺陷总数 completed_defect_num Integer 已完成缺陷数 case_success_rate String 测试用例通过率 case_execution_rate String 用例执行率 表9 ReportSummaryVo 参数 参数类型 描述 case_success_rate String 用例通过率 case_complete_rate String 用例完成率 状态码： 400 表10 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码： 401 表11 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码： 404 表12 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码： 500 表13 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 uri String URI creator String 创建者 comment String 评论内容 notifier Array of strings 评论通知人 test_case_uri String 测试用例URI create_time String 创建时间 create_time_timestamp Long 创建时间时间戳 update_time String 更新时间 update_time_timestamp Long 更新时间时间戳 project_uuid String 项目UUID version_uri String 版本/测试计划URI display_name String 是否显示通知人 状态码： 400 表5 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码： 401 表6 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码： 404 表7 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码： 500 表8 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 comment 是 String 评论 notifier 否 Array of strings 通知人列表 version_uri 否 String 分支uri/测试计划uri

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 status String 是否请求成功 result Array of packageUsage objects 套餐用量信息 error CommonResponseErrorOfAPITest object 错误详情 表4 packageUsage 参数 参数类型 描述 name String 套餐类型 used_percent Integer 套餐用量 表5 CommonResponseErrorOfAPITest 参数 参数类型 描述 code String 错误码 reason String 错误原因

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 max_running_time Integer 自定义时长 is_long_run String 是否长期运行 状态码： 401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误编码 error_msg String 错误原因 状态码： 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误编码 error_msg String 错误原因 状态码： 404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误编码 error_msg String 错误原因

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

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

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

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 project_uuid String 项目id cover_file_name String cover文件名称 background_file_name String 背景文件名称 logo_file_name String logo文件名称 状态码： 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 业务失败的提示内容

请求示例 更新测试套任务 put https://{endpoint}/v4/300c6295a54c4c698608c878f47ddd59/tasks/v91j0000vldlep5u { "description" : "", "id" : "v91j0000vldlep5u", "name" : "样例功能套件", "owner_name" : "xxx", "owner_id" : "e8d27b5521a64fb28a8fd9c99cd66eb3", "project_uuid" : "", "tags" : [ "tag1" ], "number" : "002", "service_type" : 0, "case_operation_info" : { "test_cases_info" : [ { "status" : { "id" : "0", "name" : "新建" }, "result" : { "id" : "-1" }, "owner" : { }, "case_uri" : "v91j0000vldlep4q", "is_available" : 1, "test_case_name" : "样例功能用例_修改", "test_case_number" : "008", "case_type" : 0, "id" : "v91j0000vldlep4q", "uri" : "v91j0000vldlep4q", "checked" : true, "disabled" : true } ], "set_up_cases_info" : [ ], "tear_down_cases_info" : [ ] }, "status_code" : "0", "module_path_name" : "", "module_name" : "", "nodeDetail" : { "name" : "所有用例" }, "release_dev" : "", "execute_way" : 1, "version_uri" : "v91j0000vldleodb", "iterator_version_uri" : "v91j0000vldleodb", "plan_start_timestamp" : -1, "plan_end_timestamp" : -1, "authorName" : "xxx" }

响应参数 状态码： 200 表7 响应Body参数 参数 参数类型 描述 status String success|error result ResultValueString object 请求的返回的数据对象 error ApiError object 失败时的error信息 request_id String 由接口调用方传入，建议使用UUID保证请求的唯一性。 server_address String 本次请求的受理的服务地址。 表8 ResultValueString 参数 参数类型 描述 value String testbird key 表9 ApiError 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码： 400 表10 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息 状态码： 401 表11 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息 状态码： 404 表12 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息 状态码： 500 表13 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 uri 否 String 指定创建任务的uri name 否 String 名称 stage 否 String 测试阶段 number 否 String 编号 tags 否 String 标记id description 否 String 描述 region 否 String 区域 version_uri 否 String 分支/迭代uri owner_id 否 String 处理人/责任人id parent_uri 否 String 父任务uri test_case_condition 否 String 动态任务用例过滤条件 service_type 否 Integer 服务类型0:功能测试 1:接口测试 11:性能测试 module_id 否 String 模块id module_name 否 String 模块名称 release_dev 否 String 发布版本号 status_code 否 Integer 状态code ext_param 否 String 扩展参数 execute_way 否 Integer 执行方式 1：串行，2：并行 execute_type 否 Integer 执行类型（0：冒烟，1：定时） plan_start_timestamp 否 Long 计划开始时间戳，当传入-1时，时间置为空 plan_end_timestamp 否 Long 计划结束时间戳，当传入-1时，时间置为空 assign_case_uris 否 Array of strings 任务关联用例uri数组，CloudDragon环境 case_operation_info 否 CaseOperationInfo object 任务关联用例信息 only_update_status 否 Boolean 是否只需要修改测试套状态 is_async 否 Boolean 是否异步 changes 否 Array of ResourceChangeInfo objects 自定义字段的更新记录 表4 CaseOperationInfo 参数 是否必选 参数类型 描述 empty 否 Boolean 是否为空 test_cases_info 否 Array of AssignCaseInfo objects 用例关联信息 set_up_cases_info 否 Array of AssignCaseInfo objects 前置用例关联信息 tear_down_cases_info 否 Array of AssignCaseInfo objects 后置用例关联信息 表5 AssignCaseInfo 参数 是否必选 参数类型 描述 case_uri 否 String 用例uri is_available 否 Integer 是否可用 表6 ResourceChangeInfo 参数 是否必选 参数类型 描述 field_name 否 String 字段名称 old_value 否 String 旧的value new_value 否 String 新的value old_key 否 String 旧的key new_key 否 String 新的key

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

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 code String 接口调用状态码 data Array of SystemConfig objects 系统配置数据 message String 接口调用返回信息 表6 SystemConfig 参数 参数类型 描述 id String 系统配置编号 key String 系统配置名称 value String 系统配置值 remark String 描述 region_id String region_id project_id String 项目ID update_time String 更新时间 update_name String 更新人名称 update_num String 更新人编号 状态码： 400 表7 响应Body参数 参数 参数类型 描述 code String 接口调用错误码 data String 接口调用返回体 message String 接口调用错误信息 状态码： 401 表8 响应Body参数 参数 参数类型 描述 code String 接口调用错误码 data String 接口调用返回体 message String 接口调用错误信息 状态码： 404 表9 响应Body参数 参数 参数类型 描述 code String 接口调用错误码 data String 接口调用返回体 message String 接口调用错误信息 状态码： 500 表10 响应Body参数 参数 参数类型 描述 code String 接口调用错误码 data String 接口调用返回体 message String 接口调用错误信息

响应示例 状态码： 200 OK { "code" : "success", "data" : [ { "id" : "ae3b4faf12f84ba1aa1c1fa372ec3dfd", "key" : "generateCaseStepByStep", "value" : "0", "remark" : null, "region_id" : "cn-north-7", "project_id" : "fb07002bf4ae4317a855b590a86a52e0", "update_time" : "2024/06/07 10:50:21 GMT+08:00", "update_name" : "devcloud_testman_01", "update_num" : "e8ad9e7478c94f4eaf90d5a379af9cb1" } ], "message" : null }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 params 是 SystemConfig object 系统配置信息 表4 SystemConfig 参数 是否必选 参数类型 描述 id 否 String 系统配置编号 key 否 String 系统配置名称 value 否 String 系统配置值 remark 否 String 描述 region_id 否 String region_id project_id 否 String 项目ID update_time 否 String 更新时间 update_name 否 String 更新人名称 update_num 否 String 更新人编号

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 value Array of AttachmentVo objects 实际的数据类型：单个对象，集合 或 NULL 表5 AttachmentVo 参数 参数类型 描述 uri String 附件Uri creator String 创建人 updator String 更新人 region String 逻辑region doc_id String 文档id parent_uri String 父节点Uri parent_type String 父节点类型 file_name String 文件名 store_file_name String 保存文件名 file_path String 文件路径 file_size Integer 文件大小 file_type String 文件类型 system_type String 系统区分：docman或testman create_time String 创建时间 create_time_timestamp Long 创建时间时间戳 update_time String 更新时间 update_time_timestamp Long 更新时间时间戳 project_uuid String 项目id related_type String 附件类型 0 本地上传 other 关联文档 状态码： 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 GET /GT3KServer/v4/{project_id}/resources/{resource_uri}/attachments 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: 项目id，对应"需求管理 CodeArts Req"项目唯一标识，测试计划管理页面地址栏url https://{host}/cloudtestportal/project/{project_id}/testplan中project_id变量的值 约束限制: 不涉及 取值范围: 项目uuid应符合如下规则：长度等于32位，包含大小写字母、数字 默认取值: 不涉及 resource_uri 是 String 资源Uri 表2 Query参数 参数 是否必选 参数类型 描述 resource_type 是 String 资源类型

请求示例 新增自定义过滤器 post https://{endpoint}/v4/projects/3d2378e0fc504c638f48b21377d6add1/filters { "filter_content_info" : { "results" : [ -2 ] }, "name" : "未执行用例", "project_uuid" : "84b218bb1b504019bbeb64b8dc745a94", "service_type" : -1, "stage_type" : "2" }

响应示例 状态码： 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", "project_uuid" : "3d2378e0fc504c638f48b21377d6add1" } } }

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

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

请求示例 获取资源修改历史记录 post https://{endpoint}/v4/resources/v91j0000vq997opk/histories/batch-query { "page_no" : 1, "project_uuid" : "30649eb093c2479d92c74c75d36ef280", "version_uri" : "v91i0000vq98suq1", "page_size" : 10, "type" : "TestCase" }