华为云用户手册

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 service_id 是 Integer 注册测试类型服务接口返回的服务id testcase_id_list 是 Array of strings 计划下包含的用例个数，数组长度小于50个，只能包含一种测试类型

请求示例 计划中批量添加测试用例 post https://{endpoint}/v1/projects/efdb403066474ab08836b9eeaaa23bca/plans/9b26f58ec29943f681804a6628779a23/testcases/batch-add { "service_id" : 13, "testcase_id_list" : [ "97b82412f1ca4628803b918c27ed09de", "97b82412f1ca4628803b918c27ed09de", "97b82412f1ca4628803b918c27ed09de" ] }

响应示例 状态码： 200 SUC CES S { "status" : "success", "result" : { "totalPage" : 1, "totalCount" : 1, "pageNo" : 1, "variableGroupName" : [ { "id" : "3c3234032f334eb29bc56d83e3b04a13", "name" : "Default Environment", "isDefault" : "1", "description" : null } ] }, "reason" : null, "error" : null }

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String token 表3 请求Body参数 参数 是否必选 参数类型 描述 end_time 否 Long 查询结束时间 page_num 否 Integer 分页参数，页码 page_size 否 Integer 分页参数，每页大小 start_time 否 Long 查询开始时间 task_ids 否 Array of strings 任务Id列表

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 list Array of TaskCaseResponseTimeDetailVo objects 返回结果 page_num Integer 页码 page_size Integer 分页大小 total_page Integer 总页数 total_size Long 总条数 表5 TaskCaseResponseTimeDetailVo 参数 参数类型 描述 case_id String 用例ID case_name String 用例名称 end_time Long 用例结束时间 error_reason String 用例状态 response_time Long 用例响应时间 service_id String 服务ID service_name String 服务名称 start_time Long 用例开始时间 state String 用例状态 sub_task_id String 子任务ID tag_id String 已废弃 tag_name String 已废弃 task_case_id String 任务和用例关联关系的ID task_id String 任务ID task_name String 任务名称 task_type_id String 任务类型，1=拨测，2=冒烟，4=部署测试，5=小网拨测 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 错误原因

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 value Array of TaskAssignCaseDetailVo objects 实际的数据类型：单个对象，集合 或 NULL reason String 业务失败的提示内容 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表5 TaskAssignCaseDetailVo 参数 参数类型 描述 uri String 关联关系uri sort Integer 排序顺序 owner String 责任人id stage Integer 测试阶段 project_uuid String 项目id task_uri String 任务uri update_time String 更新时间 updator_name String 更新人 updator String 更新人id case_uri String 用例uri is_available Integer 是否可用 test_case_name String 用例名称 feature_uri String 用例目录Uri test_case_number String 用例编号 svn_script_path String 脚本路径 status_code String 状态 status_name String 状态名称 result_code String 结果id result_name String 结果名称 owner_name String 责任人名称 execute_latest_time String 最新执行时间 execute_duration String 执行时长 is_keyword Integer 是否是关键用例 net_work_script_name String 脚本名称 rank_id Integer 用例等级 状态码： 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 POST /GT3KServer/v4/{project_id}/tasks/{task_id}/testcases/batch-query 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: 项目id，对应"需求管理 CodeArts Req"项目唯一标识，测试计划管理页面地址栏url https://{host}/cloudtestportal/project/{project_id}/testplan中project_id变量的值 约束限制: 不涉及 取值范围: 项目uuid应符合如下规则：长度等于32位，包含大小写字母、数字 默认取值: 不涉及 task_id 是 String 任务uri

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 stage 否 Integer 测试用例在任务中的阶段 owners 否 Array of strings 处理人过滤数组 page_no 否 Integer 页码 page_size 否 Integer 页数量 results 否 Array of strings 结果过滤 status 否 Array of strings 状态过滤 version_uri 否 String 分支/迭代uri release_dev 否 String 任务版本过滤条件，影响关联任务的结果查询，查询当前任务版本下的用例最新结果 sort_field 否 String 排序字段 sort_type 否 String 排序方法 feature_uri 否 String 特性目录URI task_result_uri 否 String 测试套结果uri rank_ids 否 Array of integers 用例等级ID集合 key_word 否 String 关键字 issue_id 否 String 需求id associated_issue 否 Boolean 是否关联需求（null：不限，false：未关联，true：已关联） select_all_pages 否 Boolean 是否全选所有页（null：不全选，false：不全选，true：全选），用于任务批量执行结果功能，只返回用例uri，不返回其他信息 is_available 否 Boolean 用例是否可用 is_script_exist 否 Boolean 用例脚本字段是否有值

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 status String success|error result ResultValueListTestItemVo object 请求的返回的数据对象 error ApiError object 失败时的error信息 request_id String 由接口调用方传入，建议使用UUID保证请求的唯一性。 server_address String 本次请求的受理的服务地址。 表5 ResultValueListTestItemVo 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 value Array of TestItemVo objects 实际的数据类型：单个对象，集合 或 NULL reason String 业务失败的提示内容 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表6 TestItemVo 参数 参数类型 描述 uri String 资源URI type String 资源类型 author String 创建人 name String 名称 rank Integer 级别 owner String 责任人 frequence String frequence值 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_feature String 是否特性 relate_htsm String 是否关联特性 aw_unique_id String aw id test_mind_id String 脑图id test_mind_url String 脑图url project_uuid String 项目id case_total Integer 用例总数 execd_total Integer 执行总数 is_direct_relation Boolean is_direct_relation has_child Boolean 是否有子特性 表7 ApiError 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码： 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参数 参数 是否必选 参数类型 描述 owner 否 String 责任人 stage 否 String 阶段 activity 否 String 活动 version_uri 否 String 版本URI task_uri 否 String 任务uri service_type 否 String 用例服务类型 contain_total 否 Boolean 是否包含用例数 project_uuid 否 String 项目id sort_type 否 String 排序类型 page_number 否 Integer 页码 page_size 否 Integer 每页数量

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 comments String 备注 config_key String 配置键 config_type String 配置类型 config_value String 配置值 create_time String 创建时间 create_user String 创建者 id String UUID test_service_id String 服务id update_time String 修改时间 update_user 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 表4 响应Body参数 参数 参数类型 描述 uri String 资源URI type String 资源类型 author String 创建人 name String 名称 rank Integer 级别 preparation String 前置条件 remark String 备注 stage String 测试阶段 activity String 测试类型 keywords String 关键词 market String apitest标记是否代码已提交 designer String 设计者 tags String 标签 execute_parameter String 执行参数 region String 逻辑region owner String 处理人id，IteratorTestCase字段 issue SimpleIssueVo object 需求 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 编号 case_type Integer 用例类型 platform_type Integer 执行平台类型 service_type Integer 服务类型 service_type_name String 服务类型名称 test_type Integer 测试类型 test_type_name String 测试类型名称 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 feature_name String 目录名称 interface_name String 测试接口名 snp_no String 网络问题ID dr_relation_id String 关联需求编号 issue_name 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 总共耗时 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 labels String 用例标签名称列表 module_id String 模块ID module_name String 模块名称 module_path String 模块path module_path_name String 模块路径名称 execute_latest_time String 最后执行时间 execute_duration String 执行时长 execute_times Integer 执行次数 is_keyword Integer 是否关键用例 release_dev String 测试版本号 new_created String 是否用户新增用例 project_uuid String 项目ID creation_version_name String 创建版本名称，原逻辑marshall添加字段 feature_path String 特性路径，原逻辑marshall添加字段 testcase_uri String 实体用例Uri，IteratorTestCase字段 owner_name String 处理人名称 iterator_case_uri String 迭代用例Uri，IteratorTestCase字段 script_link String 脚本链接scriptLink 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 last_modifier_name String 更新人名称 version_name String 迭代 steps Array of TestCaseStepVo objects 测试步骤 associate_defect Boolean 是否关联缺陷 associate_issue Boolean 是否关联需求 defect_list Array of NameAndIdVo objects 缺陷关联信息 表5 SimpleIssueVo 参数 参数类型 描述 id String ID name String 名称 path String 层级路径 tracker_name String 类型 表6 TestCaseStepVo 参数 参数类型 描述 test_step String 测试步骤 expect_result String 预期结果 表7 NameAndIdVo 参数 参数类型 描述 id String ID name String 名称 状态码： 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 业务失败的提示内容

URI GET /GT3KServer/v4/testcases/{testcase_id} 表1 路径参数 参数 是否必选 参数类型 描述 testcase_id 是 String 用例id 表2 Query参数 参数 是否必选 参数类型 描述 version_uri 否 String 分支uri project_uuid 否 String 项目id task_uri 否 String 任务 refresh 否 Boolean 是否刷新缓存 is_recycle 否 Boolean 是否回收站资源

响应示例 状态码： 200 OK { "status" : "success", "result" : { "value" : { "create_count" : 0, "design_count" : 1, "execute_count" : 0, "report_count" : 0, "total_count" : 1 } } }

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 status String success|error result ResultValueIteratorStageSummaryVo object 请求的返回的数据对象 error ApiError object 失败时的error信息 request_id String 由接口调用方传入，建议使用UUID保证请求的唯一性。 server_address String 本次请求的受理的服务地址。 表6 ResultValueIteratorStageSummaryVo 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 value IteratorStageSummaryVo object 实际的数据类型：单个对象，集合 或 NULL reason String 业务失败的提示内容 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表7 IteratorStageSummaryVo 参数 参数类型 描述 create_count Integer 新建状态数量 design_count Integer 设计状态数量 execute_count Integer 执行状态数量 report_count Integer 报告状态数量 total_count Integer 迭代计划总数 表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 接口调用失败错误信息

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

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 status String success|error result ResultValueListProjectFieldConfigVo object 请求的返回的数据对象 error ApiError object 失败时的error信息 request_id String 由接口调用方传入，建议使用UUID保证请求的唯一性。 server_address String 本次请求的受理的服务地址。 表4 ResultValueListProjectFieldConfigVo 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 value Array of ProjectFieldConfigVo objects 实际的数据类型：单个对象，集合 或 NULL reason String 业务失败的提示内容 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表5 ProjectFieldConfigVo 参数 参数类型 描述 uri String 字段配置URI标识 updator NameAndIdVo object 服务类型信息 description String 描述 customName String 项目用例自定义字段名称 table_field_name String 字段名（对应后端参数名） value_type String 字段类型(单行文本text、多行文本textArea、单选框radio、多选框checkbox、日期date、数字number、用户user)。 value_type_name String 字段类型国际化名称 is_system Integer 是否系统字段 is_display Integer 是否显示 is_required Integer 是否必填 sort_numb Integer 顺序数值 default_value String 默认值 custom_field_uri String 扩展字段uri(用于连表查扩展字段) resource_type String 资源类型 creator NameAndIdVo object 服务类型信息 create_time_stamp Long 创建时间时间戳 update_time_stamp Long 更新时间时间戳 project_uuid String 项目ID option_vos Array of ProjectFieldConfigOptionVo objects 可选项 custom_field_id Integer 项目用例自定义字段id（1-25数字） custom_field_name String 项目用例自定义字段名称 custom_field_param String 项目用例自定义字段入参或者返回参数名称 表6 ProjectFieldConfigOptionVo 参数 参数类型 描述 uri String 字段选项URI标识.新增不传，修改、删除使用必传 name String 可选项名称 code String 可选项code值 updator NameAndIdVo object 服务类型信息 description String 描述 flag Integer 修改标识，0：不可修改 1：可修改，用于结果和状态的选项值 sort_numb Integer 顺序数值 creator NameAndIdVo object 服务类型信息 create_time_stamp Long 创建时间时间戳 update_time_stamp Long 更新时间时间戳 表7 NameAndIdVo 参数 参数类型 描述 id String ID name String 名称 表8 ApiError 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码： 400 表9 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码： 401 表10 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码： 404 表11 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码： 500 表12 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容

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

响应参数 状态码： 200 表6 响应Body参数 参数 参数类型 描述 status String success|error; result ResultValueRequirementsOverviewVo object 请求的返回的数据对象 error ApiError object 失败时的error信息 表7 ResultValueRequirementsOverviewVo 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 value RequirementsOverviewVo object 实际的数据类型：单个对象，集合 或 NULL reason String 业务失败的提示内容 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表8 RequirementsOverviewVo 参数 参数类型 描述 total_number Integer 质量报告需求测试情况总数 requirement_overview_list Array of RequirementOverviewVo objects 质量报告需求测试情况列表 表9 RequirementOverviewVo 参数 参数类型 描述 name String 需求名称 workitem_id String 需求id sequence_id String 需求序列编号 board_id String 看板需求id tracker_id String 需求类型id tracker_name String 需求类型 relate_case_number Integer 需求关联用例总数 case_pass_vo CasePassVo object 需求关联用例通过情况 case_execute_vo CaseExecuteVo object 需求关联用例执行率情况 relate_defect_number Integer 需求关联缺陷总数 表10 CasePassVo 参数 参数类型 描述 pass_rate String 需求关联用例通过率 result_number_list Array of NameAndValueVo objects 需求关联用例结果与对应的用例数目列表 表11 NameAndValueVo 参数 参数类型 描述 name String 名称 value Integer 值 表12 CaseExecuteVo 参数 参数类型 描述 execute_rate String 需求关联用例执行率 executed_number Integer 需求关联已执行用例总数 not_executed_number Integer 需求关联未执行用例总数 表13 ApiError 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码： 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 业务失败的提示内容

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

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

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 status String success|error result ResultValueAccessInfoVo object 请求的返回的数据对象 error ApiError object 失败时的error信息 request_id String 由接口调用方传入，建议使用UUID保证请求的唯一性。 server_address String 本次请求的受理的服务地址 表3 ResultValueAccessInfoVo 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 value AccessInfoVo object 实际的数据类型：单个对象，集合 或 NULL reason String 业务失败的提示内容 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表4 AccessInfoVo 参数 参数类型 描述 message String 租户服务开通提示信息 domain_order_status String 租户订单状态 has_free_quota 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 表3 响应Body参数 参数 参数类型 描述 code String 错误码 data MindmapObject object 返回体 message String 错误信息 表4 MindmapObject 参数 参数类型 描述 create_time String 创建时间 creator_name String 创建人名称 creator_num String 创建人工号 folder_id String 文件路径 folder_root_id String 根目录id id String id 主键 max_depth Integer 脑图最大深度 mindmap String 脑图JSON name String 脑图名称 project_id String 项目id update_time String 更新时间 状态码： 400 表5 响应Body参数 参数 参数类型 描述 code String 接口调用错误码 data String 接口调用返回体 message String 接口调用错误信息 状态码： 401 表6 响应Body参数 参数 参数类型 描述 code String 接口调用错误码 data String 接口调用返回体 message String 接口调用错误信息 状态码： 404 表7 响应Body参数 参数 参数类型 描述 code String 接口调用错误码 data String 接口调用返回体 message String 接口调用错误信息 状态码： 500 表8 响应Body参数 参数 参数类型 描述 code String 接口调用错误码 data String 接口调用返回体 message String 接口调用错误信息

请求示例 实时计算单个自定义报表 post https://{endpoint}/v4/projects/efdb403066474ab08836b9eeaaa23bca/versions/daiuyd9tqdxas/custom-reports/generate { "name" : "name", "workpiece_type" : "case", "analysis_dim_row" : "name", "compare_dim_column" : "name", "filter" : { "creatorIds" : "1445148", "ownerIds" : "1445148", "ranks" : "1", "releaseIds" : "1", "status" : "1", "moduleIds" : "1", "results" : "1", "labelIds" : "1", "startTime" : "2020-09-08 10:42:07", "endTime" : "2020-09-08 10:42:07", "isAssociateIssue" : "true" } }

响应示例 状态码： 200 OK { "status" : "string", "result" : { "total" : 0, "value" : { "id" : "1", "name" : "报表名称", "filter" : { "creatorIds" : "1445148", "ownerIds" : "1445148", "ranks" : "1", "releaseIds" : "1", "status" : "1", "moduleIds" : "1", "results" : "1", "labelIds" : "1", "startTime" : "2020-09-08 10:42:07", "endTime" : "2020-09-08 10:42:07", "isAssociateIssue" : "true" }, "workpiece_type" : "case", "analysis_dimension" : "AUTHOR", "compare_dimension" : "AUTHOR", "chart_data" : [ { "id" : "1", "name" : "报表名称", "analyze_dim" : { "id" : "1", "name" : "名称", "value" : 0 }, "compare_dim" : [ { "id" : "1", "name" : "名称", "value" : 0 } ] } ] }, "reason" : "string", "page_size" : 0, "page_no" : 0, "has_more" : true }, "error" : { "code" : "string", "reason" : "string" }, "request_id" : "string" }

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 status String success|error result ResultValueCustomReportListVo object 请求的返回的数据对象 error ApiError object 失败时的error信息 request_id String 由接口调用方传入，建议使用UUID保证请求的唯一性。 表6 ResultValueCustomReportListVo 参数 参数类型 描述 total Integer 起始记录数大于实际总条数时，值为0，分页请求才有此值 value CustomReportListVo object 实际的数据类型：单个对象，集合 或 NULL reason String 业务失败的提示内容，对内接口才有此值 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表7 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 报表数据 表8 ReportFilter 参数 参数类型 描述 creatorIds String 参数解释: 自定义报表创建人用户ID，指定由对应用户创建的用例或测试套进行报表生成 约束限制: 不涉及 取值范围: 长度为1-1000字符（字母或数字）,可选择多个用户ID，用逗号拼接 默认取值: 不涉及 ownerIds String 参数解释: 自定义报表所属人用户ID，指定由对应用户作为Owner的用例或测试套进行报表生成 约束限制: 不涉及 取值范围: 长度为1-1000字符（字母或数字）,可选择多个用户ID，用逗号拼接 默认取值: 不涉及 ranks String 参数解释: 测试用例级别，指定对应用例级别的用例进行报表生成 约束限制: 不涉及 取值范围: 级别为数字, 可选择多个用例级别，用逗号拼接 默认取值: 不涉及 releaseIds String 参数解释: 需求管理中迭代计划的ID，指定关联了对应迭代的用例进行报表生成 约束限制: 不涉及 取值范围: 长度为1-1000字符（字母或数字），可选择多个迭代ID，用逗号拼接 默认取值: 不涉及 status String 参数解释: 测试用例状态ID, 指定对应用例状态下的用例进行报表生成 约束限制: 不涉及 取值范围: 长度为1-255字符（数字），可选择多个状态ID，用逗号拼接 默认取值: 不涉及 moduleIds String 参数解释: 需求管理中定义的模块ID，指定关联了对应模块的用例进行报表生成 约束限制: 不涉及 取值范围: 长度为1-1000字符（字母或数字），可选择多个模块，用逗号拼接 默认取值: 不涉及 results String 参数解释: 测试用例结果的状态编码，指定对应用例结果的用例进行报表生成 约束限制: 不涉及 取值范围: 长度为1-255字符（数字），可选择多个结果ID，用逗号拼接 默认取值: 不涉及 labelIds String 参数解释: 测试用例关联的标签ID，指定对应关联了该标签的用例进行报表生成 约束限制: 不涉及 取值范围: 长度为1-1000字符（字母或数字），可选择多个标签，用逗号拼接 默认取值: 不涉及 startTime String 参数解释: 开始时间，指定创建时间在该时间之后的用例进行报表生成 约束限制: 与结束时间配合，过滤在指定范围内的用例 取值范围: 日期时间格式为yyyy-MM-dd hh:mm:ss，如：2020-09-08 10:42:07 默认取值: 不涉及 endTime String 参数解释: 结束时间，指定创建时间在该时间之前的用例进行报表生成 约束限制: 与开始时间配合，过滤在指定范围内的用例 取值范围: 日期时间格式为yyyy-MM-dd hh:mm:ss，如：2020-09-08 10:42:07 默认取值: 不涉及 isAssociateIssue String 参数解释: 是否关联需求，指定已关联需求或未关联需求的用例进行报表生成 约束限制: 不涉及 取值范围: true或false 默认取值: 不涉及 表9 ReportChartDataVo 参数 参数类型 描述 id String 报表id name String 报表名称 analyze_dim ReportDimVo object 对比维度数据 compare_dim Array of ReportDimVo objects 对比维度数据 表10 ReportDimVo 参数 参数类型 描述 id String id 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 接口调用失败错误信息

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 否 String 参数解释: 自定义报表的名称，由用户定义，用于表示当前创建的自定义报表 约束限制: 不涉及 取值范围: 长度为3-128字符（中文或字母） 默认取值: 不涉及 workpiece_type 否 String 参数解释: 工件类型(用例：case,测试套：task) 约束限制: 不涉及 取值范围: case/task 默认取值: 不涉及 analysis_dim_row 否 String 参数解释: 分析维度,为自定义报表X轴 约束限制: 不涉及 取值范围: 取值需为:CREATORID(创建人),OWNERID(处理人),RANK(级别),RELEASEID(迭代),STATUS(状态),MODULEID(模块),RELEASEDEV(版本号),RESULT(结果),EXECUTOR(执行人),ASSOCIATEISSUE(关联工作项),ASSOCIATEDEFECT(关联缺陷),EXECUTETIMES(执行次数) 默认取值: 不涉及 compare_dim_column 否 String 参数解释: 对比维度,为自定义报表Y轴 约束限制: 需结合分析维度进行用例/测试套统计 取值范围: 取值需为(必填):CREATORID(创建人),OWNERID(处理人),RANK(级别),RELEASEID(迭代),STATUS(状态),MODULEID(模块),RELEASEDEV(版本号),RESULT(结果),EXECUTOR(执行人),ASSOCIATEISSUE(关联工作项),ASSOCIATEDEFECT(关联缺陷) 默认取值: 不涉及 filter 否 ReportFilter object 过滤条件 表4 ReportFilter 参数 是否必选 参数类型 描述 creatorIds 否 String 参数解释: 自定义报表创建人用户ID，指定由对应用户创建的用例或测试套进行报表生成 约束限制: 不涉及 取值范围: 长度为1-1000字符（字母或数字）,可选择多个用户ID，用逗号拼接 默认取值: 不涉及 ownerIds 否 String 参数解释: 自定义报表所属人用户ID，指定由对应用户作为Owner的用例或测试套进行报表生成 约束限制: 不涉及 取值范围: 长度为1-1000字符（字母或数字）,可选择多个用户ID，用逗号拼接 默认取值: 不涉及 ranks 否 String 参数解释: 测试用例级别，指定对应用例级别的用例进行报表生成 约束限制: 不涉及 取值范围: 级别为数字, 可选择多个用例级别，用逗号拼接 默认取值: 不涉及 releaseIds 否 String 参数解释: 需求管理中迭代计划的ID，指定关联了对应迭代的用例进行报表生成 约束限制: 不涉及 取值范围: 长度为1-1000字符（字母或数字），可选择多个迭代ID，用逗号拼接 默认取值: 不涉及 status 否 String 参数解释: 测试用例状态ID, 指定对应用例状态下的用例进行报表生成 约束限制: 不涉及 取值范围: 长度为1-255字符（数字），可选择多个状态ID，用逗号拼接 默认取值: 不涉及 moduleIds 否 String 参数解释: 需求管理中定义的模块ID，指定关联了对应模块的用例进行报表生成 约束限制: 不涉及 取值范围: 长度为1-1000字符（字母或数字），可选择多个模块，用逗号拼接 默认取值: 不涉及 results 否 String 参数解释: 测试用例结果的状态编码，指定对应用例结果的用例进行报表生成 约束限制: 不涉及 取值范围: 长度为1-255字符（数字），可选择多个结果ID，用逗号拼接 默认取值: 不涉及 labelIds 否 String 参数解释: 测试用例关联的标签ID，指定对应关联了该标签的用例进行报表生成 约束限制: 不涉及 取值范围: 长度为1-1000字符（字母或数字），可选择多个标签，用逗号拼接 默认取值: 不涉及 startTime 否 String 参数解释: 开始时间，指定创建时间在该时间之后的用例进行报表生成 约束限制: 与结束时间配合，过滤在指定范围内的用例 取值范围: 日期时间格式为yyyy-MM-dd hh:mm:ss，如：2020-09-08 10:42:07 默认取值: 不涉及 endTime 否 String 参数解释: 结束时间，指定创建时间在该时间之前的用例进行报表生成 约束限制: 与开始时间配合，过滤在指定范围内的用例 取值范围: 日期时间格式为yyyy-MM-dd hh:mm:ss，如：2020-09-08 10:42:07 默认取值: 不涉及 isAssociateIssue 否 String 参数解释: 是否关联需求，指定已关联需求或未关联需求的用例进行报表生成 约束限制: 不涉及 取值范围: true或false 默认取值: 不涉及