Configurations - List

Service:

Test Plan

API Version:

6.1-preview.1

Get a list of test configurations.

GET https://dev.azure.com/{organization}/{project}/_apis/testplan/configurations?api-version=6.1-preview.1

With optional parameters:

GET https://dev.azure.com/{organization}/{project}/_apis/testplan/configurations?continuationToken={continuationToken}&api-version=6.1-preview.1

URI Parameters

Name	In	Required	Type	Description
organization	path	True	string	The name of the Azure DevOps organization.
project	path	True	string	Project ID or project name
api-version	query	True	string	Version of the API to use. This should be set to '6.1-preview.1' to use this version of the api.
continuationToken	query		string	If the list of configurations returned is not complete, a continuation token to query next batch of configurations is included in the response header as "x-ms-continuationtoken". Omit this parameter to get the first batch of test configurations.

Responses

Name	Type	Description
200 OK	TestConfiguration[]	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.

Examples

Get a list of test configurations.

Sample Request

HTTP

GET https://dev.azure.com/fabrikam/{project}/_apis/testplan/configurations?api-version=6.1-preview.1

Sample Response

Status code:

200

transfer-Encoding: chunked

Response Body

{
  "value": [
    {
      "id": 1,
      "name": "Windows 10",
      "description": "Default operating system for testing",
      "isDefault": true,
      "values": [
        {
          "name": "Operating System",
          "value": "Windows 10"
        }
      ],
      "state": "active"
    }
  ],
  "count": 1
}

Definitions

Name	Description
NameValuePair	Name value pair
ProjectState	Project state.
ProjectVisibility	Project visibility.
TeamProjectReference	Represents a shallow reference to a TeamProject.
TestConfiguration	Test configuration
TestConfigurationState	State of the configuration

NameValuePair

Name value pair

Name	Type	Description
name	string	Name
value	string	Value

ProjectState

Project state.

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

ProjectVisibility

Project visibility.

Name	Type	Description
private	string	The project is only visible to users with explicit access.
public	string	The project is visible to all.

TeamProjectReference

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	Project identifier.
lastUpdateTime	string	Project last update time.
name	string	Project name.
revision	integer	Project revision.
state	ProjectState	Project state.
url	string	Url to the full version of the object.
visibility	ProjectVisibility	Project visibility.

TestConfiguration

Test configuration

Name	Type	Description
description	string	Description of the configuration
id	integer	Id of the configuration
isDefault	boolean	Is the configuration a default for the test plans
name	string	Name of the configuration
project	TeamProjectReference	Id of the test configuration variable
state	TestConfigurationState	State of the configuration
values	NameValuePair[]	Dictionary of Test Variable, Selected Value

TestConfigurationState

State of the configuration

Name	Type	Description
active	string	The configuration can be used for new test runs.
inactive	string	The configuration has been retired and should not be used for new test runs.