Pull Requests - Update

Service:

Git

API Version:

7.1-preview.1

更新提取要求

這些是可使用 API 更新的屬性：

• 狀態
• 標題
• 描述 (最多 4000 個字元)
• CompletionOptions
• MergeOptions
• AutoCompleteSetBy.Id
• 啟用PR重新目標功能時 (TargetRefName) 嘗試更新此清單以外的其他屬性會導致伺服器擲 InvalidArgumentValueException回 ，或以無訊息方式忽略更新。

PATCH https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullrequests/{pullRequestId}?api-version=7.1-preview.1

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 版本。 這應該設定為 『7.1-preview.1』 以使用此版本的 API。

要求本文

名稱	類型	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，這將會包含其來源的相關信息。
hasMultipleMergeBases	boolean	多個合併基底警告
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[]	與此提取要求相關聯的任何工作項目參考。

回應

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

安全性

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

名稱	Description
vso.code_write	授與讀取、更新和刪除原始程式碼、存取認可、變更集、分支和其他版本控制成品的相關元數據。 也授與建立和管理提取要求和程式代碼檢閱的能力，以及透過服務勾點接收版本控制事件的通知。

定義

名稱	Description
ChangeCountDictionary
GitChange
GitCommitRef	提供描述 Git 認可和相關聯元數據的屬性。
GitForkRef	分支參考的相關信息。
GitPullRequest	表示與提取要求相關聯的所有數據。
GitPullRequestCompletionOptions	提取要求完成方式的喜好設定。
GitPullRequestMergeOptions	建立提取要求合併時所使用的選項。
GitPullRequestMergeStrategy	指定在完成期間用來合併提取要求的策略。 如果 MergeStrategy 未設定為任何值，則會在 SquashMerge == false 時建立 no-FF 合併。 如果 MergeStrategy 未設定為任何值，則如果 SquashMerge == true，提取要求認可將會遭到壓縮。 SquashMerge 屬性已被取代。 建議您在所有情況下明確設定 MergeStrategy。 如果為 MergeStrategy 提供明確的值，則會忽略 SquashMerge 屬性。
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

GitChange

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

GitCommitRef

提供描述 Git 認可和相關聯元數據的屬性。

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

GitForkRef

分支參考的相關信息。

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

GitPullRequest

表示與提取要求相關聯的所有數據。

名稱	類型	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，則會包含其來源的相關信息。
hasMultipleMergeBases	boolean	多個合併基底警告
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

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

名稱	類型	Description
autoCompleteIgnoreConfigIds	integer[]	自動完成的任何原則設定標識符清單不應等候。 僅適用於 isBlocking == false) (選擇性原則。 (isBlocking == true) ，自動完成一律會等候必要的原則。
bypassPolicy	boolean	如果為 true，則會在提取要求完成時明確略過原則。
bypassReason	string	如果略過原則，則會將這個原因儲存為使用略過的原因。
deleteSourceBranch	boolean	如果為 true，則提取要求的來源分支會在完成之後刪除。
mergeCommitMessage	string	如果已設定，則會將這當做合併認可的認可訊息使用。
mergeStrategy	GitPullRequestMergeStrategy	指定在完成期間用來合併提取要求的策略。 如果 MergeStrategy 未設定為任何值，則會在 SquashMerge == false 時建立 no-FF 合併。 如果 MergeStrategy 未設定為任何值，則如果 SquashMerge == true，提取要求認可將會遭到壓縮。 SquashMerge 屬性已被取代。 建議您在所有情況下明確設定 MergeStrategy。 如果為 MergeStrategy 提供明確的值，則會忽略 SquashMerge 屬性。
squashMerge	boolean	SquashMerge 已被取代。 您應該明確設定 MergeStrategy 的值。 如果 MergeStrategy 設定為任何值，則會忽略 SquashMerge 值。 如果未設定 MergeStrategy，則如果此旗標為 false，合併策略將不會向前快轉，如果為 true，則為 squash。
transitionWorkItems	boolean	如果為 true，我們會嘗試將連結至提取要求的任何工作專案轉換為下一個邏輯狀態 (，也就是作用中 -> 已解決)
triggeredByAutoComplete	boolean	如果為 true，則會透過自動完成觸發目前的完成嘗試。 內部使用。

GitPullRequestMergeOptions

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

名稱	類型	Description
conflictAuthorshipCommits	boolean	如果為 true，合併期間所套用的衝突解決將會放在個別的認可中，以保留 git 的作者資訊等等。
detectRenameFalsePositives	boolean
disableRenames	boolean	如果為 true，則不會在合併期間執行重新命名偵測。

GitPullRequestMergeStrategy

指定在完成期間用來合併提取要求的策略。 如果 MergeStrategy 未設定為任何值，則會在 SquashMerge == false 時建立 no-FF 合併。 如果 MergeStrategy 未設定為任何值，則如果 SquashMerge == true，提取要求認可將會遭到壓縮。 SquashMerge 屬性已被取代。 建議您在所有情況下明確設定 MergeStrategy。 如果為 MergeStrategy 提供明確的值，則會忽略 SquashMerge 屬性。

名稱	類型	Description
noFastForward	string	雙父系無快速向前合併。 來源分支不會變更。 這是預設行為。
rebase	string	將來源分支重設為目標分支 HEAD 認可之上，並快速轉送目標分支。 來源分支會在重新基底作業期間更新。
rebaseMerge	string	將來源分支重新置入目標分支 HEAD 認可之上，並建立兩個父代、無快速向前合併。 來源分支會在重新基底作業期間更新。
squash	string	將提取要求的所有變更放入單一父系認可。

GitPushRef

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

GitRepository

名稱	類型	Description
_links	ReferenceLinks	表示 REST 參考連結集合的類別。
defaultBranch	string
id	string
isDisabled	boolean	如果停用存放庫，則為 True。 否則為 false。
isFork	boolean	True 是表示 如果儲存機制已建立為分叉。
isInMaintenance	boolean	如果存放庫處於維護中，則為 True。 否則為 false。
name	string
parentRepository	GitRepositoryRef
project	TeamProjectReference	表示 TeamProject 的淺層參考。
remoteUrl	string
size	integer	存放庫的壓縮大小 (位元組) 。
sshUrl	string
url	string
validRemoteUrls	string[]
webUrl	string

GitRepositoryRef

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

GitStatus

這個類別包含張貼狀態之服務/延伸模組的元數據。

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

GitStatusContext

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

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

GitStatusState

狀態的狀態。

名稱	類型	Description
error	string	發生錯誤的狀態。
failed	string	狀態失敗。
notApplicable	string	狀態不適用於目標物件。
notSet	string	未設定狀態。 默認狀態。
pending	string	狀態暫止。
succeeded	string	狀態成功。

GitTemplate

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

GitUserDate

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

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

IdentityRef

名稱	類型	Description
_links	ReferenceLinks	此欄位包含有關圖表主旨的零個或多個有趣連結。 您可以叫用這些連結來取得其他關聯性，或取得此圖表主體的詳細資訊。
descriptor	string	描述項是在系統執行時參考圖形主旨的主要方式。 此欄位可唯一識別帳戶和組織之間的相同圖表主旨。
directoryAlias	string	已淘汰 - 藉由查詢 IdentityRef “_links” 字典之 “self” 項目中參考的 Graph 使用者，即可擷取
displayName	string	這是圖表主旨的非唯一顯示名稱。 若要變更此欄位，您必須在來源提供者中變更其值。
id	string
imageUrl	string	已淘汰 - 可在 IdentityRef “_links” 字典的 “avatar” 專案中使用
inactive	boolean	已淘汰 - 您可以查詢 GraphUser “_links” 字典的 “membershipState” 專案中參考的 Graph 成員資格狀態來擷取
isAadIdentity	boolean	已被取代 - 可以從描述元的主旨類型推斷 (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	已被取代 - 可以從描述元的主旨類型推斷 (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	已淘汰 - 不在 ToIdentityRef 的大多數既有實作中使用
uniqueName	string	已淘汰 - 請改用 Domain+PrincipalName
url	string	此 URL 是此圖表主體來源資源的完整路由。

IdentityRefWithVote

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

名稱	類型	Description
_links	ReferenceLinks	此欄位包含有關圖表主旨的零個或多個有趣連結。 您可以叫用這些連結來取得其他關聯性，或取得此圖表主體的詳細資訊。
descriptor	string	描述項是在系統執行時參考圖形主旨的主要方式。 此欄位可唯一識別帳戶和組織之間的相同圖表主旨。
directoryAlias	string	已淘汰 - 藉由查詢 IdentityRef “_links” 字典之 “self” 項目中參考的 Graph 使用者，即可擷取
displayName	string	這是圖表主旨的非唯一顯示名稱。 若要變更此欄位，您必須在來源提供者中變更其值。
hasDeclined	boolean	指出此檢閱者是否已拒絕檢閱此提取要求。
id	string
imageUrl	string	已淘汰 - 可在 IdentityRef “_links” 字典的 “avatar” 專案中使用
inactive	boolean	已淘汰 - 您可以查詢 GraphUser “_links” 字典的 “membershipState” 專案中參考的 Graph 成員資格狀態來擷取
isAadIdentity	boolean	已被取代 - 可以從描述元的主旨類型推斷 (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	已被取代 - 可以從描述元的主旨類型推斷 (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
isFlagged	boolean	指出此檢閱者是否標示為注意此提取要求。
isReapprove	boolean	指出即使投票未變更，還是應該處理此核准投票。
isRequired	boolean	指出這是此提取要求的必要檢閱者。 分支可以有要求提取要求需要特定檢閱者的原則。
profileUrl	string	已淘汰 - 不在 ToIdentityRef 的大多數既有實作中使用
reviewerUrl	string	擷取此身分識別相關信息的URL
uniqueName	string	已淘汰 - 請改用 Domain+PrincipalName
url	string	此 URL 是此圖表主體來源資源的完整路由。
vote	integer	投票提取要求： 10 - 已核准 5 - 已核准建議 0 - 無投票 -5 - 等候作者 -10 - 已拒絕
votedFor	IdentityRefWithVote[]	此檢閱者參與的群組或小組。 群組和小組可以是提取要求的檢閱者，但無法直接投票。 當群組或小組的成員投票時，該投票會匯總到群組或小組投票中。 VotedFor 是這類投票的清單。

ItemContent

名稱	類型	Description
content	string
contentType	ItemContentType

ItemContentType

名稱	類型	Description
base64Encoded	string
rawText	string

ProjectState

項目狀態。

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

ProjectVisibility

項目可見度。

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

PullRequestAsyncStatus

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

名稱	類型	Description
conflicts	string	提取要求合併失敗，因為發生衝突。
failure	string	提取要求合併失敗。
notSet	string	未設定狀態。 默認狀態。
queued	string	提取要求合併已排入佇列。
rejectedByPolicy	string	原則拒絕提取要求合併。
succeeded	string	提取要求合併成功。

PullRequestMergeFailureType

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

名稱	類型	Description
caseSensitive	string	提取要求合併失敗，因為大小寫不符。
none	string	未設定類型。 默認類型。
objectTooLarge	string	提取要求合併失敗，因為物件太大。
unknown	string	提取要求合併失敗類型未知。

PullRequestStatus

提取要求的狀態。

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

ReferenceLinks

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

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

ResourceRef

名稱	類型	Description
id	string
url	string

TeamProjectCollectionReference

TeamProjectCollection 的參考物件。

名稱	類型	Description
avatarUrl	string	集合虛擬人偶 URL。
id	string	集合標識碼。
name	string	集合名稱。
url	string	集合 REST URL。

TeamProjectReference

表示 TeamProject 的淺層參考。

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

VersionControlChangeType

對專案所做的變更類型。

名稱	類型	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

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

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