Changesets - Get Changeset Work Items

Reference

Service:: Tfvc

API Version:: 7.1-preview.1

Retrieves the work items associated with a particular changeset.

GET https://dev.azure.com/{organization}/_apis/tfvc/changesets/{id}/workItems?api-version=7.1-preview.1

URI Parameters

Name	In	Required	Type	Description
organization	path	True	string	The name of the Azure DevOps organization.
id	path		integer int32	ID of the changeset.
api-version	query	True	string	Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.

Responses

Name	Type	Description
200 OK	AssociatedWorkItem[]	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.code	Grants the ability to read source code and metadata about commits, changesets, branches, and other version control artifacts. Also grants the ability to search code and get notified about version control events via service hooks.

Examples

GET the work items associated with a changeset

Sample Request

HTTP

GET https://dev.azure.com/{organization}/_apis/tfvc/changesets/7/workItems?api-version=7.1-preview.1

Sample Response

Status code:: 200

{
  "count": 1,
  "value": [
    {
      "webUrl": "https://codedev.ms/fabrikam/web/wi.aspx?pcguid=2f29268d-b6d1-4caa-a2dc-1f8ebe87c60d&id=1",
      "id": 1,
      "title": "Bug1",
      "workItemType": "Bug",
      "state": "New"
    }
  ]
}

Definitions

AssociatedWorkItem

Name	Type	Description
assignedTo	string
id	integer	Id of associated the work item.
state	string
title	string
url	string	REST Url of the work item.
webUrl	string
workItemType	string

Share via