Pull Requests - Get Pull Request

Referenz

Service:: Git

API Version:: 5.0

Rufen Sie einen Pull Request ab.

GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullrequests/{pullRequestId}?api-version=5.0

With optional parameters:

GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullrequests/{pullRequestId}?maxCommentLength={maxCommentLength}&$skip={$skip}&$top={$top}&includeCommits={includeCommits}&includeWorkItemRefs={includeWorkItemRefs}&api-version=5.0

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
organization	path	True	string	Der Name der Azure DevOps-Organisation.
pullRequestId	path	True	integer int32	Die ID des abzurufenden Pull Requests.
repositoryId	path	True	string	Die Repository-ID des Zielbranchs des Pull Requests.
project	path		string	Projekt-ID oder Projektname
api-version	query	True	string	Version der zu verwendenden API. Dies sollte auf "5.0" festgelegt werden, um diese Version der API zu verwenden.
$skip	query		integer int32	Nicht verwendet.
$top	query		integer int32	Nicht verwendet.
includeCommits	query		boolean	Wenn true, wird der Pull Request mit den zugeordneten Commits zurückgegeben.
includeWorkItemRefs	query		boolean	Wenn true, wird der Pull Request mit den zugeordneten Arbeitselementverweisen zurückgegeben.
maxCommentLength	query		integer int32	Nicht verwendet.

Antworten

Name	Typ	Beschreibung
200 OK	GitPullRequest	Erfolgreicher Vorgang

Sicherheit

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	Beschreibung
vso.code	Ermöglicht das Lesen von Quellcode und Metadaten zu Commits, Changesets, Branches und anderen Versionskontrollartefakten. Bietet außerdem die Möglichkeit, Code zu suchen und über Versionskontrollereignisse über Diensthooks benachrichtigt zu werden.

Definitionen

Name	Beschreibung
ChangeCountDictionary
GitChange
GitCommitRef	Stellt Eigenschaften bereit, die einen Git-Commit und zugehörige Metadaten beschreiben.
GitForkRef	Informationen zu einem Fork-Ref.
GitPullRequest	Stellt alle Daten dar, die einem Pull Request zugeordnet sind.
GitPullRequestCompletionOptions	Einstellungen darüber, wie der Pull Request abgeschlossen werden soll.
GitPullRequestMergeOptions	Die Optionen, die beim Erstellen einer Pull Request-Merge verwendet werden.
GitPushRef
GitRepository
GitRepositoryRef
GitStatus	Diese Klasse enthält die Metadaten eines Diensts/einer Erweiterung, die eine status.
GitStatusContext	Statuskontext, der die status eindeutig identifiziert.
GitStatusState	Zustand des status.
GitTemplate
GitUserDate	Benutzerinformationen und Datum für Git-Vorgänge.
IdentityRef
IdentityRefWithVote	Identitätsinformationen, einschließlich einer Abstimmung über einen Pull Request.
ItemContent
ItemContentType
ProjectState	Projektstatus.
ProjectVisibility	Projektsichtbarkeit.
PullRequestAsyncStatus	Der aktuelle status der Pull Request Merge.
PullRequestMergeFailureType	Der Typ des Fehlers (falls vorhanden) der Pull Request Merge.
PullRequestStatus	Die status des Pull Requests.
ReferenceLinks	Die Klasse, die eine Auflistung von REST-Verweislinks darstellt.
ResourceRef
TeamProjectCollectionReference	Referenzobjekt für eine TeamProjectCollection.
TeamProjectReference	Stellt einen flachen Verweis auf ein TeamProject dar.
VersionControlChangeType	Der Typ der Änderung, die am Element vorgenommen wurde.
WebApiTagDefinition	Die Darstellung einer Tagdefinition, die über das Kabel gesendet wird.

ChangeCountDictionary

GitChange

Name	Typ	Beschreibung
changeId	integer	ID der Änderung innerhalb der Gruppe der Änderungen.
changeType	VersionControlChangeType	Der Typ der Änderung, die am Element vorgenommen wurde.
item	string	Aktuelle Version.
newContent	ItemContent	Inhalt des Elements nach der Änderung.
newContentTemplate	GitTemplate	Neue Inhaltsvorlage, die beim Pushen neuer Änderungen verwendet werden soll.
originalPath	string	Der ursprüngliche Pfad des Elements, wenn er sich vom aktuellen Pfad unterscheidet.
sourceServerItem	string	Pfad des Elements auf dem Server.
url	string	URL zum Abrufen des Elements.

GitCommitRef

Stellt Eigenschaften bereit, die einen Git-Commit und zugehörige Metadaten beschreiben.

Name	Typ	Beschreibung
_links	ReferenceLinks	Eine Sammlung verwandter REST-Verweislinks.
author	GitUserDate	Autor des Commits.
changeCounts	ChangeCountDictionary	Anzahl der Im Commit enthaltenen Änderungstypen (Bearbeitungen, Löschvorgänge usw.).
changes	GitChange[]	Eine Enumeration der im Commit enthaltenen Änderungen.
comment	string	Kommentar oder Meldung des Commits.
commentTruncated	boolean	Gibt an, ob der Kommentar aus der vollständigen Git-Commitkommentarnachricht abgeschnitten wird.
commitId	string	ID (SHA-1) des Commits.
committer	GitUserDate	Committer des Commits.
parents	string[]	Eine Enumeration der übergeordneten Commit-IDs für diesen Commit.
push	GitPushRef	Der diesem Commit zugeordnete Push.
remoteUrl	string	Remote-URL-Pfad zum Commit.
statuses	GitStatus[]	Eine Liste mit status Metadaten von Diensten und Erweiterungen, die dem Commit möglicherweise zusätzliche Informationen zuordnen.
url	string	REST-URL für diese Ressource.
workItems	ResourceRef[]	Eine Liste von Arbeitselementen, die diesem Commit zugeordnet sind.

GitForkRef

Informationen zu einem Fork-Ref.

Name	Typ	Beschreibung
_links	ReferenceLinks	Die Klasse, die eine Auflistung von REST-Verweislinks darstellt.
creator	IdentityRef
isLocked	boolean
isLockedBy	IdentityRef
name	string
objectId	string
peeledObjectId	string
repository	GitRepository	Die Repository-ID des Forks.
statuses	GitStatus[]	Diese Klasse enthält die Metadaten eines Diensts/einer Erweiterung, die eine status.
url	string

GitPullRequest

Stellt alle Daten dar, die einem Pull Request zugeordnet sind.

Name	Typ	Beschreibung
_links	ReferenceLinks	Links zu anderen verwandten Objekten.
artifactId	string	Eine Zeichenfolge, die diesen Pull Request eindeutig identifiziert. Verwenden Sie diese Vorlage, um eine Artefakt-ID für einen Pull Request zu generieren: `vstfs:///Git/PullRequestId/{projectId}/{repositoryId}/{pullRequestId}`
autoCompleteSetBy	IdentityRef	Wenn festgelegt, ist die automatische Vervollständigung für diesen Pull Request aktiviert, und dies ist die Identität, die ihn aktiviert hat.
closedBy	IdentityRef	Der Benutzer, der den Pull Request geschlossen hat.
closedDate	string	Das Datum, an dem der Pull Request geschlossen wurde (abgeschlossen, abgebrochen oder extern zusammengeführt).
codeReviewId	integer	Die Codeüberprüfungs-ID des Pull Request. Wird intern verwendet.
commits	GitCommitRef[]	Die commits, die im Pull Request enthalten sind.
completionOptions	GitPullRequestCompletionOptions	Optionen, die sich darauf auswirken, wie der Pull Request zusammengeführt wird, wenn er abgeschlossen ist.
completionQueueTime	string	Das letzte Datum, an dem der Pull Request in die Warteschlange gelangt ist, um abgeschlossen zu werden. Wird intern verwendet.
createdBy	IdentityRef	Die Identität des Benutzers, der den Pull Request erstellt hat.
creationDate	string	Das Datum, an dem der Pull Request erstellt wurde.
description	string	Die Beschreibung des Pull Requests.
forkSource	GitForkRef	Wenn es sich um einen PR aus einem Fork handelt, enthält dieser Informationen zu seiner Quelle.
isDraft	boolean	Draft/WIP-Pull Request.
labels	WebApiTagDefinition[]	Die Bezeichnungen, die dem Pull Request zugeordnet sind.
lastMergeCommit	GitCommitRef	Der Commit der letzten Pull Request-Merge. Wenn sie leer ist, wird die letzte Zusammenführung ausgeführt oder war nicht erfolgreich.
lastMergeSourceCommit	GitCommitRef	Der Commit an der Spitze des Quellbranchs zum Zeitpunkt der letzten Pull Request-Merge.
lastMergeTargetCommit	GitCommitRef	Der Commit an der Spitze des Zielbranchs zum Zeitpunkt der letzten Pull Request-Merge.
mergeFailureMessage	string	Falls festgelegt, ist die Pull Request-Merge aus diesem Grund fehlgeschlagen.
mergeFailureType	PullRequestMergeFailureType	Der Typ des Fehlers (falls vorhanden) der Pull Request Merge.
mergeId	string	Die ID des Auftrags, der zum Ausführen der Pull Request Merge verwendet wird. Wird intern verwendet.
mergeOptions	GitPullRequestMergeOptions	Optionen, die verwendet werden, wenn der Pull Request Merge ausgeführt wird. Diese sind von den Vervollständigungsoptionen getrennt, da die Vervollständigung nur einmal erfolgt und jedes Mal ein neuer Merge ausgeführt wird, wenn sich der Quellbranch des Pull Requests ändert.
mergeStatus	PullRequestAsyncStatus	Der aktuelle status der Pull Request Merge.
pullRequestId	integer	Die ID des Pull Requests.
remoteUrl	string	Wird intern verwendet.
repository	GitRepository	Das Repository, das den Zielbranch des Pull Requests enthält.
reviewers	IdentityRefWithVote[]	Eine Liste der Prüfer über den Pull Request zusammen mit dem Status ihrer Stimmen.
sourceRefName	string	Der Name des Quellbranchs des Pull Requests.
status	PullRequestStatus	Die status des Pull Requests.
supportsIterations	boolean	Wenn true, unterstützt dieser Pull Request mehrere Iterationen. Iterationsunterstützung bedeutet, dass einzelne Pushvorgänge an den Quellbranch des Pull Requests überprüft werden können, und kommentare, die in einer Iteration verbleiben, werden in zukünftigen Iterationen nachverfolgt.
targetRefName	string	Der Name des Zielbranchs des Pull Requests.
title	string	Der Titel des Pull Requests.
url	string	Wird intern verwendet.
workItemRefs	ResourceRef[]	Alle Arbeitselementverweise, die diesem Pull Request zugeordnet sind.

GitPullRequestCompletionOptions

Einstellungen darüber, wie der Pull Request abgeschlossen werden soll.

Name	Typ	Beschreibung
bypassPolicy	boolean	Wenn true, werden Richtlinien explizit umgangen, während der Pull Request abgeschlossen ist.
bypassReason	string	Wenn Richtlinien umgangen werden, wird dieser Grund gespeichert, warum umgehung verwendet wurde.
deleteSourceBranch	boolean	Wenn true, wird der Quellbranch des Pull Request nach Abschluss gelöscht.
mergeCommitMessage	string	Wenn festgelegt, wird dies als Commitmeldung des Mergecommits verwendet.
squashMerge	boolean	Wenn true, werden die Commits im Pull Request nach Abschluss squashen mit dem angegebenen Zielbranch zusammengeführt.
transitionWorkItems	boolean	Wenn true, versuchen wir, alle Arbeitselemente, die mit dem Pull Request verknüpft sind, in den nächsten logischen Zustand zu überstellen (d. h. Aktiv –> Aufgelöst).
triggeredByAutoComplete	boolean	Wenn true, wurde der aktuelle Vervollständigungsversuch über die automatische Vervollständigung ausgelöst. Wird intern verwendet.

GitPullRequestMergeOptions

Die Optionen, die beim Erstellen einer Pull Request-Merge verwendet werden.

Name	Typ	Beschreibung
detectRenameFalsePositives	boolean
disableRenames	boolean	Wenn true, wird die Umbenennungserkennung während der Zusammenführung nicht ausgeführt.

GitPushRef

Name	Typ	Beschreibung
_links	ReferenceLinks	Die Klasse, die eine Auflistung von REST-Verweislinks darstellt.
date	string
pushId	integer
pushedBy	IdentityRef
url	string

GitRepository

Name	Typ	Beschreibung
_links	ReferenceLinks	Die Klasse, die eine Auflistung von REST-Verweislinks darstellt.
defaultBranch	string
id	string
isFork	boolean	True, wenn das Repository als Fork erstellt wurde
name	string
parentRepository	GitRepositoryRef
project	TeamProjectReference	Stellt einen flachen Verweis auf ein TeamProject dar.
remoteUrl	string
size	integer	Komprimierte Größe (Bytes) des Repositorys.
sshUrl	string
url	string
validRemoteUrls	string[]

GitRepositoryRef

Name	Typ	Beschreibung
collection	TeamProjectCollectionReference	Team Project Collection, in der sich dieser Fork befindet
id	string
isFork	boolean	True, wenn das Repository als Fork erstellt wurde
name	string
project	TeamProjectReference	Stellt einen flachen Verweis auf ein TeamProject dar.
remoteUrl	string
sshUrl	string
url	string

GitStatus

Diese Klasse enthält die Metadaten eines Diensts/einer Erweiterung, die eine status.

Name	Typ	Beschreibung
_links	ReferenceLinks	Verweislinks.
context	GitStatusContext	Kontext des status.
createdBy	IdentityRef	Identität, die den status erstellt hat.
creationDate	string	Erstellungsdatum und -uhrzeit des status.
description	string	Statusbeschreibung. Beschreibt in der Regel den aktuellen Zustand des status.
id	integer	Statusbezeichner.
state	GitStatusState	Zustand des status.
targetUrl	string	URL mit status Details.
updatedDate	string	Datum und Uhrzeit der letzten Aktualisierung des status.

GitStatusContext

Statuskontext, der die status eindeutig identifiziert.

Name	Typ	Beschreibung
genre	string	Genre der status. In der Regel kann der Name des Diensts/Tools, der die status generiert, leer sein.
name	string	Der Namensbezeichner des status darf nicht NULL oder leer sein.

GitStatusState

Zustand des status.

Name	Typ	Beschreibung
error	string	Status mit einem Fehler.
failed	string	Fehler beim Status.
notApplicable	string	Der Status gilt nicht für das Zielobjekt.
notSet	string	Statusstatus nicht festgelegt. Standardzustand.
pending	string	Status ausstehend.
succeeded	string	Status erfolgreich.

GitTemplate

Name	Typ	Beschreibung
name	string	Name der Vorlage
type	string	Typ der Vorlage

GitUserDate

Benutzerinformationen und Datum für Git-Vorgänge.

Name	Typ	Beschreibung
date	string	Datum des Git-Vorgangs.
email	string	Email Adresse des Benutzers, der den Git-Vorgang ausführt.
imageUrl	string	URL für den Avatar des Benutzers.
name	string	Name des Benutzers, der den Git-Vorgang ausführt.

IdentityRef

Name	Typ	Beschreibung
_links	ReferenceLinks	Dieses Feld enthält null oder interessantere Links zum Diagrammthema. Diese Links können aufgerufen werden, um zusätzliche Beziehungen oder ausführlichere Informationen zu diesem Graph-Thema zu erhalten.
descriptor	string	Der Deskriptor ist die primäre Möglichkeit, auf den Graphengegenstand zu verweisen, während das System ausgeführt wird. In diesem Feld wird derselbe Graph-Betreff sowohl für Konten als auch für Organisationen eindeutig identifiziert.
directoryAlias	string
displayName	string	Dies ist der nicht eindeutige Anzeigename des Diagrammsubjekts. Um dieses Feld zu ändern, müssen Sie seinen Wert im Quellanbieter ändern.
id	string
imageUrl	string
inactive	boolean
isAadIdentity	boolean
isContainer	boolean
isDeletedInOrigin	boolean
profileUrl	string
uniqueName	string
url	string	Diese URL ist die vollständige Route zur Quellressource dieses Graph-Betreffs.

IdentityRefWithVote

Identitätsinformationen, einschließlich einer Abstimmung über einen Pull Request.

Name	Typ	Beschreibung
_links	ReferenceLinks	Dieses Feld enthält null oder interessantere Links zum Diagrammthema. Diese Links können aufgerufen werden, um zusätzliche Beziehungen oder ausführlichere Informationen zu diesem Graph-Thema zu erhalten.
descriptor	string	Der Deskriptor ist die primäre Möglichkeit, auf den Graphengegenstand zu verweisen, während das System ausgeführt wird. In diesem Feld wird derselbe Graph-Betreff sowohl für Konten als auch für Organisationen eindeutig identifiziert.
directoryAlias	string
displayName	string	Dies ist der nicht eindeutige Anzeigename des Diagrammsubjekts. Um dieses Feld zu ändern, müssen Sie seinen Wert im Quellanbieter ändern.
id	string
imageUrl	string
inactive	boolean
isAadIdentity	boolean
isContainer	boolean
isDeletedInOrigin	boolean
isRequired	boolean	Gibt an, ob dies ein erforderlicher Prüfer für diesen Pull Request ist. Branches können Richtlinien aufweisen, für die bestimmte Prüfer für Pull Requests erforderlich sind.
profileUrl	string
reviewerUrl	string	URL zum Abrufen von Informationen zu dieser Identität
uniqueName	string
url	string	Diese URL ist die vollständige Route zur Quellressource dieses Graph-Betreffs.
vote	integer	Abstimmung über einen Pull Request: 10 - genehmigt 5 - mit Vorschlägen genehmigt 0 - nein Abstimmung - 5 - warten auf Autor -10 - abgelehnt
votedFor	IdentityRefWithVote[]	Gruppen oder Teams, zu denen dieser Prüfer beigetragen hat. Gruppen und Teams können Prüfer für Pull Requests sein, aber nicht direkt abstimmen. Wenn ein Mitglied der Gruppe oder des Teams abstimmt, wird diese Stimme in die Gruppen- oder Teamabstimmung eingerollt. VoteFor ist eine Liste dieser Stimmen.

ItemContent

Name	Typ	Beschreibung
content	string
contentType	ItemContentType

ItemContentType

Name	Typ	Beschreibung
base64Encoded	string
rawText	string

ProjectState

Projektstatus.

Name	Typ	Beschreibung
all	string	Alle Projekte unabhängig vom Zustand.
createPending	string	Project wurde für die Erstellung in die Warteschlange gestellt, aber der Prozess wurde noch nicht gestartet.
deleted	string	Project wurde gelöscht.
deleting	string	Project wird gerade gelöscht.
new	string	Das Projekt wird gerade erstellt.
unchanged	string	Project wurde nicht geändert.
wellFormed	string	Project ist vollständig erstellt und einsatzbereit.

ProjectVisibility

Projektsichtbarkeit.

Name	Typ	Beschreibung
private	string	Das Projekt ist nur für Benutzer mit explizitem Zugriff sichtbar.
public	string	Das Projekt ist für alle sichtbar.

PullRequestAsyncStatus

Der aktuelle status der Pull Request Merge.

Name	Typ	Beschreibung
conflicts	string	Fehler bei der Zusammenführung von Pull Requests aufgrund von Konflikten.
failure	string	Fehler bei der Zusammenführung von Pull Request.
notSet	string	Der Status ist nicht festgelegt. Standardzustand.
queued	string	Pull Request Merge wird in eine Warteschlange eingereiht.
rejectedByPolicy	string	Pull Request Merge wird von der Richtlinie abgelehnt.
succeeded	string	Pull Request Merge erfolgreich.

PullRequestMergeFailureType

Der Typ des Fehlers (falls vorhanden) der Pull Request Merge.

Name	Typ	Beschreibung
caseSensitive	string	Fehler bei der Zusammenführung von Pull Requests aufgrund einer fehlerhaften Groß- und Kleinschreibung.
none	string	Typ ist nicht festgelegt. Standardtyp.
objectTooLarge	string	Fehler beim Zusammenführen von Pull Requests, weil ein Objekt zu groß ist.
unknown	string	Pull Request Merge-Fehlertyp unbekannt.

PullRequestStatus

Die status des Pull Requests.

Name	Typ	Beschreibung
abandoned	string	Pull Request wird abgebrochen.
active	string	Pull Request ist aktiv.
all	string	Wird in Pull Request-Suchkriterien verwendet, um alle Status einzuschließen.
completed	string	Pull Request ist abgeschlossen.
notSet	string	Status nicht festgelegt. Standardzustand.

ReferenceLinks

Die Klasse, die eine Auflistung von REST-Verweislinks darstellt.

Name	Typ	Beschreibung
links	object	Die schreibgeschützte Ansicht der Links. Da Verweislinks schreibgeschützt sind, möchten wir sie nur als schreibgeschützt verfügbar machen.

ResourceRef

Name	Typ	Beschreibung
id	string
url	string

TeamProjectCollectionReference

Referenzobjekt für eine TeamProjectCollection.

Name	Typ	Beschreibung
id	string	Sammlungs-ID.
name	string	Sammlungsname.
url	string	SAMMLUNGS-REST-URL.

TeamProjectReference

Stellt einen flachen Verweis auf ein TeamProject dar.

Name	Typ	Beschreibung
abbreviation	string	Projektkürzel.
defaultTeamImageUrl	string	URL zum Standardmäßigen Teamidentitätsimage.
description	string	Die Projektbeschreibung (falls vorhanden).
id	string	Projektbezeichner.
name	string	Der Projektname.
revision	integer	Projektrevision.
state	ProjectState	Projektstatus.
url	string	URL zur Vollversion des Objekts.
visibility	ProjectVisibility	Projektsichtbarkeit.

VersionControlChangeType

Der Typ der Änderung, die am Element vorgenommen wurde.

Name	Typ	Beschreibung
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

WebApiTagDefinition

Die Darstellung einer Tagdefinition, die über das Kabel gesendet wird.

Name	Typ	Beschreibung
active	boolean	Gibt an, ob die Tagdefinition aktiv ist.
id	string	ID der Tagdefinition.
name	string	Der Name der Tagdefinition.
url	string	Ressourcen-URL für die Tagdefinition.

Freigeben über