Pull Requests - Get Pull Request

服務:

Git

API 版本:

5.0

擷取提取要求。

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

含選擇性參數:

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 參數

名稱	位於	必要	類型	Description
organization	path	True	string	Azure DevOps 組織的名稱。
pullRequestId	path	True	integer int32	要擷取之提取要求的識別碼。
repositoryId	path	True	string	提取要求目標分支的存放庫識別碼。
project	path		string	專案識別碼或專案名稱
api-version	query	True	string	要使用的 API 版本。 這應該設定為 '5.0' 以使用此版本的 API。
$skip	query		integer int32	未使用。
$top	query		integer int32	未使用。
includeCommits	query		boolean	如果為 true，則會以相關聯的認可傳回提取要求。
includeWorkItemRefs	query		boolean	如果為 true，則會傳回提取要求與相關聯的工作專案參考。
maxCommentLength	query		integer int32	未使用。

回應

名稱	類型	Description
200 OK	GitPullRequest	成功作業

安全性

oauth2

類型: oauth2
Flow: accessCode
授權 URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
權杖 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

範圍

名稱	Description
vso.code	授與讀取有關認可、變更集、分支和其他版本控制成品之原始程式碼和中繼資料的能力。 也授與搜尋程式碼的能力，並透過服務勾點取得版本控制事件的通知。

定義

名稱	Description
ChangeCountDictionary
GitChange
GitCommitRef	提供描述 Git 認可和相關聯中繼資料的屬性。
GitForkRef	分支參考的相關資訊。
GitPullRequest	表示與提取要求相關聯的所有資料。
GitPullRequestCompletionOptions	提取要求完成方式的喜好設定。
GitPullRequestMergeOptions	建立提取要求合併時所使用的選項。
GitPushRef
GitRepository
GitRepositoryRef
GitStatus	這個類別包含張貼狀態之服務/延伸模組的中繼資料。
GitStatusContext	可唯一識別狀態的狀態內容。
GitStatusState	狀態的狀態。
GitTemplate
GitUserDate	Git 作業的使用者資訊和日期。
IdentityRef
IdentityRefWithVote	身分識別資訊，包括提取要求的投票。
ItemContent
ItemContentType
ProjectState	專案狀態。
ProjectVisibility	專案可見度。
PullRequestAsyncStatus	提取要求合併的目前狀態。
PullRequestMergeFailureType	如果提取要求合併有任何) ，則 (失敗的類型。
PullRequestStatus	提取要求的狀態。
ReferenceLinks	表示 REST 參考連結集合的類別。
ResourceRef
TeamProjectCollectionReference	TeamProjectCollection 的參考物件。
TeamProjectReference	表示 TeamProject 的淺層參考。
VersionControlChangeType	對專案所做的變更類型。
WebApiTagDefinition	透過網路傳送的標記定義表示。

ChangeCountDictionary

Object

GitChange

Object

名稱	類型	Description
changeId	integer	變更群組內的變更識別碼。
changeType	VersionControlChangeType	對專案所做的變更類型。
item	string	目前版本。
newContent	ItemContent	變更之後的專案內容。
newContentTemplate	GitTemplate	推送新變更時要使用的新內容範本。
originalPath	string	與目前路徑不同的專案原始路徑。
sourceServerItem	string	伺服器上的專案路徑。
url	string	要擷取專案的 URL。

GitCommitRef

Object

提供描述 Git 認可和相關聯中繼資料的屬性。

名稱	類型	Description
_links	ReferenceLinks	相關 REST 參考連結的集合。
author	GitUserDate	認可作者。
changeCounts	ChangeCountDictionary	認可 (編輯、刪除等) 變更類型的計數。
changes	GitChange[]	認可中包含的變更列舉。
comment	string	認可批註或訊息。
commentTruncated	boolean	指出批註是否從完整的 Git 認可批註訊息截斷。
commitId	string	認可 (SHA-1) 識別碼。
committer	GitUserDate	認可者。
parents	string[]	這個認可之父認可識別碼的列舉。
push	GitPushRef	與此認可相關聯的推送。
remoteUrl	string	認可的遠端 URL 路徑。
statuses	GitStatus[]	來自服務和延伸模組的狀態中繼資料清單，可將其他資訊與認可產生關聯。
url	string	此資源的 REST URL。
workItems	ResourceRef[]	與此認可相關聯的工作專案清單。

GitForkRef

Object

分支參考的相關資訊。

名稱	類型	Description
_links	ReferenceLinks	表示 REST 參考連結集合的類別。
creator	IdentityRef
isLocked	boolean
isLockedBy	IdentityRef
name	string
objectId	string
peeledObjectId	string
repository	GitRepository	分叉的存放庫識別碼。
statuses	GitStatus[]	這個類別包含張貼狀態之服務/延伸模組的中繼資料。
url	string

GitPullRequest

Object

表示與提取要求相關聯的所有資料。

名稱	類型	Description
_links	ReferenceLinks	其他相關物件的連結。
artifactId	string	可唯一識別此提取要求的字串。 若要為提取要求產生成品識別碼，請使用此範本： vstfs:///Git/PullRequestId/{projectId}/{repositoryId}/{pullRequestId}
autoCompleteSetBy	IdentityRef	如果設定，就會為此提取要求啟用自動完成，而這是啟用它的身分識別。
closedBy	IdentityRef	關閉提取要求的使用者。
closedDate	string	提取要求關閉 (完成、放棄或合併) 的日期。
codeReviewId	integer	提取要求的程式碼檢閱識別碼。 內部使用。
commits	GitCommitRef[]	提取要求中包含的認可。
completionOptions	GitPullRequestCompletionOptions	影響提取要求在完成時合併方式的選項。
completionQueueTime	string	提取要求輸入要完成佇列的最新日期。 內部使用。
createdBy	IdentityRef	建立提取要求之使用者的身分識別。
creationDate	string	建立提取要求的日期。
description	string	提取要求的描述。
forkSource	GitForkRef	如果這是分支的 PR，則會包含其來源的相關資訊。
isDraft	boolean	草稿/WIP 提取要求。
labels	WebApiTagDefinition[]	與提取要求相關聯的標籤。
lastMergeCommit	GitCommitRef	最近提取要求合併的認可。 如果空白，則最近的合併正在進行中或失敗。
lastMergeSourceCommit	GitCommitRef	上次提取要求合併時，來源分支前端的認可。
lastMergeTargetCommit	GitCommitRef	上次提取要求合併時，目標分支前端的認可。
mergeFailureMessage	string	如果設定，提取要求合併會因為這個原因而失敗。
mergeFailureType	PullRequestMergeFailureType	如果提取要求合併有任何) ，則 (失敗的類型。
mergeId	string	用來執行提取要求合併之作業的識別碼。 內部使用。
mergeOptions	GitPullRequestMergeOptions	提取要求合併執行時所使用的選項。 這些與完成選項不同，因為完成隻會發生一次，而且每次提取要求的來源分支變更時，都會執行新的合併。
mergeStatus	PullRequestAsyncStatus	提取要求合併的目前狀態。
pullRequestId	integer	提取要求的識別碼。
remoteUrl	string	內部使用。
repository	GitRepository	包含提取要求之目標分支的存放庫。
reviewers	IdentityRefWithVote[]	提取要求上的檢閱者清單及其投票狀態。
sourceRefName	string	提取要求的來源分支名稱。
status	PullRequestStatus	提取要求的狀態。
supportsIterations	boolean	如果為 true，則此提取要求支援多個反復專案。 反復專案支援表示可以檢閱提取要求來源分支的個別推播，並在一個反復專案中留下的批註會跨未來的反復專案追蹤。
targetRefName	string	提取要求的目標分支名稱。
title	string	提取要求的標題。
url	string	內部使用。
workItemRefs	ResourceRef[]	與此提取要求相關聯的任何工作專案參考。

GitPullRequestCompletionOptions

Object

提取要求完成方式的喜好設定。

名稱	類型	Description
bypassPolicy	boolean	如果為 true，則會在提取要求完成時明確略過原則。
bypassReason	string	如果略過原則，則會將這個原因儲存為使用略過的原因。
deleteSourceBranch	boolean	如果為 true，則提取要求的來源分支會在完成之後刪除。
mergeCommitMessage	string	如果已設定，則會將這當做合併認可的認可訊息使用。
squashMerge	boolean	如果為 true，提取要求中的認可將會在完成時合併到指定的目標分支中。
transitionWorkItems	boolean	如果為 true，我們會嘗試將連結至提取要求的任何工作專案轉換為下一個邏輯狀態 (，也就是作用中 - > 已解決)
triggeredByAutoComplete	boolean	如果為 true，則會透過自動完成觸發目前的完成嘗試。 內部使用。

GitPullRequestMergeOptions

Object

建立提取要求合併時所使用的選項。

名稱	類型	Description
detectRenameFalsePositives	boolean
disableRenames	boolean	如果為 true，則不會在合併期間執行重新命名偵測。

GitPushRef

Object

名稱	類型	Description
_links	ReferenceLinks	表示 REST 參考連結集合的類別。
date	string
pushId	integer
pushedBy	IdentityRef
url	string

GitRepository

Object

名稱	類型	Description
_links	ReferenceLinks	表示 REST 參考連結集合的類別。
defaultBranch	string
id	string
isFork	boolean	True 是表示 如果存放庫已建立為分叉
name	string
parentRepository	GitRepositoryRef
project	TeamProjectReference	表示 TeamProject 的淺層參考。
remoteUrl	string
size	integer	存放庫的壓縮大小 (位元組) 。
sshUrl	string
url	string
validRemoteUrls	string[]

GitRepositoryRef

Object

名稱	類型	Description
collection	TeamProjectCollectionReference	此分支所在的 Team 專案集合
id	string
isFork	boolean	True 是表示 如果存放庫已建立為分叉
name	string
project	TeamProjectReference	表示 TeamProject 的淺層參考。
remoteUrl	string
sshUrl	string
url	string

GitStatus

Object

這個類別包含張貼狀態之服務/延伸模組的中繼資料。

名稱	類型	Description
_links	ReferenceLinks	參考連結。
context	GitStatusContext	狀態的內容。
createdBy	IdentityRef	建立狀態的身分識別。
creationDate	string	建立狀態的日期和時間。
description	string	狀態原因。 通常描述狀態的目前狀態。
id	integer	狀態識別碼。
state	GitStatusState	狀態的狀態。
targetUrl	string	具有狀態詳細資料的 URL。
updatedDate	string	狀態的上次更新日期和時間。

GitStatusContext

Object

可唯一識別狀態的狀態內容。

名稱	類型	Description
genre	string	狀態的內容類型。 通常產生狀態的服務/工具名稱可以是空的。
name	string	狀態的名稱識別碼不能是 Null 或空白。

GitStatusState

Enumeration

狀態的狀態。

值	Description
error	發生錯誤的狀態。
failed	狀態失敗。
notApplicable	狀態不適用於目標物件。
notSet	未設定狀態。 預設狀態。
pending	狀態暫止。
succeeded	狀態成功。

GitTemplate

Object

名稱	類型	Description
name	string	範本的名稱
type	string	範本的類型

GitUserDate

Object

Git 作業的使用者資訊和日期。

名稱	類型	Description
date	string	Git 作業的日期。
email	string	執行 Git 作業的使用者Email位址。
imageUrl	string	使用者的虛擬人偶 URL。
name	string	執行 Git 作業的使用者名稱。

IdentityRef

Object

名稱	類型	Description
_links	ReferenceLinks	此欄位包含有關圖表主旨的零個或多個有趣連結。 您可以叫用這些連結來取得其他關聯性，或取得此圖表主體的詳細資訊。
descriptor	string	描述項是在系統執行時參考圖形主旨的主要方式。 此欄位可唯一識別帳戶和組織之間的相同圖表主旨。
directoryAlias	string
displayName	string	這是圖表主旨的非唯一顯示名稱。 若要變更此欄位，您必須在來源提供者中變更其值。
id	string
imageUrl	string
inactive	boolean
isAadIdentity	boolean
isContainer	boolean
isDeletedInOrigin	boolean
profileUrl	string
uniqueName	string
url	string	此 URL 是此圖表主體來源資源的完整路由。

IdentityRefWithVote

Object

身分識別資訊，包括提取要求的投票。

名稱	類型	Description
_links	ReferenceLinks	此欄位包含圖表主旨的相關零或更多有趣連結。 您可以叫用這些連結來取得其他關聯性，或取得此圖表主體的詳細資訊。
descriptor	string	描述項是在系統執行時參考圖形主旨的主要方式。 此欄位可唯一識別帳戶和組織之間的相同圖表主旨。
directoryAlias	string
displayName	string	這是圖形主體的非唯一顯示名稱。 若要變更此欄位，您必須變更來源提供者中的值。
id	string
imageUrl	string
inactive	boolean
isAadIdentity	boolean
isContainer	boolean
isDeletedInOrigin	boolean
isRequired	boolean	指出這是這個提取要求的必要檢閱者。 分支可以有需要特定檢閱者的原則，才能提取要求。
profileUrl	string
reviewerUrl	string	擷取此身分識別相關資訊的 URL
uniqueName	string
url	string	此 URL 是此圖形主體來源資源的完整路由。
vote	integer	對提取要求投票： 10 - 核准 5 - 已核准建議 0 - 沒有投票 -5 - 等候作者 -10 - 拒絕
votedFor	IdentityRefWithVote[]	此檢閱者參與的群組或小組。 群組和小組可以是提取要求的檢閱者，但無法直接投票。 當群組或小組的成員投票時，該投票會匯總到群組或小組投票中。 VotedFor 是這類投票的清單。

ItemContent

Object

名稱	類型	Description
content	string
contentType	ItemContentType

ItemContentType

Enumeration

值	Description
base64Encoded
rawText

ProjectState

Enumeration

專案狀態。

值	Description
all	不論狀態為何，所有專案。
createPending	專案已排入佇列以建立，但程式尚未啟動。
deleted	專案已刪除。
deleting	Project 正在刪除。
new	Project 正在建立中。
unchanged	專案尚未變更。
wellFormed	Project 已完全建立並可供使用。

ProjectVisibility

Enumeration

專案可見度。

值	Description
private	只有具有明確存取權的使用者才能看到專案。
public	專案對全部可見。

PullRequestAsyncStatus

Enumeration

提取要求合併的目前狀態。

值	Description
conflicts	提取要求合併因為衝突而失敗。
failure	提取要求合併失敗。
notSet	未設定狀態。 預設狀態。
queued	提取要求合併已排入佇列。
rejectedByPolicy	原則拒絕提取要求合併。
succeeded	提取要求合併成功。

PullRequestMergeFailureType

Enumeration

如果提取要求合併有任何) ，則 (失敗的類型。

值	Description
caseSensitive	提取要求合併失敗，因為案例不符。
none	未設定類型。 預設類型。
objectTooLarge	提取要求合併失敗，因為物件太大。
unknown	提取要求合併失敗類型未知。

PullRequestStatus

Enumeration

提取要求的狀態。

值	Description
abandoned	提取要求已放棄。
active	提取要求為作用中。
all	用於提取要求搜尋準則，以包含所有狀態。
completed	提取要求已完成。
notSet	未設定狀態。 預設狀態。

ReferenceLinks

Object

表示 REST 參考連結集合的類別。

名稱	類型	Description
links	object	連結的唯讀檢視。 因為參考連結是唯讀的，所以我們只想要將它們公開為唯讀。

ResourceRef

Object

名稱	類型	Description
id	string
url	string

TeamProjectCollectionReference

Object

TeamProjectCollection 的參考物件。

名稱	類型	Description
id	string	集合識別碼。
name	string	集合名稱。
url	string	集合 REST URL。

TeamProjectReference

Object

表示 TeamProject 的淺層參考。

名稱	類型	Description
abbreviation	string	專案縮寫。
defaultTeamImageUrl	string	預設小組身分識別影像的 URL。
description	string	如果有任何) ，專案的描述 (。
id	string	專案識別碼。
name	string	專案名稱。
revision	integer	專案修訂。
state	ProjectState	專案狀態。
url	string	物件完整版本的 URL。
visibility	ProjectVisibility	專案可見度。

VersionControlChangeType

Enumeration

對專案所做的變更類型。

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

WebApiTagDefinition

Object

透過網路傳送的標記定義表示。

名稱	類型	Description
active	boolean	標籤定義是否為使用中。
id	string	標記定義的識別碼。
name	string	標籤定義的名稱。
url	string	標籤定義的資源 URL。