Changesets - Get Changeset Changes

Service:

Tfvc

API Version:

6.0

Retrieve Tfvc changes for a given changeset.

GET https://dev.azure.com/{organization}/_apis/tfvc/changesets/{id}/changes?api-version=6.0

With optional parameters:

GET https://dev.azure.com/{organization}/_apis/tfvc/changesets/{id}/changes?$skip={$skip}&$top={$top}&continuationToken={continuationToken}&api-version=6.0

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. Default: null
api-version	query	True	string	Version of the API to use. This should be set to '6.0' to use this version of the api.
$skip	query		integer int32	Number of results to skip. Default: null
$top	query		integer int32	The maximum number of results to return. Default: null
continuationToken	query		string	Return the next page of results. Default: null

Responses

Name	Type	Description
200 OK	TfvcChange[]	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 Tfvc changes for a given changeset

Sample Request

HTTP

GET https://dev.azure.com/{organization}/_apis/tfvc/changesets/7/changes?api-version=6.0

Sample Response

Status code:

200

{
  "count": 1,
  "value": [
    {
      "item": {
        "version": 7,
        "size": 11,
        "hashValue": "9cXQCGt5dzPUrCaVsL+kVA==",
        "path": "$/Project01/ExampleFolder/TestFile01.txt",
        "url": "https://codedev.ms/fabrikam/_apis/tfvc/items/$/Project01/ExampleFolder/TestFile01.txt?versionType=Changeset&version=7"
      },
      "changeType": "edit"
    }
  ]
}

Definitions

Name	Description
ItemContent
ItemContentType
TfvcChange	A change.
TfvcMergeSource
VersionControlChangeType	The type of change that was made to the item.

ItemContent

Name	Type	Description
content	string
contentType	ItemContentType

ItemContentType

Name	Type	Description
base64Encoded	string
rawText	string

TfvcChange

A change.

Name	Type	Description
changeType	VersionControlChangeType	The type of change that was made to the item.
item	string	Current version.
mergeSources	TfvcMergeSource[]	List of merge sources in case of rename or branch creation.
newContent	ItemContent	Content of the item after the change.
pendingVersion	integer	Version at which a (shelved) change was pended against
sourceServerItem	string	Path of the item on the server.
url	string	URL to retrieve the item.

TfvcMergeSource

Name	Type	Description
isRename	boolean	Indicates if this a rename source. If false, it is a merge source.
serverItem	string	The server item of the merge source.
versionFrom	integer	Start of the version range.
versionTo	integer	End of the version range.

VersionControlChangeType

The type of change that was made to the item.

Name	Type	Description
add	string
all	string
branch	string
delete	string
edit	string
encoding	string
lock	string
merge	string
none	string
property	string
rename	string
rollback	string
sourceRename	string
targetRename	string
undelete	string