华为云用户手册

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

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

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 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 业务失败的提示内容

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位，包含大小写字母、数字 默认取值: 不涉及

请求参数 表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

响应示例 状态码： 200 OK { "status" : "success", "result" : { "id" : "10896ab1bab34bd8a81b9751fb5c0f4f", "name" : "123", "changeSign" : 0, "copyFlag" : false, "region" : "cn-north-7", "create_time_string" : "2024-06-21 14:10:05 GMT+08:00", "update_time_string" : "2024-06-21 14:10:10", "create_time_stamp" : 1718950205000, "update_time_stamp" : 1718950210000, "create_user" : "devcloud_devcloud_s00314720_01", "create_time" : 1718950205000, "update_user" : "devcloud_devcloud_s00314720_01", "update_time" : 1718950210000, "tmss_property" : { "name" : "123", "number" : "104", "level" : 2, "node_name" : "其他", "test_type" : 1, "testStep" : "", "expectOutput" : "", "exe_platform" : "apitest", "auto_type" : "1", "test_feature" : "09645c1f3f954a8d9ab29174857cffc5_32559725_defaultFeature", "last_modified" : "2024-06-21 14:10:10", "last_modifier" : "efdb403066474ab08836b9eeaaa23bca", "author" : "1_devcloud_devcloud_s00314720", "creation_date" : "2024-06-21 14:10:05", "activity_id" : "1", "last_result" : "0", "isKeyWord" : 0 }, "project_id" : "23c1c5ba3b3c4e92b8adaab3529913c4", "activity_id" : "1", "package_name" : "scripts.user", "script_name" : "Case_10896ab1bab34bd8a81b9751fb5c0f4f_2", "script_path" : "src/scripts/user/Case_10896ab1bab34bd8a81b9751fb5c0f4f_2.java", "tmss_case_uri" : "v91j0000vl6b2b2e", "aw_instance" : { "setup_aw_list" : [ ], "test_aw_list" : [ { "id" : "6e11373667fe46f9881fd216cd1e4404", "projectId" : "23c1c5ba3b3c4e92b8adaab3529913c4", "changeSign" : 0, "region" : "cn-north-7", "relation" : "", "create_time_string" : "2024-06-21 14:10:10 GMT+08:00", "update_time_string" : "2024-06-21 14:10:10 GMT+08:00", "create_time_stamp" : 1718950210000, "update_time_stamp" : 1718950210000, "create_user" : "devcloud_devcloud_s00314720_01", "create_time" : 1718950210000, "update_user" : "devcloud_devcloud_s00314720_01", "update_time" : 1718950210000, "condition_type" : 20, "condition_statement" : "1000", "aw_type" : 1, "aw_id" : "", "param_type_and_value" : [ ], "check_point_list" : [ ], "variable_list" : [ ], "retry_times" : "", "retry_interval" : "", "by_order" : 0, "is_disabled" : 0, "relation_type" : 0, "custom_header" : [ ], "is_basic" : 1, "special_type" : 0, "alias_runaw" : "" } ], "teardown_aw_list" : [ ] }, "case_variable_list" : [ ], "quality_check_time" : 970970555000, "import_info_list" : [ ], "IsKeyWord" : 0, "all_variable_names" : [ "$${hostURL}(全局参数)" ], "import_edit" : 5, "case_type" : 0 } }

URI GET /v4/{project_id}/testcase/{tmss_case_uri} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，固定长度32位字符（字母和数字）。 tmss_case_uri 是 String TMSS用例uri 表2 Query参数 参数 是否必选 参数类型 描述 task_id 否 String 执行任务id

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 value Array of TestCaseVo objects 实际的数据类型：单个对象，集合 或 NULL reason String 业务失败的提示内容 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表4 TestCaseVo 参数 参数类型 描述 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字段 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 状态码： 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 表4 响应Body参数 参数 参数类型 描述 - 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 表5 响应Body参数 参数 参数类型 描述 status String success|error; result ResultValueStringForOk object 请求结果 表6 ResultValueStringForOk 参数 参数类型 描述 value String ok 状态码： 400 表7 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码： 401 表8 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码： 404 表9 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码： 500 表10 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容

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

响应参数 状态码： 200 表6 响应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字段 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 状态码： 400 表7 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码： 401 表8 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码： 404 表9 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码： 500 表10 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容

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

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

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

响应参数 状态码： 200 表6 响应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字段 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 状态码： 400 表7 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码： 401 表8 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码： 404 表9 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码： 500 表10 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容

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

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 status String success|error result ResultValueListCustomReportListVo object 请求的返回的数据对象 表5 ResultValueListCustomReportListVo 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 value Array of CustomReportListVo objects 实际的数据类型：单个对象，集合 或 NULL reason String 业务失败的提示内容 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表6 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 报表数据 表7 ReportFilter 参数 参数类型 描述 creatorIds String 创建人 ownerIds String 所属人 ranks String 级别 releaseIds String releaseId status String 状态 moduleIds String 级别 results String 结果 labelIds String 标签 startTime String 开始时间 endTime String 结束时间 isAssociateIssue String 是否关联需求 表8 ReportChartDataVo 参数 参数类型 描述 id String 报表id name String 报表名称 analyze_dim ReportDimVo object 对比维度数据 compare_dim Array of ReportDimVo objects 对比维度数据 表9 ReportDimVo 参数 参数类型 描述 id String id name String 名称 value Integer 值 状态码： 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 业务失败的提示内容

URI GET /testreport/v4/{project_id}/versions/{version_id}/custom-reports 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: 项目id，对应"需求管理 CodeArts Req"项目唯一标识，测试计划管理页面地址栏url https://{host}/cloudtestportal/project/{project_id}/testplan中project_id变量的值 约束限制: 不涉及 取值范围: 项目uuid应符合如下规则：长度等于32位，包含大小写字母、数字 默认取值: 不涉及 version_id 是 String 版本id 表2 Query参数 参数 是否必选 参数类型 描述 page_size 是 Long 每页显示的条目数量,最大支持200条 offset 是 Long 页数，page_no大于等于1 type 是 Integer 报表类型 1：首页用例库， 2：质量报告

URI GET /testexecutor/v4/{project_id}/resource-pools 表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 ResultValueListResourcePoolVo object 请求的返回的数据对象 error ApiError object 失败时的error信息 request_id String 由接口调用方传入，建议使用UUID保证请求的唯一性。 表4 ResultValueListResourcePoolVo 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 value Array of ResourcePoolVo objects 实际的数据类型：单个对象，集合 或 NULL reason String 业务失败的提示内容 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表5 ResourcePoolVo 参数 参数类型 描述 id String 资源池ID name String 资源池名称 type String 资源池类型（VM/DOCKER） selected String 是否选中 active_state String 资源池状态 表6 ApiError 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码： 400 表7 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码： 401 表8 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码： 404 表9 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码： 500 表10 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 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 业务失败的提示内容

URI GET /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 Query参数 参数 是否必选 参数类型 描述 page_no 是 Integer 页数 page_size 是 Integer 页数大小 version_uri 否 String 分支或者测试计划uri

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 value Array of TestCaseCommentVo objects 实际的数据类型：单个对象，集合 或 NULL reason String 业务失败的提示内容 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表5 TestCaseCommentVo 参数 参数类型 描述 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 表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 表2 响应Body参数 参数 参数类型 描述 value Boolean 实际的数据类型：单个对象，集合 或 NULL 状态码： 400 表3 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码： 401 表4 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码： 404 表5 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码： 500 表6 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 value TaskListVo object 实际的数据类型：单个对象，集合 或 NULL reason String 业务失败的提示内容 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表5 TaskListVo 参数 参数类型 描述 tasks Array of TaskVo objects 测试任务集合 running_count Integer 正在执行任务数 表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 编码 状态码： 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 业务失败的提示内容

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 uris 否 Array of strings 测试任务URI集合 keyword 否 String 关键字查询，任务名或编号 tags 否 Array of strings 标签集合 own 否 Boolean 是否是我的 service_type 否 Integer 服务类型 release_dev_list 否 Array of strings 发布版本号集合 result_codes 否 Array of strings 结果Code集合 status_codes 否 Array of strings 状态Code集合 owner_ids 否 Array of strings 责任人ID集合 executor_ids 否 Array of strings 执行者ID集合 creator_ids 否 Array of strings 创建者ID集合 sort_field 否 String 排序字段 sort_type 否 String 排序方式 page_no 否 Integer 当前页数 page_size 否 Integer 每页条数 is_polling_query 否 Boolean 是否轮询查询 is_query_associated_case_list 否 Boolean 是否获取关联用例列表 plan_start_start_timestamp 否 Long 计划开始时间过滤起始时间戳 plan_start_end_timestamp 否 Long 计划开始时间过滤结束时间戳 plan_end_start_timestamp 否 Long 计划结束时间过滤起始时间戳 plan_end_end_timestamp 否 Long 计划结束时间过滤结束时间戳 expiration_status_list 否 Array of integers 测试套超期状态过滤，超期状态值分别为：无状态(null)、未超期(0)、即将超期(1)、已超期(2)、延期完成(3)、按期完成(4)

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