List test suites

GET https://{{host}}/test-management/v3/functional/test-suites

Lists test suites created in your organization. The list can also include deleted test suites you can restore. The response contains an array of objects, each keyed by testSuiteId. You can use these IDs to Get a test suite with child objects.

Request Params

KeyDatatypeRequiredDescription
includeRecentlyDeletedstring(Optional) Includes items deleted within the last 30 days, which you can restore, false by default.
propertyIdstring(Optional) Unique identifier for property associated with the test suite to filter the list by. You can combine this parameter with propertyVersion. Use either this parameter or propertyName to specify the property.
propertyNamestring(Optional) Property name associated with a test suite to filter the list by. You can combine this parameter with propertyVersion. Use either this parameter or propertyId to specify the property.
propertyVersionstring(Optional) Version of the associated Property Manager property to filter the test suites by. Combine this parameter with propertyId or propertyName.
userstring(Optional) Filters the list to items created, edited, or deleted by a specific username.
accountSwitchKeystring(Optional) For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{"testSuites":[{"configs":{"propertyManager":{"propertyId":1234,"propertyName":"config_user8","propertyVersion":4}},"createdBy":"hgildong","createdDate":"2021-07-06T10:28:13+0000","executableTestCaseCount":1,"isLocked":false,"isStateful":false,"modifiedBy":"hgildong","modifiedDate":"2021-07-06T10:29:20+0000","testSuiteDescription":"This test suite performs basic check of www.user8.example.com","testSuiteId":284,"testSuiteName":"www.user8.example.com test suite"},{"createdBy":"jperez","createdDate":"2021-07-06T10:28:13+0000","executableTestCaseCount":1,"isLocked":false,"isStateful":false,"modifiedBy":"jperez","modifiedDate":"2021-07-06T10:29:20+0000","testSuiteDescription":"This test suite validates caching of images used in www.user8.example.com","testSuiteId":317,"testSuiteName":"www.user8.example.com images test suite"}]}