云服务器内容精选

  • URI GET /GT3KServer/v4/projects/{project_id}/iterator-infos 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: 项目id,对应"需求管理 CodeArts Req"项目唯一标识,测试计划管理页面地址栏url https://{host}/cloudtestportal/project/{project_id}/testplan中project_id变量的值 约束限制: 不涉及 取值范围: 项目uuid应符合如下规则:长度等于32位,包含大小写字母、数字 默认取值: 不涉及
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时, 值为0, 分页请求才有此值 value Array of TestVersionVo objects 实际的数据类型:单个对象,集合 或 NULL reason String 业务失败的提示内容 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表4 TestVersionVo 参数 参数类型 描述 uri String 资源URI type String 资源类型 author String 创建人 name String 名称 rank Integer 级别 version String 待测版本 owner String 处理者ID creator String 创建人ID iterations String 关联迭代 description String 描述 region String 区域 last_modifier String 最后修改人 last_modified String 最后修改时间 last_modified_timestamp Long 修改时间时间戳 last_change_time String 最后变更时间 version_uri String 版本URI origin_uri String 源资源URI parent_uri String 父资源URI parent_path String 父资源路径 creation_version_uri String 创建版本URI creation_date String 创建时间 creation_date_timestamp Long 创建时间时间戳 author_name String 创建人名称 comment String 备注 number String 编号 is_master Integer 是否为Master分支 is_iterator Integer 是否为迭代 plan_start_date String 开始时间 plan_end_date String 结束时间 service_id String 微服务ID service_name String 微服务名 pbi_id String PBI ID pbi_name String PBI信息 plan_id String 计划ID metric_pbi_ids String 度量PBI ID metric_pbi_id_names String 度量PBI名称 last_syn_date String 最后同步时间 is_closed String 版本是否关闭 asyn_git String 是否同步git库 schema_no Integer schema编号 finish_date String 迭代实际完成时间 owner_name String 处理者名称 creator_name String 创建人名称 current_stage String 当前所处阶段 service_types String 服务类型 risk_rating Integer 风险等级 risk_des String 风险描述 project_uuid String 项目ID domain_id String 租户ID pi_id String pi的id 状态码: 400 表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 表5 响应Body参数 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时, 值为0, 分页请求才有此值 value Array of IteratorVersionSummaryVo objects 实际的数据类型:单个对象,集合 或 NULL reason String 业务失败的提示内容 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表6 IteratorVersionSummaryVo 参数 参数类型 描述 uri String 资源URI type String 资源类型 author String 创建人 name String 名称 rank Integer 级别 version String 待测版本 owner String 处理者ID creator String 创建人ID iterations String 关联迭代 description String 描述 region String 区域 last_modifier String 最后修改人 last_modified String 最后修改时间 last_modified_timestamp Long 修改时间时间戳 last_change_time String 最后变更时间 version_uri String 版本URI origin_uri String 源资源URI parent_uri String 父资源URI parent_path String 父资源路径 creation_version_uri String 创建版本URI creation_date String 创建时间 creation_date_timestamp Long 创建时间时间戳 author_name String 创建人名称 comment String 备注 number String 编号 is_master Integer 是否为Master分支 is_iterator Integer 是否为迭代 plan_start_date String 开始时间 plan_end_date String 结束时间 service_id String 微服务ID service_name String 微服务名 pbi_id String PBI ID pbi_name String PBI信息 plan_id String 计划ID metric_pbi_ids String 度量PBI ID metric_pbi_id_names String 度量PBI名称 last_syn_date String 最后同步时间 is_closed String 版本是否关闭 asyn_git String 是否同步git库 schema_no Integer schema编号 finish_date String 迭代实际完成时间 owner_name String 处理者名称 creator_name String 创建人名称 current_stage String 当前所处阶段 service_types String 服务类型 risk_rating Integer 风险等级 risk_des String 风险描述 project_uuid String 项目ID domain_id String 租户ID pi_id String pi的id start_date String 计划开始时间 start_date_timestamp Long 计划开始时间时间戳 end_date String 计划结束时间 end_date_timestamp Long 计划结束时间时间戳 actual_start_date String 实际开始时间 actual_start_date_timestamp Long 实际开始时间时间戳 actual_end_date String 实际完成时间 actual_end_date_timestamp Long 实际开始时间时间戳 is_expired String 是否超期 expired_info String 计划过期信息,空代表不超期,否则给出具体超期信息 stages Array of strings 迭代计划,默认包含design,execute,report design DesignSummaryVo object 设计阶段信息汇总 execute ExecuteSummaryVo object 执行阶段信息汇总 report ReportSummaryVo object 报告阶段信息汇总 branch_uri String 所属分支URI branch_name String 所属分支名称 表7 DesignSummaryVo 参数 参数类型 描述 issue_num Integer 需求总数 issue_cover_num Integer 已覆盖需求数 case_num Integer 用例数 表8 ExecuteSummaryVo 参数 参数类型 描述 execute_case_num Integer 已执行用例数 defect_num Integer 缺陷总数 completed_defect_num Integer 已完成缺陷数 case_success_rate String 测试用例通过率 case_execution_rate String 用例执行率 表9 ReportSummaryVo 参数 参数类型 描述 case_success_rate String 用例通过率 case_complete_rate String 用例完成率 状态码: 400 表10 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码: 401 表11 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码: 404 表12 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码: 500 表13 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容
  • 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参数 参数 参数类型 描述 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 业务失败的提示内容
  • 响应参数 状态码: 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 表3 响应Body参数 参数 参数类型 描述 - String - 状态码: 401 表4 响应Body参数 参数 参数类型 描述 error_code String 错误编码 error_msg String 错误原因 状态码: 403 表5 响应Body参数 参数 参数类型 描述 error_code String 错误编码 error_msg String 错误原因 状态码: 404 表6 响应Body参数 参数 参数类型 描述 error_code String 错误编码 error_msg String 错误原因
  • 响应示例 状态码: 200 OK { status: "success" result: spec_code: "apitest" domain_order_status: "close" resource_id: "3d642ced03ff43128aaa2df83026abd6" concurrent_number: 0 concurrent_testcase: 0 }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 status String success|error; result ResultValueListTestVersionVo object 请求的返回的数据对象 表4 ResultValueListTestVersionVo 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时, 值为0, 分页请求才有此值 value Array of TestVersionVo objects 实际的数据类型:单个对象,集合 或 NULL reason String 业务失败的提示内容 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表5 TestVersionVo 参数 参数类型 描述 uri String 资源URI type String 资源类型 author String 创建人 name String 名称 rank Integer 级别 version String 待测版本 owner String 处理者ID creator String 创建人ID iterations String 关联迭代 description String 描述 region String 区域 last_modifier String 最后修改人 last_modified String 最后修改时间 last_modified_timestamp Long 修改时间时间戳 last_change_time String 最后变更时间 version_uri String 版本URI origin_uri String 源资源URI parent_uri String 父资源URI parent_path String 父资源路径 creation_version_uri String 创建版本URI creation_date String 创建时间 creation_date_timestamp Long 创建时间时间戳 author_name String 创建人名称 comment String 备注 number String 编号 is_master Integer 是否为Master分支 is_iterator Integer 是否为迭代 plan_start_date String 开始时间 plan_end_date String 结束时间 service_id String 微服务ID service_name String 微服务名 pbi_id String PBI ID pbi_name String PBI信息 plan_id String 计划ID metric_pbi_ids String 度量PBI ID metric_pbi_id_names String 度量PBI名称 last_syn_date String 最后同步时间 is_closed String 版本是否关闭 asyn_git String 是否同步git库 schema_no Integer schema编号 finish_date String 迭代实际完成时间 owner_name String 处理者名称 creator_name String 创建人名称 current_stage String 当前所处阶段 service_types String 服务类型 risk_rating Integer 风险等级 risk_des String 风险描述 project_uuid String 项目ID domain_id String 租户ID pi_id String pi的id 状态码: 400 表6 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码: 401 表7 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码: 404 表8 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码: 500 表9 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容
  • 响应参数 状态码: 200 表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位,包含大小写字母、数字 默认取值: 不涉及
  • 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
  • 响应参数 状态码: 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 业务失败的提示内容