Test Plan API

2.4 Test Plan API (3.7.0)¶

2.4.1 Get Test Plan List¶

Path： /api-task/testPlan

Method： GET

Headers：Headers

Request Parameters¶

Parameter	Parameter Format	Description	Required	Type
page	query	Page number	Yes	number
pageSize	query	Items per page	Yes	number
options	query	Filter options, must be stringified and URL-encoded, e.g.: `encodeURIComponent(JSON.stringify(params.options))`	Yes	FilterOptions

Response Data¶

Code	Description	Type
200	Ok	{list: TestPlan; page: number; total: number}

2.4.2 Get Test Plan¶

Path： /api-task/testPlan/{id}

Method： GET

Headers：Headers

Request Parameters¶

Parameter	Parameter Format	Description	Required	Type
id	path	Test Plan ID	Yes	string

Response Data¶

Code	Description	Type
200	Ok	TestPlan

2.4.3 Create Test Plan¶

Path： /api-task/testPlan

Method： POST

Headers：Headers

Request Parameters¶

Parameter	Parameter Format	Description	Required	Type
data	body	Create Test Plan	Yes	TestPlan

Response Data¶

Code	Description	Type
200	Ok	{id: string}

2.4.4 Update Test Plan¶

Path： /api-task/testPlan/{id}

Method： PUT

Headers：Headers

Request Parameters¶

Parameter	Parameter Format	Description	Required	Type
id	path	Test Plan ID	Yes	string
data	body	Test Plan data	Yes	TestPlan

Response Data¶

Code	Description	Type
200	Ok	TestPlan

2.4.5 Delete Test Plan¶

Path： /api-task/testPlan/{id}

Method： DELETE

Headers：Headers

Request Parameters¶

Parameter	Parameter Format	Description	Required	Type
id	path	Test Plan ID	Yes	string

Response Data¶

Code	Description	Type
200	Ok	{id: string}

2.4.5 Delete Test Plans (Multiple at Once)¶

Path： /api-task/testPlan/{id}

Method： POST

Headers：Headers

Request Parameters¶

Parameter	Parameter Format	Description	Required	Type
ids	body	Test Plan ID list	Yes	string[]

Response Data¶

Code	Description	Type
200	Ok	{deleted: string[]}

2.4.6 Execute Test Plan¶

Path： /api-task/testPlan/execute

Method： POST

Headers：Headers

Request Parameters¶

Parameter	Parameter Format	Description	Required	Type
ids	body	Test Plan ID list	Yes	string[]

Response Data¶

Code	Description	Type
200	Ok	{sessionIds: string[]}

2.4.7 Clone Test Plan¶

Path： /api-task/testPlan/{id}/clone

Method： POST

Headers：Headers

Request Parameters¶

Parameter	Parameter Format	Description	Required	Type
id	path	Test Plan ID	Yes	string

Response Data¶

Code	Description	Type
200	Ok	{id: string}

2.4.8 Check Whether Test Plan Name Already Exists¶

Path： /api-task/testPlan/isrepeat

Method： GET

Headers：Headers

Request Parameters¶

Parameter	Parameter Format	Description	Required	Type
name	query	Test Plan name	Yes	string
type	query	Test Plan Use Case type	Yes	Enum: `"worldsim"`, `"logsim"`

Response Data¶

Code	Description	Type
200	Ok	{isRepeat: boolean}