Suite Test Case - Get Test Case List

Service:

Test Plan

API Version:

7.1

Get Test Case List return those test cases which have all the configuration Ids as mentioned in the optional parameter. If configuration Ids is null, it return all the test cases

GET https://dev.azure.com/{organization}/{project}/_apis/testplan/Plans/{planId}/Suites/{suiteId}/TestCase?api-version=7.1

With optional parameters:

GET https://dev.azure.com/{organization}/{project}/_apis/testplan/Plans/{planId}/Suites/{suiteId}/TestCase?testIds={testIds}&configurationIds={configurationIds}&witFields={witFields}&continuationToken={continuationToken}&returnIdentityRef={returnIdentityRef}&expand={expand}&excludeFlags={excludeFlags}&isRecursive={isRecursive}&api-version=7.1

URI Parameters

Name	In	Required	Type	Description
organization	path	True	string	The name of the Azure DevOps organization.
planId	path	True	integer (int32)	ID of the test plan for which test cases are requested.
project	path	True	string	Project ID or project name
suiteId	path	True	integer (int32)	ID of the test suite for which test cases are requested.
api-version	query	True	string	Version of the API to use. This should be set to '7.1' to use this version of the api.
configurationIds	query		string	Fetch Test Cases which contains all the configuration Ids specified.
continuationToken	query		string	If the list of test cases returned is not complete, a continuation token to query next batch of test cases is included in the response header as "x-ms-continuationtoken". Omit this parameter to get the first batch of test cases.
excludeFlags	query		ExcludeFlags	Flag to exclude various values from payload. For example to remove point assignments pass exclude = 1. To remove extra information (links, test plan , test suite) pass exclude = 2. To remove both extra information and point assignments pass exclude = 3 (1 + 2).
expand	query		boolean	If set to false, will get a smaller payload containing only basic details about the suite test case object
isRecursive	query		boolean
returnIdentityRef	query		boolean	If set to true, returns all identity fields, like AssignedTo, ActivatedBy etc., as IdentityRef objects. If set to false, these fields are returned as unique names in string format. This is false by default.
testIds	query		string	Test Case Ids to be fetched.
witFields	query		string	Get the list of witFields.

Responses

Name	Type	Description
200 OK	TestCase[]	successful operation

Security

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Scopes

Name	Description
vso.test	Grants the ability to read test plans, cases, results and other test management related artifacts.

Definitions

Name	Description
ExcludeFlags	Flag to exclude various values from payload. For example to remove point assignments pass exclude = 1. To remove extra information (links, test plan , test suite) pass exclude = 2. To remove both extra information and point assignments pass exclude = 3 (1 + 2).
IdentityRef
PointAssignment	Assignments for the Test Point
ProjectState	Project state.
ProjectVisibility	Project visibility.
ReferenceLinks	The class to represent a collection of REST reference links.
TeamProjectReference	Represents a shallow reference to a TeamProject.
TestCase	Test Case Class
TestPlanReference	The test plan reference resource.
TestSuiteReference	The test suite reference resource.
WorkItemDetails	Work Item Class

ExcludeFlags

Enumeration

Flag to exclude various values from payload. For example to remove point assignments pass exclude = 1. To remove extra information (links, test plan , test suite) pass exclude = 2. To remove both extra information and point assignments pass exclude = 3 (1 + 2).

Value	Description
extraInformation	To exclude extra information (links, test plan, test suite), pass exclude = 2
none	To exclude nothing
pointAssignments	To exclude point assignments, pass exclude = 1

IdentityRef

Object

Name	Type	Description
_links	ReferenceLinks	This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject.
descriptor	string	The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.
directoryAlias	string	Deprecated - Can be retrieved by querying the Graph user referenced in the "self" entry of the IdentityRef "_links" dictionary
displayName	string	This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.
id	string
imageUrl	string	Deprecated - Available in the "avatar" entry of the IdentityRef "_links" dictionary
inactive	boolean	Deprecated - Can be retrieved by querying the Graph membership state referenced in the "membershipState" entry of the GraphUser "_links" dictionary
isAadIdentity	boolean	Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Deprecated - not in use in most preexisting implementations of ToIdentityRef
uniqueName	string	Deprecated - use Domain+PrincipalName instead
url	string	This url is the full route to the source resource of this graph subject.

PointAssignment

Object

Assignments for the Test Point

Name	Type	Description
configurationId	integer (int32)	Id of the Configuration Assigned to the Test Point
configurationName	string	Name of the Configuration Assigned to the Test Point
id	integer (int32)	Id of the Test Point
tester	IdentityRef	Tester Assigned to the Test Point

ProjectState

Enumeration

Project state.

Value	Description
all	All projects regardless of state except Deleted.
createPending	Project has been queued for creation, but the process has not yet started.
deleted	Project has been deleted.
deleting	Project is in the process of being deleted.
new	Project is in the process of being created.
unchanged	Project has not been changed.
wellFormed	Project is completely created and ready to use.

ProjectVisibility

Enumeration

Project visibility.

Value	Description
private	The project is only visible to users with explicit access.
public	The project is visible to all.

ReferenceLinks

Object

The class to represent a collection of REST reference links.

Name	Type	Description
links	object	The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.

TeamProjectReference

Object

Represents a shallow reference to a TeamProject.

Name	Type	Description
abbreviation	string	Project abbreviation.
defaultTeamImageUrl	string	Url to default team identity image.
description	string	The project's description (if any).
id	string (uuid)	Project identifier.
lastUpdateTime	string (date-time)	Project last update time.
name	string	Project name.
revision	integer (int64)	Project revision.
state	ProjectState	Project state.
url	string	Url to the full version of the object.
visibility	ProjectVisibility	Project visibility.

TestCase

Object

Test Case Class

Name	Type	Description
links	ReferenceLinks	Reference links
order	integer (int32)	Order of the TestCase in the Suite
pointAssignments	PointAssignment[]	List of Points associated with the Test Case
project	TeamProjectReference	Project under which the Test Case is
testPlan	TestPlanReference	Test Plan under which the Test Case is
testSuite	TestSuiteReference	Test Suite under which the Test Case is
workItem	WorkItemDetails	Work Item details of the TestCase

TestPlanReference

Object

The test plan reference resource.

Name	Type	Description
id	integer (int32)	ID of the test plan.
name	string	Name of the test plan.

TestSuiteReference

Object

The test suite reference resource.

Name	Type	Description
id	integer (int32)	ID of the test suite.
name	string	Name of the test suite.

WorkItemDetails

Object

Work Item Class

Name	Type	Description
id	integer (int32)	Work Item Id
name	string	Work Item Name
workItemFields	object[]	Work Item Fields