Build qualities

Last Update: 12/5/2016

api-version = 1.0

Each team 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 team project.

GET https://{instance}/DefaultCollection/{project}/_apis/build/qualities?api-version={version}&projectId={string}
Parameter Type Notes
URL
instance string VS Team Services account ({account}.visualstudio.com) or TFS server ({server:port}).
project string Team project ID or name.
Query
api-version string Version of the API to use.

Sample request

GET https://fabrikam-fiber-inc.visualstudio.com/DefaultCollection/Fabrikam-Fiber-Git/_apis/build/qualities?api-version=1.0

Sample response

Status code: 200
{
  "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 team project.

PUT https://{instance}/DefaultCollection/{project}/_apis/build/qualities/{quality}?api-version={version}
Parameter Type Notes
URL
instance string VS Team Services account ({account}.visualstudio.com) or TFS server ({server:port}).
project string Team project ID or name.
quality string Quality value to add.
Query
api-version string Version of the API to use.

Sample request

PUT https://fabrikam-fiber-inc.visualstudio.com/DefaultCollection/Fabrikam-Fiber-Git/_apis/build/qualities/To%20be%20evaluated?api-version=1.0
Content-Type: application/json
{}

Sample response

Status code: 204

Remove a quality

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

DELETE https://{instance}/DefaultCollection/{project}/_apis/build/qualities/{quality}?api-version={version}
Parameter Type Notes
URL
instance string VS Team Services account ({account}.visualstudio.com) or TFS server ({server:port}).
project string Team project ID or name.
quality string Quality value to add.
Query
projectId string Add the build quality to the team project with this name.
api-version string Version of the API to use.

Sample request

DELETE https://fabrikam-fiber-inc.visualstudio.com/DefaultCollection/Fabrikam-Fiber-Git/_apis/build/qualities/To%20be%20evaluated?api-version=1.0

Sample response

Status code: 204