Build qualities

TFS 2017 | TFS 2015 | TFS 2013

Note

Looking for REST APIS that support TFS 2018 or later versions? See the Azure DevOps REST API Reference.

api-version = 1.0

Each project has a set of qualities that can be assigned to builds.

If you haven't already, look at the information on getting started with these APIs.

Get a list of qualities

Gets the build qualities that are used in a project.

GET https://{instance}/DefaultCollection/{project}/_apis/build/qualities?api-version={version}&projectId={string}

Parameter	Type	Notes
URL
instance	string	TFS server name ({server:port}).
project	string	Project ID or name.
Query
api-version	string	Version of the API to use.

Sample request

GET https://mytfsserver/DefaultCollection/Fabrikam-Fiber-Git/_apis/build/qualities?api-version=1.0

Sample response

{
  "value": [
    "Initial Test Passed",
    "Lab Test Passed",
    "Ready for Deployment",
    "Ready for Initial Test",
    "Rejected",
    "Released",
    "UAT Passed",
    "Under Investigation"
  ],
  "count": 8
}

Add a quality

Adds a build quality value to the list of qualities that can be used for builds in the project.

PUT https://{instance}/DefaultCollection/{project}/_apis/build/qualities/{quality}?api-version={version}

Parameter	Type	Notes
URL
instance	string	TFS server name ({server:port}).
project	string	Project ID or name.
quality	string	Quality value to add.
Query
api-version	string	Version of the API to use.

Sample request

PUT https://mytfsserver/DefaultCollection/Fabrikam-Fiber-Git/_apis/build/qualities/To%20be%20evaluated?api-version=1.0

{}

Remove a quality

Removes a build quality value from the list of qualities that can be used in the project.

DELETE https://{instance}/DefaultCollection/{project}/_apis/build/qualities/{quality}?api-version={version}

Parameter	Type	Notes
URL
instance	string	TFS server name ({server:port}).
project	string	Project ID or name.
quality	string	Quality value to add.
Query
projectId	string	Add the build quality to the project with this name.
api-version	string	Version of the API to use.

Sample request

DELETE https://mytfsserver/DefaultCollection/Fabrikam-Fiber-Git/_apis/build/qualities/To%20be%20evaluated?api-version=1.0