Scenario

Scenario Design and Orchestration Management - Visually design and manage complex test workflows through a UI-driven interface

---

Query the basic information list of scenario

GET

/api/v1/scenario

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

查询参数

id

类型integer

format"int64"

name

类型string

projectId*

Project id

类型integer

必填

format"int64"

plugin

类型string

scriptType

类型string

枚举

"TEST_FUNCTIONALITY""TEST_PERFORMANCE""TEST_STABILITY""TEST_CUSTOMIZATION""MOCK_DATA""MOCK_APIS"

admin

Required when app administrators query all scenarios

类型boolean

hasPermission

Required when the user query has the one permission scenario

类型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

Page data size, default 1, maximum 100000

类型integer

format"int32"

maximum100000

minimum1

pageSize

Page data size, default 10, maximum 2000

类型integer

format"int32"

maximum2000

minimum1

orderBy

Sort field

类型string

orderSort

Sorting method

类型string

枚举

"ASC""DESC"

filters[0].key

Filter field name

类型string

filters[0].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型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

Filter value

filters[1].key

Filter field name

类型string

filters[1].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型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

Filter value

filters[2].key

Filter field name

类型string

filters[2].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型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

Filter value

infoScope

Query information scope

类型string

枚举

"BASIC""DETAIL"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

/api/v1/scenario

试验场

授权

UserHttpBearer

变量

键

值

id

name

projectId*

plugin

scriptType

admin

hasPermission

createdBy

createdDate

lastModifiedBy

lastModifiedDate

favouriteBy

followBy

pageNo

pageSize

orderBy

orderSort

filters[0].key

filters[0].op

filters[0].value

filters[1].key

filters[1].op

filters[1].value

filters[2].key

filters[2].op

filters[2].value

infoScope

示例

cURL

JavaScript

PHP

Python

---

Replace scenario

PUT

/api/v1/scenario

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PUT

/api/v1/scenario

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

Add scenario

POST

/api/v1/scenario

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

POST

/api/v1/scenario

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

Update scenario

PATCH

/api/v1/scenario

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PATCH

/api/v1/scenario

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

Clone scenario

POST

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

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Scenario id

类型integer

必填

format"int64"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

POST

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

试验场

授权

UserHttpBearer

变量

键

值

id*

示例

cURL

JavaScript

PHP

Python

---

Import the scenario example

POST

/api/v1/scenario/example/import

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

查询参数

projectId*

Project id

类型integer

必填

format"int64"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

POST

/api/v1/scenario/example/import

试验场

授权

UserHttpBearer

变量

键

值

projectId*

示例

cURL

JavaScript

PHP

Python

---

Move the scenario to another dir

PATCH

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

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

scenarioId*

Scenario id

类型integer

必填

format"int64"

targetProjectId*

Target parent id

类型integer

必填

format"int64"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PATCH

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

试验场

授权

UserHttpBearer

变量

键

值

scenarioId*

targetProjectId*

示例

cURL

JavaScript

PHP

Python

---

Query the detail of scenario

GET

/api/v1/scenario/{id}

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Scenario id

类型integer

必填

format"int64"

响应

OK

GET

/api/v1/scenario/{id}

试验场

授权

UserHttpBearer

变量

键

值

id*

示例

cURL

JavaScript

PHP

Python

---

Delete scenario

DELETE

/api/v1/scenario/{id}

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Scenario id

类型integer

必填

format"int64"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

DELETE

/api/v1/scenario/{id}

试验场

授权

UserHttpBearer

变量

键

值

id*

示例

cURL

JavaScript

PHP

Python

---

Fulltext search the basic information list of scenario

GET

/api/v1/scenario/search

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

查询参数

id

类型integer

format"int64"

name

类型string

projectId*

Project id

类型integer

必填

format"int64"

plugin

类型string

scriptType

类型string

枚举

"TEST_FUNCTIONALITY""TEST_PERFORMANCE""TEST_STABILITY""TEST_CUSTOMIZATION""MOCK_DATA""MOCK_APIS"

admin

Required when app administrators query all scenarios

类型boolean

hasPermission

Required when the user query has the one permission scenario

类型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

Page data size, default 1, maximum 100000

类型integer

format"int32"

maximum100000

minimum1

pageSize

Page data size, default 10, maximum 2000

类型integer

format"int32"

maximum2000

minimum1

orderBy

Sort field

类型string

orderSort

Sorting method

类型string

枚举

"ASC""DESC"

filters[0].key

Filter field name

类型string

filters[0].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型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

Filter value

filters[1].key

Filter field name

类型string

filters[1].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型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

Filter value

filters[2].key

Filter field name

类型string

filters[2].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型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

Filter value

infoScope

Query information scope

类型string

枚举

"BASIC""DETAIL"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

/api/v1/scenario/search

试验场

授权

UserHttpBearer

变量

键

值

id

name

projectId*

plugin

scriptType

admin

hasPermission

createdBy

createdDate

lastModifiedBy

lastModifiedDate

favouriteBy

followBy

pageNo

pageSize

orderBy

orderSort

filters[0].key

filters[0].op

filters[0].value

filters[1].key

filters[1].op

filters[1].value

filters[2].key

filters[2].op

filters[2].value

infoScope

示例

cURL

JavaScript

PHP

Python

---

Query the list of scenario

GET

/api/v1/scenario/list

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

查询参数

ids*

类型array

必填

maxItems200

minItems0

uniqueItemstrue

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

/api/v1/scenario/list

试验场

授权

UserHttpBearer

变量

键

值

ids*

示例

cURL

JavaScript

PHP

Python

---