Source Providers - Get Pull Request
ソース プロバイダーから pull request オブジェクトを取得します。
GET https://dev.azure.com/{organization}/{project}/_apis/sourceProviders/{providerName}/pullrequests/{pullRequestId}?api-version=7.1GET https://dev.azure.com/{organization}/{project}/_apis/sourceProviders/{providerName}/pullrequests/{pullRequestId}?repositoryId={repositoryId}&serviceEndpointId={serviceEndpointId}&api-version=7.1URI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
organization
|
path | True |
string |
Azure DevOps 組織の名前。 |
|
project
|
path | True |
string |
プロジェクト ID またはプロジェクト名 |
|
provider
|
path | True |
string |
ソース プロバイダーの名前。 |
|
pull
|
path | True |
string |
プル要求のベンダー固有の ID。 |
|
api-version
|
query | True |
string |
使う API のバージョン。 このバージョンの API を使用するには、これを '7.1' に設定する必要があります。 |
|
repository
|
query |
string |
ベンダー固有の識別子、またはプル要求を含むリポジトリの名前。 |
|
|
service
|
query |
string (uuid) |
指定した場合、クエリを実行するサービス エンドポイントの ID。 TFVC や TFGit など、サービス エンドポイントを使用しないプロバイダーの場合にのみ省略できます。 |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 200 OK |
成功した操作 |
セキュリティ
oauth2
型:
oauth2
フロー:
accessCode
Authorization URL (承認 URL):
https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL (トークン 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
スコープ
| 名前 | 説明 |
|---|---|
| vso.build | ビルドの結果、定義、要求など、ビルド成果物にアクセスする機能と、サービス フックを介してビルド イベントに関する通知を受信する機能を付与します。 |
定義
| 名前 | 説明 |
|---|---|
|
Identity |
|
|
Pull |
pull request オブジェクトを表します。 これらはソース プロバイダーから取得されます。 |
|
Reference |
REST 参照リンクのコレクションを表すクラス。 |
IdentityRef
| 名前 | 型 | 説明 |
|---|---|---|
| _links |
このフィールドには、グラフの件名に関する興味深いリンクが 0 個以上含まれています。 これらのリンクを呼び出して、このグラフの件名に関する追加のリレーションシップや詳細情報を取得できます。 |
|
| descriptor |
string |
記述子は、システムの実行中にグラフの件名を参照する主な方法です。 このフィールドは、アカウントと組織の両方で同じグラフの件名を一意に識別します。 |
| directoryAlias |
string |
非推奨 - IdentityRef "_links" ディクショナリの "自己" エントリで参照されている 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 は、このグラフの件名のソース リソースへの完全なルートです。 |
PullRequest
pull request オブジェクトを表します。 これらはソース プロバイダーから取得されます。
| 名前 | 型 | 説明 |
|---|---|---|
| _links |
このオブジェクトに関連する他のオブジェクトへのリンク。 |
|
| author |
pull request の作成者。 |
|
| currentState |
string |
pull request の現在の状態 (オープン、マージ、クローズ、競合など)。 |
| description |
string |
pull request の説明。 |
| draft |
boolean |
pull request が下書きである場合に返します。 |
| id |
string |
pull request の一意識別子 |
| providerName |
string |
このプル要求が関連付けられているプロバイダーの名前。 |
| sourceBranchRef |
string |
このプル要求のソース ブランチ参照 |
| sourceRepositoryOwner |
string |
このプル要求のソース リポジトリの所有者 |
| targetBranchRef |
string |
このプル要求のターゲット ブランチ参照 |
| targetRepositoryOwner |
string |
この pull request のターゲット リポジトリの所有者 |
| title |
string |
pull request のタイトル。 |
ReferenceLinks
REST 参照リンクのコレクションを表すクラス。
| 名前 | 型 | 説明 |
|---|---|---|
| links |
object |
リンクの読み取りビュー。 参照リンクは読み取り専用であるため、読み取り専用として公開する必要があります。 |