文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 接口测试管理/ 批量创建用例 - BatchCreateTestCaseAndScript
更新时间：2026-07-07 GMT+08:00
在线调试
CLI示例
查看PDF
分享

批量创建用例 - BatchCreateTestCaseAndScript

功能介绍

批量创建用例和用例脚本

调用方法

请参见如何调用API。

URI

POST /v1/{project_id}/batch/testcase

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

项目uuid应符合如下规则：长度等于32位字符，包含大小写字母、数字

默认取值:

不涉及
表2 Query参数

参数

是否必选

参数类型

描述

iterator_uri

否

String

迭代uri

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

约束限制：

必传。

取值范围：

字符串长度不少于1，不超过10万。

默认取值：

不涉及。
表4 请求Body参数

参数

是否必选

参数类型

描述

[数组元素]

是

Array of CreateTestCaseReq objects

批量创建用例请求信息
表5 CreateTestCaseReq

参数

是否必选

参数类型

描述

activity_id

否

String

参数解释

活动唯一标识

取值范围

32个字符组成的字符串

addToPlan

否

Boolean

是否添加到计划

aw_cata_list

否

Array of BasicAwCata objects

创建时可选择导入的关键字目录直接产生测试步骤

aw_instance

否

CaseAwInstance object

关键字实例

case_type

否

Integer

用例类型：0商用现有类型，1从内部导过来的用例类型

case_variable_list

否

Array of AwVariable objects

用例局部变量

demoFlag

否

String

演示标志

errorStep

否

Array of integers

错误测试阶段

id

否

String

参数解释

唯一标识

取值范围

32个字符组成的字符串

import_info_list

否

Array of strings

导入信息集合

isKeyWord

否

Integer

是否设置为关键字操作

isSync

否

Boolean

是否同步

issueId

否

String

问题唯一标识

name

否

String

参数解释

名称

取值范围

不超过300个字符组成的字符串

old_tmss_case_uri

否

String

被复制用例的测试管理用例uri

old_tmss_case_uri_list

否

Array of strings

被复制用例的测试管理用例uri列表，内部使用

package_name

否

String

包名

planId

否

String

参数解释

计划唯一标识

取值范围

32个字符组成的字符串

project_id

否

String

参数解释

工程唯一标识

取值范围

32个字符组成的字符串

releaseDev

否

String

新服务新建用例版本号

script_name

否

String

脚本名(类名)

script_path

否

String

脚本路径

source

否

String

来源

sourceWay

否

String

来源的方式

src_tmss_case_uri

否

String

选择用例中测试步骤生成关键字时的原用例 测试管理CaseUri

tmss_case_uri

否

String

测试管理用例uri

tmss_feature_uri

否

String

测试管理用例uri

tmss_property

否

TmssTestcase object

测试管理的测试用例

type

否

String

类型

  • apitest

  • performancetest

variableGroupId

否

String

参数解释

环境参数分组唯一标识

取值范围

32个字符组成的字符串
表6 BasicAwCata

参数

是否必选

参数类型

描述

aw_dir

否

String

关键字归属目录信息

cata_type

否

Integer

目录层级

取值范围

  • 1,title

  • 2,tags

  • 3,customize

  • 4,default folder

  • 7,combined aw folder

create_time

否

String

参数解释

创建时间(格式：yyyy-MM-dd HH:mm:ss)

取值范围

不涉及

create_user

否

String

参数解释

创建者

取值范围

不超过255个字符组成的字符串

create_user_id

否

String

参数解释

创建者唯一标识

取值范围

32个字符组成的字符串

desc

否

String

目录描述

extra_info

否

String

引用次数

id

否

String

参数解释

唯一标识

取值范围

32个字符组成的字符串

is_folder

否

String

参数解释

判断是否为文件夹的标识

取值范围

  • 0,文件

  • 1,文件夹

name

否

String

参数解释

名称

取值范围

不超过300个字符组成的字符串

nameView

否

String

参数解释

关键字在页面上显示的名字

取值范围

不超过300个字符组成的字符串

parent_id

否

String

参数解释

关键字目录父编号

取值范围

32个字符组成的字符串

project_id

否

String

参数解释

工程唯一标识

取值范围

32个字符组成的字符串

refCnt

否

Integer

引用次数

region

否

String

参数解释

区域名称

取值范围

不超过32个字符组成的字符串

update_time

否

String

参数解释

更新时间(格式：yyyy-MM-dd HH:mm:ss)

取值范围

不涉及

update_user

否

String

参数解释

更新者

取值范围

不超过32个字符组成的字符串
表7 CaseAwInstance

参数

是否必选

参数类型

描述

setup_aw_list

否

Array of AwInstance objects

测试用例前置步骤

teardown_aw_list

否

Array of AwInstance objects

测试用例后置步骤

test_aw_list

否

Array of AwInstance objects

测试步骤
表8 AwInstance

参数

是否必选

参数类型

描述

alias_runaw

否

String

参数解释

关键字内容描述字段

取值范围

不超过100个字符组成的字符串

authentication_info

否

AuthInfo object

参数解释

认证信息

authentication_type

否

String

参数解释

认证类型

取值范围

  • 0,无认证

  • 1,aksk认证

aw_description

否

String

参数解释

脚本模板描述信息，在用例更新时添加

取值范围

不超过500个字符组成的字符串

aw_id

否

String

参数解释

关键字唯一标识

取值范围

32个字符组成的字符串

aw_type

否

Integer

参数解释

关键字类型

取值范围

  • 1,普通关键字

  • 2,组合关键字

  • 3,导入关键字

basic_aw

否

BasicAw object

参数解释

关键字

body_param_type

否

String

参数解释

关键字实例的参数body体类型

取值范围

  • form

  • text

by_order

否

Integer

参数解释

顺序

取值范围

0-9999

changeSign

否

Integer

参数解释

变化标志

取值范围

  • 0,没有变更

  • 1,发生变更

check_point_list

否

Array of CheckPoint objects

参数解释

检查点集合

children

否

Array of AwInstance objects

参数解释

关键字实例

condition_statement

否

String

参数解释

条件语句

取值范围

不涉及

condition_type

否

Integer

参数解释

条件类型

取值范围

  • 0,not condition

  • 1,if begin

  • 2,if

create_time

否

String

参数解释

创建时间(格式：yyyy-MM-dd HH:mm:ss)

取值范围

不涉及

create_time_stamp

否

Long

参数解释

创建时间戳(单位：毫秒)

取值范围

不涉及

create_time_string

否

String

参数解释

创建时间字符串(格式：yyyy-MM-dd HH:mm:ss)

取值范围

不涉及

create_user

否

String

参数解释

创建者

取值范围

不超过255个字符组成的字符串

custom_header

否

Array of AwParam objects

参数解释

测试步骤自定义请求头集合；后续自定义URL请求头不再使用该字段

description

否

String

描述

error_info

否

ErrorInfo object

参数解释

执行的错误日志内容列表

extra_info

否

ExtraInfo object

参数解释

补充信息

from_outside

否

Integer

参数解释

该关键字是否来自外部工程

取值范围

  • 0,no

  • 1,yes

hasLevel

否

Integer

参数解释

层级

header_array

否

Object

参数解释

请求头列表

取值范围

不涉及

his_script

否

String

参数解释

值不为null表示老的IF判断语句；值为null表示新的IF判断语句

取值范围

  • null,新的IF判断语句

  • 不为null,老的IF判断语句

id

否

String

参数解释

唯一标识

取值范围

32个字符组成的字符串

is_basic

否

Integer

是否模板类型测试步骤 0：自定义URL配置类型；1：模板类型测试步骤

is_contract_aw

否

Integer

是否是契约关键字 0-否；1-yes

is_disabled

否

Integer

是否被禁用 0-否；1-yes

is_sectest_aw

否

Integer

是否是安全测试关键字

level

否

Integer

用例级别

name

否

String

参数解释

名称

取值范围

不超过300个字符组成的字符串

param_dependent

否

String

参数解释

参数依赖

取值范围

不涉及

param_dependent_enabled

否

Integer

是否启用参数依赖

param_type_and_value

否

Array of AwParam objects

参数类型和参数值对应集合

projectId

否

String

参数解释

工程唯一标识

取值范围

32个字符组成的字符串

region

否

String

参数解释

区域名称

取值范围

不超过32个字符组成的字符串

relation

否

String

参数解释

关键字唯一标识层级关系

取值范围

不超过512个字符组成的字符串

relation_id

否

String

参数解释

层级关系唯一标识

取值范围

32个字符组成的字符串

relation_type

否

Integer

参数解释

映射类型

取值范围

  • 1,反向删除映射

  • 2,用例自动添加的方向删除步骤

retry_interval

否

String

参数解释

重试间隔时间 (ms)， 为空表示不等待

取值范围

正整数或空

retry_times

否

String

参数解释

重试次数

取值范围

自然数

scriptName

否

String

参数解释

获取脚本生成时，要使用的步骤名称

取值范围

1-128个字符

service_and_stage

否

String

参数解释

关键字所来自工程的服务名和阶段名 fromOutside为1时该值有效

取值范围

不涉及

special_type

否

Integer

参数解释

特殊关键字类型

取值范围

  • 0,导入yaml生成模板aw

  • 1,导入yaml 生成用例区分

  • 9,公共AW

  • 10,导入yaml 生成模板header

  • 99,自定义url

  • 90,自定义url生成模板aw

  • 11,自定义AW

update_time

否

String

参数解释

更新时间(格式：yyyy-MM-dd HH:mm:ss)

取值范围

不涉及

update_time_stamp

否

Long

参数解释

更新时间戳(单位：毫秒)

取值范围

不涉及

update_time_string

否

String

参数解释

更新时间字符串(格式：yyyy-MM-dd HH:mm:ss)

取值范围

不涉及

update_user

否

String

参数解释

更新者

取值范围

不超过32个字符组成的字符串

user_id

否

String

参数解释

用户唯一标识

取值范围

32个字符组成的字符串

variable_list

否

Array of AwVariable objects

用例局部变量
表9 AuthInfo

参数

是否必选

参数类型

描述

access_key

否

String

访问密钥

secret_key

否

String

私钥
表10 BasicAw

参数

是否必选

参数类型

描述

aw_code

否

String

参数解释

关键字代码, hasCode为1时有效

取值范围

不涉及

aw_description

否

String

参数解释

脚本模板描述信息，在用例更新时添加

取值范围

不超过500个字符组成的字符串

aw_ins_list

否

Array of AwInstance objects

组合关键字包含的关键字实例信息，关键字类型为2时该字段有效

aw_mark

否

Integer

参数解释

关键字标记

取值范围

  • 0,normal

  • 1,new

  • 2,update

  • 3,delete

aw_operationid

否

String

参数解释

接口的唯一标识

取值范围

不超过300个字符组成的字符串

aw_tags

否

String

参数解释

接口的标签

取值范围

不超过300个字符组成的字符串

aw_type

否

Integer

参数解释

关键字类型

取值范围

  • 1,普通关键字

  • 2,组合关键字

  • 3,导入关键字

aw_uniqueid

否

String

参数解释

关键字唯一标识和关键字标签的拼接

取值范围

不超过600个字符组成的字符串

by_order

否

Integer

参数解释

顺序

取值范围

0-9999

create_time

否

String

参数解释

创建时间(格式：yyyy-MM-dd HH:mm:ss)

取值范围

不涉及

create_time_stamp

否

Long

参数解释

创建时间戳(单位：毫秒)

取值范围

不涉及

create_time_string

否

String

参数解释

创建时间字符串(格式：yyyy-MM-dd HH:mm:ss)

取值范围

不涉及

create_user

否

String

参数解释

创建者

取值范围

不超过255个字符组成的字符串

create_user_id

否

String

参数解释

创建者唯一标识

取值范围

32个字符组成的字符串

custom_aw_libs

否

Array of UploadFile objects

参数解释

关键字库的文件列表

delete_time

否

String

参数解释

删除时间(格式：yyyy-MM-dd HH:mm:ss)

取值范围

不涉及

delete_user

否

String

参数解释

删除者

取值范围

32个字符组成的字符串

description

否

String

描述

dft_check_point_list

否

Array of CheckPoint objects

参数解释

检查点集合

dft_custom_header

否

Array of AwParam objects

参数解释

默认请求头参数对象

dft_retry_interval

否

String

参数解释

重试间隔时间 (ms)， 为空表示不等待

取值范围

正整数或空

dft_retry_times

否

String

参数解释

重试次数

取值范围

自然数

dft_variable_list

否

Array of AwVariable objects

参数解释

定义的变量信息

extra_info

否

Object

补充信息

group_name

否

String

参数解释

分组名

取值范围

不超过50个字符组成的字符串

has_code

否

Integer

参数解释

是否自带代码

取值范围

  • 0,不自带代码，该关键字依赖source字段中的源码

  • 1，自带代码

id

否

String

参数解释

唯一标识

取值范围

32个字符组成的字符串

import_package

否

Array of strings

参数解释

导入的包

interface_label

否

String

参数解释

接口的x-extend

取值范围

不超过300个字符组成的字符串

is_favorite

否

Integer

参数解释

是否是当前工程的收藏关键字，该字段不存数据库，每次获取时实时判断

取值范围

  • 0,未收藏

  • 1,已收藏

keyword_variable_value

否

Array of AwVariable objects

参数解释

关键字局部变量

method

否

String

参数解释

方法

取值范围

不超过300个字符组成的字符串

name

否

String

参数解释

名称

取值范围

不超过300个字符组成的字符串

nameView

否

String

参数解释

关键字在页面上显示的名字

取值范围

不超过300个字符组成的字符串

origin_project

否

String

参数解释

源工程信息，如该关键字是从其他工程过来的(继承或者copy to local)

取值范围

32个字符组成的字符串

output_param_list

否

Array of AwVariable objects

参数解释

组合关键字的输出参数信息，该字段不存数据库，实时获取

param_type_and_dft_value

否

Array of AwParam objects

参数解释

参数类型和参数默认值对应集合

project_id

否

String

参数解释

工程唯一标识

取值范围

32个字符组成的字符串

protocol_type

否

String

参数解释

协议类型

取值范围

  • http/https

  • dsf

  • other

public_aw_lib

否

PublicAwLib object

公共关键字信息

public_aw_lib_id

否

String

所属公共关键字库唯一标识

region

否

String

参数解释

区域名称

取值范围

不超过32个字符组成的字符串

return_type

否

String

参数解释

返回类型

取值范围

不涉及

root_id

否

String

参数解释

root唯一标识

取值范围

32个字符组成的字符串

source

否

String

来源

special_type

否

Integer

参数解释

特殊关键字类型

取值范围

  • 0,导入yaml生成模板aw

  • 1,导入yaml 生成用例区分

  • 9,公共AW

  • 10,导入yaml 生成模板header

  • 99,自定义url

  • 90,自定义url生成模板aw

  • 11,自定义AW

tmssCaseNumber

否

String

参数解释

关键字管理的用例编号

取值范围

不涉及

tmss_case_id

否

String

参数解释

关键字管理的用例唯一标识

取值范围

不超过32个字符组成的字符串

update_time

否

String

参数解释

更新时间(格式：yyyy-MM-dd HH:mm:ss)

取值范围

不涉及

update_time_stamp

否

Long

参数解释

更新时间戳(单位：毫秒)

取值范围

不涉及

update_time_string

否

String

参数解释

更新时间字符串(格式：yyyy-MM-dd HH:mm:ss)

取值范围

不涉及

update_user

否

String

参数解释

更新者

取值范围

不超过32个字符组成的字符串

warningMsg

否

String

参数解释

警告信息

取值范围

不涉及

yamlName

否

String

参数解释

所属yaml文件名称,该字段不存库，用来记录从哪个yaml文件导入

取值范围

不涉及
表11 UploadFile

参数

是否必选

参数类型

描述

awInsId

否

String

参数解释

所属的关键字实例的唯一标识

取值范围

32个字符组成的字符串

create_time

否

String

参数解释

创建时间(格式：yyyy-MM-dd HH:mm:ss)

取值范围

不涉及

create_time_stamp

否

Long

参数解释

创建时间戳(单位：毫秒)

取值范围

不涉及

create_time_string

否

String

参数解释

创建时间字符串(格式：yyyy-MM-dd HH:mm:ss)

取值范围

不涉及

create_user

否

String

参数解释

创建者

取值范围

不超过255个字符组成的字符串

current_size

否

Long

参数解释

当前大小

取值范围

自然数

filePath

否

String

参数解释

文件路径

取值范围

不涉及

id

否

String

参数解释

唯一标识

取值范围

32个字符组成的字符串

name

否

String

参数解释

名称

取值范围

不超过300个字符组成的字符串

originName

否

String

参数解释

文件的原名

取值范围

不超过300个字符组成的字符串

projectId

否

String

参数解释

项目唯一标识

取值范围

32个字符组成的字符串

region

否

String

参数解释

区域名称

取值范围

不超过32个字符组成的字符串

testcase_id

否

String

参数解释

测试用例的唯一标识符

取值范围

32个字符组成的字符串

update_time

否

String

参数解释

更新时间(格式：yyyy-MM-dd HH:mm:ss)

取值范围

不涉及

update_time_stamp

否

Long

参数解释

更新时间戳(单位：毫秒)

取值范围

不涉及

update_time_string

否

String

参数解释

更新时间字符串(格式：yyyy-MM-dd HH:mm:ss)

取值范围

不涉及

update_user

否

String

参数解释

更新者

取值范围

不超过32个字符组成的字符串
表12 PublicAwLib

参数

是否必选

参数类型

描述

create_time

否

String

参数解释

创建时间(格式：yyyy-MM-dd HH:mm:ss)

取值范围

不涉及

create_time_stamp

否

Long

参数解释

创建时间戳(单位：毫秒)

取值范围

不涉及

create_time_string

否

String

参数解释

创建时间字符串(格式：yyyy-MM-dd HH:mm:ss)

取值范围

不涉及

create_user

否

String

参数解释

创建者

取值范围

不超过255个字符组成的字符串

document_link

否

String

参数解释

文档链接

取值范围

不超过300个字符组成的字符串

id

否

String

参数解释

唯一标识

取值范围

32个字符组成的字符串

name

否

String

参数解释

名称

取值范围

不超过300个字符组成的字符串

net_area

否

Array of strings

参数解释

蓝区:Blue,绿区:Green,黄区:Yellow

取值范围

  • Blue

  • Green

  • Yellow

obs_temp_url

否

String

obs临时url

product_line

否

String

产品线

repo_branch

否

String

参数解释

仓库分支

取值范围

不超过50个字符组成的字符串

repo_lib_path

否

String

存公共关键字依赖jar包的目录

repo_password

否

String

参数解释

仓库密码

取值范围

不超过1000个字符组成的字符串

repo_private_key

否

String

参数解释

仓库密钥

取值范围

不超过3000个字符组成的字符串

repo_url

否

String

参数解释

仓库地址

取值范围

不超过300个字符组成的字符串

repo_username

否

String

参数解释

仓库用户名

取值范围

不超过50个字符组成的字符串

update_time

否

String

参数解释

更新时间(格式：yyyy-MM-dd HH:mm:ss)

取值范围

不涉及

update_time_stamp

否

Long

参数解释

更新时间戳(单位：毫秒)

取值范围

不涉及

update_time_string

否

String

参数解释

更新时间字符串(格式：yyyy-MM-dd HH:mm:ss)

取值范围

不涉及

update_user

否

String

参数解释

更新者

取值范围

不超过32个字符组成的字符串
表13 CheckPoint

参数

是否必选

参数类型

描述

comparison

否

String

参数解释

比较符

取值范围

不涉及

description

否

String

参数解释

描述信息

function_arg

否

String

参数解释

类型值

取值范围

不涉及

function_type

否

String

参数解释

高级提取类型

取值范围

  • REGEX,正则表达式

  • SUBSTRING, 字符串截取

property

否

String

参数解释

属性

取值范围

不涉及

value

否

String

参数解释

目标值
表14 ErrorInfo

参数

是否必选

参数类型

描述

error_content

否

String

参数解释

错误内容的描述

取值范围

不涉及

error_index

否

String

参数解释

错误索引的描述

取值范围

不涉及

error_point

否

String

参数解释

错误点的描述

取值范围

不涉及

high_light

否

Boolean

参数解释

是否高亮标识

取值范围

  • true

  • false
表15 ExtraInfo

参数

是否必选

参数类型

描述

childImportPackage

否

Array of strings

参数解释

子级导入的包

取值范围

不涉及

document_link

否

String

参数解释

文档链接

取值范围

不超过300个字符组成的字符串

http_method

否

String

参数解释

http请求方法

取值范围

  • get

  • post

  • put

  • delete

http_url

否

String

参数解释

HTTP请求的URL

取值范围

不涉及

importPackage

否

Array of strings

参数解释

导入的包

取值范围

不涉及

mock

否

MockInfo object

参数解释

关键字实例中的mock信息

取值范围

不涉及

outputParam

否

Array of AwVariable objects

参数解释

输出参数

取值范围

不涉及

param_dependent

否

String

参数解释

参数依赖

取值范围

不涉及

summary

否

String

参数解释

摘要

取值范围

不涉及
表16 AwParam

参数

是否必选

参数类型

描述

basic_value

否

AwParamBasicValue object

参数解释

关键字参数基本类型取值类

取值范围

不涉及

basic_value_list

否

Array of AwParamBasicValue objects

参数解释

关键字参数, valueType为1时该值有效

取值范围

不涉及

custom_body

否

String

参数解释

自定义requestBody内容,inType为2且isBodyCustom为1时有效

取值范围

不涉及

defaultValue

否

String

参数解释

默认值

取值范围

不涉及

description

否

String

参数解释

关键字参数描述

取值范围

不超过3000个字符组成的字符串

disabled

否

Boolean

参数解释

是否禁用,只有非必需参数才能被禁用

取值范围

  • true

  • false

drop_down_value

否

String

参数解释

用于存储下拉菜单的值

取值范围

不涉及

enum_type

否

String

参数解释

枚举类型

取值范围

  • 0,基本类型

  • 1,基本类型数组

  • 2,结构体

  • 3,结构体数组

  • 5,枚举，下拉框展示

  • 6,枚举，单选框展示

  • 7,下拉框

  • 8,单选按钮

  • 9,公共的

enum_type_selected

否

String

参数解释

当前选中的枚举类型

取值范围

  • 0,基本类型

  • 1,基本类型数组

  • 2,结构体

  • 3,结构体数组

  • 5,枚举，下拉框展示

  • 6,枚举，单选框展示

  • 7,下拉框

  • 8,单选按钮

  • 9,公共的

format

否

String

参数解释

num和String有效

取值范围

不涉及

in_type

否

Integer

参数解释

rest接口输入参数类型

取值范围

  • 0,query

  • 1,path

  • 2,body

  • 3,header

  • 4,formdata

  • 5,config

isChecked

否

Boolean

参数解释

是否是被选中参数

取值范围

  • true

  • false

is_big_field

否

Boolean

参数解释

是否是大字段参数

取值范围

  • true

  • false

is_body_custom

否

Integer

参数解释

requestBody是否自定义，inType为2时有效。0-非自定义，用原有逻辑；1-自定义body,requestBody直接使用字段customBody

取值范围

  • 0,非自定义

  • 1,自定义body

is_contract_param

否

Integer

参数解释

是否是契约关键字

参数解释

  • 0, 否

  • 1, yes

is_sensitive

否

Boolean

参数解释

是否敏感参数

参数解释

  • 0,是

  • 1,不是

item

否

ItemParam object

参数解释

关键字基本参数

参数解释

不涉及

maxItems

否

Integer

参数解释

Array类型最大元素数

取值范围

不涉及

maxLength

否

Long

参数解释

String类型最大长度

取值范围

不涉及

maximum

否

Object

参数解释

Number类型最大值

取值范围

不涉及

minItems

否

Integer

参数解释

Array类型最小元素数

取值范围

不涉及

minLength

否

Long

参数解释

String类型最小长度

取值范围

不涉及

minimum

否

Object

参数解释

Number类型最小值

取值范围

不涉及

mock

否

MockInfo object

参数解释

关键字实例中的mock信息

取值范围

不涉及

name

否

String

参数解释

参数名

取值范围

不超过300个字符组成的字符串

object_value

否

Array of AwParam objects

参数解释

valueType为2时该值有效。valueType为3时，该值用来表示数组中单个结构体

取值范围

不涉及

object_value_list

否

Array<Array<AwParam>>

参数解释

valueType为3时该值有效

取值范围

不涉及

pattern

否

String

参数解释

num和String有效

取值范围

不涉及

required

否

Boolean

参数解释

是否必需参数

取值范围

  • true

  • false

type

否

String

参数解释

参数类型

取值范围

  • String

  • boolean

  • int

  • Integer

  • integer

  • float

  • short

  • double

  • long

  • BigDecimal

  • Object

  • ObjectNode

  • ArrayNode

  • file,file不是java的File类型，实际是String类型，传的文件路径

  • List[/topic/body/section/table/tgroup/tbody/row/entry/ul/li/p/br {""}) (br]

  • Json

  • JsonNode

validate_rule

否

ValidateRule object

参数解释

校验规则

取值范围

不涉及

value_type

否

Integer

参数解释

参数值类型

取值范围

  • 0, 基本类型，type字段为String,Integer等基本类型

  • 1, type字段为List[/topic/body/section/table/tgroup/tbody/row/entry/ul/li/p/br {""}) (br],List[/topic/body/section/table/tgroup/tbody/row/entry/ul/li/p/br {""}) (br]等基本类型List

  • 2, 结构体，type字段为除了基本类型以外的结构体

  • 3, 结构体数组，type字段为List<结构体>

  • 5, 枚举类型，TCP协议测试引入

xChoiceValue

否

String

参数解释

choice选择关系

取值范围

不涉及
表17 AwParamBasicValue

参数

是否必选

参数类型

描述

value

否

String

参数解释

参数默认值，用例有效

value_range

否

String

参数解释

参数值范围，逻辑用例有效
表18 ItemParam

参数

是否必选

参数类型

描述

basic_value

否

AwParamBasicValue object

参数解释

关键字参数基本类型取值类

defaultValue

否

String

参数解释

默认值

取值范围

不涉及

enum_type

否

String

参数解释

枚举类型

enum_type_selected

否

String

参数解释

当前选中的枚举类型

format

否

String

参数解释

num和String有效

is_big_field

否

Boolean

参数解释

是否是大字段参数

maxItems

否

Integer

参数解释

Array类型最大元素数

maxLength

否

Long

参数解释

String类型最大长度

maximum

否

Object

Number类型最大值

minItems

否

Integer

参数解释

Array类型最小元素数

minLength

否

Long

参数解释

String类型最小长度

minimum

否

Object

参数解释

Number类型最小值

pattern

否

String

参数解释

num和String有效

type

否

String

参数解释

参数类型

  • String

  • boolean

  • int

  • Integer

  • integer

  • float

  • short

  • double

  • long

  • BigDecimal

  • Object

  • ObjectNode

  • ArrayNode

  • file,file不是java的File类型，实际是String类型，传的文件路径

  • List[/topic/body/section/table/tgroup/tbody/row/entry/ul/li/p/br {""}) (br]

  • Json

  • JsonNode

validate_rule

否

ValidateRule object

参数解释

校验规则

value_type

否

Integer

参数解释

参数值类型

  • 0, 基本类型，type字段为String,Integer等基本类型

  • 1, type字段为List[/topic/body/section/table/tgroup/tbody/row/entry/ul/li/p/br {""}) (br],List[/topic/body/section/table/tgroup/tbody/row/entry/ul/li/p/br {""}) (br]等基本类型List

  • 2, 结构体，type字段为除了基本类型以外的结构体

  • 3, 结构体数组，type字段为List<结构体>

  • 5, 枚举类型，TCP协议测试引入

xChoiceValue

否

String

参数解释

choice选择关系
表19 MockInfo

参数

是否必选

参数类型

描述

mock_id

否

String

参数解释

mock唯一标识

取值范围

32个字符组成的字符串

mock_switch

否

Boolean

参数解释

mock开关

取值范围

  • true

  • false

mock_url

否

String

参数解释

mock地址

取值范围

不涉及
表20 ValidateRule

参数

是否必选

参数类型

描述

dependent_info

否

Array of ConditionInstance objects

参数解释

依赖信息列表

取值范围

不涉及

enabled

否

Boolean

参数解释

是否启用的标识符

取值范围

  • true

  • false

is_configDep

否

Boolean

参数解释

配置依赖的标识符

取值范围

  • true

  • false

is_dependent

否

Boolean

参数解释

是否依赖的标识符

取值范围

  • true

  • false

message

否

String

参数解释

消息

取值范围

不涉及

result

否

String

参数解释

结果

取值范围

不涉及

special_char

否

String

参数解释

特殊字符

取值范围

不涉及

special_char_valid

否

String

参数解释

特殊字符的有效性

取值范围

不涉及

x_example

否

String

参数解释

示例

取值范围

不涉及
表21 ConditionInstance

参数

是否必选

参数类型

描述

conditionIndex

否

Integer

参数解释

条件索引，用于标识当前处理的是哪个条件

conditionMap

否

Map<String,Array<String>>

参数解释

条件映射，键为整数，值为字符串列表，用于存储各个条件的信息

取值范围

不涉及

depParamMap

否

Map<String,DepParamInstance>

参数解释

依赖参数实例的映射

取值范围

不涉及

statementIndex

否

Integer

参数解释

声明索引，用于标识当前处理的是哪个声明
表22 DepParamInstance

参数

是否必选

参数类型

描述

compareValue

否

String

参数解释

比较值

取值范围

不涉及

comparison

否

String

参数解释

比较符

取值范围

不涉及

condition

否

Boolean

参数解释

条件

inValidValues

否

Array of strings

参数解释

无效值列表

name

否

String

参数解释

名称

取值范围

不超过300个字符组成的字符串

nullInfo

否

String

参数解释

空值信息

取值范围

不涉及

relationMap

否

Map<String,String>

参数解释

关系映射，key为整数，value为字符串

取值范围

不涉及

relationNum

否

Integer

参数解释

关系数量

取值范围

自然数

values

否

Array of strings

参数解释

值列表

取值范围

不涉及
表23 AwVariable

参数

是否必选

参数类型

描述

by_order

否

Integer

参数解释

节点顺序

取值范围

0-9999

currentPermission

否

String

参数解释

当前用户权限

取值范围

不涉及

description

否

String

参数解释

参数描述

dynamicParam

否

String

参数解释

动态参数名称

取值范围

不涉及

dynamicParamFlag

否

Boolean

参数解释

动态参数标志,默认为false. true代表动态参数; false代表非动态参数

functionParams

否

String

参数解释

变量参数（[]:空参、[a]:一参，[a,b]:两参）

取值范围

不涉及

function_arg

否

String

参数解释

提取类型的类型值

取值范围

不涉及

function_type

否

String

参数解释

高级提取类型，响应提取时要使用什么方法处理参数

取值范围

  • REGEX, 正则表达式

  • SUBSTRING, 字符串截取

isSensitiveInfo

否

Boolean

参数解释

是否是敏感字段

取值范围

  • true,

  • false

isSensitiveModified

否

Boolean

参数解释

敏感字段是否被修改，不敏感字段不关注此值

is_out_put

否

Boolean

参数解释

是否是组合关键字的输出参数，只有组合关键字下awInstance的关键字变量有该字段

name

否

String

参数解释

参数名称

取值范围

不超过300个字符组成的字符串

node_id

否

String

参数解释

节点唯一标识

取值范围

32个字符组成的字符串

node_type

否

Integer

参数解释

节点类型

取值范围

  • 0,变量节点

  • null,变量节点

  • 1,目录节点

oldName

否

String

参数解释

旧名称

取值范围

不涉及

parent_node_id

否

String

参数解释

父节点唯一标识

取值范围

32个字符组成的字符串

property

否

String

参数解释

属性

取值范围

不涉及

regex

否

String

参数解释

内置函数枚举

取值范围

不涉及

sensitiveInfoSetterTime

否

String

参数解释

敏感参数设置时间

取值范围

不涉及

sensitiveInfoSetterUser

否

String

参数解释

敏感参数设置者名称

取值范围

不涉及

type

否

String

参数解释

类型

取值范围

  • String

  • boolean

  • int

  • Integer

  • integer

  • float

  • short

  • double

  • long

  • BigDecimal

  • Object

  • ObjectNode

  • ArrayNode

  • file,file不是java的File类型，实际是String类型，传的文件路径

  • List[/topic/body/section/table/tgroup/tbody/row/entry/ul/li/p/br {""}) (br]

  • Json

  • JsonNode

variableType

否

Integer

参数解释

变量类型（0：text，10-16：分别对应7个内置函数）

取值范围

  • 10,任意长度随机字符串

  • 11,指定范围随机int

  • 12,生成当前整数时间戳（从1970-01-01 00:00 UTC开始的秒数)

  • 13,按照指定的format格式化时间戳，如 $timestamp_format(timestamp, YYYY-MM-DD)

  • 14,生成UUID

  • 15,使用Base64方法编码参数

  • 16,使用指定参数生成MD5哈希值

  • 18,sha512编码参数
表24 TmssTestcase

参数

是否必选

参数类型

描述

activity_id

否

String

参数解释

活动唯一标识

取值范围

32个字符组成的字符串

applied_product

否

String

应用产品

author

否

String

创建人

auto_type

否

String

自动化类型

cataId

否

String

用例分类唯一标识

creation_date

否

String

创建日期

custom_field_1

否

String

自定义字段1

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_2

否

String

自定义字段2

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

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

description

否

String

描述

dr_relationid

否

String

dr关系唯一标识

env_type

否

String

环境类型

exe_platform

否

String

执行平台

expect_output

否

String

内部预期输出

feature_path

否

String

特性路径

isKeyWord

否

Integer

是否为关键字

is_contract_testcase

否

String

是否为合同测试用例

is_paraValidator_testcase

否

String

是否为参数校验测试用例

labelId

否

Array of strings

标签唯一标识列表

last_modified

否

String

最后修改时间

last_modifier

否

String

最后修改人

last_result

否

String

最后的结果

level

否

Integer

用例级别

market

否

String

市场

moduleId

否

String

模块唯一标识

name

否

String

参数解释

用例名称

取值范围

不超过300个字符组成的字符串

networkScriptName

否

String

公共关键字和项目的关联关系

node_name

否

String

节点名称

number

否

String

用例编号

originUri

否

String

原始的uri

owner

否

String

测试的所有者

ownerId

否

String

所有者唯一标识

preparation

否

String

测试前置条件

releaseDev

否

String

新服务新建用例版本号

releaseId

否

String

发布唯一标识

remark

否

String

备注

stage

否

String

阶段

steps

否

Array of TmssStep objects

存储测试步骤和预期结果值对象

svnScriptPath

否

String

脚本路径

tags

否

String

标签

test_feature

否

String

测试特性

test_step

否

String

内部测试步骤

test_type

否

Integer

测试类型

uri

否

String

用例基线Uri(BAM 接口覆盖率迭代下用例信息获取用)

expectOutput

否

String

预期输出

testStep

否

String

测试步骤
表25 TmssStep

参数

是否必选

参数类型

描述

expectResult

否

String

测试步骤

testStep

否

String

预期结果对象

响应参数

状态码：200

表26 响应Body参数

参数

参数类型

描述

code

String

参数解释

接口调用失败错误码

取值范围

不超过256个字符组成的字符串

error

CommonResponseErrorObject object

参数解释

统一错误返回

取值范围

不涉及

reason

String

参数解释

接口调用失败原因

取值范围

不超过1000个字符组成的字符串

result

Object

参数解释

结果

取值范围

不涉及

status

String

参数解释

'状态值，如success、error'

取值范围

  • success，请求成功

  • error，请求报错
表27 CommonResponseErrorObject

参数

参数类型

描述

code

String

参数解释

接口调用失败错误码

取值范围

不超过256个字符组成的字符串

reason

String

参数解释

接口调用失败原因

取值范围

不超过1000个字符组成的字符串

状态码：201

Created

状态码：401

表28 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

接口调用失败错误码

取值范围

12-18个字符组成的字符串

error_msg

String

参数解释

接口调用失败错误信息

取值范围

3-1000个字符组成的字符串

状态码：403

表29 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

接口调用失败错误码

取值范围

12-18个字符组成的字符串

error_msg

String

参数解释

接口调用失败错误信息

取值范围

3-1000个字符组成的字符串

状态码：404

表30 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

接口调用失败错误码

取值范围

12-18个字符组成的字符串

error_msg

String

参数解释

接口调用失败错误信息

取值范围

3-1000个字符组成的字符串

请求示例

[ {
  "name" : "1411",
  "script_name" : "1411",
  "releaseDev" : "",
  "tmss_case_uri" : "",
  "tmss_feature_uri" : "",
  "activity_id" : 1,
  "addToPlan" : false,
  "case_type" : 0,
  "tmss_property" : {
    "projectUUId" : "2d8247c5e9424bccb0cfa8a47b5d311c",
    "type" : 1,
    "asstype" : 1,
    "name" : "1411",
    "description" : "新建接口自动化用例",
    "preparation" : "无",
    "scriptUrl" : "",
    "steps" : [ {
      "testStep" : "abc",
      "expectResult" : "resultabc"
    } ],
    "number" : "1411",
    "level" : "2",
    "moduleId" : "",
    "releaseDev" : "",
    "releaseId" : "",
    "ownerId" : "",
    "test_type" : 1,
    "labelId" : [ "1411" ],
    "issueId" : "",
    "r_issueName" : "",
    "exe_platform" : "apitest",
    "test_step_model" : "table",
    "planId" : ""
  },
  "import_info_list" : [ ],
  "case_variable_list" : [ ],
  "aw_instance" : {
    "setup_aw_list" : [ ],
    "test_aw_list" : [ ],
    "teardown_aw_list" : [ ]
  },
  "source" : "cloudtest",
  "issueId" : "",
  "only_create_script" : true
} ]

响应示例

状态码：200

OK

{
  "status" : "error",
  "result" : null,
  "reason" : null,
  "error" : {
    "code" : "DEV_21_100169",
    "reason" : "项目不存在或项目已被删除",
    "detail" : [ ]
  },
  "code" : null
}

状态码

状态码

描述

200

OK

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码。

父主题： 接口测试管理

相关文档