Configurations - Get

Service:

Test Plan

API Version:

7.1

Get a test configuration

GET https://dev.azure.com/{organization}/{project}/_apis/testplan/configurations/{testConfigurationId}?api-version=7.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
testConfigurationId	path	True	integer (int32)	ID of the test configuration to get.
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.

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 test configuration by Id.

Sample request

HTTP

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

Sample response

Status code:

200

{
  "id": 1,
  "project": {
    "id": "eaedf3e5-b163-488b-be43-06d8c2b95d4d",
    "name": "MyProject",
    "url": "https://dev.azure.com/fabrikam/_apis/projects/MyProject",
    "state": "unchanged",
    "visibility": "unchanged"
  },
  "name": "Windows 10",
  "description": "Default operating system for testing",
  "isDefault": true,
  "values": [
    {
      "name": "Operating System",
      "value": "Windows 10"
    }
  ],
  "state": "active"
}

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

Object

Name value pair

Name	Type	Description
name	string	Name
value	string	Value

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.

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.

TestConfiguration

Object

Test configuration

Name	Type	Description
description	string	Description of the configuration
id	integer (int32)	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

Enumeration

State of the configuration

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