文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 用例模板管理/ 查询用例模板详情
更新时间：2025-07-24 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询用例模板详情

功能介绍

查询用例模板详情

调用方法

请参见如何调用API。

URI

GET /v4/{project_id}/case-templates/{template_uri}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

template_uri

是

String

模板id

请求参数

无

响应参数

状态码：200

表2 响应Body参数

参数

参数类型

描述

status

String

success|error

result

ResultValueTestCaseTemplateVo object

请求返回的数据

error

ApiError object

错误信息

request_id

String

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

server_address

String

本次请求的受理的服务地址
表3 ResultValueTestCaseTemplateVo

参数

参数类型

描述

total

Integer

起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值

value

TestCaseTemplateVo object

请求返回的数据

reason

String

业务失败的提示内容

page_size

Integer

分页大小

page_no

Integer

分页编码

has_more

Boolean

是否有更多
表4 TestCaseTemplateVo

参数

参数类型

描述

uri

String

模板uri

name

String

模板名称

description

String

模板描述

number

String

用例编号

rank

Integer

用例等级

preparation

String

前置条件

creator

String

创建人

region

String

逻辑Region

updator

String

修改人

template_test_type

Integer

模板测试类型(1：性能，2：安全，3：功能，4：韧性可靠性，5：过载场景)

service_type

Integer

执行类型

test_type

Integer

测试类型

test_step

String

步骤

expect_output

String

预期结果

case_name

String

用例名称

case_description

String

用例描述

label_list

Array of strings

标签列表

script_url

String

脚本路径

creator_name

String

创建人名称

create_time

String

创建时间

tenant_id

String

租户

update_time

String

修改时间

is_default

Boolean

是否为内置模板

is_recommended

Boolean

是否精选模板

industry_type

Integer

行业分类id

is_solution_template

Boolean

是否解决方案模板

solution_template_uri

String

解决方案模板URI

feature_uri

String

目录URI

steps

Array of TestCaseStepVo objects

用例测试步骤和预期结果
表5 TestCaseStepVo

参数

参数类型

描述

test_step

String

参数解释

测试步骤

取值范围

不涉及

expect_result

String

参数解释

预期结果

取值范围

不涉及
表6 ApiError

参数

参数类型

描述

code

String

参数解释:

业务失败的错误码

取值范围:

不涉及

reason

String

参数解释:

业务失败的提示内容

取值范围:

不涉及

状态码：400

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

接口调用失败错误码

取值范围:

不涉及

error_msg

String

参数解释:

接口调用失败错误信息

取值范围:

不涉及

状态码：401

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

接口调用失败错误码

取值范围:

不涉及

error_msg

String

参数解释:

接口调用失败错误信息

取值范围:

不涉及

状态码：404

表9 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

接口调用失败错误码

取值范围:

不涉及

error_msg

String

参数解释:

接口调用失败错误信息

取值范围:

不涉及

状态码：500

表10 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

接口调用失败错误码

取值范围:

不涉及

error_msg

String

参数解释:

接口调用失败错误信息

取值范围:

不涉及

请求示例

get https://{endpoint}/v4/2e8b14eb90d54b6c9bc4c0b5cde1f449/case-templates/2e8b14eb90

响应示例

状态码：200

OK

{
  "status" : "string",
  "result" : {
    "total" : 1,
    "value" : [ {
      "uri" : "模板uri",
      "name" : "模板名称",
      "description" : "模板描述",
      "creator" : "创建人",
      "updator" : "更新人",
      "is_recommended" : false,
      "industry_type" : 0,
      "label_list" : [ "string" ],
      "create_time" : "2025-06-20T06:47:18.326Z",
      "update_time" : "2025-06-20T06:47:18.326Z"
    } ],
    "reason" : "string",
    "page_size" : 0,
    "page_no" : 0,
    "has_more" : true
  },
  "error" : { }
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题： 用例模板管理

相关文档