共用方式為

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

多個合併基底警告
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

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[]