Pull Request Share - Share Pull Request

サービス:

Git

API バージョン:

7.1-preview.1

特定の pull request に関する電子メール通知を受信者のセットに送信します

POST https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/share?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	Git リポジトリの ID。
project	path		string	プロジェクト ID またはプロジェクト名
api-version	query	True	string	使う API のバージョン。 このバージョンの API を使用するには、これを '7.1-preview.1' に設定する必要があります。

要求本文

名前	型	説明
message	string	オプションのユーザーメモまたはメッセージ。
receivers	IdentityRef[]	共有通知を受け取るユーザーの ID。

応答

名前	型	説明
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.code_write	ソース コードの読み取り、更新、削除、コミット、変更セット、ブランチ、およびその他のバージョン管理成果物に関するメタデータへのアクセスを許可します。 また、pull request とコード レビューを作成および管理したり、サービス フックを介してバージョン管理イベントに関する通知を受信したりすることもできます。

定義

名前	説明
IdentityRef
ReferenceLinks	REST 参照リンクのコレクションを表す クラス。
ShareNotificationContext	pull request の共有中に使用されるコンテキスト。

IdentityRef

Object

名前	型	説明
_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 は、このグラフの件名のソース リソースへの完全なルートです。

ReferenceLinks

Object

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

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

ShareNotificationContext

Object

pull request の共有中に使用されるコンテキスト。

名前	型	説明
message	string	オプションのユーザーメモまたはメッセージ。
receivers	IdentityRef[]	共有通知を受け取るユーザーの ID。