ListTestPlan - List test plans - Alibaba Cloud DevOps - Alibaba Cloud Documentation Center

Service endpoint and authorization

Obtain the service endpoint: Replace {domain} in the API request syntax.
Obtain a personal access token.

Product	Resource	Required permissions
Test Management	test plan	Read-only

Request syntax

Region edition

POST https://{domain}/oapi/v1/projex/testPlan/list

Request headers

Parameter	Type	Required	Description	Example value
x-yunxiao-token	string	Yes	Your personal access token.	pt-0fh3**0fbG_35af**0484

Request parameters

Parameter	Type	In	Required	Description	Example value
page	integer	query	No	The page number to return. Default value: 1.
perPage	integer	query	No	The number of entries per page. Maximum value: 1000. Default value: 1000.
sprintIdentifier	string	query	No	The sprint identifier. If specified, only test plans from this sprint are returned.
projectIdentifier	string	query	No	The project identifier. When used with `sprintIdentifier`, it verifies that the sprint belongs to this project. When used alone, it filters test plans by this project.
status	string	query	No	The test plan status. Valid values: `TODO`, `DOING`, and `DONE`. Separate multiple values with commas.	DOING,DONE
name	string	query	No	Filters test plans by name using a fuzzy match.

Request examples

Region edition

curl -X 'POST' \
  'https://{domain}/oapi/v1/projex/testPlan/list?page={page}&perPage={perPage}&sprintIdentifier={sprintIdentifier}&projectIdentifier={projectIdentifier}&status={status}&name={name}' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

Response parameters

Parameter	Type	Description	Example value
-	array	An array of test plan objects.
-	object	A test plan object.
gmtCreate	string	The timestamp when the test plan was created.
managers	array[string]	The IDs of the test plan managers.
spaceIdentifier	string	The ID of the associated project.
testPlanIdentifier	string	The ID of the test plan.

Response example

[
    {
        "gmtCreate": "",
        "managers": [
        ],
        "name": "",
        "spaceIdentifier": "",
        "testPlanIdentifier": ""
    }
]

Response headers

Parameter	Description	Example value
x-next-page	The next page number.
x-page	The current page number.
x-per-page	The number of entries per page.
x-prev-page	The previous page number.
x-total	The total number of entries.
x-total-pages	The total number of pages.

Error codes

For API error codes, see the Error Code Center.