GitPullRequest interface

套件:

azure-devops-extension-api

代表與提取請求相關聯的所有資料。

屬性

artifactId	唯一識別此提取請求的字串。 若要產生提取要求的成品識別碼，請使用此範本： vstfs:///Git/PullRequestId/{projectId}/{repositoryId}/{pullRequestId}
autoCompleteSetBy	如果設定，則會為此提取請求啟用自動完成，這是啟用它的身分識別。
closedBy	關閉提取要求的使用者。
closedDate	提取要求關閉的日期 （完成、放棄或外部合併）。
codeReviewId	提取要求的程式碼檢閱識別碼。 內部使用。
commits	提取請求中包含的認可。
completionOptions	影響提取要求完成時合併方式的選項。
completionQueueTime	提取要求進入佇列以完成的最近日期。 內部使用。
createdBy	建立提取要求之使用者身分識別。
creationDate	建立提取要求的日期。
description	提取要求的描述。
forkSource	如果這是來自分支的 PR，這將包含有關其來源的資訊。
hasMultipleMergeBases	多個合併基底警告
ignoreTargetRefAndChooseDynamically	此選擇性參數可讓用戶端對目標參考使用伺服器端動態選擇。由於預先存在的合約，使用者 必須 指定目標引用，但此選項將導致伺服器忽略它並從使用者的收藏夾（或預設分支）中動態選擇。
isDraft	草稿/WIP 提取請求。
labels	與提取要求相關聯的標籤。
lastMergeCommit	最近提取要求合併的認可。 如果為空，則最近的合併正在進行中或不成功。
lastMergeSourceCommit	在最後一次提取要求合併時，來源分支頭的認可。
lastMergeTargetCommit	上次提取要求合併時目標分支頭的認可。
mergeFailureMessage	如果設定，提取要求合併會因為這個原因而失敗。
mergeFailureType	提取要求合併的失敗類型 （如果有的話）。
mergeId	用來執行提取要求合併的作業識別碼。 內部使用。
mergeOptions	提取要求合併執行時使用的選項。 這些與完成選項是分開的，因為完成只會發生一次，而且每次提取要求的來源分支變更時，都會執行新的合併。
mergeStatus	提取要求合併的目前狀態。
pullRequestId	提取要求的識別碼。
remoteUrl	內部使用。
repository	包含提取要求目標分支的存放庫。
reviewers	提取請求上的檢閱者清單及其投票狀態。
sourceRefName	提取要求的來源分支名稱。
status	提取請求的狀態。
supportsIterations	如果為true，則此提取請求支援多次反覆專案。 反覆專案支援表示可以檢閱提取要求來源分支的個別推送，並將在未來的反覆專案中追蹤在一次反覆專案中留下的批注。
targetRefName	提取要求的目標分支名稱。
title	提取請求的標題。
url	內部使用。
workItemRefs	與此提取要求相關聯的任何工作專案參考。

屬性詳細資料

artifactId

唯一識別此提取請求的字串。 若要產生提取要求的成品識別碼，請使用此範本： vstfs:///Git/PullRequestId/{projectId}/{repositoryId}/{pullRequestId}

artifactId: string

屬性值

string

autoCompleteSetBy

如果設定，則會為此提取請求啟用自動完成，這是啟用它的身分識別。

autoCompleteSetBy: IdentityRef

屬性值

IdentityRef

closedBy

關閉提取要求的使用者。

closedBy: IdentityRef

屬性值

IdentityRef

closedDate

提取要求關閉的日期 （完成、放棄或外部合併）。

closedDate: Date

屬性值

Date

codeReviewId

提取要求的程式碼檢閱識別碼。 內部使用。

codeReviewId: number

屬性值

number

commits

提取請求中包含的認可。

commits: GitCommitRef[]

屬性值

GitCommitRef[]

completionOptions

影響提取要求完成時合併方式的選項。

completionOptions: GitPullRequestCompletionOptions

屬性值

GitPullRequestCompletionOptions

completionQueueTime

提取要求進入佇列以完成的最近日期。 內部使用。

completionQueueTime: Date

屬性值

Date

createdBy

建立提取要求之使用者身分識別。

createdBy: IdentityRef

屬性值

IdentityRef

creationDate

建立提取要求的日期。

creationDate: Date

屬性值

Date

description

提取要求的描述。

description: string

屬性值

string

forkSource

如果這是來自分支的 PR，這將包含有關其來源的資訊。

forkSource: GitForkRef

屬性值

GitForkRef

hasMultipleMergeBases

多個合併基底警告

hasMultipleMergeBases: boolean

屬性值

boolean

ignoreTargetRefAndChooseDynamically

此選擇性參數可讓用戶端對目標參考使用伺服器端動態選擇。由於預先存在的合約，使用者 必須 指定目標引用，但此選項將導致伺服器忽略它並從使用者的收藏夾（或預設分支）中動態選擇。

ignoreTargetRefAndChooseDynamically: boolean

屬性值

boolean

isDraft

草稿/WIP 提取請求。

isDraft: boolean

屬性值

boolean

labels

與提取要求相關聯的標籤。

labels: WebApiTagDefinition[]

屬性值

WebApiTagDefinition[]

lastMergeCommit

最近提取要求合併的認可。 如果為空，則最近的合併正在進行中或不成功。

lastMergeCommit: GitCommitRef

屬性值

GitCommitRef

lastMergeSourceCommit

在最後一次提取要求合併時，來源分支頭的認可。

lastMergeSourceCommit: GitCommitRef

屬性值

GitCommitRef

lastMergeTargetCommit

上次提取要求合併時目標分支頭的認可。

lastMergeTargetCommit: GitCommitRef

屬性值

GitCommitRef

mergeFailureMessage

如果設定，提取要求合併會因為這個原因而失敗。

mergeFailureMessage: string

屬性值

string

mergeFailureType

提取要求合併的失敗類型 （如果有的話）。

mergeFailureType: PullRequestMergeFailureType

屬性值

PullRequestMergeFailureType

mergeId

用來執行提取要求合併的作業識別碼。 內部使用。

mergeId: string

屬性值

string

mergeOptions

提取要求合併執行時使用的選項。 這些與完成選項是分開的，因為完成只會發生一次，而且每次提取要求的來源分支變更時，都會執行新的合併。

mergeOptions: GitPullRequestMergeOptions

屬性值

GitPullRequestMergeOptions

mergeStatus

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

mergeStatus: PullRequestAsyncStatus

屬性值

PullRequestAsyncStatus

pullRequestId

提取要求的識別碼。

pullRequestId: number

屬性值

number

remoteUrl

內部使用。

remoteUrl: string

屬性值

string

repository

包含提取要求目標分支的存放庫。

repository: GitRepository

屬性值

GitRepository

reviewers

提取請求上的檢閱者清單及其投票狀態。

reviewers: IdentityRefWithVote[]

屬性值

IdentityRefWithVote[]

sourceRefName

提取要求的來源分支名稱。

sourceRefName: string

屬性值

string

status

提取請求的狀態。

status: PullRequestStatus

屬性值

PullRequestStatus

supportsIterations

如果為true，則此提取請求支援多次反覆專案。 反覆專案支援表示可以檢閱提取要求來源分支的個別推送，並將在未來的反覆專案中追蹤在一次反覆專案中留下的批注。

supportsIterations: boolean

屬性值

boolean

targetRefName

提取要求的目標分支名稱。

targetRefName: string

屬性值

string

title

提取請求的標題。

title: string

屬性值

string

url

內部使用。

url: string

屬性值

string

workItemRefs

與此提取要求相關聯的任何工作專案參考。

workItemRefs: ResourceRef[]

屬性值

ResourceRef[]