Commits - Get
特定のコミットを取得します。
GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/commits/{commitId}?api-version=7.1
GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/commits/{commitId}?changeCount={changeCount}&api-version=7.1
URI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
commit
|
path | True |
string |
コミットの ID。 |
|
organization
|
path | True |
string |
Azure DevOps 組織の名前。 |
|
repository
|
path | True |
string |
リポジトリの ID またはフレンドリ名。 フレンドリ名を使用するには、projectId も指定する必要があります。 |
|
project
|
path |
string |
プロジェクト ID またはプロジェクト名 |
|
|
api-version
|
query | True |
string |
使用する API のバージョン。 このバージョンの API を使用するには、これを '7.1' に設定する必要があります。 |
|
change
|
query |
integer (int32) |
結果に含める変更の数。 |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 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 | コミット、変更セット、ブランチ、およびその他のバージョン管理成果物に関するソース コードとメタデータを読み取る機能を付与します。 また、コードを検索し、サービス フックを使用してバージョン管理イベントに関する通知を受け取る機能も付与されます。 |
例
| Get by ID |
| With limited changes |
Get by ID
要求のサンプル
GET https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/commits/be67f8871a4d2c75f13a51c1d3c30ac0d74d4ef4?api-version=7.1
応答のサンプル
{
"parents": [],
"treeId": "7fa1a3523ffef51c525ea476bffff7d648b8cb3d",
"push": {
"pushedBy": {
"id": "8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
"displayName": "Chuck Reinhart",
"uniqueName": "fabrikamfiber3@hotmail.com",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d"
},
"pushId": 1,
"date": "2014-01-29T23:33:15.2434002Z"
},
"commitId": "be67f8871a4d2c75f13a51c1d3c30ac0d74d4ef4",
"author": {
"name": "Chuck Reinhart",
"email": "fabrikamfiber3@hotmail.com",
"date": "2014-01-29T23:32:09Z"
},
"committer": {
"name": "Chuck Reinhart",
"email": "fabrikamfiber3@hotmail.com",
"date": "2014-01-29T23:32:09Z"
},
"comment": "First cut\n",
"url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/commits/be67f8871a4d2c75f13a51c1d3c30ac0d74d4ef4",
"remoteUrl": "https://dev.azure.com/fabrikam/_git/Fabrikam-Fiber-Git/commit/be67f8871a4d2c75f13a51c1d3c30ac0d74d4ef4",
"_links": {
"self": {
"href": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/commits/be67f8871a4d2c75f13a51c1d3c30ac0d74d4ef4"
},
"repository": {
"href": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249"
},
"changes": {
"href": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/commits/be67f8871a4d2c75f13a51c1d3c30ac0d74d4ef4/changes"
},
"web": {
"href": "https://dev.azure.com/fabrikam/_git/Fabrikam-Fiber-Git/commit/be67f8871a4d2c75f13a51c1d3c30ac0d74d4ef4"
},
"tree": {
"href": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/trees/7fa1a3523ffef51c525ea476bffff7d648b8cb3d"
}
}
}
With limited changes
要求のサンプル
GET https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/commits/be67f8871a4d2c75f13a51c1d3c30ac0d74d4ef4?changeCount=10&api-version=7.1
応答のサンプル
{
"parents": [],
"treeId": "7fa1a3523ffef51c525ea476bffff7d648b8cb3d",
"push": {
"pushedBy": {
"id": "8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
"displayName": "Chuck Reinhart",
"uniqueName": "fabrikamfiber3@hotmail.com",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d"
},
"pushId": 1,
"date": "2014-01-29T23:33:15.2434002Z"
},
"commitId": "be67f8871a4d2c75f13a51c1d3c30ac0d74d4ef4",
"author": {
"name": "Chuck Reinhart",
"email": "fabrikamfiber3@hotmail.com",
"date": "2014-01-29T23:32:09Z"
},
"committer": {
"name": "Chuck Reinhart",
"email": "fabrikamfiber3@hotmail.com",
"date": "2014-01-29T23:32:09Z"
},
"comment": "First cut\n",
"changeCounts": {
"Add": 456
},
"changes": [
{
"item": {
"gitObjectType": "blob",
"path": "/.gitattributes",
"url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/items/.gitattributes?versionType=Commit"
},
"changeType": "add"
},
{
"item": {
"gitObjectType": "blob",
"path": "/.gitignore",
"url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/items/.gitignore?versionType=Commit"
},
"changeType": "add"
},
{
"item": {
"gitObjectType": "tree",
"path": "/MyWebSite",
"isFolder": true,
"url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/items/MyWebSite?versionType=Commit"
},
"changeType": "add"
},
{
"item": {
"gitObjectType": "tree",
"path": "/MyWebSite/MyWebSite",
"isFolder": true,
"url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/items/MyWebSite/MyWebSite?versionType=Commit"
},
"changeType": "add"
},
{
"item": {
"gitObjectType": "blob",
"path": "/MyWebSite/MyWebSite.sln",
"url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/items/MyWebSite/MyWebSite.sln?versionType=Commit"
},
"changeType": "add"
},
{
"item": {
"gitObjectType": "tree",
"path": "/MyWebSite/packages",
"isFolder": true,
"url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/items/MyWebSite/packages?versionType=Commit"
},
"changeType": "add"
},
{
"item": {
"gitObjectType": "tree",
"path": "/MyWebSite/MyWebSite/App_Start",
"isFolder": true,
"url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/items/MyWebSite/MyWebSite/App_Start?versionType=Commit"
},
"changeType": "add"
},
{
"item": {
"gitObjectType": "tree",
"path": "/MyWebSite/MyWebSite/Areas",
"isFolder": true,
"url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/items/MyWebSite/MyWebSite/Areas?versionType=Commit"
},
"changeType": "add"
},
{
"item": {
"gitObjectType": "tree",
"path": "/MyWebSite/MyWebSite/Content",
"isFolder": true,
"url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/items/MyWebSite/MyWebSite/Content?versionType=Commit"
},
"changeType": "add"
},
{
"item": {
"gitObjectType": "tree",
"path": "/MyWebSite/MyWebSite/Controllers",
"isFolder": true,
"url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/items/MyWebSite/MyWebSite/Controllers?versionType=Commit"
},
"changeType": "add"
}
],
"url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/commits/be67f8871a4d2c75f13a51c1d3c30ac0d74d4ef4",
"remoteUrl": "https://dev.azure.com/fabrikam/_git/Fabrikam-Fiber-Git/commit/be67f8871a4d2c75f13a51c1d3c30ac0d74d4ef4",
"_links": {
"self": {
"href": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/commits/be67f8871a4d2c75f13a51c1d3c30ac0d74d4ef4"
},
"repository": {
"href": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249"
},
"changes": {
"href": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/commits/be67f8871a4d2c75f13a51c1d3c30ac0d74d4ef4/changes"
},
"web": {
"href": "https://dev.azure.com/fabrikam/_git/Fabrikam-Fiber-Git/commit/be67f8871a4d2c75f13a51c1d3c30ac0d74d4ef4"
},
"tree": {
"href": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/trees/7fa1a3523ffef51c525ea476bffff7d648b8cb3d"
}
}
}
定義
| 名前 | 説明 |
|---|---|
|
Change |
|
|
Git |
|
|
Git |
|
|
Git |
|
|
Git |
このクラスには、状態を投稿するサービス/拡張機能のメタデータが含まれています。 |
|
Git |
状態を一意に識別する状態コンテキスト。 |
|
Git |
状態の状態。 |
|
Git |
|
|
Git |
Git 操作のユーザー情報と日付。 |
|
Identity |
|
|
Item |
|
|
Item |
|
|
Reference |
REST 参照リンクのコレクションを表すクラス。 |
|
Resource |
|
|
Version |
アイテムに対して行われた変更の種類。 |
ChangeCountDictionary
GitChange
| 名前 | 型 | 説明 |
|---|---|---|
| changeId |
integer (int32) |
変更のグループ内の変更の ID。 |
| changeType |
アイテムに対して行われた変更の種類。 |
|
| item |
string (T) |
現在のバージョン。 |
| newContent |
変更後のアイテムの内容。 |
|
| newContentTemplate |
新しい変更をプッシュするときに使用する新しいコンテンツ テンプレート。 |
|
| originalPath |
string |
現在のパスと異なる場合は、アイテムの元のパス。 |
| sourceServerItem |
string |
サーバー上の項目のパス。 |
| url |
string |
アイテムを取得する URL。 |
GitCommit
| 名前 | 型 | 説明 |
|---|---|---|
| _links |
関連する REST 参照リンクのコレクション。 |
|
| author |
コミットの作成者。 |
|
| changeCounts |
コミットに含まれる変更の種類 (編集、削除など) の数。 |
|
| changes |
コミットに含まれる変更の列挙。 |
|
| comment |
string |
コミットのコメントまたはメッセージ。 |
| commentTruncated |
boolean |
完全な Git コミット コメント メッセージからコメントが切り捨てられているかどうかを示します。 |
| commitId |
string |
コミットの ID (SHA-1)。 |
| commitTooManyChanges |
boolean |
コミットに含まれる変更が多すぎて表示できないことを示します |
| committer |
コミットのコミッター。 |
|
| parents |
string[] |
このコミットの親コミット ID の列挙。 |
| push |
このコミットに関連付けられているプッシュ。 |
|
| remoteUrl |
string |
コミットへのリモート URL パス。 |
| statuses |
コミットに追加情報を関連付ける可能性があるサービスと拡張機能からの状態メタデータの一覧。 |
|
| treeId |
string |
|
| url |
string |
このリソースの REST URL。 |
| workItems |
このコミットに関連付けられている作業項目の一覧。 |
GitPushRef
| 名前 | 型 | 説明 |
|---|---|---|
| _links |
REST 参照リンクのコレクションを表すクラス。 |
|
| date |
string (date-time) |
|
| pushId |
integer (int32) |
|
| pushedBy | ||
| url |
string |
GitStatus
このクラスには、状態を投稿するサービス/拡張機能のメタデータが含まれています。
| 名前 | 型 | 説明 |
|---|---|---|
| _links |
参照リンク。 |
|
| context |
状態のコンテキスト。 |
|
| createdBy |
状態を作成した ID。 |
|
| creationDate |
string (date-time) |
状態の作成日時。 |
| description |
string |
状態の説明。 通常、状態の現在の状態について説明します。 |
| id |
integer (int32) |
状態識別子。 |
| state |
状態の状態。 |
|
| targetUrl |
string |
状態の詳細を含む URL。 |
| updatedDate |
string (date-time) |
状態の最終更新日時。 |
GitStatusContext
状態を一意に識別する状態コンテキスト。
| 名前 | 型 | 説明 |
|---|---|---|
| genre |
string |
ステータスのジャンル。 通常、状態を生成するサービス/ツールの名前は空にすることができます。 |
| name |
string |
状態の名前識別子を null または空にすることはできません。 |
GitStatusState
状態の状態。
| 値 | 説明 |
|---|---|
| error |
エラーが発生した状態。 |
| failed |
状態が失敗しました。 |
| notApplicable |
状態はターゲット オブジェクトには適用されません。 |
| notSet |
状態が設定されていません。 既定の状態。 |
| pending |
保留中の状態。 |
| succeeded |
状態が成功しました。 |
GitTemplate
| 名前 | 型 | 説明 |
|---|---|---|
| name |
string |
テンプレートの名前 |
| type |
string |
テンプレートの種類 |
GitUserDate
Git 操作のユーザー情報と日付。
| 名前 | 型 | 説明 |
|---|---|---|
| date |
string (date-time) |
Git 操作の日付。 |
|
string |
Git 操作を実行しているユーザーの電子メール アドレス。 |
|
| imageUrl |
string |
ユーザーのアバターの URL。 |
| name |
string |
Git 操作を実行しているユーザーの名前。 |
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 は、このグラフの件名のソース リソースへの完全なルートです。 |
ItemContent
| 名前 | 型 | 説明 |
|---|---|---|
| content |
string |
|
| contentType |
ItemContentType
| 値 | 説明 |
|---|---|
| base64Encoded | |
| rawText |
ReferenceLinks
REST 参照リンクのコレクションを表すクラス。
| 名前 | 型 | 説明 |
|---|---|---|
| links |
object |
リンクの読み取りビュー。 参照リンクは読み取り専用であるため、読み取り専用として公開する必要があります。 |
ResourceRef
| 名前 | 型 | 説明 |
|---|---|---|
| id |
string |
|
| url |
string |
VersionControlChangeType
アイテムに対して行われた変更の種類。
| 値 | 説明 |
|---|---|
| add | |
| all | |
| branch | |
| delete | |
| edit | |
| encoding | |
| lock | |
| merge | |
| none | |
| property | |
| rename | |
| rollback | |
| sourceRename | |
| targetRename | |
| undelete |