创建组合关键字
功能介绍
创建组合关键字
调用方法
请参见如何调用API。
URI
POST /v3/{project_id}/basic-aw/combined-aw
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释 项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目唯一标识。 约束限制 不涉及 取值范围 32个字符组成的字符串 默认取值 不涉及 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释： 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 约束限制： 必传。 取值范围： 字符串长度不少于1，不超过10万。 默认取值： 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
aw_ins_list |
否 |
Array of AwInstanceReq objects |
参数解释 组合关键字包含的关键字实例信息，关键字类型为2时该字段有效 |
|
body_param_type |
否 |
String |
关键字实例的参数body体类型：form/text |
|
description |
否 |
String |
描述 |
|
dft_check_point_list |
否 |
Array of CheckPoint objects |
参数解释 默认检查点List |
|
dft_custom_header |
否 |
Array of AwParam objects |
参数解释 默认请求头参数对象 |
|
dft_variable_list |
否 |
Array of AwVariable objects |
参数解释 默认变量信息集合 |
|
extra_info |
否 |
ExtraInfo object |
补充信息 |
|
group_name |
否 |
String |
参数解释 环境组名 |
|
import_package |
否 |
Array of strings |
参数解释 导入的包 |
|
keyword_variable_value |
否 |
Array of AwVariable objects |
参数解释 关键字局部变量 |
|
name |
否 |
String |
名称 |
|
param_type_and_dft_value |
否 |
Array of AwParam objects |
参数解释 参数类型和参数默认值对应List |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
alias_runaw |
否 |
String |
关键字内容描述字段 |
|
aw_description |
否 |
String |
脚本模板描述信息，在用例更新时添加 |
|
aw_id |
否 |
String |
关键字唯一标识 |
|
aw_type |
否 |
Integer |
关键字类型 0-setup;1-test;2-teardown |
|
basic_aw |
否 |
BasicAwReq object |
关键字 |
|
body_param_type |
否 |
String |
关键字实例的参数body体类型：form/text |
|
by_order |
否 |
Integer |
顺序 |
|
changeSign |
否 |
Integer |
变化标志 |
|
check_point_list |
否 |
Array of CheckPoint objects |
检查点集合 |
|
condition_statement |
否 |
String |
条件语句 |
|
condition_type |
否 |
Integer |
条件类型 0-not condition;1-if begin;2-if |
|
create_time |
否 |
DateTime |
创建时间 |
|
create_user |
否 |
String |
创建人 |
|
custom_header |
否 |
Array of AwParam objects |
参数解释 默认请求头参数对象 |
|
description |
否 |
String |
描述 |
|
error_info |
否 |
ErrorInfo object |
执行的错误日志内容列表 |
|
extra_info |
否 |
ExtraInfo object |
补充信息 |
|
from_outside |
否 |
Integer |
该关键字是否来自外部工程 0-no;1-yes |
|
hasLevel |
否 |
Integer |
层级 |
|
his_script |
否 |
String |
值不为null表示老的IF判断语句；值为null表示新的IF判断语句 |
|
id |
否 |
String |
唯一标识 |
|
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 |
用例级别 |
|
param_dependent |
否 |
String |
参数依赖 |
|
param_dependent_enabled |
否 |
Integer |
是否启用参数依赖 |
|
param_type_and_value |
否 |
Array of AwParam objects |
参数类型和参数值对应List |
|
projectId |
否 |
String |
工程唯一标识 |
|
region |
否 |
String |
区域 |
|
relation |
否 |
String |
关键字唯一标识层级关系 |
|
relation_id |
否 |
String |
层级关系唯一标识 |
|
relation_type |
否 |
Integer |
映射类型 1-反向删除映射;2-用例自动添加的方向删除步骤 |
|
retry_interval |
否 |
String |
重试间隔时间 (ms) 为空表示不等待 |
|
retry_times |
否 |
String |
重试次数 |
|
service_and_stage |
否 |
String |
关键字所来自工程的服务名和阶段名 fromOutside为1时该值有效 |
|
special_type |
否 |
Integer |
测试步骤来源 |
|
update_time |
否 |
DateTime |
更新时间 |
|
update_user |
否 |
String |
更新人 |
|
user_id |
否 |
String |
用户唯一标识 |
|
variable_list |
否 |
Array of AwVariable objects |
参数解释 默认变量信息集合 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
aw_code |
否 |
String |
关键字代码, hasCode为1时有效 |
|
aw_description |
否 |
String |
脚本模板描述信息，在用例更新时添加 |
|
aw_ins_list |
否 |
Array of AwInstanceReq objects |
组合关键字包含的关键字实例信息，关键字类型为2时该字段有效 |
|
aw_mark |
否 |
Integer |
关键字标记 0-normal；1-new；2-update 3-delete |
|
aw_operationid |
否 |
String |
接口的唯一标识 |
|
aw_tags |
否 |
String |
接口的标签 |
|
aw_type |
否 |
Integer |
关键字类型1-普通关键字,2-组合关键字,3-导入关键字 |
|
aw_uniqueid |
否 |
String |
关键字唯一标识和标签的拼接 |
|
by_order |
否 |
Integer |
顺序 |
|
create_time |
否 |
DateTime |
创建时间 |
|
create_user |
否 |
String |
创建人 |
|
create_user_id |
否 |
String |
创建人唯一标识 |
|
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 |
组名 |
|
has_code |
否 |
Integer |
是否自带代码 0-不自带代码，该关键字依赖source字段中的源；1-自带代码 |
|
id |
否 |
String |
唯一标识 |
|
import_package |
否 |
Array of strings |
导入的包 |
|
interface_label |
否 |
String |
接口的x-extend |
|
is_favorite |
否 |
Integer |
是否是当前工程的收藏关键字，该字段不存数据库，每次获取时实时判断 |
|
keyword_variable_value |
否 |
Array of AwVariable objects |
关键字局部变量 |
|
method |
否 |
String |
方法 |
|
name |
否 |
String |
名称 |
|
nameView |
否 |
String |
关键字在页面上显示的名字 |
|
origin_project |
否 |
String |
源工程信息，如果该关键字是从其他工程过来的(继承或者copy to local) |
|
output_param_list |
否 |
Array of AwVariable objects |
组合关键字的输出参数信息，该字段不存数据库，实时获取 |
|
param_type_and_dft_value |
否 |
Array of AwParam objects |
参数类型和参数默认值对应集合 |
|
project_id |
否 |
String |
参数解释 项目唯一标识 |
|
protocol_type |
否 |
String |
协议类型 (http/dsf/other) |
|
public_aw_lib |
否 |
PublicAwLibReq object |
参数解释 公共关键字信息 |
|
public_aw_lib_id |
否 |
String |
参数解释 所属公共关键字库唯一标识 |
|
region |
否 |
String |
区域 |
|
return_type |
否 |
String |
参数解释 返回类型 |
|
source |
否 |
String |
参数解释 来源 |
|
special_type |
否 |
Integer |
测试步骤来源 |
|
tmssCaseNumber |
否 |
String |
参数解释 关键字管理的用例编号 |
|
tmss_case_id |
否 |
String |
参数解释 关键字关键字管理的用例ID |
|
update_time |
否 |
DateTime |
更新时间 |
|
update_user |
否 |
String |
更新人 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
create_time |
否 |
DateTime |
创建时间 |
|
create_user |
否 |
String |
创建人 |
|
document_link |
否 |
String |
文档链接 |
|
id |
否 |
String |
唯一标识 |
|
name |
否 |
String |
名称 |
|
net_area |
否 |
Array of strings |
蓝区:Blue,绿区:Green,黄区:Yellow |
|
product_line |
否 |
String |
产品线 |
|
repo_branch |
否 |
String |
仓库分支 |
|
repo_lib_path |
否 |
String |
存公共关键字依赖jar包的目录 |
|
repo_password |
否 |
String |
仓库密码 |
|
repo_private_key |
否 |
String |
仓库秘钥 |
|
repo_url |
否 |
String |
仓库地址 |
|
repo_username |
否 |
String |
仓库用户名 |
|
update_time |
否 |
DateTime |
更新时间 |
|
update_user |
否 |
String |
更新人 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
error_content |
否 |
String |
错误内容的描述 |
|
error_index |
否 |
String |
错误索引的描述 |
|
error_point |
否 |
String |
错误点的描述 |
|
high_light |
否 |
Boolean |
是否高亮标识 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
comparison |
否 |
String |
参数解释 比较符 |
|
description |
否 |
String |
参数解释 描述信息 |
|
function_arg |
否 |
String |
参数解释 类型值 |
|
function_type |
否 |
String |
参数解释 高级提取类型 |
|
property |
否 |
String |
参数解释 属性名称 |
|
value |
否 |
String |
参数解释 目标值 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
childImportPackage |
否 |
Array of strings |
子级导入的包 |
|
document_link |
否 |
String |
文档链接 |
|
http_method |
否 |
String |
http请求方法 |
|
http_url |
否 |
String |
HTTP请求的URL |
|
importPackage |
否 |
Array of strings |
导入的包 |
|
mock |
否 |
MockInfo object |
关键字实例中的mock信息 |
|
outputParam |
否 |
Array of AwVariable objects |
输出参数 |
|
param_dependent |
否 |
String |
参数依赖 |
|
summary |
否 |
String |
摘要 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
by_order |
否 |
Integer |
参数解释 节点顺序 |
|
currentPermission |
否 |
String |
参数解释 当前人员权限 |
|
description |
否 |
String |
参数解释 参数描述 |
|
dynamicParam |
否 |
String |
参数解释 动态参数名称 |
|
dynamicParamFlag |
否 |
Boolean |
参数解释 动态参数标志,默认为false. true代表动态参数; false代表非动态参数 |
|
functionParams |
否 |
String |
参数解释 变量参数（[]:空参、[a]:一参，[a,b]:两参） |
|
function_arg |
否 |
String |
参数解释 提取类型的类型值 |
|
function_type |
否 |
String |
参数解释 高级提取类型，响应提取时要使用什么方法处理参数 |
|
isSensitiveInfo |
否 |
Boolean |
参数解释 是否是敏感字段 |
|
isSensitiveModified |
否 |
Boolean |
参数解释 敏感字段是否被修改，不敏感字段不关注此值 |
|
is_out_put |
否 |
Boolean |
参数解释 是否是组合关键字的输出参数，只有组合关键字下awInstance的关键字变量有该字段 |
|
name |
否 |
String |
参数解释 参数名称 |
|
node_id |
否 |
String |
参数解释 节点id |
|
node_type |
否 |
Integer |
参数解释 0/null-变量节点; 1-目录节点 |
|
oldName |
否 |
String |
参数解释 旧名称 |
|
parent_node_id |
否 |
String |
参数解释 父节点唯一标识 |
|
property |
否 |
String |
参数解释 属性 |
|
regex |
否 |
String |
参数解释 内置函数枚举 |
|
sensitiveInfoSetterTime |
否 |
String |
参数解释 敏感参数设置时间 |
|
sensitiveInfoSetterUser |
否 |
String |
参数解释 敏感参数设置者名称 |
|
type |
否 |
String |
参数解释 类型 |
|
variableType |
否 |
Integer |
参数解释 变量类型（0：text，10-16：分别对应7个内置函数） |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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 |
参数解释 关键字参数描述 |
|
disabled |
否 |
Boolean |
参数解释 是否禁用,只有非必需参数才能被禁用 |
|
drop_down_value |
否 |
String |
参数解释 用于存储下拉菜单的值 |
|
enum_type |
否 |
String |
参数解释 枚举类型 |
|
enum_type_selected |
否 |
String |
参数解释 当前选中的枚举类型 |
|
format |
否 |
String |
参数解释 num和String有效 |
|
in_type |
否 |
Integer |
参数解释 rest接口输入参数类型: 0-query 1-path 2-body 3-header 4-formdata 5-config |
|
isChecked |
否 |
Boolean |
参数解释 是否是被选中参数 |
|
is_big_field |
否 |
Boolean |
参数解释 是否是大字段参数 |
|
is_body_custom |
否 |
Integer |
参数解释 requestBody是否自定义，inType为2时有效。0-非自定义，用原有逻辑；1-自定义body,requestBody直接使用字段customBody |
|
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 |
参数解释 参数名 |
|
object_value |
否 |
Array of AwParam objects |
参数解释 valueType为2时该值有效。valueType为3时，该值用来表示数组中单个结构体 |
|
object_value_list |
否 |
Array<Array<AwParam>> |
参数解释 valueType为3时该值有效 |
|
pattern |
否 |
String |
参数解释 num和String有效 |
|
required |
否 |
Boolean |
参数解释 是否必需参数 |
|
type |
否 |
String |
参数解释 参数类型 |
|
validate_rule |
否 |
ValidateRule object |
参数解释 校验规则 |
|
value_type |
否 |
Integer |
参数解释 参数值类型 |
|
xChoiceValue |
否 |
String |
参数解释 choice选择关系 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
value |
否 |
String |
参数解释 参数默认值，用例有效 |
|
value_range |
否 |
String |
参数解释 参数值范围，逻辑用例有效 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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 |
参数解释 参数类型 |
|
validate_rule |
否 |
ValidateRule object |
参数解释 校验规则 |
|
value_type |
否 |
Integer |
参数解释 参数值类型 |
|
xChoiceValue |
否 |
String |
参数解释 choice选择关系 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
mock_id |
否 |
String |
参数解释 mock唯一标识 |
|
mock_switch |
否 |
Boolean |
参数解释 mock开关 |
|
mock_url |
否 |
String |
参数解释 mock地址 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
dependent_info |
否 |
Array of ConditionInstance objects |
参数解释 依赖信息列表 |
|
enabled |
否 |
Boolean |
参数解释 是否启用的标识符 |
|
is_configDep |
否 |
Boolean |
参数解释 配置依赖的标识符 |
|
is_dependent |
否 |
Boolean |
参数解释 是否依赖的标识符 |
|
message |
否 |
String |
参数解释 消息 |
|
result |
否 |
String |
参数解释 结果 |
|
special_char |
否 |
String |
参数解释 特殊字符 |
|
special_char_valid |
否 |
String |
参数解释 特殊字符的有效性 |
|
x_example |
否 |
String |
参数解释 示例 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
conditionIndex |
否 |
Integer |
参数解释 条件索引，用于标识当前处理的是哪个条件 |
|
conditionMap |
否 |
Map<String,Array<String>> |
参数解释 条件映射，键为整数，值为字符串列表，用于存储各个条件的信息 |
|
depParamMap |
否 |
Map<String,DepParamInstance> |
参数解释 依赖参数实例的映射 |
|
statementIndex |
否 |
Integer |
参数解释 声明索引，用于标识当前处理的是哪个声明 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
compareValue |
否 |
String |
参数解释 比较值 |
|
comparison |
否 |
String |
参数解释 比较符 |
|
condition |
否 |
Boolean |
参数解释 条件 |
|
inValidValues |
否 |
Array of strings |
参数解释 无效值列表 |
|
name |
否 |
String |
参数解释 名称 |
|
nullInfo |
否 |
String |
参数解释 空值信息 |
|
relationMap |
否 |
Map<String,String> |
参数解释 关系映射，key为整数，value为字符串 |
|
relationNum |
否 |
Integer |
参数解释 关系数量 |
|
values |
否 |
Array of strings |
参数解释 值列表 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
参数解释 错误码 |
|
error |
CommonResponseErrorObject object |
参数解释 统一错误返回 |
|
reason |
String |
参数解释 失败原因 |
|
result |
Object |
参数解释 结果 |
|
status |
String |
参数解释 响应状态 |
状态码：201
Created
状态码：401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释 接口调用失败错误码 取值范围 12-18个字符组成的字符串 |
|
error_msg |
String |
参数解释 接口调用失败错误信息 取值范围 3-1000个字符组成的字符串 |
状态码：403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释 接口调用失败错误码 取值范围 12-18个字符组成的字符串 |
|
error_msg |
String |
参数解释 接口调用失败错误信息 取值范围 3-1000个字符组成的字符串 |
状态码：404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释 接口调用失败错误码 取值范围 12-18个字符组成的字符串 |
|
error_msg |
String |
参数解释 接口调用失败错误信息 取值范围 3-1000个字符组成的字符串 |
请求示例
{
"name" : "CombinAW_98rZu",
"description" : "CombinAW_description_Sqjhf",
"import_package" : [ ],
"aw_ins_list" : [ {
"id" : "",
"aw_id" : "",
"aw_type" : 1,
"is_disabled" : 0,
"condition_type" : 20,
"condition_statement" : 3000,
"checkedForKeyword" : false,
"isEdit" : false
} ],
"group_name" : "ef3afde7e5144fdf8de1ecad0069b34d",
"param_type_and_dft_value" : [ ],
"keyword_variable_value" : [ ]
}响应示例
状态码：200
OK
{
"status" : "ok",
"result" : {
"id" : "e91be3f0029845a4bffbe283e96e0a95"
},
"reason" : null,
"error" : null,
"code" : null,
"costTimeResult" : null
}状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
201 |
Created |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
错误码
请参见错误码。
