跳转到内容

场景

场景设计与编排管理 - 通过可视化界面驱动的方式,设计和管控复杂的测试工作流


查询场景列表

GET
/api/v1/scenario/list

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

查询参数

ids*
类型array
必填
maxItems200
minItems0
uniqueItemstrue

响应

成功

*/*
JSON
"string"

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

导入场景示例

POST
/api/v1/scenario/example/import

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

查询参数

projectId*

项目ID

类型integer
必填
format"int64"

响应

成功

*/*
JSON
"string"

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

查询场景详情

GET
/api/v1/scenario/{id}

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

路径参数

id*

场景ID

类型integer
必填
format"int64"

响应

成功

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

删除场景

DELETE
/api/v1/scenario/{id}

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

路径参数

id*

场景ID

类型integer
必填
format"int64"

响应

成功

*/*
JSON
"string"

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

查询场景的基础信息列表

GET
/api/v1/scenario

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

查询参数

id
类型integer
format"int64"
name
类型string
projectId*

项目ID

类型integer
必填
format"int64"
plugin
类型string
scriptType
类型string
枚举
"TEST_FUNCTIONALITY""TEST_PERFORMANCE""TEST_STABILITY""TEST_CUSTOMIZATION""MOCK_DATA""MOCK_APIS"
admin

当应用管理员查询所有场景时为必填项

类型boolean
hasPermission

当用户查询涉及单一权限场景时必填

类型string
枚举
"VIEW""MODIFY""DELETE""TEST""GRANT""EXPORT"
createdBy
类型integer
format"int64"
createdDate
类型string
format"date-time"
lastModifiedBy
类型integer
format"int64"
lastModifiedDate
类型string
format"date-time"
favouriteBy
类型integer
format"int64"
followBy
类型integer
format"int64"
pageNo

页面数据大小,默认为1,最大值为100000

类型integer
format"int32"
maximum100000
minimum1
pageSize

页面数据大小,默认为10,最大值为2000

类型integer
format"int32"
maximum2000
minimum1
orderBy

排序字段

类型string
orderSort

排序方式

类型string
枚举
"ASC""DESC"
filters[0].key

筛选字段名称

类型string
filters[0].op

过滤条件(等于、不等于、大于等)

类型string
枚举
"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"
filters[0].value

筛选值

类型object
filters[1].key

筛选字段名称

类型string
filters[1].op

过滤条件(等于、不等于、大于等)

类型string
枚举
"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"
filters[1].value

筛选值

类型object
filters[2].key

筛选字段名称

类型string
filters[2].op

过滤条件(等于、不等于、大于等)

类型string
枚举
"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"
filters[2].value

筛选值

类型object
infoScope

查询信息范围

类型string
枚举
"BASIC""DETAIL"

响应

成功

*/*
JSON
"string"

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

替换场景

PUT
/api/v1/scenario

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

请求体

application/json

响应

成功

*/*
JSON
"string"

试验场

授权
主体

示例

cURL
JavaScript
PHP
Python

添加场景

POST
/api/v1/scenario

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

请求体

application/json

响应

成功

*/*
JSON
"string"

试验场

授权
主体

示例

cURL
JavaScript
PHP
Python

更新场景

PATCH
/api/v1/scenario

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

请求体

application/json

响应

成功

*/*
JSON
"string"

试验场

授权
主体

示例

cURL
JavaScript
PHP
Python

将场景移动到另一个目录

PATCH
/api/v1/scenario/{scenarioId}/{targetProjectId}/move

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

路径参数

scenarioId*

场景ID

类型integer
必填
format"int64"
targetProjectId*

目标父级ID

类型integer
必填
format"int64"

响应

成功

*/*
JSON
"string"

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

克隆场景

POST
/api/v1/scenario/{id}/clone

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

路径参数

id*

场景ID

类型integer
必填
format"int64"

响应

成功

*/*
JSON
"string"

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

场景基础信息列表全文搜索

GET
/api/v1/scenario/search
UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

查询参数

id
类型integer
format"int64"
name
类型string
projectId*

项目ID

类型integer
必填
format"int64"
plugin
类型string
scriptType
类型string
枚举
"TEST_FUNCTIONALITY""TEST_PERFORMANCE""TEST_STABILITY""TEST_CUSTOMIZATION""MOCK_DATA""MOCK_APIS"
admin

当应用管理员查询所有场景时为必填项

类型boolean
hasPermission

当用户查询涉及单一权限场景时必填

类型string
枚举
"VIEW""MODIFY""DELETE""TEST""GRANT""EXPORT"
createdBy
类型integer
format"int64"
createdDate
类型string
format"date-time"
lastModifiedBy
类型integer
format"int64"
lastModifiedDate
类型string
format"date-time"
favouriteBy
类型integer
format"int64"
followBy
类型integer
format"int64"
pageNo

页面数据大小,默认为1,最大值为100000

类型integer
format"int32"
maximum100000
minimum1
pageSize

页面数据大小,默认为10,最大值为2000

类型integer
format"int32"
maximum2000
minimum1
orderBy

排序字段

类型string
orderSort

排序方式

类型string
枚举
"ASC""DESC"
filters[0].key

筛选字段名称

类型string
filters[0].op

过滤条件(等于、不等于、大于等)

类型string
枚举
"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"
filters[0].value

筛选值

类型object
filters[1].key

筛选字段名称

类型string
filters[1].op

过滤条件(等于、不等于、大于等)

类型string
枚举
"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"
filters[1].value

筛选值

类型object
filters[2].key

筛选字段名称

类型string
filters[2].op

过滤条件(等于、不等于、大于等)

类型string
枚举
"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"
filters[2].value

筛选值

类型object
infoScope

查询信息范围

类型string
枚举
"BASIC""DETAIL"

成功

*/*
JSON
"string"
授权
变量
cURL
JavaScript
PHP
Python

基于 GPL-3.0 许可发布