文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 外部服务管理/ 外部系统根据用例编号获取用例
更新时间:2025-07-24 GMT+08:00
分享

外部系统根据用例编号获取用例

功能介绍

根据用例编号获取用例

调用方法

请参见如何调用API

URI

GET /v4/testhub/projects/{project_id}/testcase

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目UUID,项目唯一标识,固定长度32位字符(字母和数字)。获取方式请参见获取项目ID

表2 Query参数

参数

是否必选

参数类型

描述

version_uri

String

分支uri

testcase_number

String

用例编号

请求参数

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

status

String

success|error

error

ApiError object

错误信息

request_id

String

由接口调用方传入,建议使用UUID保证请求的唯一性。

server_address

String

本次请求的受理的服务地址

result

ExternalQueryCaseVo object

请求结果

表4 ApiError

参数

参数类型

描述

code

String

参数解释:

业务失败的错误码

取值范围:

不涉及

reason

String

参数解释:

业务失败的提示内容

取值范围:

不涉及

表5 ExternalQueryCaseVo

参数

参数类型

描述

testcase_id

String

用例id

project_id

String

项目UUID,项目唯一标识,固定长度32位字符(字母和数字)。获取方式请参见获取项目ID

service_id

Integer

服务类型

name

String

名称

testcase_number

String

用例编号

rank_id

Integer

用例等级

status_id

String

用例状态

execute_count

Integer

用例结果数

result_id

String

用例结果

assigned_user

NameAndIdVo object

用例处理人信息

extend_info

ExtendInfoVo object

用例扩展信息

表6 ExtendInfoVo

参数

参数类型

描述

author

UserBaseVo object

用例更新信息

updator

UserBaseVo object

用例更新信息

domain

NameAndIdVo object

参数解释

服务类型信息

取值范围

不涉及

preparation

String

前置条件

steps

Array of TestCaseStepVo objects

用例测试步骤和预期结果

module

NamePathAndPathVo object

用例模块信息

issue

NameAndIdVo object

参数解释

服务类型信息

取值范围

不涉及

description

String

备注

label_list

Array of NameAndIdVo objects

用例标签信息

defect_list

Array of NameAndIdVo objects

用例tracker信息

fixed_version

NameAndIdVo object

参数解释

服务类型信息

取值范围

不涉及

test_version_id

String

版本号

表7 UserBaseVo

参数

参数类型

描述

id

String

用户id

name

String

用户名

time

String

更新或者创建时间

表8 TestCaseStepVo

参数

参数类型

描述

test_step

String

参数解释

测试步骤

取值范围

不涉及

expect_result

String

参数解释

预期结果

取值范围

不涉及

表9 NamePathAndPathVo

参数

参数类型

描述

id

String

ID

name

String

名称

path

String

路径id

path_name

String

模块路径名称

表10 NameAndIdVo

参数

参数类型

描述

id

String

参数解释

ID

取值范围

不涉及

name

String

参数解释

名称

取值范围

不涉及

状态码:400

表11 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

接口调用失败错误码

取值范围:

不涉及

error_msg

String

参数解释:

接口调用失败错误信息

取值范围:

不涉及

状态码:401

表12 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

接口调用失败错误码

取值范围:

不涉及

error_msg

String

参数解释:

接口调用失败错误信息

取值范围:

不涉及

状态码:404

表13 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

接口调用失败错误码

取值范围:

不涉及

error_msg

String

参数解释:

接口调用失败错误信息

取值范围:

不涉及

状态码:500

表14 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

接口调用失败错误码

取值范围:

不涉及

error_msg

String

参数解释:

接口调用失败错误信息

取值范围:

不涉及

请求示例

get https://{endpoint}/v4/testhub/projects/{project_id}/testcase?version_uri=&testcase_number=

响应示例

状态码:200

OK

{
  "status" : "success",
  "result" : {
    "testcase_id" : "001rvc8k178",
    "project_id" : "0000dbab7df44231a72bfa25a1259c73",
    "service_id" : 3,
    "name" : "用例",
    "testcase_number" : "用例编号:-Copy-bbe028df",
    "rank_id" : 2,
    "status_id" : "4sfsd82e",
    "execute_count" : 1,
    "result_id" : "4sfsd82e",
    "assigned_user" : { },
    "extend_info" : { }
  }
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码

相关文档