Execution

User Execution API - End-user scenario/script execution and result access

---

Replace execution script configuration

PUT

/api/v1/exec/{id}/script/config

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Execution id

类型integer

必填

格式"int64"

请求体

application/json

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PUT

/api/v1/exec/{id}/script/config

试验场

授权

UserHttpBearer

变量

键

值

id*

主体

示例

cURL

JavaScript

PHP

Python

---

Replace execution configuration

PUT

/api/v1/exec/{id}/config

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Execution id

类型integer

必填

格式"int64"

请求体

application/json

{

"name": "string",

"iterations": 0,

"duration": {

"value": 0,

"unit": "string"

},

"thread": 0,

"priority": 0,

"ignoreAssertions": true,

"updateTestResult": true,

"startMode": "string",

"startAtDate": "string",

"reportInterval": {

"value": 0,

"unit": "string"

}

}

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PUT

/api/v1/exec/{id}/config

试验场

授权

UserHttpBearer

变量

键

值

id*

主体

示例

cURL

JavaScript

PHP

Python

---

Stop execution

POST

/api/v1/exec/stop

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json

{

"broadcast": true,

"id": 0,

"remoteNodeIds": [

0

]

}

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

POST

/api/v1/exec/stop

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

Start execution

POST

/api/v1/exec/start

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json

{

"broadcast": true,

"id": 0,

"remoteNodeIds": [

0

],

"lastNodeId": 0

}

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

POST

/api/v1/exec/start

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

Create execution by script id

POST

/api/v1/exec/byscript

授权

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/exec/byscript

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

Create execution by script content

POST

/api/v1/exec/bycontent

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json

{

"projectId": 0,

"name": "string",

"scriptContent": "string",

"trial": true

}

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

POST

/api/v1/exec/bycontent

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

Create execution by script arguments

POST

/api/v1/exec/byargs

授权

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/exec/byargs

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

Query the list of execution

GET

/api/v1/exec

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

查询参数

projectId*

Project id

类型integer

必填

格式"int64"

id

类型integer

格式"int64"

name

类型string

plugin

类型string

status

类型string

有效值

"CREATED""PENDING""RUNNING""STOPPED""FAILED""COMPLETED""TIMEOUT"

scriptId

类型integer

格式"int64"

scriptType

类型string

有效值

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

scriptSource

类型string

有效值

"USER_DEFINED""IMPORTED""SERVICE_SMOKE""SERVICE_SECURITY""API""SCENARIO""GENERATE_DATA"

scriptSourceId

类型integer

格式"int64"

priority

类型integer

格式"int32"

最大值9223372036854776000

最小值0

nodeId

类型integer

格式"int64"

startMode

类型string

有效值

"IMMEDIATELY""TIMING"

startDate

类型string

格式"date-time"

actualStartDate

类型string

格式"date-time"

endDate

类型string

格式"date-time"

execBy

类型integer

格式"int64"

createdBy

类型integer

格式"int64"

createdDate

类型string

格式"date-time"

lastModifiedBy

类型integer

格式"int64"

lastModifiedDate

类型string

格式"date-time"

pageNo

Page data size, default 1, maximum 100000

类型integer

格式"int32"

最大值100000

最小值1

pageSize

Page data size, default 10, maximum 2000

类型integer

格式"int32"

最大值2000

最小值1

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/exec

试验场

授权

UserHttpBearer

变量

键

值

projectId*

id

name

plugin

status

scriptId

scriptType

scriptSource

scriptSourceId

priority

nodeId

startMode

startDate

actualStartDate

endDate

execBy

createdBy

createdDate

lastModifiedBy

lastModifiedDate

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

---

Delete executions

DELETE

/api/v1/exec

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json

[

0

]

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

DELETE

/api/v1/exec

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

Query the detail of execution

GET

/api/v1/exec/{id}

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Execution id

类型integer

必填

格式"int64"

响应

OK

GET

/api/v1/exec/{id}

试验场

授权

UserHttpBearer

变量

键

值

id*

示例

cURL

JavaScript

PHP

Python

---

Query all testing server configurations of the execution, only Http plugin is supported

GET

/api/v1/exec/{id}/test/server

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Execution id

类型integer

必填

格式"int64"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

/api/v1/exec/{id}/test/server

试验场

授权

UserHttpBearer

变量

键

值

id*

示例

cURL

JavaScript

PHP

Python

---

Query the actual script of execution

GET

/api/v1/exec/{id}/script

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Execution id

类型integer

必填

格式"int64"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

/api/v1/exec/{id}/script

试验场

授权

UserHttpBearer

变量

键

值

id*

示例

cURL

JavaScript

PHP

Python

---

Query the basic information of execution

GET

/api/v1/exec/{id}/info

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Execution id

类型integer

必填

格式"int64"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

/api/v1/exec/{id}/info

试验场

授权

UserHttpBearer

变量

键

值

id*

示例

cURL

JavaScript

PHP

Python

---

Fulltext search the list of execution

GET

/api/v1/exec/search

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

查询参数

projectId*

Project id

类型integer

必填

格式"int64"

id

类型integer

格式"int64"

name

类型string

plugin

类型string

status

类型string

有效值

"CREATED""PENDING""RUNNING""STOPPED""FAILED""COMPLETED""TIMEOUT"

scriptId

类型integer

格式"int64"

scriptType

类型string

有效值

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

scriptSource

类型string

有效值

"USER_DEFINED""IMPORTED""SERVICE_SMOKE""SERVICE_SECURITY""API""SCENARIO""GENERATE_DATA"

scriptSourceId

类型integer

格式"int64"

priority

类型integer

格式"int32"

最大值9223372036854776000

最小值0

nodeId

类型integer

格式"int64"

startMode

类型string

有效值

"IMMEDIATELY""TIMING"

startDate

类型string

格式"date-time"

actualStartDate

类型string

格式"date-time"

endDate

类型string

格式"date-time"

execBy

类型integer

格式"int64"

createdBy

类型integer

格式"int64"

createdDate

类型string

格式"date-time"

lastModifiedBy

类型integer

格式"int64"

lastModifiedDate

类型string

格式"date-time"

pageNo

Page data size, default 1, maximum 100000

类型integer

格式"int32"

最大值100000

最小值1

pageSize

Page data size, default 10, maximum 2000

类型integer

格式"int32"

最大值2000

最小值1

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/exec/search

试验场

授权

UserHttpBearer

变量

键

值

projectId*

id

name

plugin

status

scriptId

scriptType

scriptSource

scriptSourceId

priority

nodeId

startMode

startDate

actualStartDate

endDate

execBy

createdBy

createdDate

lastModifiedBy

lastModifiedDate

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

---