Pull Requests - Get Pull Request

Service:

Git

API Version:

7.1-preview.1

pull request を取得します。

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

With optional parameters:

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=7.1-preview.1

URI パラメーター

名前	/	必須	型	説明
organization	path	True	string	Azure DevOps 組織の名前です。
pullRequestId	path	True	integer int32	取得する pull request の ID。
repositoryId	path	True	string	pull request のターゲット ブランチのリポジトリ ID。
project	path		string	プロジェクト ID またはプロジェクト名
api-version	query	True	string	使う API のバージョン。 このバージョンの API を使用するには、これを '7.1-preview.1' に設定する必要があります。
$skip	query		integer int32	使用しません。
$top	query		integer int32	使用しません。
includeCommits	query		boolean	true の場合、関連付けられたコミットと共に pull request が返されます。
includeWorkItemRefs	query		boolean	true の場合、関連付けられている作業項目参照と共に pull request が返されます。
maxCommentLength	query		integer int32	使用しません。

応答

名前	型	説明
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

名前	説明
vso.code	コミット、変更セット、ブランチ、およびその他のバージョン管理成果物に関するソース コードとメタデータを読み取る機能を付与します。 また、サービス フックを使用してコードを検索し、バージョン管理イベントに関する通知を受け取る機能も付与されます。

定義

名前	説明
ChangeCountDictionary
GitChange
GitCommitRef	Git コミットと関連するメタデータを記述するプロパティを提供します。
GitForkRef	フォーク参照に関する情報。
GitPullRequest	pull request に関連付けられているすべてのデータを表します。
GitPullRequestCompletionOptions	pull request の完了方法に関する基本設定。
GitPullRequestMergeOptions	pull request マージの作成時に使用されるオプション。
GitPullRequestMergeStrategy	完了時に pull request をマージするために使用する戦略を指定します。 MergeStrategy が値に設定されていない場合、SquashMerge == false の場合、FF なしのマージが作成されます。 MergeStrategy が値に設定されていない場合、SquashMerge == true の場合、pull request コミットはスカッシュされます。 SquashMerge プロパティは非推奨です。 すべてのケースで MergeStrategy を明示的に設定することをお勧めします。 MergeStrategy に明示的な値が指定されている場合、SquashMerge プロパティは無視されます。
GitPushRef
GitRepository
GitRepositoryRef
GitStatus	このクラスには、状態を投稿するサービス/拡張機能のメタデータが含まれます。
GitStatusContext	状態を一意に識別する状態コンテキスト。
GitStatusState	状態の状態。
GitTemplate
GitUserDate	Git 操作のユーザー情報と日付。
IdentityRef
IdentityRefWithVote	pull request に対する投票を含む ID 情報。
ItemContent
ItemContentType
ProjectState	プロジェクトの状態。
ProjectVisibility	プロジェクトの可視性。
PullRequestAsyncStatus	pull request マージの現在の状態。
PullRequestMergeFailureType	pull request マージの失敗の種類 (存在する場合)。
PullRequestStatus	pull request の状態。
ReferenceLinks	REST 参照リンクのコレクションを表す クラス。
ResourceRef
TeamProjectCollectionReference	TeamProjectCollection の参照オブジェクト。
TeamProjectReference	TeamProject への浅い参照を表します。
VersionControlChangeType	アイテムに対して行われた変更の種類。
WebApiTagDefinition	ワイヤを介して送信されるタグ定義の表現。

ChangeCountDictionary

GitChange

名前	型	説明
changeId	integer	変更のグループ内の変更の ID。
changeType	VersionControlChangeType	アイテムに対して行われた変更の種類。
item	string	現在のバージョン。
newContent	ItemContent	変更後のアイテムの内容。
newContentTemplate	GitTemplate	新しい変更をプッシュするときに使用する新しいコンテンツ テンプレート。
originalPath	string	現在のパスと異なる場合は、アイテムの元のパス。
sourceServerItem	string	サーバー上の項目のパス。
url	string	アイテムを取得する URL。

GitCommitRef

Git コミットと関連するメタデータを記述するプロパティを提供します。

名前	型	説明
_links	ReferenceLinks	関連する REST 参照リンクのコレクション。
author	GitUserDate	コミットの作成者。
changeCounts	ChangeCountDictionary	コミットに含まれる変更の種類 (編集、削除など) の数。
changes	GitChange[]	コミットに含まれる変更の列挙。
comment	string	コミットのコメントまたはメッセージ。
commentTruncated	boolean	完全な Git コミット コメント メッセージからコメントが切り捨てられているかどうかを示します。
commitId	string	コミットの ID (SHA-1)。
commitTooManyChanges	boolean	コミットに含まれる変更が多すぎて表示できないことを示します
committer	GitUserDate	コミットのコミッター。
parents	string[]	このコミットの親コミット ID の列挙。
push	GitPushRef	このコミットに関連付けられているプッシュ。
remoteUrl	string	コミットへのリモート URL パス。
statuses	GitStatus[]	コミットに追加情報を関連付ける可能性があるサービスと拡張機能からの状態メタデータの一覧。
url	string	このリソースの REST URL。
workItems	ResourceRef[]	このコミットに関連付けられている作業項目の一覧。

GitForkRef

フォーク参照に関する情報。

名前	型	説明
_links	ReferenceLinks	REST 参照リンクのコレクションを表す クラス。
creator	IdentityRef
isLocked	boolean
isLockedBy	IdentityRef
name	string
objectId	string
peeledObjectId	string
repository	GitRepository	フォークのリポジトリ ID。
statuses	GitStatus[]	このクラスには、状態を投稿するサービス/拡張機能のメタデータが含まれます。
url	string

GitPullRequest

pull request に関連付けられているすべてのデータを表します。

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

GitPullRequestCompletionOptions

pull request の完了方法に関する基本設定。

名前	型	説明
autoCompleteIgnoreConfigIds	integer[]	自動完了を待機しないポリシー構成 ID の一覧。 オプションのポリシーにのみ適用されます (isBlocking == false)。 オートコンプリートは常に必要なポリシーを待機します (isBlocking == true)。
bypassPolicy	boolean	true の場合、プル要求の完了時にポリシーが明示的にバイパスされます。
bypassReason	string	ポリシーがバイパスされた場合、この理由はバイパスが使用された理由として格納されます。
deleteSourceBranch	boolean	true の場合、pull request のソース ブランチは完了後に削除されます。
mergeCommitMessage	string	設定した場合、これはマージ コミットのコミット メッセージとして使用されます。
mergeStrategy	GitPullRequestMergeStrategy	完了時に pull request をマージするために使用する戦略を指定します。 MergeStrategy が値に設定されていない場合、SquashMerge == false の場合、FF なしのマージが作成されます。 MergeStrategy が値に設定されていない場合、SquashMerge == true の場合、pull request コミットはスカッシュされます。 SquashMerge プロパティは非推奨です。 すべてのケースで MergeStrategy を明示的に設定することをお勧めします。 MergeStrategy に明示的な値が指定されている場合、SquashMerge プロパティは無視されます。
squashMerge	boolean	スカッシュMerge は非推奨です。 MergeStrategy の値を明示的に設定する必要があります。 MergeStrategy が任意の値に設定されている場合、スカッシュマージ値は無視されます。 MergeStrategy が設定されていない場合、このフラグが false の場合はマージ戦略はfast-forwardされず、true の場合はsquashされます。
transitionWorkItems	boolean	true の場合、pull request にリンクされている作業項目を次の論理状態 (つまりアクティブ -> 解決済み) に移行しようとします。
triggeredByAutoComplete	boolean	true の場合、現在の完了試行は自動完了によってトリガーされました。 内部使用。

GitPullRequestMergeOptions

pull request マージの作成時に使用されるオプション。

名前	型	説明
conflictAuthorshipCommits	boolean	true の場合、マージ中に適用された競合の解決は、git の責任などの作成者情報を保持するために、個別のコミットに配置されます。
detectRenameFalsePositives	boolean
disableRenames	boolean	true の場合、マージ中に名前変更の検出は実行されません。

GitPullRequestMergeStrategy

完了時に pull request をマージするために使用する戦略を指定します。 MergeStrategy が値に設定されていない場合、SquashMerge == false の場合、FF なしのマージが作成されます。 MergeStrategy が値に設定されていない場合、SquashMerge == true の場合、pull request コミットはスカッシュされます。 SquashMerge プロパティは非推奨です。 すべてのケースで MergeStrategy を明示的に設定することをお勧めします。 MergeStrategy に明示的な値が指定されている場合、SquashMerge プロパティは無視されます。

名前	型	説明
noFastForward	string	2 親のfast-forwardマージ。 ソース ブランチは変更されません。 これが既定の動作です。
rebase	string	ターゲット ブランチの上にソース ブランチをリベースHEADコミットし、ターゲット ブランチをfast-forwardします。 ソース ブランチは、リベース操作中に更新されます。
rebaseMerge	string	ターゲット ブランチHEADコミットの上にソース ブランチをリベースし、2 親のfast-forwardマージを作成します。 ソース ブランチは、リベース操作中に更新されます。
squash	string	pull request からのすべての変更を単一親コミットに配置します。

GitPushRef

名前	型	説明
_links	ReferenceLinks	REST 参照リンクのコレクションを表す クラス。
date	string
pushId	integer
pushedBy	IdentityRef
url	string

GitRepository

名前	型	説明
_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

名前	型	説明
collection	TeamProjectCollectionReference	このフォークが存在するチーム プロジェクト コレクション
id	string
isFork	boolean	リポジトリがフォークとして作成された場合は True
name	string
project	TeamProjectReference	TeamProject への浅い参照を表します。
remoteUrl	string
sshUrl	string
url	string

GitStatus

このクラスには、状態を投稿するサービス/拡張機能のメタデータが含まれます。

名前	型	説明
_links	ReferenceLinks	参照リンク。
context	GitStatusContext	状態のコンテキスト。
createdBy	IdentityRef	状態を作成した ID。
creationDate	string	状態の作成日時。
description	string	状態の説明。 通常、状態の現在の状態を記述します。
id	integer	状態識別子。
state	GitStatusState	状態の状態。
targetUrl	string	状態の詳細を含む URL。
updatedDate	string	状態の最終更新日時。

GitStatusContext

状態を一意に識別する状態コンテキスト。

名前	型	説明
genre	string	状態のジャンル。 通常、状態を生成するサービス/ツールの名前は空にすることができます。
name	string	状態の名前識別子。null または空にすることはできません。

GitStatusState

状態の状態。

名前	型	説明
error	string	エラーが発生した状態。
failed	string	状態が失敗しました。
notApplicable	string	状態はターゲット オブジェクトには適用されません。
notSet	string	状態が設定されていません。 既定の状態です。
pending	string	状態は保留中です。
succeeded	string	状態が成功しました。

GitTemplate

名前	型	説明
name	string	テンプレートの名前
type	string	テンプレートの種類

GitUserDate

Git 操作のユーザー情報と日付。

名前	型	説明
date	string	Git 操作の日付。
email	string	git 操作を実行しているユーザーのアドレスをEmailします。
imageUrl	string	ユーザーのアバターの URL。
name	string	Git 操作を実行しているユーザーの名前。

IdentityRef

名前	型	説明
_links	ReferenceLinks	このフィールドには、グラフの件名に関する 0 個以上の興味深いリンクが含まれています。 これらのリンクを呼び出して、このグラフの主題に関する追加のリレーションシップや詳細情報を取得できます。
descriptor	string	記述子は、システムの実行中にグラフの件名を参照する主な方法です。 このフィールドは、アカウントと組織の両方で同じグラフの件名を一意に識別します。
directoryAlias	string	非推奨 - IdentityRef "_links" ディクショナリの "self" エントリで参照されている Graph ユーザーにクエリを実行することで取得できます
displayName	string	これは、グラフの件名の一意でない表示名です。 このフィールドを変更するには、ソース プロバイダーでその値を変更する必要があります。
id	string
imageUrl	string	非推奨 - IdentityRef "_links" ディクショナリの "アバター" エントリで使用できます
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

pull request に対する投票を含む ID 情報。

名前	型	説明
_links	ReferenceLinks	このフィールドには、グラフの件名に関する 0 個以上の興味深いリンクが含まれています。 これらのリンクを呼び出して、このグラフの件名に関する追加のリレーションシップまたは詳細情報を取得できます。
descriptor	string	記述子は、システムの実行中にグラフの件名を参照する主な方法です。 このフィールドは、アカウントと組織の両方で同じグラフの件名を一意に識別します。
directoryAlias	string	非推奨 - IdentityRef "_links" ディクショナリの "self" エントリで参照されている Graph ユーザーに対してクエリを実行することで取得できます
displayName	string	これは、グラフの件名の一意でない表示名です。 このフィールドを変更するには、ソース プロバイダーでその値を変更する必要があります。
hasDeclined	boolean	このレビュー担当者がこの pull request のレビューを拒否したかどうかを示します。
id	string
imageUrl	string	非推奨 - IdentityRef "_links" 辞書の "アバター" エントリで使用できます
inactive	boolean	非推奨 - GraphUser "_links" ディクショナリの "membershipState" エントリで参照されている Graph メンバーシップの状態を照会することで取得できます
isAadIdentity	boolean	非推奨 - 記述子のサブジェクト型 (Descriptor.IsAadUserType/Descriptor.IsAadGroupType) から推論できます
isContainer	boolean	非推奨 - 記述子のサブジェクト型 (Descriptor.IsGroupType) から推論できます
isDeletedInOrigin	boolean
isFlagged	boolean	この校閲者に、この pull request に対する注意のフラグが設定されているかどうかを示します。
isReapprove	boolean	投票が変更されなかった場合でも、この承認投票を処理する必要があるかどうかを示します。
isRequired	boolean	これがこの pull request に必要なレビュー担当者であるかどうかを示します。 ブランチには、プル要求に特定のレビュー担当者が必要なポリシーを含めることができます。
profileUrl	string	非推奨 - ToIdentityRef の既存のほとんどの実装では使用されていません
reviewerUrl	string	この ID に関する情報を取得する URL
uniqueName	string	非推奨 - 代わりに Domain+PrincipalName を使用する
url	string	この URL は、このグラフの件名のソース リソースへの完全なルートです。
vote	integer	pull request に投票する: 10 - 承認 5 - 提案 0 で承認 - 投票なし -5 - 作成者 -10 を待機中 - 却下
votedFor	IdentityRefWithVote[]	このレビュー担当者が投稿したグループまたはチーム。 グループとチームは pull request のレビュー担当者にすることができますが、直接投票することはできません。 グループまたはチームのメンバーが投票すると、その投票はグループまたはチームの投票にロールアップされます。 VotedFor は、このような投票の一覧です。

ItemContent

名前	型	説明
content	string
contentType	ItemContentType

ItemContentType

名前	型	説明
base64Encoded	string
rawText	string

ProjectState

プロジェクトの状態。

名前	型	説明
all	string	[削除済み] を除く状態に関係なく、すべてのプロジェクト。
createPending	string	プロジェクトは作成のためにキューに登録されていますが、プロセスはまだ開始されていません。
deleted	string	プロジェクトが削除されました。
deleting	string	プロジェクトは削除中です。
new	string	プロジェクトは作成中です。
unchanged	string	プロジェクトは変更されていません。
wellFormed	string	プロジェクトは完全に作成され、使用できる状態になります。

ProjectVisibility

プロジェクトの可視性。

名前	型	説明
private	string	プロジェクトは、明示的なアクセス権を持つユーザーにのみ表示されます。
public	string	プロジェクトはすべてのユーザーに表示されます。

PullRequestAsyncStatus

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

名前	型	説明
conflicts	string	競合のため、プル要求のマージに失敗しました。
failure	string	プル要求のマージに失敗しました。
notSet	string	状態が設定されていません。 既定の状態です。
queued	string	pull request マージがキューに入れられます。
rejectedByPolicy	string	ポリシーによって拒否されたプル要求のマージ。
succeeded	string	Pull request のマージに成功しました。

PullRequestMergeFailureType

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

名前	型	説明
caseSensitive	string	大文字と小文字の不一致が原因で、Pull request のマージに失敗しました。
none	string	型が設定されていません。 既定の型。
objectTooLarge	string	オブジェクトが大きすぎるため、プル要求のマージに失敗しました。
unknown	string	Pull request マージ エラーの種類が不明です。

PullRequestStatus

pull request の状態。

名前	型	説明
abandoned	string	pull request は破棄されます。
active	string	Pull request がアクティブです。
all	string	pull request 検索条件で使用され、すべての状態が含まれます。
completed	string	pull request が完了しました。
notSet	string	状態が設定されていません。 既定の状態です。

ReferenceLinks

REST 参照リンクのコレクションを表す クラス。

名前	型	説明
links	object	リンクの読み取り時ビュー。 参照リンクは読み取り専用であるため、参照リンクは読み取り専用として公開する必要があります。

ResourceRef

名前	型	説明
id	string
url	string

TeamProjectCollectionReference

TeamProjectCollection の参照オブジェクト。

名前	型	説明
avatarUrl	string	コレクションアバターの URL。
id	string	コレクション ID。
name	string	コレクション名。
url	string	コレクション REST URL。

TeamProjectReference

TeamProject への浅い参照を表します。

名前	型	説明
abbreviation	string	プロジェクトの省略形。
defaultTeamImageUrl	string	既定のチーム ID イメージへの URL。
description	string	プロジェクトの説明 (存在する場合)。
id	string	プロジェクト識別子。
lastUpdateTime	string	プロジェクトの最終更新時刻。
name	string	プロジェクト名。
revision	integer	プロジェクトリビジョン。
state	ProjectState	プロジェクトの状態。
url	string	オブジェクトの完全なバージョンへの URL。
visibility	ProjectVisibility	プロジェクトの可視性。

VersionControlChangeType

アイテムに対して行われた変更の種類。

名前	型	説明
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

ワイヤを介して送信されるタグ定義の表現。

名前	型	説明
active	boolean	タグ定義がアクティブかどうか。
id	string	タグ定義の ID。
name	string	タグ定義の名前。
url	string	タグ定義のリソース URL。