Configurations - List

Service:: Test

API Version:: 5.0-preview.2

Get a list of test configurations

GET https://dev.azure.com/{organization}/{project}/_apis/test/configurations?api-version=5.0-preview.2

With optional parameters:

GET https://dev.azure.com/{organization}/{project}/_apis/test/configurations?$skip={$skip}&$top={$top}&continuationToken={continuationToken}&includeAllProperties={includeAllProperties}&api-version=5.0-preview.2

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 '5.0-preview.2' to use this version of the api.
$skip	query		integer (int32)	Number of test configurations to skip.
$top	query		integer (int32)	Number of test configurations to return.
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.
includeAllProperties	query		boolean	If true, it returns all properties of the test configurations. Otherwise, it returns the skinny version.

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

A page at a time

Get a list of test configurations

Include all properties of the test configurations

With continuation token

A page at a time

Sample request

HTTP

GET https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/configurations?$top=5&api-version=5.0-preview.2

Sample response

Status code:: 200

{
  "value": [
    {
      "id": 1,
      "name": "Windows 10",
      "url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Configurations/1",
      "description": "Default operating system for testing",
      "isDefault": true,
      "state": "active"
    },
    {
      "id": 2,
      "name": "Win10 IE11",
      "url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Configurations/2",
      "description": "Windows 10 - IE 11"
    }
  ],
  "count": 2
}

Get a list of test configurations

Sample request

HTTP

GET https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/configurations?api-version=5.0-preview.2

Sample response

Status code:: 200

{
  "value": [
    {
      "id": 1,
      "name": "Windows 10",
      "url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Configurations/1",
      "description": "Default operating system for testing",
      "isDefault": true,
      "state": "active"
    },
    {
      "id": 2,
      "name": "Win10 IE11",
      "url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Configurations/2",
      "description": "Windows 10 - IE 11"
    },
    {
      "id": 3,
      "name": "Win10 English",
      "url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Configurations/3",
      "description": ""
    }
  ],
  "count": 3
}

Include all properties of the test configurations

Sample request

HTTP

GET https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/configurations?includeAllProperties=true&api-version=5.0-preview.2

Sample response

Status code:: 200

{
  "value": [
    {
      "id": 1,
      "name": "Windows 10",
      "url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Configurations/1",
      "project": {
        "name": "fabrikam-fiber-tfvc",
        "url": "https://dev.azure.com/fabrikam/_apis/projects/fabrikam-fiber-tfvc"
      },
      "description": "Default operating system for testing",
      "lastUpdatedBy": {
        "id": "e5a5f7f8-6507-4c34-b397-6c4818e002f4",
        "displayName": "Fabrikam Fiber",
        "uniqueName": "fabrikamfiber1@outlook.com",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/e5a5f7f8-6507-4c34-b397-6c4818e002f4",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=e5a5f7f8-6507-4c34-b397-6c4818e002f4"
      },
      "lastUpdatedDate": "2015-12-23T05:21:26.42Z",
      "area": {
        "name": "fabrikam-fiber-tfvc"
      },
      "isDefault": true,
      "revision": 1,
      "values": [
        {
          "name": "Operating System",
          "value": "Windows 10"
        }
      ],
      "state": "active"
    },
    {
      "id": 2,
      "name": "Win10 IE11",
      "url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Configurations/2",
      "project": {
        "name": "fabrikam-fiber-tfvc",
        "url": "https://dev.azure.com/fabrikam/_apis/projects/fabrikam-fiber-tfvc"
      },
      "description": "Windows 10 - IE 11",
      "lastUpdatedBy": {
        "id": "e5a5f7f8-6507-4c34-b397-6c4818e002f4",
        "displayName": "Fabrikam Fiber",
        "uniqueName": "fabrikamfiber1@outlook.com",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/e5a5f7f8-6507-4c34-b397-6c4818e002f4",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=e5a5f7f8-6507-4c34-b397-6c4818e002f4"
      },
      "lastUpdatedDate": "2015-12-23T05:49:13.94Z",
      "area": {
        "name": "fabrikam-fiber-tfvc"
      },
      "revision": 2,
      "values": [
        {
          "name": "Operating System",
          "value": "Windows 10"
        },
        {
          "name": "Renamed Language",
          "value": "English - US"
        }
      ]
    },
    {
      "id": 3,
      "name": "Win10 English",
      "url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Configurations/3",
      "project": {
        "name": "fabrikam-fiber-tfvc",
        "url": "https://dev.azure.com/fabrikam/_apis/projects/fabrikam-fiber-tfvc"
      },
      "description": "",
      "lastUpdatedBy": {
        "id": "e5a5f7f8-6507-4c34-b397-6c4818e002f4",
        "displayName": "Fabrikam Fiber",
        "uniqueName": "fabrikamfiber1@outlook.com",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/e5a5f7f8-6507-4c34-b397-6c4818e002f4",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=e5a5f7f8-6507-4c34-b397-6c4818e002f4"
      },
      "lastUpdatedDate": "2015-12-23T05:52:48.167Z",
      "area": {
        "name": "fabrikam-fiber-tfvc\\QA"
      },
      "revision": 2,
      "values": [
        {
          "name": "Operating System",
          "value": "Windows 10"
        },
        {
          "name": "Renamed Language",
          "value": "English - US"
        }
      ]
    }
  ],
  "count": 3
}

With continuation token

Sample request

HTTP

GET https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/configurations?$skip=10&$top=15&continuationToken=14;12&api-version=5.0-preview.2

Sample response

Status code:: 200

{
  "value": [
    {
      "id": 14,
      "name": "Windows 10-2",
      "url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Configurations/14",
      "description": "Default operating system for testing",
      "isDefault": true,
      "state": "active"
    },
    {
      "id": 15,
      "name": "Win10 IE11-2",
      "url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Configurations/15",
      "description": "Windows 10 - IE 11"
    },
    {
      "id": 16,
      "name": "Win10 English-2",
      "url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Configurations/16",
      "description": ""
    }
  ],
  "count": 3
}

Definitions

Name	Description
IdentityRef
NameValuePair	Name value pair
ReferenceLinks	The class to represent a collection of REST reference links.
ShallowReference	An abstracted reference to some other resource. This class is used to provide the build data contracts with a uniform way to reference other resources in a way that provides easy traversal through links.
TestConfiguration	Test configuration
TestConfigurationState	State of the configuration

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
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
inactive	boolean
isAadIdentity	boolean
isContainer	boolean
isDeletedInOrigin	boolean
profileUrl	string
uniqueName	string
url	string	This url is the full route to the source resource of this graph subject.

NameValuePair

Object

Name value pair

Name	Type	Description
name	string	Name
value	string	Value

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.

ShallowReference

Object

An abstracted reference to some other resource. This class is used to provide the build data contracts with a uniform way to reference other resources in a way that provides easy traversal through links.

Name	Type	Description
id	string	ID of the resource
name	string	Name of the linked resource (definition name, controller name, etc.)
url	string	Full http link to the resource

TestConfiguration

Object

Test configuration

Name	Type	Description
area	ShallowReference	Area of the configuration
description	string	Description of the configuration
id	integer (int32)	Id of the configuration
isDefault	boolean	Is the configuration a default for the test plans
lastUpdatedBy	IdentityRef	Last Updated By Reference
lastUpdatedDate	string (date-time)	Last Updated Data
name	string	Name of the configuration
project	ShallowReference	Project to which the configuration belongs
revision	integer (int32)	Revision of the the configuration
state	TestConfigurationState	State of the configuration
url	string	Url of Configuration Resource
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.

Feedback

Was this page helpful?