Builds - Get Changes Between Builds

Gets the changes made to the repository between two given builds.

GET https://dev.azure.com/{organization}/{project}/_apis/build/changes?api-version=5.0-preview.2
GET https://dev.azure.com/{organization}/{project}/_apis/build/changes?fromBuildId={fromBuildId}&toBuildId={toBuildId}&$top={$top}&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.

$top
query

integer

int32

The maximum number of changes to return.

fromBuildId
query

integer

int32

The ID of the first build.

toBuildId
query

integer

int32

The ID of the last build.

Responses

Name Type Description
200 OK

Change[]

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.build Grants the ability to access build artifacts, including build results, definitions, and requests, and the ability to receive notifications about build events via service hooks.

Definitions

Name Description
Change

Represents a change associated with a build.

IdentityRef
ReferenceLinks

The class to represent a collection of REST reference links.

Change

Represents a change associated with a build.

Name Type Description
author

IdentityRef

The author of the change.

displayUri

string

The location of a user-friendly representation of the resource.

id

string

The identifier for the change. For a commit, this would be the SHA1. For a TFVC changeset, this would be the changeset ID.

location

string

The location of the full representation of the resource.

message

string

The description of the change. This might be a commit message or changeset description.

messageTruncated

boolean

Indicates whether the message was truncated.

pusher

string

The person or process that pushed the change.

timestamp

string

The timestamp for the change.

type

string

The type of change. "commit", "changeset", etc.

IdentityRef

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.

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.