华为云用户手册

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 list Array of MsgInfoVo objects 返回结果 page_num Integer 页码 page_size Integer 分页大小 total_page Integer 总页数 total_size Long 总条数 表5 MsgInfoVo 参数 参数类型 描述 alert_channels String 告警渠道 alert_groups String 告警分组 alert_level Integer 告警级别 alert_num Integer 总告警次数 alert_time String 告警时间 alert_type String 告警类型 content String 告警内容 id String MsgInfo的id link String 链接 location_names String 执行机区域 send_alert_type String 发送告警类型 sub_task_case_id String 子任务用例id sub_task_case_start_time String 子任务用例开始时间 sub_task_id String 子任务id sub_task_start_time String 子任务开始时间 task_id String 任务id task_name String 任务名 test_case_id String 用例id test_case_name String 用例名称 test_suite_type Integer 测试套类型 状态码： 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 错误原因

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String token 表3 请求Body参数 参数 是否必选 参数类型 描述 alert_types 否 Array of strings 告警类型 case_id 否 String 用例id case_name 否 String 用例名 end_time 否 Long 结束时间 page_num 否 Integer 页码 page_size 否 Integer 分页大小 send_alert_type 否 String 发送类型 start_time 否 Long 开始时间 task_id 否 String 任务id task_name 否 String 任务名

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 related_case_uris Array of strings 关联的用例uris not_related_case_uris Array of strings 未关联的用例uris case_task_info Array of RelateTaskTestCasesVo objects 用例及任务信息 表5 RelateTaskTestCasesVo 参数 参数类型 描述 test_case_num String 用例编号 test_case_name String 用例名 test_case_uri String 用例uri task_uri String 任务uri task_name String 任务名 task_num String 任务编号 task_creator 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 业务失败的提示内容

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 page_no 否 Integer 页码 page_size 否 Integer 每页数量 start_index 否 Integer 起始位 end_index 否 Integer 结束位 key_word 否 String 关键字 test_case_uris 否 Array of strings 用例uri列表 iterator_uri 否 String 测试计划uri

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

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 status String success|error result ResultValueQueryIssueVo object 请求的返回的数据对象 error ApiError object 失败时的error信息 request_id String 由接口调用方传入，建议使用UUID保证请求的唯一性。 server_address String 本次请求的受理的服务地址 表4 ResultValueQueryIssueVo 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 value QueryIssueVo object 实际的数据类型：单个对象，集合 或 NULL reason String 业务失败的提示内容，对内接口才有此值 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表5 QueryIssueVo 参数 参数类型 描述 total_count Integer 总数 issue_list Array of QueryIssueAssociatedResultBo objects 缺陷列表 表6 QueryIssueAssociatedResultBo 参数 参数类型 描述 workitem_id String 缺陷id name String 缺陷名称 tracker_name String 工作项名称 tracker_id String 工作项id status_name String 状态名 status_id String 状态id project_id String 项目id owner String 处理人 creator String 创建者id severity_name String 重要程度名称 severity_id String 重要程度id start_date String 预计开始日期 start_date_timestamp Long 预计开始日期时间戳 due_date String 预计结束日期 due_date_timestamp Long 预计结束日期时间戳 board_id String 板id board_name String 板名称 sequence_id String xBoard项目工作项序列号 表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 接口调用失败错误信息

请求示例 查询分支或迭代计划下缺陷列表 post https://{endpoint}/v4/26927372bbae40b184fe764e7a0d21f7/versions/v91k0000vgtfg1jk/defects/batch-query { "page_no" : 1, "page_size" : 15, "case_type" : "0", "fixed_version_id" : "991653560740388864,-2" }

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 own 否 Boolean 是否是我的 case_type 否 String 用例类型 keyword 否 String 关键字 owner_id 否 String 所属人 creator_id 否 String 创建人 status_id 否 String 状态id列表 serverity_id 否 String 服务性id page_size 否 Integer 每页数量 page_no 否 Integer 页码 sort_field 否 String 排序字段 sort_type 否 String 排序类型 module_id 否 String 模块id fixed_version_id 否 String 版本id

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 code String 错误码 data BasePageInfoTemplateV2 object 返回体 message String 错误信息 表6 BasePageInfoTemplateV2 参数 参数类型 描述 limit Integer 每页显示的条目数量，最大支持200条 list Array of TemplateV2 objects 返回体 offset Integer 起始偏移量，表示从此偏移量开始查询，offset大于等于0，小于等于100000 pages Integer 页数 size Integer 记录数 total Long 总数 表7 TemplateV2 参数 参数类型 描述 create_time String 创建时间 creator_name String 创建人名称 creator_num String 创建人工号 description String 描述 id String id 主键 is_default String 是否默认 mindmap String 脑图json name String 名称 update_time String 更新时间 editPermission Boolean 编辑权限 deletePermission Boolean 删除权限 状态码： 400 表8 响应Body参数 参数 参数类型 描述 code String 接口调用错误码 data String 接口调用返回体 message String 接口调用错误信息 状态码： 401 表9 响应Body参数 参数 参数类型 描述 code String 接口调用错误码 data String 接口调用返回体 message String 接口调用错误信息 状态码： 404 表10 响应Body参数 参数 参数类型 描述 code String 接口调用错误码 data String 接口调用返回体 message String 接口调用错误信息 状态码： 500 表11 响应Body参数 参数 参数类型 描述 code String 接口调用错误码 data String 接口调用返回体 message String 接口调用错误信息

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 params 否 TemplatePageParam object 模板分页参数 表4 TemplatePageParam 参数 是否必选 参数类型 描述 creator_num 否 String 创建人ID offset 否 Integer 起始偏移量，表示从此偏移量开始查询，offset大于等于0，小于等于100000 limit 否 Integer 每页显示的条目数量，最大支持200条 name 否 String 脑图名称

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 value Array of TestCaseListVo objects 实际的数据类型：单个对象，集合 或 NULL reason String 业务失败的提示内容 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表6 TestCaseListVo 参数 参数类型 描述 uri String 用例URI name String 用例名称 owner NameAndIdVo object 服务类型信息 status NameAndIdVo object 服务类型信息 result NameAndIdVo object 服务类型信息 module NameAndIdVo object 服务类型信息 iteration NameAndIdVo object 服务类型信息 exeplatform String 执行平台，如：apittest,其他三方执行平台 number String 用例编号 description String 用例描述 rank_id String 用例等级 feature_uri String 目录URI release_dev String 版本号 is_keyword Boolean 是否组合关键字 script_url String 脚本路径 report_url String 实时报告地址 project_uuid String 项目ID service_type NameAndIdVo object 服务类型信息 test_type IntegerIdAndNameVo object 测试类型信息 create_info CreateInfoVo object 创建信息 execute_info ExecuteInfoVo object 执行信息 associate_issue_info AssociateIssueInfoVo object 关联需求信息 associate_defect_info AssociateDefectInfoVo object 关联缺陷信息 case_type Integer 用例类型 labels String 用例标签名称列表 custom_field_info Array of CustomFieldVo objects 自定义字段信息 is_test_design Boolean 是否来自测试设计（null：不限，false：否来自测试设计，true：来自测试设计） last_modified Long 最后修改时间（null：不限） review_status Integer 用例评审状态（null：0至127） 表7 NameAndIdVo 参数 参数类型 描述 id String ID name String 名称 表8 IntegerIdAndNameVo 参数 参数类型 描述 id Integer 数据库存储数字 name String 页面显示值 表9 CreateInfoVo 参数 参数类型 描述 time String 创建时间 timestamp Long 创建时间时间戳 user_id String 用户ID user_name String 用户名称 表10 ExecuteInfoVo 参数 参数类型 描述 time String 执行开始时间 timestamp Long 执行开始时间时间戳 duration String 执行时长 user_id String 用户ID user_name String 用户名称 execute_times Integer 执行次数 表11 AssociateIssueInfoVo 参数 参数类型 描述 associate Boolean 是否已关联 issue_id String 需求ID tracker_id String 需求类型 board_id String 工作项层级ID tracker_name String 需求类型名称 表12 AssociateDefectInfoVo 参数 参数类型 描述 associate Boolean 是否已关联 associate_count Integer 关联缺陷数 表13 CustomFieldVo 参数 参数类型 描述 type String 字段类型（单行文本text、多行文本textArea、单选框radio、多选框checkBox、日期date、数字number、单选用户user） value String 测试用例自定义字段值 custom_field_param String 项目用例自定义字段入参或者返回参数名称 user_name String user类型测试用例自定义字段对应用户名，其它类型字段不返回 状态码： 400 表14 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码： 401 表15 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码： 404 表16 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码： 500 表17 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 keyword 否 String 关键字查询，用例名或编号 exeplatforms 否 Array of strings 执行平台 own 否 Boolean 是否是我的 useOffset 否 Boolean 是否使用偏移量方式查询 version_uri 否 String 版本URI case_uris 否 Array of strings 用例URI集合 owner_ids 否 Array of strings 处理者ID集合 status_codes 否 Array of strings 状态Code集合 rank_ids 否 Array of strings 用例等级ID集合 module_ids 否 Array of strings 模块ID集合 issue_id 否 String 需求编号 creator_ids 否 Array of strings 创建者ID集合 result_codes 否 Array of strings 结果Code集合 iteration_ids 否 Array of strings 归属迭代ID集合 create_start_time 否 String 创建开始时间 create_end_time 否 String 创建结束时间 associated_issue 否 Boolean 是否关联需求（null：不限，false：未关联，true：已关联） associated_defects 否 Boolean 是否关联缺陷（null：不限，false：未关联，true：已关联） include_sub_issue 否 Boolean 是否查询子需求关联的用例，默认true include_sub_feature 否 Boolean 是否查询子目录的用例，默认true label_ids 否 Array of strings 标签ID集合 execute_start_time 否 String 执行开始时间 execute_end_time 否 String 执行结束时间 executor_ids 否 Array of strings 执行者ID集合 test_types 否 Array of strings 类型 is_keyword 否 Boolean 是否组合关键字 issue_tree_search 否 Boolean 是否是需求树点击的查询关联用例 service_type 否 Integer 服务类型 service_types 否 Array of integers 服务类型集合 stage_type 否 Integer 阶段过程（2：测试设计，3：测试执行，4：质量报告） feature_uri 否 String 目录URI sort_field 否 String 排序字段 sort_type 否 String 排序方式 page_no 否 Integer 当前页数 page_size 否 Integer 每页条数 case_type 否 Integer 用例类型 custom_field_info 否 Array of QueryCustomFieldsInfo objects 用例自定义字段信息 task_uri 否 String 测试套uri associate_issue_detail 否 Boolean 是否返回需求具体信息（返回需求名称，需求id） not_assign_task 否 Boolean 该字段为false,则查询全量用例，为true表示查询未分配测试套的用例 test_designs 否 Array of booleans 是否来自测试设计（null或者[true, false]：不限，[true]：来自测试设计，[false]：否来自测试设计） review_status 否 Integer 用例评审状态 表4 QueryCustomFieldsInfo 参数 是否必选 参数类型 描述 id 否 Integer 测试用例自定义字段Id values 否 Array of strings 测试用例自定义字段值 field_name 否 String 自定义字段名，优先取id再取fieldName

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

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 status String success|error; result ResultValueDisplayIssueDynamicVo object 请求的返回的数据对象 error ApiError object 失败时的error信息 request_id String 由接口调用方传入，建议使用UUID保证请求的唯一性。 server_address String 本次请求的受理的服务地址 表5 ResultValueDisplayIssueDynamicVo 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 value DisplayIssueDynamicVo object 实际的数据类型：单个对象，集合 或 NULL reason String 业务失败的提示内容 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表6 DisplayIssueDynamicVo 参数 参数类型 描述 is_display_issue_dynamic String 需求更新自定开关 表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/projects/{project_id}/issue-update-notification 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: 项目id，对应"需求管理 CodeArts Req"项目唯一标识，测试计划管理页面地址栏url https://{host}/cloudtestportal/project/{project_id}/testplan中project_id变量的值 约束限制: 不涉及 取值范围: 项目uuid应符合如下规则：长度等于32位，包含大小写字母、数字 默认取值: 不涉及 表2 Query参数 参数 是否必选 参数类型 描述 owner_id 是 String 用户id

响应示例 状态码： 200 OK { "status" : "success", "result" : { "value" : { "uri" : "v91j0000vldlep5u", "name" : "样例功能套件", "number" : "002", "region" : "cn-north-7", "author_id" : "e8d27b5521a64fb28a8fd9c99cd66eb3", "author_name" : "xxx", "owner_id" : "e8d27b5521a64fb28a8fd9c99cd66eb3", "owner_name" : "xxx", "parent_path" : "/300c6295a54c4c698608c878f47ddd59/v91j0000vldleo9v/", "version_uri" : "v91j0000vldleo9v", "branch_uri" : "v91j0000vldleo9v", "creation_date" : "2024-06-24 10:26:19", "create_date_timestamp" : 1719195979000, "update_time" : "2024-06-24 10:26:19", "update_time_timestamp" : 1719195979000, "relation_change_time" : "2024-06-24 10:26:19", "relation_change_time_timestamp" : 1719195979000, "updator_id" : "e8d27b5521a64fb28a8fd9c99cd66eb3", "relation_changer_id" : "e8d27b5521a64fb28a8fd9c99cd66eb3", "service_type" : 0, "tag_list" : [ ], "execute_way" : 1, "execute_type" : 0, "status_code" : 0, "execute_status_code" : 0, "project_uuid" : "300c6295a54c4c698608c878f47ddd59", "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 } ], "set_up_cases_info" : [ ], "tear_down_cases_info" : [ ] }, "assign_case_num" : 0, "finish_case_num" : 0, "assign_defect_num" : 0, "iterator_version_uri" : "v91j0000vldleodb" } } }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 status String success|error; result ResultValueTaskVo object 请求的返回的数据对象 error ApiError object 失败时的error信息 request_id String 由接口调用方传入，建议使用UUID保证请求的唯一性。 server_address String 本次请求的受理的服务地址 表5 ResultValueTaskVo 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 value TaskVo object 测试任务集合 reason String 业务失败的提示内容 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表6 TaskVo 参数 参数类型 描述 uri String 测试任务URI name String 测试任务名称 stage String 测试阶段 number String 编号 tags String 标签 description String 描述 region String 区域 author_id String 创建人ID author_name String 创建人名称 owner_id String 责任人ID owner_name String 责任人名称 parent_uri String 父任务URI parent_path String 父任务路径 origin_uri String 源任务URI version_uri String 版本URI branch_uri String 分支URI version_name String 版本名称 creation_date String 创建时间 create_date_timestamp Long 创建时间时间戳 update_time String 更新时间 update_time_timestamp Long 更新时间时间戳 relation_change_time String 关联关系修改时时间 relation_change_time_timestamp Long 关联关系修改时间时间戳 test_case_condition String 动态任务用例过滤条件 updator_id String 修改人Id updator_name String 修改人名称 relation_changer_id String 关联关系修改人Id service_type Integer 服务类型ID service_type_name String 服务类型名称 tag_list Array of strings 标签名称集合 module_id String 模块ID module_name String 模块名称 module_path String 模块path module_path_name String 模块路径名称 release_dev String 发布版本号 ext_param String 扩展参数 execute_way Integer 执行方式（1：串行，2：并行） execute_type Integer 执行类型（0：冒烟，1：定时） status_code Integer 生命周期状态Code status_name String 生命周期状态名称 result_code Integer 执行结果Code result_name String 执行状态名称 execute_status_code Integer Echo执行状态Code execute_status_name String Echo执行状态名称 executor_id String 执行人ID executor_name String 执行人名称 execute_latest_time String 最近执行时间 execute_latest_time_timestamp Long 最近执行时间时间戳 execute_duration String 执行时长 execute_times Integer 执行次数 project_uuid String 项目ID case_operation_info CaseOperationVo object 任务关联用例信息 assign_case_num Integer 关联用例数 finish_case_num Integer 已完成用例数量 assign_defect_num Integer 关联缺陷数量 task_assign_msg String 任务关联用例变更提示信息 iterator_version_uri String 测试套所属迭代uri，非迭代下创建的测试套返回null result_number_list Array of NameAndValueAndCodeVo objects 用户自定义结果对应的用例数目 finish_date String 测试套完成时间 finish_date_timestamp Long 测试套完成时间戳 plan_start_date String 计划开始时间 plan_start_timestamp Long 计划开始时间戳 plan_end_date String 计划结束时间 plan_end_timestamp Long 计划结束时间戳 expiration_status Integer 测试套超期状态值，分别为：无状态(null)、未超期(0)、即将超期(1)、已超期(2)、延期完成(3)、按期完成(4) expiration_status_name String 测试套超期状态名称，分别为：无状态(不显示状态)、未超期(Unexpired)、即将超期(About to expire)、已超期(Expired)、延期完成(Delayed completion)、按期完成(On schedule completion) 表7 CaseOperationVo 参数 参数类型 描述 test_cases_info Array of TaskAssignCaseVo objects 用例关联信息 set_up_cases_info Array of TaskAssignCaseVo objects 前置用例关联信息 tear_down_cases_info Array of TaskAssignCaseVo objects 后置用例关联信息 表8 TaskAssignCaseVo 参数 参数类型 描述 sort Integer 排序顺序 case_uri String 用例uri is_available Integer 是否可用 test_case_name String 用例名称 test_case_number String 用例编号 表9 NameAndValueAndCodeVo 参数 参数类型 描述 name String 名称 value Integer 值 code String 编码 表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 接口调用失败错误信息

URI GET /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 Query参数 参数 是否必选 参数类型 描述 version_uri 否 String 分支/迭代uri

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 status String success|error; result ResultValueStringForOk object 请求结果 表4 ResultValueStringForOk 参数 参数类型 描述 value String ok 状态码： 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 业务失败的提示内容

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 code String 错误码 error CommonResponseErrorString object 统一错误返回 reason String 失败原因 result String 结果 status String 状态 表4 CommonResponseErrorString 参数 参数类型 描述 code String 错误码 reason String 错误原因

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 code String 错误码 error CommonResponseErrorOfAPITest object 统一错误返回 reason String 失败原因 result BasicAwRes object 结果 status String 状态 表4 CommonResponseErrorOfAPITest 参数 参数类型 描述 code String 错误码 reason String 错误原因 表5 BasicAwRes 参数 参数类型 描述 aw_code String 关键字代码, hascode字段为1是有效 aw_description String 模板描述 aw_mark Integer 关键字标记 aw_operationid String 关键字操作编号 aw_tags String 关键字tags aw_type Integer 关键字类型 aw_uniqueid String 关键字来源编号 by_order Integer 关键字顺序 create_time String 创建时间 create_time_stamp Long 创建时间戳 create_time_string String 创建时间戳 create_user String 创建人 create_user_id String 创建人ID delete_time String 更新时间 delete_user String 删除人 description String 描述 dft_check_point_list Array of objects 默认检查点列表 dft_custom_header Array of objects 默认请求头参数对象 dft_retry_interval String 重试间隔时间 (ms) 为空表示不等待 dft_retry_times String 重试次数 dft_variable_list Array of objects 默认变量信息 extra_info Object 补充信息 group_name String 分组名 has_code Integer 是否存在代码 id String 编号 import_package Array of strings 导入的包名 interface_label String 接口的x-extend字段说明 is_favorite Integer 是否收藏 method String 方法名 name String 关键字名 nameView String 在页面上显示的名字 origin_project String 源工程信息 param_type_and_dft_value Array of objects 参数类型和参数默认值 project_id String 工程编号 protocol_type String 协议类型 public_aw_lib Object 公共关键字信息 public_aw_lib_id String 公共关键字id region String region信息 return_type String 返回值类型 root_id String 根节点编号 source String 关键字依赖的类源 special_type Integer 特殊关键字类型 tmssCaseNumber String 关键字编号（来自测试管理服务） tmss_case_id String 测试用例id update_time String 更新时间 update_time_stamp Long 更新时间戳 update_time_string String 更新时间戳（字符串格式） update_user String 更新人 warningMsg String 警告信息 yamlName String yaml名称

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

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 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" } ] } }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 status String success|error result ResultValueHomePageOverviewVo object 请求的返回的数据对象 error ApiError object 失败时的error信息 request_id String 由接口调用方传入，建议使用UUID保证请求的唯一性。 server_address String 本次请求的受理的服务地址。 表4 ResultValueHomePageOverviewVo 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 value HomePageOverviewVo object 实际的数据类型：单个对象，集合 或 NULL reason String 业务失败的提示内容 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表5 HomePageOverviewVo 参数 参数类型 描述 case_completion_rate CaseCompletionRateVo object 计算用例完成率 case_pass_rate CasePassRateVo object 计算用例通过率 defect_status DefectStatusVo object 统计缺陷信息，组装缺陷状态分组信息 defect_severity DefectSeverityVo object 统计缺陷信息，组装缺陷重要程度分组信息 表6 CaseCompletionRateVo 参数 参数类型 描述 total Integer 总用例数 completion_rate String 用例完成率 status_number_list Array of NameAndValueVo objects 用户自定义状态对应的用例数目 表7 CasePassRateVo 参数 参数类型 描述 pass_rate String 用例通过率 result_number_list Array of NameAndValueVo objects 用户自定义结果对应的用例数目 表8 DefectStatusVo 参数 参数类型 描述 total Integer 缺陷数 not_solved Integer 未关闭缺陷数 status_number_list Array of NameAndValueVo objects 每种状态的名称和对应的数目 表9 DefectSeverityVo 参数 参数类型 描述 total Integer 缺陷数 severity_number_list Array of NameAndValueVo objects 每种重要程度的名称和对应的数目 表10 NameAndValueVo 参数 参数类型 描述 name String 名称 value Integer 值 表11 ApiError 参数 参数类型 描述 code String 业务失败的错误码 reason 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 接口调用失败错误信息

请求示例 质量报告看板统计 post https://{endpoint}/v4/projects/26927372bbae40b184fe764e7a0d21f7/report/overview { "version_uri" : "v91k0000vgtfg1jk", "module_id" : "994928222970748929,994928245960912896,994928263572795393,994928294128300032,994928330747584512,-2", "pi_filter" : { "all_pi" : true, "pi_sprints" : [ { "pi_id" : "1035314883144495104", "sprints" : [ "" ] }, { "pi_id" : "991653518035169281", "sprints" : [ "991653560740388864", "" ] }, { "pi_id" : "", "sprints" : [ "" ] } ] } }

响应示例 状态码： 200 OK { "status" : "success", "result" : { "value" : { "defect" : { "total" : 2, "not_solved" : 0, "severity_number_list" : [ { "name" : "提示", "value" : 2 } ] }, "case_pass_rate" : { "pass_rate" : "0.0%", "result_number_list" : [ { "name" : "成功", "value" : 2 }, { "name" : "失败", "value" : 2 }, { "name" : "执行中", "value" : 3 }, { "name" : "停止", "value" : 1 }, { "name" : "未执行", "value" : 19994 } ] }, "project_type" : "ipd", "issue_cover_rate" : { "epic" : { "testing" : 0, "finished" : 0, "not_tested" : 0, "total_number" : 0, "cover_rate" : "0.0%" }, "feature" : { "testing" : 0, "finished" : 0, "not_tested" : 0, "total_number" : 0, "cover_rate" : "0.0%" }, "story" : { "testing" : 2, "finished" : 0, "not_tested" : 4, "total_number" : 6, "cover_rate" : "0.0%" } } } } }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 status String success|error result ResultValueOverviewVo object 请求的返回的数据对象 error ApiError object 失败时的error信息 request_id String 由接口调用方传入，建议使用UUID保证请求的唯一性。 server_address String 对内接口才有此属性 表4 ResultValueOverviewVo 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 value OverviewVo object 当接口对内且status为failed时，存放只有reason的ApiError对象 reason String 业务失败的提示内容，对内接口才有此值 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表5 OverviewVo 参数 参数类型 描述 defect DefectVo object 整体缺陷信息 case_pass_rate CasePassRateVo object 计算用例通过率 case_completion_rate CaseCompletionRateVo object 计算用例完成率 risk_rating RiskRatingVo object 测试计划的风险等级和风险描述 project_type String 项目类型 issue_cover_rate IssueCoverRateVo object 看板项目的需求覆盖率 表6 DefectVo 参数 参数类型 描述 total Integer 缺陷数 not_solved Integer 未关闭缺陷数 severity_number_list Array of NameAndValueVo objects 组装缺陷每种重要程度的名称和对应的数目 表7 CasePassRateVo 参数 参数类型 描述 pass_rate String 用例通过率 result_number_list Array of NameAndValueVo objects 用户自定义结果对应的用例数目 表8 CaseCompletionRateVo 参数 参数类型 描述 total Integer 总用例数 completion_rate String 用例完成率 status_number_list Array of NameAndValueVo objects 用户自定义状态对应的用例数目 表9 NameAndValueVo 参数 参数类型 描述 name String 名称 value Integer 值 表10 RiskRatingVo 参数 参数类型 描述 risk_rating Integer 测试计划的风险等级 risk_description String 测试计划的风险描述 表11 IssueCoverRateVo 参数 参数类型 描述 epic CoverRateVo object epic类型需求覆盖率, 仅scrum项目返回 feature CoverRateVo object feature类型需求覆盖率, 仅scrum项目返回 story CoverRateVo object story类型需求覆盖率, 仅scrum项目返回 summary CoverRateVo object 需求覆盖率(scrum项目仅返回epic、feature、story。非scrum项目仅返回summary) 表12 CoverRateVo 参数 参数类型 描述 testing Integer 统计测试中的需求 finished Integer 统计已完成的需求 not_tested Integer 统计未测试的需求 total_number Integer 计算需求总数 cover_rate String 需求覆盖率 表13 ApiError 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码： 400 表14 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息 状态码： 401 表15 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息 状态码： 404 表16 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息 状态码： 500 表17 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 work_item_ids 否 Array of strings 需求/缺陷ID列表 project_uuid 否 String 项目id version_uri 否 String 版本uri relate_type 否 String 关联关系类型

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