Pull Requests - Get Pull Request

Service:

Git

API Version:

5.0

Načtení žádosti o přijetí změn

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
organization	path	True	string	Název organizace Azure DevOps.
pullRequestId	path	True	integer int32	ID žádosti o přijetí změn, která se má načíst.
repositoryId	path	True	string	ID úložiště cílové větve žádosti o přijetí změn.
project	path		string	ID projektu nebo název projektu
api-version	query	True	string	Verze rozhraní API, která se má použít. Aby se tato verze rozhraní API používala, měla by být nastavená na hodnotu 5.0.
$skip	query		integer int32	Nepoužívá se.
$top	query		integer int32	Nepoužívá se.
includeCommits	query		boolean	Pokud je true, žádost o přijetí změn se vrátí s přidruženými potvrzeními.
includeWorkItemRefs	query		boolean	Pokud je true, žádost o přijetí změn se vrátí s přidruženými odkazy na pracovní položky.
maxCommentLength	query		integer int32	Nepoužívá se.

Odpovědi

Name	Typ	Description
200 OK	GitPullRequest	úspěšná operace

Zabezpečení

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	Uděluje možnost číst zdrojový kód a metadata o potvrzeních, sadách změn, větvích a dalších artefaktech správy verzí. Umožňuje také prohledávat kód a dostávat oznámení o událostech správy verzí prostřednictvím hooků služeb.

Definice

Name	Description
ChangeCountDictionary
GitChange
GitCommitRef	Poskytuje vlastnosti, které popisují potvrzení Gitu a přidružená metadata.
GitForkRef	Informace o referenčním odkazu forku
GitPullRequest	Představuje všechna data přidružená k žádosti o přijetí změn.
GitPullRequestCompletionOptions	Předvolby způsobu dokončení žádosti o přijetí změn
GitPullRequestMergeOptions	Možnosti, které se použijí při vytvoření žádosti o přijetí změn.
GitPushRef
GitRepository
GitRepositoryRef
GitStatus	Tato třída obsahuje metadata služby nebo rozšíření, které zveřejňuje stav.
GitStatusContext	Kontext stavu, který jednoznačně identifikuje stav.
GitStatusState	Stav stavu.
GitTemplate
GitUserDate	Informace o uživateli a datum operací Gitu
IdentityRef
IdentityRefWithVote	Informace o identitě včetně hlasování o žádosti o přijetí změn
ItemContent
ItemContentType
ProjectState	Stav projektu.
ProjectVisibility	Viditelnost projektu.
PullRequestAsyncStatus	Aktuální stav sloučení žádosti o přijetí změn
PullRequestMergeFailureType	Typ selhání (pokud existuje) sloučení žádosti o přijetí změn.
PullRequestStatus	Stav žádosti o přijetí změn
ReferenceLinks	Třída představující kolekci odkazů REST.
ResourceRef
TeamProjectCollectionReference	Referenční objekt pro TeamProjectCollection.
TeamProjectReference	Představuje mělký odkaz na TeamProject.
VersionControlChangeType	Typ změny provedené u položky
WebApiTagDefinition	Reprezentace definice značky, která se odesílá přes drát.

ChangeCountDictionary

GitChange

Name	Typ	Description
changeId	integer	ID změny v rámci skupiny změn.
changeType	VersionControlChangeType	Typ změny provedené u položky
item	string	Aktuální verze.
newContent	ItemContent	Obsah položky po změně.
newContentTemplate	GitTemplate	Nová šablona obsahu, která se má použít při nabízení nových změn.
originalPath	string	Původní cesta k položce, pokud se liší od aktuální cesty.
sourceServerItem	string	Cesta k položce na serveru.
url	string	Adresa URL pro načtení položky

GitCommitRef

Poskytuje vlastnosti, které popisují potvrzení Gitu a přidružená metadata.

Name	Typ	Description
_links	ReferenceLinks	Kolekce souvisejících odkazů rest.
author	GitUserDate	Autor potvrzení.
changeCounts	ChangeCountDictionary	Počítá typy změn (úpravy, odstranění atd.), které jsou součástí potvrzení.
changes	GitChange[]	Výčet změn zahrnutých v potvrzení.
comment	string	Komentář nebo zpráva potvrzení
commentTruncated	boolean	Označuje, jestli je komentář zkrácený od úplné zprávy o potvrzení Gitu.
commitId	string	ID (SHA-1) potvrzení.
committer	GitUserDate	Committer potvrzení.
parents	string[]	Výčet ID nadřazeného potvrzení pro toto potvrzení.
push	GitPushRef	Nabízené oznámení přidružené k tomuto potvrzení.
remoteUrl	string	Vzdálená cesta URL k potvrzení.
statuses	GitStatus[]	Seznam metadat stavu ze služeb a rozšíření, která můžou k potvrzení přidružit další informace.
url	string	Adresa URL REST pro tento prostředek.
workItems	ResourceRef[]	Seznam pracovních položek přidružených k tomuto potvrzení.

GitForkRef

Informace o referenčním odkazu forku

Name	Typ	Description
_links	ReferenceLinks	Třída představující kolekci odkazů REST.
creator	IdentityRef
isLocked	boolean
isLockedBy	IdentityRef
name	string
objectId	string
peeledObjectId	string
repository	GitRepository	ID úložiště forku.
statuses	GitStatus[]	Tato třída obsahuje metadata služby nebo rozšíření, které publikuje stav.
url	string

GitPullRequest

Představuje všechna data přidružená k žádosti o přijetí změn.

Name	Typ	Description
_links	ReferenceLinks	Odkazy na další související objekty.
artifactId	string	Řetězec, který jednoznačně identifikuje tuto žádost o přijetí změn. K vygenerování ID artefaktu pro žádost o přijetí změn použijte tuto šablonu: vstfs:///Git/PullRequestId/{projectId}/{repositoryId}/{pullRequestId}
autoCompleteSetBy	IdentityRef	Pokud je tato možnost nastavená, je pro tuto žádost o přijetí změn povolené automatické dokončování a tato identita ji povolila.
closedBy	IdentityRef	Uživatel, který zavřel žádost o přijetí změn.
closedDate	string	Datum, kdy byla žádost o přijetí změn uzavřena (dokončena, opuštěna nebo sloučena externě).
codeReviewId	integer	ID kontroly kódu žádosti o přijetí změn Používá se interně.
commits	GitCommitRef[]	Potvrzení obsažená v žádosti o přijetí změn
completionOptions	GitPullRequestCompletionOptions	Možnosti, které ovlivňují způsob sloučení žádosti o přijetí změn po dokončení.
completionQueueTime	string	Poslední datum, ke kterému žádost o přijetí změn vstoupila do fronty, která se má dokončit. Používá se interně.
createdBy	IdentityRef	Identita uživatele, který vytvořil žádost o přijetí změn.
creationDate	string	Datum vytvoření žádosti o přijetí změn.
description	string	Popis žádosti o přijetí změn
forkSource	GitForkRef	Pokud se jedná o žádost o přijetí změn z forku, bude obsahovat informace o jeho zdroji.
isDraft	boolean	Koncept nebo žádost o přijetí změn WIP
labels	WebApiTagDefinition[]	Popisky přidružené k žádosti o přijetí změn.
lastMergeCommit	GitCommitRef	Potvrzení posledního sloučení žádosti o přijetí změn Pokud je prázdné, probíhá poslední sloučení nebo bylo neúspěšné.
lastMergeSourceCommit	GitCommitRef	Potvrzení v záhlaví zdrojové větve v době posledního sloučení žádosti o přijetí změn
lastMergeTargetCommit	GitCommitRef	Potvrzení v čele cílové větve v době posledního sloučení žádosti o přijetí změn.
mergeFailureMessage	string	Pokud je tato možnost nastavená, sloučení žádosti o přijetí změn se z tohoto důvodu nezdařilo.
mergeFailureType	PullRequestMergeFailureType	Typ selhání (pokud existuje) sloučení žádosti o přijetí změn.
mergeId	string	ID úlohy použité ke spuštění sloučení žádosti o přijetí změn. Používá se interně.
mergeOptions	GitPullRequestMergeOptions	Možnosti použité při spuštění sloučení žádosti o přijetí změn Tyto možnosti jsou oddělené od možností dokončení, protože k dokončení dochází pouze jednou a nové sloučení se spustí pokaždé, když se změní zdrojová větev žádosti o přijetí změn.
mergeStatus	PullRequestAsyncStatus	Aktuální stav sloučení žádosti o přijetí změn
pullRequestId	integer	ID žádosti o přijetí změn.
remoteUrl	string	Používá se interně.
repository	GitRepository	Úložiště obsahující cílovou větev žádosti o přijetí změn
reviewers	IdentityRefWithVote[]	Seznam kontrolorů žádosti o přijetí změn spolu se stavem jejich hlasů.
sourceRefName	string	Název zdrojové větve žádosti o přijetí změn.
status	PullRequestStatus	Stav žádosti o přijetí změn
supportsIterations	boolean	Pokud ano, tato žádost o přijetí změn podporuje více iterací. Podpora iterace znamená, že jednotlivá oznámení do zdrojové větve žádosti o přijetí změn je možné zkontrolovat a komentáře, které zůstaly v jedné iteraci, budou sledovány v budoucích iteracích.
targetRefName	string	Název cílové větve žádosti o přijetí změn.
title	string	Název žádosti o přijetí změn
url	string	Používá se interně.
workItemRefs	ResourceRef[]	Všechny odkazy na pracovní položky přidružené k této žádosti o přijetí změn

GitPullRequestCompletionOptions

Předvolby způsobu dokončení žádosti o přijetí změn

Name	Typ	Description
bypassPolicy	boolean	Pokud ano, zásady se při dokončení žádosti o přijetí změn explicitně vynechají.
bypassReason	string	Pokud jsou zásady vynechány, uloží se tento důvod jako důvod použití bypassu.
deleteSourceBranch	boolean	Pokud ano, zdrojová větev žádosti o přijetí změn se po dokončení odstraní.
mergeCommitMessage	string	Pokud je tato možnost nastavená, použije se jako zpráva o potvrzení sloučení.
squashMerge	boolean	Pokud ano, potvrzení v žádosti o přijetí změn se po dokončení sloučí do zadané cílové větve.
transitionWorkItems	boolean	Pokud ano, pokusíme se převést všechny pracovní položky propojené s žádostí o přijetí změn do dalšího logického stavu (tj. Aktivní –> Vyřešeno).
triggeredByAutoComplete	boolean	Pokud ano, aktuální pokus o dokončení se aktivoval prostřednictvím automatického dokončování. Používá se interně.

GitPullRequestMergeOptions

Možnosti, které se použijí při vytvoření žádosti o přijetí změn.

Name	Typ	Description
detectRenameFalsePositives	boolean
disableRenames	boolean	Pokud je hodnota true, nebude během sloučení provedeno zjišťování přejmenování.

GitPushRef

Name	Typ	Description
_links	ReferenceLinks	Třída představující kolekci odkazů REST.
date	string
pushId	integer
pushedBy	IdentityRef
url	string

GitRepository

Name	Typ	Description
_links	ReferenceLinks	Třída představující kolekci odkazů REST.
defaultBranch	string
id	string
isFork	boolean	Hodnota True, pokud se úložiště vytvořilo jako fork
name	string
parentRepository	GitRepositoryRef
project	TeamProjectReference	Představuje mělký odkaz na TeamProject.
remoteUrl	string
size	integer	Komprimovaná velikost (bajty) úložiště.
sshUrl	string
url	string
validRemoteUrls	string[]

GitRepositoryRef

Name	Typ	Description
collection	TeamProjectCollectionReference	Kolekce týmových projektů, kde se nachází tento fork
id	string
isFork	boolean	Hodnota True, pokud se úložiště vytvořilo jako fork
name	string
project	TeamProjectReference	Představuje mělký odkaz na TeamProject.
remoteUrl	string
sshUrl	string
url	string

GitStatus

Tato třída obsahuje metadata služby nebo rozšíření, které zveřejňuje stav.

Name	Typ	Description
_links	ReferenceLinks	Odkazy.
context	GitStatusContext	Kontext stavu
createdBy	IdentityRef	Identita, která vytvořila stav.
creationDate	string	Datum a čas vytvoření stavu.
description	string	Popis stavu. Obvykle popisuje aktuální stav stavu.
id	integer	Identifikátor stavu.
state	GitStatusState	Stav stavu.
targetUrl	string	Adresa URL s podrobnostmi o stavu
updatedDate	string	Datum a čas poslední aktualizace stavu.

GitStatusContext

Kontext stavu, který jednoznačně identifikuje stav.

Name	Typ	Description
genre	string	Žánr stavu. Název služby nebo nástroje, který generuje stav, může být obvykle prázdný.
name	string	Identifikátor názvu stavu nesmí být null ani prázdný.

GitStatusState

Stav stavu.

Name	Typ	Description
error	string	Stav s chybou
failed	string	Stav se nezdařil.
notApplicable	string	Stav se nevztahuje na cílový objekt.
notSet	string	Stav není nastavený. Výchozí stav.
pending	string	Stav čeká na vyřízení.
succeeded	string	Stav byl úspěšný.

GitTemplate

Name	Typ	Description
name	string	Název šablony
type	string	Typ šablony

GitUserDate

Informace o uživateli a datum operací Gitu

Name	Typ	Description
date	string	Datum operace Git.
email	string	Email adresu uživatele, který provádí operaci Gitu.
imageUrl	string	Adresa URL avatara uživatele
name	string	Jméno uživatele, který provádí operaci Git.

IdentityRef

Name	Typ	Description
_links	ReferenceLinks	Toto pole obsahuje nula nebo více zajímavých odkazů o předmětu grafu. Tyto odkazy mohou být vyvolány za účelem získání dalších relací nebo podrobnějších informací o tomto předmětu grafu.
descriptor	string	Popisovač je primárním způsobem, jak odkazovat na předmět grafu, když je systém spuštěný. Toto pole jednoznačně identifikuje stejný předmět grafu napříč účty i organizacemi.
directoryAlias	string
displayName	string	Toto je jedinečný zobrazovaný název předmětu grafu. Pokud chcete toto pole změnit, musíte změnit jeho hodnotu ve zdrojovém poskytovateli.
id	string
imageUrl	string
inactive	boolean
isAadIdentity	boolean
isContainer	boolean
isDeletedInOrigin	boolean
profileUrl	string
uniqueName	string
url	string	Tato adresa URL je úplná trasa ke zdrojovému prostředku tohoto předmětu grafu.

IdentityRefWithVote

Informace o identitě včetně hlasování o žádosti o přijetí změn

Name	Typ	Description
_links	ReferenceLinks	Toto pole neobsahuje žádný nebo více zajímavých odkazů na téma grafu. Tyto odkazy mohou být vyvolány za účelem získání dalších relací nebo podrobnějších informací o tomto předmětu grafu.
descriptor	string	Popisovač je primárním způsobem, jak odkazovat na předmět grafu, když je systém spuštěný. Toto pole jednoznačně identifikuje stejný předmět grafu v rámci účtů i organizací.
directoryAlias	string
displayName	string	Toto je jedinečný zobrazovaný název předmětu grafu. Pokud chcete toto pole změnit, musíte změnit jeho hodnotu ve zdrojovém poskytovateli.
id	string
imageUrl	string
inactive	boolean
isAadIdentity	boolean
isContainer	boolean
isDeletedInOrigin	boolean
isRequired	boolean	Určuje, jestli se jedná o požadovaného revidujícího pro tuto žádost o přijetí změn. Větve můžou mít zásady, které vyžadují, aby pro žádosti o přijetí změn museli být konkrétní revidující.
profileUrl	string
reviewerUrl	string	Adresa URL pro načtení informací o této identitě
uniqueName	string
url	string	Tato adresa URL představuje úplnou trasu ke zdrojovému prostředku tohoto předmětu grafu.
vote	integer	Hlasování o žádosti o přijetí změn: 10 - schváleno 5 - schváleno s návrhy 0 - žádné hlasování -5 - čekání na autora -10 - zamítnuto
votedFor	IdentityRefWithVote[]	Skupiny nebo týmy, do které tento revidující přispěl. Skupiny a týmy můžou revidovat žádosti o přijetí změn, ale nemůžou hlasovat přímo. Když člen skupiny nebo týmu hlasuje, je tento hlas zahrnut do hlasování skupiny nebo týmu. VotedFor je seznam takových hlasů.

ItemContent

Name	Typ	Description
content	string
contentType	ItemContentType

ItemContentType

Name	Typ	Description
base64Encoded	string
rawText	string

ProjectState

Stav projektu.

Name	Typ	Description
all	string	Všechny projekty bez ohledu na stav.
createPending	string	Projekt byl zařazen do fronty k vytvoření, ale tento proces ještě nebyl zahájen.
deleted	string	Projekt byl odstraněn.
deleting	string	Projekt se právě odstraňuje.
new	string	Projekt se právě vytváří.
unchanged	string	Projekt nebyl změněn.
wellFormed	string	Projekt je zcela vytvořený a připravený k použití.

ProjectVisibility

Viditelnost projektu.

Name	Typ	Description
private	string	Projekt je viditelný pouze uživatelům s explicitním přístupem.
public	string	Projekt je viditelný pro všechny.

PullRequestAsyncStatus

Aktuální stav sloučení žádosti o přijetí změn

Name	Typ	Description
conflicts	string	Sloučení žádostí o přijetí změn se nezdařilo kvůli konfliktům.
failure	string	Sloučení žádostí o přijetí změn se nezdařilo.
notSet	string	Stav není nastavený. Výchozí stav.
queued	string	Sloučení žádostí o přijetí změn je zařazeno do fronty.
rejectedByPolicy	string	Sloučení žádostí o přijetí změn zamítnuté zásadami
succeeded	string	Sloučení žádostí o přijetí změn bylo úspěšné.

PullRequestMergeFailureType

Typ selhání (pokud existuje) sloučení žádosti o přijetí změn.

Name	Typ	Description
caseSensitive	string	Sloučení žádostí o přijetí změn se nezdařilo kvůli neshodě velkých a malých písmen.
none	string	Typ není nastavený. Výchozí typ.
objectTooLarge	string	Sloučení žádosti o přijetí změn se nezdařilo kvůli příliš velkému objektu.
unknown	string	Typ chyby sloučení žádosti o přijetí změn je neznámý.

PullRequestStatus

Stav žádosti o přijetí změn

Name	Typ	Description
abandoned	string	Žádost o přijetí změn se zrušila.
active	string	Žádost o přijetí změn je aktivní.
all	string	Používá se v kritériích hledání žádostí o přijetí změn k zahrnutí všech stavů.
completed	string	Žádost o přijetí změn se dokončí.
notSet	string	Stav není nastavený. Výchozí stav.

ReferenceLinks

Třída představující kolekci odkazů REST.

Name	Typ	Description
links	object	Zobrazení odkazů jen pro čtení. Vzhledem k tomu, že odkazy jsou jen pro čtení, chceme je zveřejnit jenom jako jen pro čtení.

ResourceRef

Name	Typ	Description
id	string
url	string

TeamProjectCollectionReference

Referenční objekt pro TeamProjectCollection.

Name	Typ	Description
id	string	ID kolekce.
name	string	Název kolekce.
url	string	Adresa URL REST kolekce.

TeamProjectReference

Představuje mělký odkaz na TeamProject.

Name	Typ	Description
abbreviation	string	Zkratka projektu
defaultTeamImageUrl	string	Adresa URL výchozího obrázku týmové identity
description	string	Popis projektu (pokud existuje).
id	string	Identifikátor projektu.
name	string	Název projektu.
revision	integer	Revize projektu.
state	ProjectState	Stav projektu.
url	string	Adresa URL na plnou verzi objektu.
visibility	ProjectVisibility	Viditelnost projektu.

VersionControlChangeType

Typ změny provedené u položky

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

WebApiTagDefinition

Reprezentace definice značky, která se odesílá přes drát.

Name	Typ	Description
active	boolean	Určuje, jestli je definice značky aktivní.
id	string	ID definice značky.
name	string	Název definice značky.
url	string	Adresa URL prostředku pro definici značky