分页获取工程关键字详细信息列表(含目录)
功能介绍
分页获取工程关键字列表(含目录)
调用方法
请参见如何调用API。
URI
GET /v2/{project_id}/aw-cata/aw-info-list
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释 项目UUID,项目唯一标识,固定长度32位字符(字母和数字)。获取方式请参见获取项目唯一标识。 约束限制 不涉及 取值范围 32个字符组成的字符串 默认取值 不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
aw_name |
否 |
String |
过滤条件 |
page_no |
是 |
String |
当前页数 |
page_size |
是 |
String |
每页多少记录 |
parent_id |
否 |
String |
父目录唯一标识 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 字符串长度不少于1,不超过10万。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
code |
String |
参数解释 错误码 |
error |
参数解释 统一错误返回 |
|
reason |
String |
参数解释 失败原因 |
result |
PageResultBasicAWInfo object |
参数解释 结果 |
status |
String |
参数解释 状态 |
参数 |
参数类型 |
描述 |
---|---|---|
code |
String |
参数解释 错误码 |
detail |
PageResultBasicAWInfo object |
参数解释 错误信息详情 |
reason |
String |
参数解释 错误原因 |
参数 |
参数类型 |
描述 |
---|---|---|
page_list |
Array of BasicAWInfo objects |
参数解释 当前页数据 |
page_no |
Integer |
参数解释 当前页数 |
page_size |
Integer |
参数解释 每页条数 |
total_page |
Integer |
参数解释 总页数 |
total_size |
Long |
参数解释 数据总条数 |
参数 |
参数类型 |
描述 |
---|---|---|
aw_code |
String |
参数解释 关键字代码, hasCode为1时有效 |
aw_description |
String |
参数解释 模板描述 |
aw_ins_list |
Array of AwInstanceRes 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 |
参数解释 顺序 |
cata_type |
Integer |
参数解释 目录层级 |
child_list |
Array of BasicAWInfo objects |
参数解释 新增childList以支持嵌套层级结构 |
create_time |
String |
参数解释 创建时间 |
create_time_stamp |
Long |
参数解释 时间戳字段 |
create_time_string |
String |
参数解释 时间字符串 |
create_user |
String |
参数解释 创建者 |
create_user_id |
String |
参数解释 创建者唯一标识 |
custom_aw_libs |
Array of UploadFileRes objects |
参数解释 自定义关键字的依赖包 |
delete_time |
String |
参数解释 删除时间 |
delete_user |
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 |
参数解释 是否是当前工程的收藏关键字,该字段不存数据库,每次获取时实时判断 |
is_folder |
String |
参数解释 判断是否为文件夹的标识 |
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 |
参数解释 组合关键字的输出参数信息,该字段不存数据库,实时获取 |
page_no |
Integer |
参数解释 当前页数 |
page_size |
Integer |
参数解释 每页条数 |
param_type_and_dft_value |
Array of AwParam objects |
参数解释 参数类型和参数默认值对应List |
parent_id |
String |
参数解释 关键字目录父编号 |
project_id |
String |
参数解释 项目唯一标识 |
protocol_type |
String |
参数解释 协议类型 (http/https/other) |
public_aw_lib |
PublicAwLibRes object |
参数解释 公共关键字信息 |
public_aw_lib_id |
String |
参数解释 所属公共关键字库唯一标识 |
region |
String |
参数解释 区域名称 |
return_type |
String |
参数解释 返回类型 |
root_id |
String |
参数解释 root唯一标识 |
source |
String |
参数解释 来源 |
special_type |
Integer |
参数解释 特殊关键字类型 0-common,10-header,1-beforeHeader |
tmssCaseNumber |
String |
参数解释 关键字管理的用例编号 |
tmss_case_id |
String |
参数解释 关键字关键字管理的用例唯一标识 |
total_page |
Integer |
参数解释 总页数 |
total_size |
Integer |
参数解释 总条数 |
update_time |
String |
参数解释 更新时间 |
update_time_stamp |
Long |
参数解释 更新时间戳 |
update_time_string |
String |
参数解释 更新字符串 |
update_user |
String |
参数解释 更新者 |
warningMsg |
String |
参数解释 警告信息 |
yamlName |
String |
参数解释 所属yaml文件名称,该字段不存库,用来记录从哪个yaml文件导入 |
参数 |
参数类型 |
描述 |
---|---|---|
alias_runaw |
String |
关键字内容描述字段 |
authentication_info |
AuthInfo object |
认证信息 |
authentication_type |
String |
认证类型,0-无认证;1-aksk认证 |
aw_description |
String |
脚本模板描述信息,在用例更新时添加 |
aw_id |
String |
关键字唯一标识 |
aw_type |
Integer |
关键字类型 0-setup;1-test;2-teardown |
basic_aw |
BasicAwRes object |
关键字 |
body_param_type |
String |
关键字实例的参数body体类型:form/text |
by_order |
Integer |
顺序 |
changeSign |
Integer |
变化标志 |
check_point_list |
Array of CheckPoint objects |
检查点集合 |
children |
Array of AwInstanceRes objects |
关键字实例 |
condition_statement |
String |
条件语句 |
condition_type |
Integer |
条件类型 0-not condition;1-if begin;2-if |
create_time |
String |
创建时间 |
create_time_stamp |
Long |
创建时间戳 |
create_time_string |
String |
创建时间字符串 |
create_user |
String |
创建人 |
custom_header |
Array of AwParam objects |
测试步骤自定义请求头List;后续自定义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判断语句 |
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 |
用例级别 |
name |
String |
名称 |
param_dependent |
String |
参数依赖规则 |
param_dependent_enabled |
Integer |
是否启用参数依赖 |
param_type_and_value |
Array of AwParam objects |
参数类型和参数值对应集合 |
projectId |
String |
项目的唯一标识 |
region |
String |
区域名称 |
relation |
String |
关键字唯一标识层级关系 |
relation_id |
String |
层级关系唯一标识 |
relation_type |
Integer |
映射类型 1-反向删除映射;2-用例自动添加的方向删除步骤 |
retry_interval |
String |
重试间隔时间 (ms) 为空表示不等待 |
retry_times |
String |
重试次数 |
scriptName |
String |
获取脚本生成时,要使用的步骤名称 |
service_and_stage |
String |
关键字所来自工程的服务名和阶段名 fromOutside为1时该值有效 |
special_type |
Integer |
测试步骤来源 |
update_time |
String |
更新时间 |
update_time_stamp |
Long |
更新时间戳 |
update_time_string |
String |
更新时间字符串 |
update_user |
String |
更新人 |
user_id |
String |
用户唯一标识 |
variable_list |
Array of AwVariable objects |
定义的变量信息 |
参数 |
参数类型 |
描述 |
---|---|---|
aw_code |
String |
参数解释 关键字代码, hascode字段为1时有效 |
aw_description |
String |
参数解释 关键字描述 |
aw_mark |
Integer |
参数解释 关键字标记 |
aw_operationid |
String |
参数解释 关键字操作编号 |
aw_tags |
String |
参数解释 关键字标签 |
aw_type |
Integer |
参数解释 关键字类型 |
aw_uniqueid |
String |
参数解释 关键字来源 |
by_order |
Integer |
参数解释 关键字顺序 |
create_time |
String |
参数解释 关键字创建时间 |
create_time_stamp |
Long |
参数解释 关键字创建时间戳 |
create_time_string |
String |
参数解释 关键字创建时间戳(字符串格式) |
create_user |
String |
参数解释 关键字创建者 |
create_user_id |
String |
参数解释 关键字创建者ID |
delete_time |
String |
参数解释 关键字删除时间 |
delete_user |
String |
参数解释 关键字删除者 |
description |
String |
参数解释 关键字描述 |
dft_check_point_list |
Array of objects |
参数解释 默认检查点列表 |
dft_custom_header |
Array of objects |
参数解释 默认请求头参数对象 |
dft_retry_interval |
String |
参数解释 重试间隔时间 (ms) ,为空表示不等待 |
dft_retry_times |
String |
参数解释 重试次数 |
keyword_variable_value |
Array of AwVariable objects |
参数解释 变量值 |
dft_variable_list |
Array of objects |
参数解释 默认变量信息列表 |
aw_ins_list |
Array of AwInstance objects |
组合关键字包含的关键字实例信息,关键字类型为2时该字段有效 |
output_param_list |
Array of AwVariable objects |
参数解释 组合关键字的输出参数信息,该字段不存数据库,实时获取 |
custom_aw_libs |
Array of UploadFile objects |
关键字库的文件列表 |
extra_info |
Object |
参数解释 补充信息 |
group_name |
String |
参数解释 分组名 |
has_code |
Integer |
参数解释 是否存在代码, 0-不存在代;1-存在代码 |
id |
String |
参数解释 关键字编号 |
import_package |
Array of strings |
参数解释 导入的包名 |
interface_label |
String |
参数解释 接口的x-extend字段说明 |
is_favorite |
Integer |
参数解释 是否收藏 |
method |
String |
参数解释 关键字方法名 |
name |
String |
参数解释 关键字名 |
nameView |
String |
参数解释 在页面上显示的名字 |
origin_project |
String |
参数解释 源工程信息 |
param_type_and_dft_value |
Array of objects |
参数解释 参数类型和参数默认值 |
project_id |
String |
参数解释 工程编号 |
protocol_type |
String |
参数解释 协议类型 |
public_aw_lib |
Object |
参数解释 公共关键字信息 |
public_aw_lib_id |
String |
参数解释 公共关键字唯一标识 |
region |
String |
参数解释 region信息 |
return_type |
String |
参数解释 返回值类型 |
root_id |
String |
参数解释 根节点编号 |
source |
String |
参数解释 关键字依赖的类源 |
special_type |
Integer |
参数解释 特殊关键字类型 |
tmssCaseNumber |
String |
参数解释 关键字编号(来自测试管理服务) |
tmss_case_id |
String |
参数解释 测试用例唯一标识 |
update_time |
String |
参数解释 关键字更新时间 |
update_time_stamp |
Long |
参数解释 关键字更新时间戳 |
update_time_string |
String |
参数解释 关键字更新时间戳(字符串格式) |
update_user |
String |
参数解释 关键字更新者 |
warningMsg |
String |
参数解释 警告信息 |
yamlName |
String |
参数解释 yaml名称 |
参数 |
参数类型 |
描述 |
---|---|---|
alias_runaw |
String |
关键字内容描述字段 |
authentication_info |
AuthInfo object |
认证信息 |
authentication_type |
String |
认证类型,0-无认证;1-aksk认证 |
aw_description |
String |
脚本模板描述信息,在用例更新时添加 |
aw_id |
String |
关键字唯一标识 |
aw_type |
Integer |
关键字类型 0-setup;1-test;2-teardown |
basic_aw |
BasicAw object |
关键字 |
body_param_type |
String |
关键字实例的参数body体类型:form/text |
by_order |
Integer |
顺序 |
changeSign |
Integer |
变化标志 |
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 |
创建时间 |
create_time_stamp |
Long |
创建时间戳 |
create_time_string |
String |
创建时间字符串 |
create_user |
String |
创建人 |
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判断语句 |
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 |
用例级别 |
name |
String |
名称 |
param_dependent |
String |
参数依赖 |
param_dependent_enabled |
Integer |
是否启用参数依赖 |
param_type_and_value |
Array of AwParam objects |
参数类型和参数值对应集合 |
projectId |
String |
工程唯一标识 |
region |
String |
区域名称 |
relation |
String |
关键字唯一标识层级关系 |
relation_id |
String |
层级关系唯一标识 |
relation_type |
Integer |
映射类型 1-反向删除映射;2-用例自动添加的方向删除步骤 |
retry_interval |
String |
重试间隔时间 (ms) 为空表示不等待 |
retry_times |
String |
重试次数 |
scriptName |
String |
获取脚本生成时,要使用的步骤名称 |
service_and_stage |
String |
关键字所来自工程的服务名和阶段名 fromOutside为1时该值有效 |
special_type |
Integer |
测试步骤来源 |
update_time |
String |
更新时间 |
update_time_stamp |
Long |
更新时间戳 |
update_time_string |
String |
更新时间字符串 |
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 AwInstance 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 |
String |
创建时间 |
create_time_stamp |
Long |
创建时间戳 |
create_time_string |
String |
创建时间字符串 |
create_user |
String |
创建人 |
create_user_id |
String |
创建人唯一标识 |
custom_aw_libs |
Array of UploadFile objects |
关键字库的文件列表 |
delete_time |
String |
删除时间 |
delete_user |
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 |
PublicAwLib object |
公共关键字信息 |
public_aw_lib_id |
String |
所属公共关键字库唯一标识 |
region |
String |
区域名称 |
return_type |
String |
返回类型 |
root_id |
String |
root唯一标识 |
source |
String |
来源 |
special_type |
Integer |
测试步骤来源 |
tmssCaseNumber |
String |
关键字管理的用例编号 |
tmss_case_id |
String |
关键字管理的用例唯一标识 |
update_time |
DateTime |
更新时间 |
update_time_stamp |
Long |
更新时间戳 |
update_time_string |
String |
更新时间字符串 |
update_user |
String |
更新人 |
warningMsg |
String |
警告信息 |
yamlName |
String |
所属yaml文件名称,该字段不存库,用来记录从哪个yaml文件导入 |
参数 |
参数类型 |
描述 |
---|---|---|
create_time |
DateTime |
创建时间 |
create_time_stamp |
Long |
创建时间戳 |
create_time_string |
String |
创建时间字符串 |
create_user |
String |
创建人 |
document_link |
String |
文档链接 |
id |
String |
唯一标识 |
name |
String |
名称 |
net_area |
Array of strings |
蓝区:Blue,绿区:Green,黄区:Yellow |
obs_temp_url |
String |
obs临时url |
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_time_stamp |
Long |
更新时间戳 |
update_time_string |
String |
更新时间字符串 |
update_user |
String |
更新人 |
参数 |
参数类型 |
描述 |
---|---|---|
awInsId |
String |
所属的关键字实例的唯一标识 |
create_time |
String |
创建时间 |
create_time_stamp |
Long |
创建时间戳 |
create_time_string |
String |
创建时间字符串 |
create_user |
String |
创建人 |
current_size |
Long |
当前大小 |
filePath |
String |
文件路径 |
id |
String |
唯一标识 |
name |
String |
名称 |
originName |
String |
文件的原名 |
projectId |
String |
项目唯一标识 |
region |
String |
区域名称 |
testcase_id |
String |
测试用例的唯一标识符 |
update_time |
String |
更新时间 |
update_time_stamp |
Long |
更新时间戳 |
update_time_string |
String |
更新时间字符串 |
update_user |
String |
更新人 |
参数 |
参数类型 |
描述 |
---|---|---|
error_content |
String |
错误内容的描述 |
error_index |
String |
错误索引的描述 |
error_point |
String |
错误点的描述 |
high_light |
Boolean |
是否高亮标识 |
参数 |
参数类型 |
描述 |
---|---|---|
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 |
摘要 |
参数 |
参数类型 |
描述 |
---|---|---|
awInsId |
String |
所属的关键字实例的唯一标识 |
create_time |
String |
创建时间 |
create_time_stamp |
Long |
创建时间戳 |
create_time_string |
String |
创建时间字符串 |
create_user |
String |
创建人 |
current_size |
Long |
当前大小 |
filePath |
String |
文件路径 |
id |
String |
唯一标识 |
name |
String |
文件在系统中的名字 |
originName |
String |
文件的原名 |
projectId |
String |
项目唯一标识 |
region |
String |
区域名称 |
testcase_id |
String |
测试用例的唯一标识符 |
update_time |
String |
更新时间 |
update_time_stamp |
Long |
更新时间戳 |
update_time_string |
String |
更新时间字符串 |
update_user |
String |
更新人 |
参数 |
参数类型 |
描述 |
---|---|---|
comparison |
String |
参数解释 比较符 |
description |
String |
参数解释 描述信息 |
function_arg |
String |
参数解释 类型值 |
function_type |
String |
参数解释 高级提取类型 |
property |
String |
参数解释 属性名称 |
value |
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选择关系 |
参数 |
参数类型 |
描述 |
---|---|---|
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 |
参数解释 值列表 |
参数 |
参数类型 |
描述 |
---|---|---|
create_time |
String |
创建时间 |
create_time_stamp |
Long |
创建时间戳 |
create_time_string |
String |
创建时间字符串 |
create_user |
String |
创建人 |
document_link |
String |
关联公共关键字时的编辑链接 |
id |
String |
唯一标识 |
name |
String |
名称 |
net_area |
Array of strings |
蓝区:Blue,绿区:Green,黄区:Yellow |
obs_temp_url |
String |
obs临时url |
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 |
String |
更新时间 |
update_time_stamp |
Long |
更新时间戳 |
update_time_string |
String |
更新时间字符串 |
update_user |
String |
更新人 |
状态码: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个字符组成的字符串 |
请求示例
{
"parent_id" : "TOP",
"page_no" : 1,
"page_size" : 0,
"search_type" : "name",
"search_value" : "",
"cata_type" : 0
}
响应示例
状态码:200
OK
{
"status" : "success",
"result" : {
"page_no" : 1,
"page_size" : 10,
"total_page" : 1,
"total_size" : 3,
"page_list" : [ {
"id" : "122d0e967213495ebb922b1f746b6784",
"warningMsg" : null,
"source" : "",
"method" : "",
"description" : null,
"nameView" : null,
"tmssCaseNumber" : null,
"region" : null,
"yamlName" : null,
"create_time_string" : "2025-06-12 19:51:09 GMT+08:00",
"update_time_string" : "2025-06-12 19:51:09 GMT+08:00",
"create_time_stamp" : 1749729069000,
"update_time_stamp" : 1749729069000,
"create_user" : "fdc93bccd8d040778701d4d35a4a4313",
"create_time" : "2025-06-12T07:51:09+0800",
"update_user" : "fdc93bccd8d040778701d4d35a4a4313",
"update_time" : "2025-06-12T07:51:09+0800",
"name" : "默认文件夹",
"param_type_and_dft_value" : null,
"dft_custom_header" : null,
"dft_check_point_list" : null,
"dft_variable_list" : null,
"keyword_variable_value" : null,
"dft_retry_times" : "",
"dft_retry_interval" : "",
"return_type" : "",
"aw_type" : 0,
"aw_ins_list" : null,
"project_id" : "1ac05b43669448f3bcc52446b1aa0b11",
"public_aw_lib_id" : "",
"special_type" : null,
"has_code" : null,
"aw_code" : "",
"group_name" : "",
"protocol_type" : "",
"by_order" : null,
"aw_mark" : null,
"output_param_list" : null,
"is_favorite" : null,
"tmss_case_id" : null,
"create_user_id" : "",
"aw_description" : null,
"origin_project" : null,
"aw_uniqueid" : null,
"aw_tags" : null,
"aw_operationid" : null,
"interface_label" : null,
"import_package" : null,
"public_aw_lib" : null,
"root_id" : null,
"custom_aw_libs" : null,
"delete_time" : null,
"delete_user" : null,
"parent_id" : "TOP",
"is_folder" : "0",
"cata_type" : 4,
"page_no" : null,
"page_size" : null,
"total_page" : null,
"total_size" : null,
"child_list" : [ ],
"extra_info" : null
}, {
"id" : "8f49efe3119c49e694f51ac0b2d8fceb",
"warningMsg" : null,
"source" : "",
"method" : "",
"description" : "",
"nameView" : null,
"tmssCaseNumber" : null,
"region" : null,
"yamlName" : null,
"create_time_string" : "2025-06-12 19:40:19 GMT+08:00",
"update_time_string" : "2025-06-12 19:40:19 GMT+08:00",
"create_time_stamp" : 1749728419000,
"update_time_stamp" : 1749728419000,
"create_user" : "CloudTest-0704",
"create_time" : "2025-06-12T07:40:19+0800",
"update_user" : "CloudTest-0704",
"update_time" : "2025-06-12T07:40:19+0800",
"name" : "cataFolder_E3HCO",
"param_type_and_dft_value" : null,
"dft_custom_header" : null,
"dft_check_point_list" : null,
"dft_variable_list" : null,
"keyword_variable_value" : null,
"dft_retry_times" : "",
"dft_retry_interval" : "",
"return_type" : "",
"aw_type" : 0,
"aw_ins_list" : null,
"project_id" : "1ac05b43669448f3bcc52446b1aa0b11",
"public_aw_lib_id" : "",
"special_type" : null,
"has_code" : null,
"aw_code" : "",
"group_name" : "",
"protocol_type" : "",
"by_order" : null,
"aw_mark" : null,
"output_param_list" : null,
"is_favorite" : null,
"tmss_case_id" : null,
"create_user_id" : "",
"aw_description" : null,
"origin_project" : null,
"aw_uniqueid" : null,
"aw_tags" : null,
"aw_operationid" : null,
"interface_label" : null,
"import_package" : null,
"public_aw_lib" : null,
"root_id" : null,
"custom_aw_libs" : null,
"delete_time" : null,
"delete_user" : null,
"parent_id" : "TOP",
"is_folder" : "0",
"cata_type" : 3,
"page_no" : null,
"page_size" : null,
"total_page" : null,
"total_size" : null,
"child_list" : [ ],
"extra_info" : null
}, {
"id" : "72ee811957a5401cb9d8ab07cb0c2a18",
"warningMsg" : null,
"source" : "",
"method" : "",
"description" : "",
"nameView" : null,
"tmssCaseNumber" : null,
"region" : null,
"yamlName" : null,
"create_time_string" : "2025-06-12 19:51:22 GMT+08:00",
"update_time_string" : "2025-06-12 19:51:22 GMT+08:00",
"create_time_stamp" : 1749729082000,
"update_time_stamp" : 1749729082000,
"create_user" : "CloudTest-0704",
"create_time" : "2025-06-12T07:51:22+0800",
"update_user" : "CloudTest-0704",
"update_time" : "2025-06-12T07:51:22+0800",
"name" : "cataFolder_mI6Ex",
"param_type_and_dft_value" : null,
"dft_custom_header" : null,
"dft_check_point_list" : null,
"dft_variable_list" : null,
"keyword_variable_value" : null,
"dft_retry_times" : "",
"dft_retry_interval" : "",
"return_type" : "",
"aw_type" : 0,
"aw_ins_list" : null,
"project_id" : "1ac05b43669448f3bcc52446b1aa0b11",
"public_aw_lib_id" : "",
"special_type" : null,
"has_code" : null,
"aw_code" : "",
"group_name" : "",
"protocol_type" : "",
"by_order" : null,
"aw_mark" : null,
"output_param_list" : null,
"is_favorite" : null,
"tmss_case_id" : null,
"create_user_id" : "",
"aw_description" : null,
"origin_project" : null,
"aw_uniqueid" : null,
"aw_tags" : null,
"aw_operationid" : null,
"interface_label" : null,
"import_package" : null,
"public_aw_lib" : null,
"root_id" : null,
"custom_aw_libs" : null,
"delete_time" : null,
"delete_user" : null,
"parent_id" : "TOP",
"is_folder" : "0",
"cata_type" : 3,
"page_no" : null,
"page_size" : null,
"total_page" : null,
"total_size" : null,
"child_list" : [ ],
"extra_info" : null
} ]
},
"reason" : null,
"error" : null,
"code" : null,
"costTimeResult" : null
}
状态码
状态码 |
描述 |
---|---|
200 |
OK |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
错误码
请参见错误码。