GitPullRequest interface

パッケージ:

azure-devops-extension-api

プル要求に関連付けられているすべてのデータを表します。

プロパティ

artifactId	このプル要求を一意に識別する文字列。 pull request の成果物 ID を生成するには、次のテンプレートを使用します。 vstfs:///Git/PullRequestId/{projectId}/{repositoryId}/{pullRequestId}
autoCompleteSetBy	設定すると、このプル要求に対してオートコンプリートが有効になり、これが有効になっている ID になります。
closedBy	プル要求を閉じたユーザー。
closedDate	pull request が閉じられた (完了、破棄、または外部でマージされた) 日付。
codeReviewId	プル要求のコード レビュー ID。 内部的に使用されます。
commits	プル要求に含まれるコミット。
completionOptions	完了時のプル要求のマージ方法に影響するオプション。
completionQueueTime	pull request が完了するキューに入った最新の日付。 内部的に使用されます。
createdBy	プル要求を作成したユーザーの ID。
creationDate	pull request が作成された日付。
description	プル要求の説明。
forkSource	これがフォークからの PR の場合、そのソースに関する情報が含まれます。
hasMultipleMergeBases	複数のマージベースの警告
ignoreTargetRefAndChooseDynamically	このオプションのパラメーターを使用すると、クライアントはターゲット参照にサーバー側の動的選択肢を使用できます。既存のコントラクトのため、ユーザーはターゲット参照を指定する 必要があります が、このオプションを使用すると、サーバーはそれを無視し、ユーザーのお気に入り (またはデフォルトのブランチ) から動的に選択します。
isDraft	下書き/WIP プル要求。
labels	プル要求に関連付けられているラベル。
lastMergeCommit	最新の pull request マージのコミット。 空の場合、最新のマージが進行中であるか、失敗しました。
lastMergeSourceCommit	最後の pull request マージ時のソース ブランチの先頭でのコミット。
lastMergeTargetCommit	最後の pull request マージ時のターゲット ブランチの先頭でのコミット。
mergeFailureMessage	設定した場合、この理由により pull request マージが失敗しました。
mergeFailureType	pull request マージの失敗の種類 (存在する場合)。
mergeId	pull request マージの実行に使用されるジョブの ID。 内部的に使用されます。
mergeOptions	プル要求のマージの実行時に使用されるオプション。 完了は 1 回だけ行われ、pull request のソース ブランチが変更されるたびに新しいマージが実行されるため、これらは完了オプションとは別です。
mergeStatus	pull request マージの現在の状態。
pullRequestId	プル要求の ID。
remoteUrl	内部的に使用されます。
repository	プル要求のターゲット ブランチを含むリポジトリ。
reviewers	投票の状態と共に、pull request のレビュー担当者の一覧。
sourceRefName	プル要求のソース ブランチの名前。
status	プル要求の状態。
supportsIterations	true の場合、この pull request は複数のイテレーションをサポートします。 イテレーションのサポートは、プル要求のソース ブランチへの個々のプッシュを確認できることを意味し、1 回のイテレーションで残されたコメントは、今後のイテレーションにわたって追跡されます。
targetRefName	プル要求のターゲット ブランチの名前。
title	プル要求のタイトル。
url	内部的に使用されます。
workItemRefs	このプル要求に関連付けられている作業項目参照。

プロパティの詳細

artifactId

このプル要求を一意に識別する文字列。 pull request の成果物 ID を生成するには、次のテンプレートを使用します。 vstfs:///Git/PullRequestId/{projectId}/{repositoryId}/{pullRequestId}

artifactId: string

プロパティ値

string

autoCompleteSetBy

設定すると、このプル要求に対してオートコンプリートが有効になり、これが有効になっている ID になります。

autoCompleteSetBy: IdentityRef

プロパティ値

IdentityRef

closedBy

プル要求を閉じたユーザー。

closedBy: IdentityRef

プロパティ値

IdentityRef

closedDate

pull request が閉じられた (完了、破棄、または外部でマージされた) 日付。

closedDate: Date

プロパティ値

Date

codeReviewId

プル要求のコード レビュー ID。 内部的に使用されます。

codeReviewId: number

プロパティ値

number

commits

プル要求に含まれるコミット。

commits: GitCommitRef[]

プロパティ値

GitCommitRef[]

completionOptions

完了時のプル要求のマージ方法に影響するオプション。

completionOptions: GitPullRequestCompletionOptions

プロパティ値

GitPullRequestCompletionOptions

completionQueueTime

pull request が完了するキューに入った最新の日付。 内部的に使用されます。

completionQueueTime: Date

プロパティ値

Date

createdBy

プル要求を作成したユーザーの ID。

createdBy: IdentityRef

プロパティ値

IdentityRef

creationDate

pull request が作成された日付。

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

最新の pull request マージのコミット。 空の場合、最新のマージが進行中であるか、失敗しました。

lastMergeCommit: GitCommitRef

プロパティ値

GitCommitRef

lastMergeSourceCommit

最後の pull request マージ時のソース ブランチの先頭でのコミット。

lastMergeSourceCommit: GitCommitRef

プロパティ値

GitCommitRef

lastMergeTargetCommit

最後の pull request マージ時のターゲット ブランチの先頭でのコミット。

lastMergeTargetCommit: GitCommitRef

プロパティ値

GitCommitRef

mergeFailureMessage

設定した場合、この理由により pull request マージが失敗しました。

mergeFailureMessage: string

プロパティ値

string

mergeFailureType

pull request マージの失敗の種類 (存在する場合)。

mergeFailureType: PullRequestMergeFailureType

プロパティ値

PullRequestMergeFailureType

mergeId

pull request マージの実行に使用されるジョブの ID。 内部的に使用されます。

mergeId: string

プロパティ値

string

mergeOptions

プル要求のマージの実行時に使用されるオプション。 完了は 1 回だけ行われ、pull request のソース ブランチが変更されるたびに新しいマージが実行されるため、これらは完了オプションとは別です。

mergeOptions: GitPullRequestMergeOptions

プロパティ値

GitPullRequestMergeOptions

mergeStatus

pull request マージの現在の状態。

mergeStatus: PullRequestAsyncStatus

プロパティ値

PullRequestAsyncStatus

pullRequestId

プル要求の ID。

pullRequestId: number

プロパティ値

number

remoteUrl

内部的に使用されます。

remoteUrl: string

プロパティ値

string

repository

プル要求のターゲット ブランチを含むリポジトリ。

repository: GitRepository

プロパティ値

GitRepository

reviewers

投票の状態と共に、pull request のレビュー担当者の一覧。

reviewers: IdentityRefWithVote[]

プロパティ値

IdentityRefWithVote[]

sourceRefName

プル要求のソース ブランチの名前。

sourceRefName: string

プロパティ値

string

status

プル要求の状態。

status: PullRequestStatus

プロパティ値

PullRequestStatus

supportsIterations

true の場合、この pull request は複数のイテレーションをサポートします。 イテレーションのサポートは、プル要求のソース ブランチへの個々のプッシュを確認できることを意味し、1 回のイテレーションで残されたコメントは、今後のイテレーションにわたって追跡されます。

supportsIterations: boolean

プロパティ値

boolean

targetRefName

プル要求のターゲット ブランチの名前。

targetRefName: string

プロパティ値

string

title

プル要求のタイトル。

title: string

プロパティ値

string

url

内部的に使用されます。

url: string

プロパティ値

string

workItemRefs

このプル要求に関連付けられている作業項目参照。

workItemRefs: ResourceRef[]

プロパティ値

ResourceRef[]