手工用例导入 支持批量导入的方式完成手工用例新建。建议在用例较多时使用。 点击【导入】，在弹窗中点击【下载用例模板】，将用例模板下载到本地。 图3 用例导入 打开下载好的用例模板表格，根据用例模板中的备注指导信息填写用例信息，红色加粗列名为必填项。 图4 用例模板表格 请按照用例模板表格中的红色备注提示操作； 请注意没有内容的单元格中不能存在空格或换行符； 完成模板填写后，建议删除三行红色提示文字。如未删除，在导入时解决方案工作台会提示这三行校验失败，但不影响用例导入结果。 在导入弹窗中点击【选择文件】，选择用例模板文件打开。 同名校验：校验用例名称，用例名称不能重复，包括文件中的用例名称、以及已经在解决方案工作台上创建好的用例名称； 同名忽略：已有重复名称的用例时，新增的用例将不会导入；如果新增用例中存在多个重复名称时，只保留第一个； 不校验用例名称：不校验用例名称是否重复，全部导入。 显示校验成功，点击【确定上传】，完成用例导入。

关键字库入口 在“脚本”页签，页面右侧展示“关键字库”。 通过Swagger文件导入的关键字放置在关键字库的“接口”页签中，详细操作请参考接口关键字。 关键字用例和组合关键字放置在关键字库的“组合”页签中，支持从0到1创建新的组合关键字，详细操作请参考组合关键字。 认证类、数据库操作类、中间件类、协议类等实用关键字放置在“系统”页签中，详细操作请参考接口自动化用例关键字。 单击关键字库中“名称”下拉列表，可以按照“名称”、“描述”，搜索对应的关键字。

接口关键字 接口关键字中定义单个接口的请求，可以通过导入Swagger文件、保存自定义URL请求等方式生成。 导入Swagger文件生成数据 在右侧“关键字库”界面，单击“导入接口”。 在弹出的“导入接口”页面，单击“点击添加文件或拖拽上传”，选择配置好的Swagger接口文档，单击“确定”，完成Swagger文件导入。 文档导入成功后，系统自动解析生成脚本模板，脚本模板包含了接口的基本描述信息。可以从“关键字库”界面单击“+”或直接拖拽接口添加至测试步骤，只需要按模板输入接口参数就可以进行测试。 具体请参考CodeArts Testplan的接口关键字。

接口自动化用例系统关键字 接口自动化测试将常见的操作封装成关键字供用户使用，用于提升编写接口测试用例的效率。 表1 系统关键字一览表 分类 关键字集 认证类 认证类—Get IAM Token 认证类—OAuth2For OneAccess 数据库操作类 数据库类—MySQLQuery 数据库类—MySQLUpdate 数据库类—MySQLInsert 数据库类—MySQLDelete 数据库类—OpenGaussQuery 数据库类—OpenGaussUpdate 数据库类—OpenGaussInsert 数据库类—OpenGaussDelete 数据库类—PostgreSQLQuery 数据库类—PostgreSQLUpdate 数据库类—PostgreSQLInsert 数据库类—PostgreSQLDelete 数据库类—MongoDBQuery 数据库类—MongoDBInsert 数据库类—MongoDBUpdate 数据库类—MongoDBDelete 中间件类 中间件类—RedisGet 中间件类—RedisSet 中间件类—OBSWrite 中间件类—OBSDelete 中间件类—OBSQuery 中间件类—KafkaProducer 中间件类—KafkaConsumer 协议类 协议类—TCP 协议类—UDP 协议类—WSConnect 协议类—WSRequest 协议类—WSWriteOnly 协议类—WSReadOnly 协议类—WSDisConnect 协议类—MQTTConnect 协议类—MQTTDisconnect 协议类—MQTTPublish 协议类—MQ TTS ubscribe 协议类—DubboClient 具体请参考CodeArts Testplan的接口自动化用例系统关键字。

响应参数 状态码：200 表7 响应Body参数 参数 参数类型 描述 status String success|error result ResultValueUpdateTestCaseListVo object 请求的返回的数据对象 error ApiError object 失败时的error信息 request_id String 由接口调用方传入，建议使用UUID保证请求的唯一性。 server_address String 本次请求的受理的服务地址 表8 ResultValueUpdateTestCaseListVo 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 value UpdateTestCaseListVo object 实际的数据类型：单个对象，集合 或 NULL reason String 业务失败的提示内容 page_size Integer 分页大小 page_no Integer 分页编号 has_more Boolean 是否有更多 表9 UpdateTestCaseListVo 参数 参数类型 描述 id String CTS 需要返回资源id name String CTS需要返回资源name success_list Array of strings 成功批量更新用例的id列表 failed_list Array of strings 没有批量更新用例的id列表 表10 ApiError 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：400 表11 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：401 表12 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：404 表13 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：500 表14 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及

请求示例 put https://{endpoint}/GT3KServer/v4/a2a0efd74f5a4cc2a066306178dad16b/testcases/batch-update { "version_uri": "v92t00010bdca497", "case_id_list": [ "v92u00010bfj1vbr", "v92t00010bdca4s4" ], "rank": 0, }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 约束限制 不涉及 取值范围 字符串长度不少于1，不超过100000 默认取值 不涉及 表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 参数解释 附件是否要被覆盖 约束限制 不涉及 取值范围 true|false 默认取值 不涉及 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位，包含大小写字母、数字 默认取值: 不涉及

请求示例 post https://{endpoint}/GT3KServer/v4/dc3f9aa646ad4707831080d3fcce474d/versions/v92s00010db208e5/custom-reports { "workpiece_type" : "case", "analysis_dim_row" : "STATUS", "type" : "2", "name" : "ccc" }

响应参数 状态码：200 表5 响应Body参数 参数 参数类型 描述 status String 参数解释: 本次请求的处理状态 取值范围: success|error result ResultValueString object 参数解释: 请求结果 取值范围: 非必返 error ApiError object 参数解释: 错误信息 取值范围: 非必返 request_id String 参数解释: 请求的唯一id 取值范围: 非必返 address String 参数解释: 本次请求的受理的服务地址。 取值范围: 非必返 表6 ResultValueString 参数 参数类型 描述 value String 参数解释 resultObject 取值范围 不涉及 表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 参数解释: 业务失败的提示内容 取值范围: 不涉及

URI POST /GT3KServer/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 版本uri

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 约束限制 不涉及 取值范围 字符串长度不少于1，不超过100000 默认取值 不涉及 表3 请求Body参数 参数 是否必选 参数类型 描述 name 否 String 报表名称 type 否 Integer 报表类型 1：首页用例库， 2：质量报告 workpiece_type 否 String 工件类型(用例：case,测试套：suite) analysis_dim_row 否 String 分析维度 compare_dim_column 否 String 对比维度 filter 否 ReportFilter object 过滤条件 表4 ReportFilter 参数 是否必选 参数类型 描述 creatorIds 否 String 参数解释: 创建人 取值范围: 不涉及 ownerIds 否 String 参数解释: 所属人 取值范围: 不涉及 ranks 否 String 参数解释: 级别 取值范围: 不涉及 releaseIds 否 String 参数解释: releaseId 取值范围: 不涉及 status 否 String 参数解释: 状态 取值范围: 不涉及 moduleIds 否 String 参数解释: 级别 取值范围: 不涉及 results 否 String 参数解释: 结果 取值范围: 不涉及 labelIds 否 String 参数解释: 标签 取值范围: 不涉及 startTime 否 String 参数解释: 开始时间 取值范围: 不涉及 endTime 否 String 参数解释: 结束时间 取值范围: 不涉及 isAssociateIssue 否 String 参数解释: 是否关联需求 取值范围: 不涉及

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 value Array of IntegerIdAndNameVo objects 测试类型信息 表4 IntegerIdAndNameVo 参数 参数类型 描述 id Integer 参数解释 数据库存储数字 取值范围 不涉及 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 OK { "value" : [ { "id" : 1, "name" : "功能性测试" }, { "id" : 4, "name" : "性能测试" }, { "id" : 2, "name" : "兼容性测试" }, { "id" : 15, "name" : "易用性测试" }, { "id" : 22, "name" : "可靠性测试" }, { "id" : 14, "name" : "安全性测试" }, { "id" : 21, "name" : "可服务性测试" } ] }

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