Skip to content

ScenarioTest

User Scenario Testing - End-user interfaces for executing and tracking custom test scenarios


Configure and generate functionality, performance, stability testing tasks of scenario, which will override the configuration when the task exists

PUT
/api/v1/scenario/{id}/test/task/{taskSprintId}/generate

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Scenario id

类型integer
必填
format"int64"

查询参数

taskSprintId

Task sprint id, it is required for agile project management

类型integer
format"int64"

请求体

application/json
JSON
[
{
"assigneeId": 0,
"testType": "FUNCTIONAL",
"priority": "MEDIUM",
"deadlineDate": "2022-12-01 12:00:00"
}
]

响应

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场

授权
变量
主体

示例

cURL
JavaScript
PHP
Python

Find enabled functionality, performance, stability testing type of scenario

GET
/api/v1/scenario/{id}/test/enabled

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*
类型integer
必填
format"int64"

响应

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

Enable or disable the functionality, performance, stability testing of scenarioAfter enabled, the test will be marked as a mandatory activity and the results will be included in the performance analysis

PUT
/api/v1/scenario/{id}/test/enabled

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*
类型integer
必填
format"int64"

查询参数

testTypes*

Apis test type, allowable values: PERFORMANCE, FUNCTIONAL, STABILITY

类型array
必填
uniqueItemstrue
enabled*

Enabled or Disabled

类型boolean
必填

响应

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

Create the scenario testing execution. Note: Only HTTP servers is supported

PUT
/api/v1/scenario/{id}/exec

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Scenario id

类型integer
必填
format"int64"

请求体

application/json
JSON
[
{
"url": "https://{env}-api.xcan.cloud:{port}/{basePath}",
"description": "The production API server",
"variables": {
"extensions": {
"additionalProperties": {
}
},
"empty": true,
"additionalProperties": {
}
},
"extensions": {
"additionalProperties": {
}
},
"emptyContent": true,
"notEmptyContent": true
}
]

响应

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场

授权
变量
主体

示例

cURL
JavaScript
PHP
Python

Restart the existing functionality, performance, stability testing tasks of scenario

PATCH
/api/v1/scenario/{id}/test/task/restart

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Scenario id

类型integer
必填
format"int64"

响应

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

Reopen the existing functionality, performance, stability testing tasks of scenario

PATCH
/api/v1/scenario/{id}/test/task/reopen

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Scenario id

类型integer
必填
format"int64"

响应

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

Query all server configurations of the scenario

GET
/api/v1/scenario/{id}/test/schema/server

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Scenario id

类型integer
必填
format"int64"

响应

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

Query the test results of scenario

GET
/api/v1/scenario/{id}/test/result

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Scenario id

类型integer
必填
format"int64"

响应

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

The testing scenario summary the functionality, performance, stability testing of project

GET
/api/v1/project/{id}/test/scenario/count

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*
类型integer
必填
format"int64"

查询参数

creatorObjectType

Query organization type, default USER

类型string
枚举
"USER""DEPT""GROUP"
creatorObjectId

Query organization id

类型integer
format"int64"
createdDateStart

Resources creation start date

类型string
format"date-time"
createdDateEnd

Resources creation end date

类型string
format"date-time"

响应

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

Delete the functionality, performance, stability testing tasks of scenario

DELETE
/api/v1/scenario/{id}/test/task

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Scenario id

类型integer
必填
format"int64"

查询参数

testTypes*

Test type

类型array
必填
uniqueItemstrue

响应

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

Released under the GPL-3.0 License.