Pull Request Iterations - Get

Service:

Git

API Version:

4.1

Get the specified iteration for a pull request.

GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/iterations/{iterationId}?api-version=4.1

URI Parameters

Name	In	Required	Type	Description
iterationId	path	True	integer (int32)	ID of the pull request iteration to return.
organization	path	True	string	The name of the Azure DevOps organization.
pullRequestId	path	True	integer (int32)	ID of the pull request.
repositoryId	path	True	string	ID or name of the repository.
project	path		string	Project ID or project name
api-version	query	True	string	Version of the API to use. This should be set to '4.1' to use this version of the api.

Responses

Name	Type	Description
200 OK	GitPullRequestIteration	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 get notified about version control events via service hooks.

Definitions

Name	Description
ChangeCountDictionary
GitChange
GitCommitRef	Provides properties that describe a Git commit and associated metadata.
GitPullRequestChange	Change made in a pull request.
GitPullRequestIteration	Provides properties that describe a Git pull request iteration. Iterations are created as a result of creating and pushing updates to a pull request.
GitPushRef
GitStatus	This class contains the metadata of a service/extension posting a status.
GitStatusContext	Status context that uniquely identifies the status.
GitStatusState	State of the status.
GitTemplate
GitUserDate	User info and date for Git operations.
IdentityRef
ItemContent
ItemContentType
IterationReason	The reason for which the pull request iteration was created.
ReferenceLinks	The class to represent a collection of REST reference links.
ResourceRef
VersionControlChangeType	The type of change that was made to the item.

ChangeCountDictionary

Object

GitChange

Object

Name	Type	Description
changeId	integer (int32)	ID of the change within the group of changes.
changeType	VersionControlChangeType	The type of change that was made to the item.
item	string (T)	Current version.
newContent	ItemContent	Content of the item after the change.
newContentTemplate	GitTemplate	New Content template to be used when pushing new changes.
originalPath	string	Original path of item if different from current path.
sourceServerItem	string	Path of the item on the server.
url	string	URL to retrieve the item.

GitCommitRef

Object

Provides properties that describe a Git commit and associated metadata.

Name	Type	Description
_links	ReferenceLinks	A collection of related REST reference links.
author	GitUserDate	Author of the commit.
changeCounts	ChangeCountDictionary	Counts of the types of changes (edits, deletes, etc.) included with the commit.
changes	GitChange[]	An enumeration of the changes included with the commit.
comment	string	Comment or message of the commit.
commentTruncated	boolean	Indicates if the comment is truncated from the full Git commit comment message.
commitId	string	ID (SHA-1) of the commit.
committer	GitUserDate	Committer of the commit.
parents	string[]	An enumeration of the parent commit IDs for this commit.
remoteUrl	string	Remote URL path to the commit.
statuses	GitStatus[]	A list of status metadata from services and extensions that may associate additional information to the commit.
url	string	REST URL for this resource.
workItems	ResourceRef[]	A list of workitems associated with this commit.

GitPullRequestChange

Object

Change made in a pull request.

Name	Type	Description
changeId	integer (int32)	ID of the change within the group of changes.
changeTrackingId	integer (int32)	ID used to track files through multiple changes.
changeType	VersionControlChangeType	The type of change that was made to the item.
item	string (T)	Current version.
newContent	ItemContent	Content of the item after the change.
newContentTemplate	GitTemplate	New Content template to be used when pushing new changes.
originalPath	string	Original path of item if different from current path.
sourceServerItem	string	Path of the item on the server.
url	string	URL to retrieve the item.

GitPullRequestIteration

Object

Provides properties that describe a Git pull request iteration. Iterations are created as a result of creating and pushing updates to a pull request.

Name	Type	Description
_links	ReferenceLinks	A collection of related REST reference links.
author	IdentityRef	Author of the pull request iteration.
changeList	GitPullRequestChange[]	Changes included with the pull request iteration.
commits	GitCommitRef[]	The commits included with the pull request iteration.
commonRefCommit	GitCommitRef	The first common Git commit of the source and target refs.
createdDate	string (date-time)	The creation date of the pull request iteration.
description	string	Description of the pull request iteration.
hasMoreCommits	boolean	Indicates if the Commits property contains a truncated list of commits in this pull request iteration.
id	integer (int32)	ID of the pull request iteration. Iterations are created as a result of creating and pushing updates to a pull request.
push	GitPushRef	The Git push information associated with this pull request iteration.
reason	IterationReason	The reason for which the pull request iteration was created.
sourceRefCommit	GitCommitRef	The source Git commit of this iteration.
targetRefCommit	GitCommitRef	The target Git commit of this iteration.
updatedDate	string (date-time)	The updated date of the pull request iteration.

GitPushRef

Object

Name	Type	Description
_links	ReferenceLinks	The class to represent a collection of REST reference links.
date	string (date-time)
pushId	integer (int32)
pushedBy	IdentityRef
url	string

GitStatus

Object

This class contains the metadata of a service/extension posting a status.

Name	Type	Description
_links	ReferenceLinks	Reference links.
context	GitStatusContext	Context of the status.
createdBy	IdentityRef	Identity that created the status.
creationDate	string (date-time)	Creation date and time of the status.
description	string	Status description. Typically describes current state of the status.
id	integer (int32)	Status identifier.
state	GitStatusState	State of the status.
targetUrl	string	URL with status details.
updatedDate	string (date-time)	Last update date and time of the status.

GitStatusContext

Object

Status context that uniquely identifies the status.

Name	Type	Description
genre	string	Genre of the status. Typically name of the service/tool generating the status, can be empty.
name	string	Name identifier of the status, cannot be null or empty.

GitStatusState

Enumeration

State of the status.

Value	Description
notSet	Status state not set. Default state.
pending	Status pending.
succeeded	Status succeeded.
failed	Status failed.
error	Status with an error.
notApplicable	Status is not applicable to the target object.

GitTemplate

Object

Name	Type	Description
name	string	Name of the Template
type	string	Type of the Template

GitUserDate

Object

User info and date for Git operations.

Name	Type	Description
date	string (date-time)	Date of the Git operation.
email	string	Email address of the user performing the Git operation.
name	string	Name of the user performing the Git operation.

IdentityRef

Object

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
profileUrl	string
uniqueName	string
url	string	This url is the full route to the source resource of this graph subject.

ItemContent

Object

Name	Type	Description
content	string
contentType	ItemContentType

ItemContentType

Enumeration

Value	Description
rawText
base64Encoded

IterationReason

Enumeration

The reason for which the pull request iteration was created.

Value	Description
push
forcePush
create
rebase
unknown

ReferenceLinks

Object

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.

ResourceRef

Object

Name	Type	Description
id	string
url	string

VersionControlChangeType

Enumeration

The type of change that was made to the item.

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