Pull Requests - Get Pull Request

Service:

Git

API Version:

5.0

Recuperare una richiesta pull.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
organization	path	True	string	Nome dell'organizzazione di Azure DevOps.
pullRequestId	path	True	integer int32	ID della richiesta pull da recuperare.
repositoryId	path	True	string	ID repository del ramo di destinazione della richiesta pull.
project	path		string	ID progetto o nome progetto
api-version	query	True	string	Versione dell'API da usare. Questa opzione deve essere impostata su '5.0' per usare questa versione dell'API.
$skip	query		integer int32	Non usato.
$top	query		integer int32	Non usato.
includeCommits	query		boolean	Se true, la richiesta pull verrà restituita con i commit associati.
includeWorkItemRefs	query		boolean	Se true, la richiesta pull verrà restituita con i riferimenti all'elemento di lavoro associato.
maxCommentLength	query		integer int32	Non usato.

Risposte

Nome	Tipo	Descrizione
200 OK	GitPullRequest	operazione riuscita

Sicurezza

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

Nome	Descrizione
vso.code	Concede la possibilità di leggere codice sorgente e metadati relativi a commit, set di modifiche, rami e altri artefatti di controllo della versione. Concede inoltre la possibilità di cercare codice e ricevere notifiche sugli eventi di controllo della versione tramite gli hook del servizio.

Definizioni

Nome	Descrizione
ChangeCountDictionary
GitChange
GitCommitRef	Fornisce proprietà che descrivono un commit Git e metadati associati.
GitForkRef	Informazioni su un fork ref.
GitPullRequest	Rappresenta tutti i dati associati a una richiesta pull.
GitPullRequestCompletionOptions	Preferenze sulla modalità di completamento della richiesta pull.
GitPullRequestMergeOptions	Opzioni usate quando viene creata un'unione di richieste pull.
GitPushRef
GitRepository
GitRepositoryRef
GitStatus	Questa classe contiene i metadati di un servizio/estensione che registrano uno stato.
GitStatusContext	Contesto di stato che identifica in modo univoco lo stato.
GitStatusState	Stato dello stato.
GitTemplate
GitUserDate	Informazioni utente e data per le operazioni Git.
IdentityRef
IdentityRefWithVote	Informazioni sull'identità, tra cui un voto su una richiesta pull.
ItemContent
ItemContentType
ProjectState	Stato del progetto.
ProjectVisibility	Visibilità del progetto.
PullRequestAsyncStatus	Stato corrente dell'unione della richiesta pull.
PullRequestMergeFailureType	Tipo di errore (se presente) dell'unione della richiesta pull.
PullRequestStatus	Stato della richiesta pull.
ReferenceLinks	Classe da rappresentare una raccolta di collegamenti di riferimento REST.
ResourceRef
TeamProjectCollectionReference	Oggetto di riferimento per un Oggetto TeamProjectCollection.
TeamProjectReference	Rappresenta un riferimento superficiale a un TeamProject.
VersionControlChangeType	Tipo di modifica apportata all'elemento.
WebApiTagDefinition	Rappresentazione di una definizione di tag inviata attraverso il filo.

ChangeCountDictionary

GitChange

Nome	Tipo	Descrizione
changeId	integer	ID della modifica all'interno del gruppo di modifiche.
changeType	VersionControlChangeType	Tipo di modifica apportata all'elemento.
item	string	Versione corrente.
newContent	ItemContent	Contenuto dell'elemento dopo la modifica.
newContentTemplate	GitTemplate	Nuovo modello di contenuto da usare durante il push di nuove modifiche.
originalPath	string	Percorso originale dell'elemento se diverso dal percorso corrente.
sourceServerItem	string	Percorso dell'elemento nel server.
url	string	URL per recuperare l'elemento.

GitCommitRef

Fornisce proprietà che descrivono un commit Git e metadati associati.

Nome	Tipo	Descrizione
_links	ReferenceLinks	Raccolta di collegamenti di riferimento REST correlati.
author	GitUserDate	Autore del commit.
changeCounts	ChangeCountDictionary	Conteggi dei tipi di modifiche (modifiche, eliminazioni e così via) incluse nel commit.
changes	GitChange[]	Enumerazione delle modifiche incluse nel commit.
comment	string	Commento o messaggio del commit.
commentTruncated	boolean	Indica se il commento viene troncato dal messaggio di commento del commit Git completo.
commitId	string	ID (SHA-1) del commit.
committer	GitUserDate	Commiter del commit.
parents	string[]	Enumerazione degli ID commit padre per questo commit.
push	GitPushRef	Push associato a questo commit.
remoteUrl	string	Percorso URL remoto al commit.
statuses	GitStatus[]	Elenco dei metadati di stato dai servizi e dalle estensioni che possono associare informazioni aggiuntive al commit.
url	string	URL REST per questa risorsa.
workItems	ResourceRef[]	Elenco di elementi di lavoro associati al commit.

GitForkRef

Informazioni su un fork ref.

Nome	Tipo	Descrizione
_links	ReferenceLinks	Classe da rappresentare una raccolta di collegamenti di riferimento REST.
creator	IdentityRef
isLocked	boolean
isLockedBy	IdentityRef
name	string
objectId	string
peeledObjectId	string
repository	GitRepository	ID repository del fork.
statuses	GitStatus[]	Questa classe contiene i metadati di un servizio/estensione che registrano uno stato.
url	string

GitPullRequest

Rappresenta tutti i dati associati a una richiesta pull.

Nome	Tipo	Descrizione
_links	ReferenceLinks	Collegamenti ad altri oggetti correlati.
artifactId	string	Stringa che identifica in modo univoco questa richiesta pull. Per generare un ID artefatto per una richiesta pull, usare questo modello: vstfs:///Git/PullRequestId/{projectId}/{repositoryId}/{pullRequestId}
autoCompleteSetBy	IdentityRef	Se impostato, il completamento automatico è abilitato per questa richiesta pull e questa è l'identità abilitata.
closedBy	IdentityRef	Utente che ha chiuso la richiesta pull.
closedDate	string	Data di chiusura della richiesta pull (completata, abbandonata o unita esternamente).
codeReviewId	integer	ID di revisione del codice della richiesta pull. Per uso interno.
commits	GitCommitRef[]	I commit contenuti nella richiesta pull.
completionOptions	GitPullRequestCompletionOptions	Opzioni che influiscono sul modo in cui la richiesta pull verrà unita al completamento.
completionQueueTime	string	Data più recente in cui la richiesta pull ha immesso la coda da completare. Per uso interno.
createdBy	IdentityRef	Identità dell'utente che ha creato la richiesta pull.
creationDate	string	Data di creazione della richiesta pull.
description	string	Descrizione della richiesta pull.
forkSource	GitForkRef	Se si tratta di una richiesta pr da un fork, questo conterrà informazioni sulla relativa origine.
isDraft	boolean	Richiesta pull bozza/WIP.
labels	WebApiTagDefinition[]	Etichette associate alla richiesta pull.
lastMergeCommit	GitCommitRef	Commit del merge della richiesta pull più recente. Se vuoto, l'unione più recente è in corso o ha avuto esito negativo.
lastMergeSourceCommit	GitCommitRef	Commit all'inizio del ramo di origine al momento dell'ultima unione della richiesta pull.
lastMergeTargetCommit	GitCommitRef	Commit all'inizio del ramo di destinazione al momento dell'ultima unione della richiesta pull.
mergeFailureMessage	string	Se impostato, l'unione della richiesta pull non è riuscita per questo motivo.
mergeFailureType	PullRequestMergeFailureType	Tipo di errore (se presente) dell'unione della richiesta pull.
mergeId	string	ID del processo usato per eseguire l'unione della richiesta pull. Per uso interno.
mergeOptions	GitPullRequestMergeOptions	Opzioni usate quando viene eseguita l'unione della richiesta pull. Queste sono separate dalle opzioni di completamento poiché il completamento avviene una sola volta e una nuova unione verrà eseguita ogni volta che il ramo di origine della richiesta pull cambia.
mergeStatus	PullRequestAsyncStatus	Stato corrente dell'unione della richiesta pull.
pullRequestId	integer	ID della richiesta pull.
remoteUrl	string	Per uso interno.
repository	GitRepository	Repository contenente il ramo di destinazione della richiesta pull.
reviewers	IdentityRefWithVote[]	Elenco di revisori sulla richiesta pull insieme allo stato dei loro voti.
sourceRefName	string	Nome del ramo di origine della richiesta pull.
status	PullRequestStatus	Stato della richiesta pull.
supportsIterations	boolean	Se true, questa richiesta pull supporta più iterazioni. Il supporto dell'iterazione significa che i singoli push nel ramo di origine della richiesta pull possono essere esaminati e i commenti lasciati in un'iterazione verranno rilevati tra iterazioni future.
targetRefName	string	Nome del ramo di destinazione della richiesta pull.
title	string	Titolo della richiesta pull.
url	string	Per uso interno.
workItemRefs	ResourceRef[]	Tutti i riferimenti all'elemento di lavoro associati a questa richiesta pull.

GitPullRequestCompletionOptions

Preferenze sulla modalità di completamento della richiesta pull.

Nome	Tipo	Descrizione
bypassPolicy	boolean	Se true, i criteri verranno ignorati in modo esplicito mentre la richiesta pull viene completata.
bypassReason	string	Se i criteri vengono ignorati, questo motivo viene archiviato come motivo per cui è stato usato il bypass.
deleteSourceBranch	boolean	Se true, il ramo di origine della richiesta pull verrà eliminato dopo il completamento.
mergeCommitMessage	string	Se impostato, verrà usato come messaggio di commit del commit del commit.
squashMerge	boolean	Se true, i commit nella richiesta pull verranno uniti nel ramo di destinazione specificato al completamento.
transitionWorkItems	boolean	Se true, si tenterà di eseguire la transizione di eventuali elementi di lavoro collegati alla richiesta pull nello stato logico successivo (ad esempio Active -> Resolved)
triggeredByAutoComplete	boolean	Se true, il tentativo di completamento corrente è stato attivato tramite il completamento automatico. Per uso interno.

GitPullRequestMergeOptions

Opzioni usate quando viene creata un'unione di richieste pull.

Nome	Tipo	Descrizione
detectRenameFalsePositives	boolean
disableRenames	boolean	Se true, il rilevamento della ridenominazione non verrà eseguito durante l'unione.

GitPushRef

Nome	Tipo	Descrizione
_links	ReferenceLinks	Classe da rappresentare una raccolta di collegamenti di riferimento REST.
date	string
pushId	integer
pushedBy	IdentityRef
url	string

GitRepository

Nome	Tipo	Descrizione
_links	ReferenceLinks	Classe da rappresentare una raccolta di collegamenti di riferimento REST.
defaultBranch	string
id	string
isFork	boolean	True se il repository è stato creato come fork
name	string
parentRepository	GitRepositoryRef
project	TeamProjectReference	Rappresenta un riferimento superficiale a un TeamProject.
remoteUrl	string
size	integer	Dimensioni compresse (byte) del repository.
sshUrl	string
url	string
validRemoteUrls	string[]

GitRepositoryRef

Nome	Tipo	Descrizione
collection	TeamProjectCollectionReference	Raccolta di progetti team in cui risiede questo fork
id	string
isFork	boolean	True se il repository è stato creato come fork
name	string
project	TeamProjectReference	Rappresenta un riferimento superficiale a un TeamProject.
remoteUrl	string
sshUrl	string
url	string

GitStatus

Questa classe contiene i metadati di un servizio/estensione che registrano uno stato.

Nome	Tipo	Descrizione
_links	ReferenceLinks	Collegamenti di riferimento.
context	GitStatusContext	Contesto dello stato.
createdBy	IdentityRef	Identità che ha creato lo stato.
creationDate	string	Data e ora di creazione dello stato.
description	string	Descrizione dello stato. In genere viene descritto lo stato corrente dello stato.
id	integer	Identificatore di stato.
state	GitStatusState	Stato dello stato.
targetUrl	string	URL con dettagli sullo stato.
updatedDate	string	Ultima data e ora di aggiornamento dello stato.

GitStatusContext

Contesto di stato che identifica in modo univoco lo stato.

Nome	Tipo	Descrizione
genre	string	Genere dello stato. In genere, il nome del servizio o dello strumento che genera lo stato può essere vuoto.
name	string	L'identificatore del nome dello stato non può essere null o vuoto.

GitStatusState

Stato dello stato.

Nome	Tipo	Descrizione
error	string	Stato con un errore.
failed	string	Stato non riuscito.
notApplicable	string	Lo stato non è applicabile all'oggetto di destinazione.
notSet	string	Stato non impostato. Stato predefinito.
pending	string	Stato in sospeso.
succeeded	string	Stato completato.

GitTemplate

Nome	Tipo	Descrizione
name	string	Nome del modello
type	string	Tipo del modello

GitUserDate

Informazioni utente e data per le operazioni Git.

Nome	Tipo	Descrizione
date	string	Data dell'operazione Git.
email	string	Email indirizzo dell'utente che esegue l'operazione Git.
imageUrl	string	Url dell'avatar dell'utente.
name	string	Nome dell'utente che esegue l'operazione Git.

IdentityRef

Nome	Tipo	Descrizione
_links	ReferenceLinks	Questo campo contiene zero o più collegamenti interessanti sull'oggetto grafico. Questi collegamenti possono essere richiamati per ottenere relazioni aggiuntive o informazioni più dettagliate su questo argomento grafico.
descriptor	string	Il descrittore è il modo principale per fare riferimento all'oggetto del grafico durante l'esecuzione del sistema. Questo campo identificherà in modo univoco lo stesso soggetto grafo in account e organizzazioni.
directoryAlias	string
displayName	string	Si tratta del nome visualizzato non univoco dell'oggetto grafico. Per modificare questo campo, è necessario modificarlo nel provider di origine.
id	string
imageUrl	string
inactive	boolean
isAadIdentity	boolean
isContainer	boolean
isDeletedInOrigin	boolean
profileUrl	string
uniqueName	string
url	string	Questo URL è la route completa alla risorsa di origine di questo oggetto grafico.

IdentityRefWithVote

Informazioni sull'identità, tra cui un voto su una richiesta pull.

Nome	Tipo	Descrizione
_links	ReferenceLinks	Questo campo contiene zero o più collegamenti interessanti sull'oggetto grafico. Questi collegamenti possono essere richiamati per ottenere relazioni aggiuntive o informazioni più dettagliate su questo argomento grafico.
descriptor	string	Il descrittore è il modo principale per fare riferimento all'oggetto del grafico durante l'esecuzione del sistema. Questo campo identificherà in modo univoco lo stesso soggetto grafo in account e organizzazioni.
directoryAlias	string
displayName	string	Si tratta del nome visualizzato non univoco dell'oggetto grafico. Per modificare questo campo, è necessario modificarlo nel provider di origine.
id	string
imageUrl	string
inactive	boolean
isAadIdentity	boolean
isContainer	boolean
isDeletedInOrigin	boolean
isRequired	boolean	Indica se si tratta di un revisore obbligatorio per questa richiesta pull. I rami possono avere criteri che richiedono revisori specifici per le richieste pull.
profileUrl	string
reviewerUrl	string	URL per recuperare informazioni su questa identità
uniqueName	string
url	string	Questo URL è la route completa alla risorsa di origine di questo oggetto grafico.
vote	integer	Votare su una richiesta pull: 10 - approvato 5 - approvato con suggerimenti 0 - nessun voto -5 - in attesa dell'autore -10 - rifiutato
votedFor	IdentityRefWithVote[]	Gruppi o team a cui ha contribuito questo revisore. I gruppi e i team possono essere revisori sulle richieste pull, ma non possono votare direttamente. Quando un membro del gruppo o del gruppo vota, tale voto viene eseguito nel gruppo o nel voto del team. VoteFor è un elenco di tali voti.

ItemContent

Nome	Tipo	Descrizione
content	string
contentType	ItemContentType

ItemContentType

Nome	Tipo	Descrizione
base64Encoded	string
rawText	string

ProjectState

Stato del progetto.

Nome	Tipo	Descrizione
all	string	Tutti i progetti indipendentemente dallo stato.
createPending	string	Il progetto è stato accodato per la creazione, ma il processo non è ancora stato avviato.
deleted	string	Il progetto è stato eliminato.
deleting	string	Il progetto si trova nel processo di eliminazione.
new	string	Il progetto è in fase di creazione.
unchanged	string	Il progetto non è stato modificato.
wellFormed	string	Il progetto è completamente creato e pronto per l'uso.

ProjectVisibility

Visibilità del progetto.

Nome	Tipo	Descrizione
private	string	Il progetto è visibile solo agli utenti con accesso esplicito.
public	string	Il progetto è visibile a tutti.

PullRequestAsyncStatus

Stato corrente dell'unione della richiesta pull.

Nome	Tipo	Descrizione
conflicts	string	Unione della richiesta pull non riuscita a causa di conflitti.
failure	string	Unione della richiesta pull non riuscita.
notSet	string	Lo stato non è impostato. Stato predefinito.
queued	string	L'unione della richiesta pull viene accodata.
rejectedByPolicy	string	Unione della richiesta pull rifiutata dai criteri.
succeeded	string	Unione della richiesta pull completata.

PullRequestMergeFailureType

Tipo di errore (se presente) dell'unione della richiesta pull.

Nome	Tipo	Descrizione
caseSensitive	string	Unione della richiesta pull non riuscita a causa della mancata corrispondenza tra maiuscole e minuscole.
none	string	Il tipo non è impostato. Tipo predefinito.
objectTooLarge	string	Unione richiesta pull non riuscita a causa di un oggetto troppo grande.
unknown	string	Tipo di errore di unione della richiesta pull sconosciuto.

PullRequestStatus

Stato della richiesta pull.

Nome	Tipo	Descrizione
abandoned	string	La richiesta pull viene abbandonata.
active	string	La richiesta pull è attiva.
all	string	Usato nei criteri di ricerca della richiesta pull per includere tutti gli stati.
completed	string	La richiesta pull viene completata.
notSet	string	Stato non impostato. Stato predefinito.

ReferenceLinks

Classe da rappresentare una raccolta di collegamenti di riferimento REST.

Nome	Tipo	Descrizione
links	object	Visualizzazione di lettura dei collegamenti. Poiché i collegamenti di riferimento sono in sola lettura, si vuole esporre solo i collegamenti di riferimento come sola lettura.

ResourceRef

Nome	Tipo	Descrizione
id	string
url	string

TeamProjectCollectionReference

Oggetto di riferimento per un Oggetto TeamProjectCollection.

Nome	Tipo	Descrizione
id	string	ID raccolta.
name	string	Nome raccolta.
url	string	URL REST raccolta.

TeamProjectReference

Rappresenta un riferimento superficiale a un TeamProject.

Nome	Tipo	Descrizione
abbreviation	string	Abbreviazione del progetto.
defaultTeamImageUrl	string	Url dell'immagine di identità del team predefinita.
description	string	Descrizione del progetto (se presente).
id	string	Identificatore del progetto.
name	string	Nome progetto.
revision	integer	Revisione del progetto.
state	ProjectState	Stato del progetto.
url	string	Url alla versione completa dell'oggetto.
visibility	ProjectVisibility	Visibilità del progetto.

VersionControlChangeType

Tipo di modifica apportata all'elemento.

Nome	Tipo	Descrizione
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

Rappresentazione di una definizione di tag inviata attraverso il filo.

Nome	Tipo	Descrizione
active	boolean	Indica se la definizione del tag è attiva.
id	string	ID della definizione del tag.
name	string	Nome della definizione del tag.
url	string	URL della risorsa per la definizione di tag.