Reverts - Create

リファレンス

サービス:: Git

API バージョン:: 7.1

プル要求に関連付けられている特定のコミットまたはコミットによって導入された変更を元に戻す新しいブランチを作成する操作を開始します。

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

URI パラメーター

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

要求本文

名前	型	説明
generatedRefName	string	チェリーピックまたは元に戻す操作のターゲットブランチ名を提案しました。
ontoRefName	string	チェリーピックまたは元に戻す操作のターゲットブランチ。
repository	GitRepository	チェリーピックまたは元に戻す操作の git リポジトリ。
source	GitAsyncRefOperationSource	チェリーピックまたは元に戻す操作のソースに関する詳細 (プル要求や特定のコミットなど)。

応答

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

セキュリティ

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

名前

説明

vso.code_manage

ソースコードの読み取り、更新、削除、コミット、変更セット、ブランチ、およびその他のバージョン管理成果物に関するメタデータへのアクセスを許可します。また、コードリポジトリの作成と管理、プル要求とコードレビューの作成と管理、サービスフックを介したバージョン管理イベントに関する通知の受信を行う機能も付与されます。

例

要求のサンプル

HTTP

POST https://dev.azure.com/fabrikam/{project}/_apis/git/repositories/{repositoryId}/reverts?api-version=7.1

{
  "repository": {
    "id": "9a6b6a4a-83df-47ab-8c2a-07742cede4cb",
    "name": "FabrikamOps",
    "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/9a6b6a4a-83df-47ab-8c2a-07742cede4cb",
    "project": {
      "id": "0807fc91-4393-482d-9e23-defdbb7d0857",
      "name": "Test1",
      "url": "https://dev.azure.com/fabrikam/_apis/projects/0807fc91-4393-482d-9e23-defdbb7d0857",
      "state": "wellFormed",
      "revision": 165
    },
    "defaultBranch": "refs/heads/master",
    "remoteUrl": "https://dev.azure.com/fabrikam/Test1/_git/FabrikamOps"
  },
  "source": {
    "commitList": [
      {
        "commitId": "4388fbc9e8511520a9ae8dc6ab0080322a9ebe01"
      }
    ]
  },
  "ontoRefName": "refs/heads/master",
  "generatedRefName": "refs/heads/vsts-dotnet-samples/stop-brass-division"
}

応答のサンプル

状態コード:: 201

{
  "revertId": 19,
  "parameters": {
    "repository": {
      "id": "9a6b6a4a-83df-47ab-8c2a-07742cede4cb",
      "name": "FabrikamOps",
      "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/9a6b6a4a-83df-47ab-8c2a-07742cede4cb",
      "project": {
        "id": "0807fc91-4393-482d-9e23-defdbb7d0857",
        "name": "Test1",
        "url": "https://dev.azure.com/fabrikam/_apis/projects/0807fc91-4393-482d-9e23-defdbb7d0857",
        "state": "wellFormed",
        "revision": 165
      },
      "remoteUrl": "https://dev.azure.com/fabrikam/Test1/_git/FabrikamOps",
      "sshUrl": "ssh://fabrikam@vs-ssh.visualstudio.com:22/Test1/_ssh/FabrikamOps"
    },
    "source": {
      "commitList": [
        {
          "commitId": "4388fbc9e8511520a9ae8dc6ab0080322a9ebe01",
          "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/9a6b6a4a-83df-47ab-8c2a-07742cede4cb/commits/4388fbc9e8511520a9ae8dc6ab0080322a9ebe01"
        }
      ]
    },
    "ontoRefName": "refs/heads/master",
    "generatedRefName": "refs/heads/vsts-dotnet-samples/stop-brass-division"
  },
  "status": "queued",
  "detailedStatus": null,
  "_links": {
    "self": {
      "href": "https://dev.azure.com/fabrikam/0807fc91-4393-482d-9e23-defdbb7d0857/_apis/git/repositories/9a6b6a4a-83df-47ab-8c2a-07742cede4cb/reverts/19"
    },
    "repository": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/9a6b6a4a-83df-47ab-8c2a-07742cede4cb"
    }
  },
  "url": "https://dev.azure.com/fabrikam/0807fc91-4393-482d-9e23-defdbb7d0857/_apis/git/repositories/9a6b6a4a-83df-47ab-8c2a-07742cede4cb/reverts/19"
}

定義

名前	説明
ChangeCountDictionary
GitAsyncOperationStatus
GitAsyncRefOperationDetail	チェリーピックまたは元に戻す操作の進行状況に関する情報。
GitAsyncRefOperationFailureStatus	チェリーピックまたは元に戻すが失敗した理由を示す状態コードを提供します。
GitAsyncRefOperationParameters	チェリーピックまたは元に戻す要求時に要求本文で指定されるパラメーター。
GitAsyncRefOperationSource	GitAsyncRefOperationSource は、チェリーピックおよび元に戻す操作要求を行うときに使用するプル要求またはコミットの一覧を指定します。指定する必要があるのは 1 つだけです。
GitChange
GitCommitRef	Git コミットと関連付けられたメタデータを記述するプロパティを提供します。
GitPushRef
GitRepository
GitRepositoryRef
GitRevert
GitStatus	このクラスには、状態を投稿するサービス/拡張機能のメタデータが含まれています。
GitStatusContext	状態を一意に識別する状態コンテキスト。
GitStatusState	状態の状態。
GitTemplate
GitUserDate	Git 操作のユーザー情報と日付。
IdentityRef
ItemContent
ItemContentType
ProjectState	プロジェクトの状態。
ProjectVisibility	プロジェクトの可視性。
ReferenceLinks	REST 参照リンクのコレクションを表すクラス。
ResourceRef
TeamProjectCollectionReference	TeamProjectCollection の参照オブジェクト。
TeamProjectReference	TeamProject への浅い参照を表します。
VersionControlChangeType	アイテムに対して行われた変更の種類。

ChangeCountDictionary

Object

GitAsyncOperationStatus

列挙

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

GitAsyncRefOperationDetail

Object

チェリーピックまたは元に戻す操作の進行状況に関する情報。

名前	型	説明
conflict	boolean	変更をチェリーピックまたは元に戻そうとしたときに競合が生成されたかどうかを示します。
currentCommitId	string	選択または元に戻されているコミットの一覧からの現在のコミット。
failureMessage	string	チェリーピックまたは元に戻すのが完了しなかった理由に関する詳細情報。
progress	number (double)	操作の完了率を示す 0 から 1 までの数値。
status	GitAsyncRefOperationFailureStatus	チェリーピックまたは元に戻すが失敗した理由を示す状態コードを提供します。
timedout	boolean	操作が、チェリーピックまたは元に戻す操作に許可されている最大時間を超えたかどうかを示します。

GitAsyncRefOperationFailureStatus

列挙

チェリーピックまたは元に戻すが失敗した理由を示す状態コードを提供します。

値	説明
asyncOperationNotFound	非同期操作が見つかりませんでした
createBranchPermissionRequired	ユーザーにブランチを作成する権限がないため、ref 更新要求を完了できませんでした
emptyCommitterSignature	非同期操作のイニシエーターに、名前または電子メールが空の署名がある
gitObjectTooLarge	Git オブジェクトが大きすぎてメモリに具体化するには
invalidRefName	要求に表示された ref 名が有効でなかったため、ref 更新要求を完了できなかったことを示します。
none	状態なし
operationIndentityNotFound	操作を承認した ID が見つかりませんでした
other	予期しないエラー
refNameConflict	ref の更新を完了できませんでした。これは、大文字と小文字を区別しないモードでは、ref 名が、大文字と小文字が異なる既存の ref 名と競合するためです。
targetBranchDeleted	Git 非同期操作の開始後にターゲットブランチが削除されました
writePermissionRequired	ユーザーにこの ref を書き込むための書き込みアクセス許可がないため、ref 更新要求を完了できませんでした

GitAsyncRefOperationParameters

Object

チェリーピックまたは元に戻す要求時に要求本文で指定されるパラメーター。

名前	型	説明
generatedRefName	string	チェリーピックまたは元に戻す操作のターゲットブランチ名を提案しました。
ontoRefName	string	チェリーピックまたは元に戻す操作のターゲットブランチ。
repository	GitRepository	チェリーピックまたは元に戻す操作の git リポジトリ。
source	GitAsyncRefOperationSource	チェリーピックまたは元に戻す操作のソースに関する詳細 (プル要求や特定のコミットなど)。

GitAsyncRefOperationSource

Object

GitAsyncRefOperationSource は、チェリーピックおよび元に戻す操作要求を行うときに使用するプル要求またはコミットの一覧を指定します。指定する必要があるのは 1 つだけです。

名前	型	説明
commitList	GitCommitRef[]	チェリーピックまたは元に戻すコミットの一覧
pullRequestId	integer (int32)	チェリーピックまたは元に戻す pull request の ID

GitChange

Object

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

GitCommitRef

Object

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[]	このコミットに関連付けられている作業項目の一覧。

GitPushRef

Object

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

GitRepository

Object

名前	型	説明
_links	ReferenceLinks	REST 参照リンクのコレクションを表すクラス。
defaultBranch	string
id	string (uuid)
isDisabled	boolean	True の場合は、リポジトリが無効です。それ以外の場合は False。
isFork	boolean	True の場合は、リポジトリがフォークとして作成されました。
isInMaintenance	boolean	True の場合は、リポジトリがメンテナンス中です。それ以外の場合は False。
name	string
parentRepository	GitRepositoryRef
project	TeamProjectReference	TeamProject への浅い参照を表します。
remoteUrl	string
size	integer (int64)	リポジトリの圧縮サイズ (バイト)。
sshUrl	string
url	string
validRemoteUrls	string[]
webUrl	string

GitRepositoryRef

Object

名前	型	説明
collection	TeamProjectCollectionReference	このフォークが存在する Team Project Collection
id	string (uuid)
isFork	boolean	True リポジトリがフォークとして作成された場合
name	string
project	TeamProjectReference	TeamProject への浅い参照を表します。
remoteUrl	string
sshUrl	string
url	string

GitRevert

Object

名前	型	説明
_links	ReferenceLinks	REST 参照リンクのコレクションを表すクラス。
detailedStatus	GitAsyncRefOperationDetail	チェリーピックまたは元に戻す操作の進行状況に関する情報。
parameters	GitAsyncRefOperationParameters	チェリーピックまたは元に戻す要求時に要求本文で指定されるパラメーター。
revertId	integer (int32)
status	GitAsyncOperationStatus
url	string	操作に関する状態をさらに要求するために使用できる URL

GitStatus

Object

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

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

GitStatusContext

Object

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

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

GitStatusState

列挙

状態の状態。

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

GitTemplate

Object

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

GitUserDate

Object

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

名前	型	説明
date	string (date-time)	Git 操作の日付。
email	string	Git 操作を実行しているユーザーの電子メールアドレス。
imageUrl	string	ユーザーのアバターの URL。
name	string	Git 操作を実行しているユーザーの名前。

IdentityRef

Object

名前	型	説明
_links	ReferenceLinks	このフィールドには、グラフの件名に関する興味深いリンクが 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 は、このグラフの件名のソースリソースへの完全なルートです。

ItemContent

Object

名前	型	説明
content	string
contentType	ItemContentType

ItemContentType

列挙

値	説明
base64Encoded
rawText

ProjectState

列挙

プロジェクトの状態。

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

ProjectVisibility

列挙

プロジェクトの可視性。

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

ReferenceLinks

Object

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

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

ResourceRef

Object

名前	型	説明
id	string
url	string

TeamProjectCollectionReference

Object

TeamProjectCollection の参照オブジェクト。

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

TeamProjectReference

Object

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

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

VersionControlChangeType

列挙

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

値	説明
add
all
branch
delete
edit
encoding
lock
merge
none
property
rename
rollback
sourceRename
targetRename
undelete

次の方法で共有

Reverts - Create

URI パラメーター

要求本文

応答

セキュリティ

oauth2

スコープ

例

要求のサンプル

応答のサンプル

定義

ChangeCountDictionary

GitAsyncOperationStatus

GitAsyncRefOperationDetail

GitAsyncRefOperationFailureStatus

GitAsyncRefOperationParameters

GitAsyncRefOperationSource

GitChange

GitCommitRef

GitPushRef

GitRepository

GitRepositoryRef

GitRevert

GitStatus

GitStatusContext

GitStatusState

GitTemplate

GitUserDate

IdentityRef

ItemContent

ItemContentType

ProjectState

ProjectVisibility

ReferenceLinks

ResourceRef

TeamProjectCollectionReference

TeamProjectReference

VersionControlChangeType