FuncPlan

Test Plan Configuration - Core interface for creating/maintaining test plans that define testing scope, methodology, resources, etc

---

Query the list of testing plan

GET

/api/v1/func/plan

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

查询参数

id

类型integer

format"int64"

projectId*

Project id

类型integer

必填

format"int64"

name

类型string

review

类型boolean

status

类型string

枚举

"PENDING""IN_PROGRESS""COMPLETED""BLOCKED"

startDate

类型string

format"date-time"

deadlineDate

类型string

format"date-time"

ownerId

类型integer

format"int64"

createdBy

类型integer

format"int64"

createdDate

类型string

format"date-time"

lastModifiedBy

类型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/func/plan

试验场

授权

UserHttpBearer

变量

键

值

id

projectId*

name

review

status

startDate

deadlineDate

ownerId

createdBy

createdDate

lastModifiedBy

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 the plan of functional testing

PUT

/api/v1/func/plan

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json

{

"id": 1,

"projectId": 0,

"name": "Example plan",

"auth": true,

"startDate": "2023-06-10 00:00:00",

"deadlineDate": "2029-06-20 00:00:00",

"ownerId": 0,

"testerResponsibilities": {

"additionalProperties": "string"

},

"testingScope": "string",

"testingObjectives": "string",

"acceptanceCriteria": "string",

"otherInformation": "string",

"attachments": [

{

"name": "string",

"url": "string"

}

],

"casePrefix": "EXAMPLE_",

"review": true,

"evalWorkloadMethod": "STORY_POINT"

}

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PUT

/api/v1/func/plan

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

Add the plan of functional testing

POST

/api/v1/func/plan

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json

{

"projectId": 0,

"name": "Example plan",

"auth": true,

"startDate": "2023-06-10 00:00:00",

"deadlineDate": "2029-06-20 00:00:00",

"ownerId": 0,

"testerResponsibilities": {

"additionalProperties": "string"

},

"testingScope": "string",

"testingObjectives": "string",

"acceptanceCriteria": "string",

"otherInformation": "string",

"attachments": [

{

"name": "string",

"url": "string"

}

],

"casePrefix": "EXAMPLE_",

"review": true,

"evalWorkloadMethod": "STORY_POINT"

}

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

POST

/api/v1/func/plan

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

Update the plan of functional testing

PATCH

/api/v1/func/plan

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json

{

"id": 0,

"name": "Example plan",

"startDate": "2023-06-10 00:00:00",

"deadlineDate": "2029-06-20 00:00:00",

"ownerId": 0,

"testerResponsibilities": {

"additionalProperties": "string"

},

"testingScope": "string",

"testingObjectives": "string",

"acceptanceCriteria": "string",

"otherInformation": "string",

"attachments": [

{

"name": "string",

"url": "string"

}

],

"review": true,

"evalWorkloadMethod": "STORY_POINT"

}

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PATCH

/api/v1/func/plan

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

Start the plan of functional testing

PATCH

/api/v1/func/plan/{id}/start

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Plan id

类型integer

必填

format"int64"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PATCH

/api/v1/func/plan/{id}/start

试验场

授权

UserHttpBearer

变量

键

值

id*

示例

cURL

JavaScript

PHP

Python

---

End the plan of functional testing

PATCH

/api/v1/func/plan/{id}/end

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Plan id

类型integer

必填

format"int64"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PATCH

/api/v1/func/plan/{id}/end

试验场

授权

UserHttpBearer

变量

键

值

id*

示例

cURL

JavaScript

PHP

Python

---

Clone the plan of functional testing

PATCH

/api/v1/func/plan/{id}/clone

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Plan id

类型integer

必填

format"int64"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PATCH

/api/v1/func/plan/{id}/clone

试验场

授权

UserHttpBearer

变量

键

值

id*

示例

cURL

JavaScript

PHP

Python

---

Block the plan of functional testing

PATCH

/api/v1/func/plan/{id}/block

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Plan id

类型integer

必填

format"int64"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PATCH

/api/v1/func/plan/{id}/block

试验场

授权

UserHttpBearer

变量

键

值

id*

示例

cURL

JavaScript

PHP

Python

---

Reset the review result of testing plan

PATCH

/api/v1/func/plan/case/review/reset

授权

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": {

}

}

}

PATCH

/api/v1/func/plan/case/review/reset

试验场

授权

UserHttpBearer

变量

键

值

ids*

示例

cURL

JavaScript

PHP

Python

---

Reset the test result of testing plan

PATCH

/api/v1/func/plan/case/result/reset

授权

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": {

}

}

}

PATCH

/api/v1/func/plan/case/result/reset

试验场

授权

UserHttpBearer

变量

键

值

ids*

示例

cURL

JavaScript

PHP

Python

---

Query the not reviewed case list of testing plan

GET

/api/v1/func/plan/{planId}/case/notReviewed

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

planId*

Plan id

类型integer

必填

format"int64"

查询参数

moduleId

Module id

类型integer

format"int64"

reviewId

Review id

类型integer

format"int64"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

/api/v1/func/plan/{planId}/case/notReviewed

试验场

授权

UserHttpBearer

变量

键

值

planId*

moduleId

reviewId

示例

cURL

JavaScript

PHP

Python

---

Query the not established baseline case list of functional testing plan

GET

/api/v1/func/plan/{planId}/case/notEstablishedBaseline

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

planId*

Plan id

类型integer

必填

format"int64"

查询参数

moduleId

Module id

类型integer

format"int64"

baselineId

Baseline id

类型integer

format"int64"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

/api/v1/func/plan/{planId}/case/notEstablishedBaseline

试验场

授权

UserHttpBearer

变量

键

值

planId*

moduleId

baselineId

示例

cURL

JavaScript

PHP

Python

---

Query the detail of testing plan

GET

/api/v1/func/plan/{id}

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Plan id

类型integer

必填

format"int64"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

/api/v1/func/plan/{id}

试验场

授权

UserHttpBearer

变量

键

值

id*

示例

cURL

JavaScript

PHP

Python

---

Delete the plan of functional testing

DELETE

/api/v1/func/plan/{id}

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Plan id

类型integer

必填

format"int64"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

DELETE

/api/v1/func/plan/{id}

试验场

授权

UserHttpBearer

变量

键

值

id*

示例

cURL

JavaScript

PHP

Python

---

Fulltext search the list of testing plan

GET

/api/v1/func/plan/search

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

查询参数

id

类型integer

format"int64"

projectId*

Project id

类型integer

必填

format"int64"

name

类型string

review

类型boolean

status

类型string

枚举

"PENDING""IN_PROGRESS""COMPLETED""BLOCKED"

startDate

类型string

format"date-time"

deadlineDate

类型string

format"date-time"

ownerId

类型integer

format"int64"

createdBy

类型integer

format"int64"

createdDate

类型string

format"date-time"

lastModifiedBy

类型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/func/plan/search

试验场

授权

UserHttpBearer

变量

键

值

id

projectId*

name

review

status

startDate

deadlineDate

ownerId

createdBy

createdDate

lastModifiedBy

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

---