Pushes - Get

リファレンス

Service:: Git

API Version:: 7.1-preview.2

特定のプッシュを取得します。

GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pushes/{pushId}?api-version=7.1-preview.2

With optional parameters:

GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pushes/{pushId}?includeCommits={includeCommits}&includeRefUpdates={includeRefUpdates}&api-version=7.1-preview.2

URI パラメーター

名前	/	必須	型	説明
organization	path	True	string	Azure DevOps 組織の名前です。
pushId	path	True	integer int32	プッシュの ID。
repositoryId	path	True	string	リポジトリの名前または ID。
project	path		string	プロジェクト ID またはプロジェクト名
api-version	query	True	string	使用する API のバージョン。このバージョンの API を使用するには、これを '7.1-preview.2' に設定する必要があります。
includeCommits	query		integer int32	結果に含めるコミットの数。
includeRefUpdates	query		boolean	true の場合は、プッシュによって更新された ref の一覧を含めます。

応答

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

セキュリティ

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

例

Just the push

Sample Request

HTTP

GET https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/pushes/23?api-version=7.1-preview.2

Sample Response

Status code:: 200

{
  "commits": [],
  "pushedBy": {
    "id": "d6245f20-2af8-44f4-9451-8107cb2767db",
    "displayName": "Normal Paulk",
    "uniqueName": "fabrikamfiber16@hotmail.com",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d6245f20-2af8-44f4-9451-8107cb2767db",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d6245f20-2af8-44f4-9451-8107cb2767db"
  },
  "pushId": 23,
  "date": "2014-06-30T18:11:18.0929091Z",
  "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/pushes/23",
  "_links": {
    "self": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/pushes/23"
    },
    "repository": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249"
    },
    "commits": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/pushes/23/commits"
    },
    "pusher": {
      "href": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d6245f20-2af8-44f4-9451-8107cb2767db"
    }
  }
}

定義

名前	説明
ChangeCountDictionary
GitChange
GitCommitRef	Git コミットと関連するメタデータを記述するプロパティを提供します。
GitPush
GitPushRef
GitRefUpdate
GitRepository
GitRepositoryRef
GitStatus	このクラスには、状態を投稿するサービス/拡張機能のメタデータが含まれます。
GitStatusContext	状態を一意に識別する状態コンテキスト。
GitStatusState	状態の状態。
GitTemplate
GitUserDate	Git 操作のユーザー情報と日付。
IdentityRef
ItemContent
ItemContentType
ProjectState	プロジェクトの状態。
ProjectVisibility	プロジェクトの可視性。
ReferenceLinks	REST 参照リンクのコレクションを表すクラス。
ResourceRef
TeamProjectCollectionReference	TeamProjectCollection の参照オブジェクト。
TeamProjectReference	TeamProject への浅い参照を表します。
VersionControlChangeType	アイテムに対して行われた変更の種類。

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

GitPush

名前	型	説明
_links	ReferenceLinks	REST 参照リンクのコレクションを表すクラス。
commits	GitCommitRef[]	Git コミットと関連するメタデータを記述するプロパティを提供します。
date	string
pushId	integer
pushedBy	IdentityRef
refUpdates	GitRefUpdate[]
repository	GitRepository
url	string

GitPushRef

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

GitRefUpdate

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

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	プロジェクトはすべてのユーザーに表示されます。

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

次の方法で共有