Forks - Create fork sync request

サービス:

Git

API バージョン:

7.1

別のリポジトリの ref をこのリポジトリにフェッチすることを要求します。 2 つの既存のフォークを同期します。 フォークを作成するには、 リポジトリエンドポイントの を参照してください

POST https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryNameOrId}/forkSyncRequests?api-version=7.1

省略可能なパラメーターを含む:

POST https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryNameOrId}/forkSyncRequests?includeLinks={includeLinks}&api-version=7.1

URI パラメーター

名前	/	必須	型	説明
organization	path	True	string	Azure DevOps 組織の名前。
repositoryNameOrId	path	True	string	リポジトリの名前または ID。
project	path		string	プロジェクト ID またはプロジェクト名
api-version	query	True	string	使用する API のバージョン。 このバージョンの API を使用するには、これを '7.1' に設定する必要があります。
includeLinks	query		boolean	リンクを含める場合は True

要求本文

名前	型	説明
source	GlobalGitRepositoryKey	ソース リポジトリの完全修飾識別子。
sourceToTargetRefs	SourceToTargetRef[]	指定した場合、"同期" または作成の実行時に使用する ref マッピングのセット。 見つからない場合、すべての参照が同期されます。

応答

名前	型	説明
200 OK	GitForkSyncRequest	成功した操作

セキュリティ

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

定義

名前	説明
GitAsyncOperationStatus
GitForkOperationStatusDetail	要求されたフォーク操作に関する状態情報。
GitForkSyncRequest	2 つのフォーク間でデータを同期するように要求します。
GitForkSyncRequestParameters	フォーク要求を作成するためのパラメーター
GlobalGitRepositoryKey	リポジトリのグローバル一意キー。
ReferenceLinks	REST 参照リンクのコレクションを表すクラス。
SourceToTargetRef

GitAsyncOperationStatus

列挙

値	説明
abandoned	操作は破棄されました。
completed	操作が完了しました。
failed	操作が失敗しました。 エラー メッセージを確認します。
inProgress	操作は現在進行中です。
queued	操作はキューで待機しており、まだ開始されていません。

GitForkOperationStatusDetail

Object

要求されたフォーク操作に関する状態情報。

名前	型	説明
allSteps	string[]	フォーク プロセスのすべての有効な手順
currentStep	integer (int32)	現在のステップの AllSteps にインデックスを作成する
errorMessage	string	操作が失敗した場合のエラー メッセージ。

GitForkSyncRequest

Object

2 つのフォーク間でデータを同期するように要求します。

名前	型	説明
_links	ReferenceLinks	関連リンクのコレクション
detailedStatus	GitForkOperationStatusDetail	要求されたフォーク操作に関する状態情報。
operationId	integer (int32)	操作の一意識別子。
source	GlobalGitRepositoryKey	ソース リポジトリの完全修飾識別子。
sourceToTargetRefs	SourceToTargetRef[]	指定した場合、"同期" または作成の実行時に使用する ref マッピングのセット。 見つからない場合、すべての参照が同期されます。
status	GitAsyncOperationStatus

GitForkSyncRequestParameters

Object

フォーク要求を作成するためのパラメーター

名前	型	説明
source	GlobalGitRepositoryKey	ソース リポジトリの完全修飾識別子。
sourceToTargetRefs	SourceToTargetRef[]	指定した場合、"同期" または作成の実行時に使用する ref マッピングのセット。 見つからない場合、すべての参照が同期されます。

GlobalGitRepositoryKey

Object

リポジトリのグローバル一意キー。

名前	型	説明
collectionId	string (uuid)	リポジトリのコレクションのチーム プロジェクト コレクション ID。
projectId	string (uuid)	リポジトリのプロジェクトのチーム プロジェクト ID。
repositoryId	string (uuid)	リポジトリの ID。

ReferenceLinks

Object

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

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

SourceToTargetRef

Object

名前	型	説明
sourceRef	string	コピーするソース参照。 たとえば、refs/heads/master などです。
targetRef	string	更新するターゲット参照。 たとえば、refs/heads/master などです。