Commits - Get Commits Batch
検索条件に一致するプロジェクトの git コミットを取得する
POST https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/commitsbatch?api-version=7.1
POST https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/commitsbatch?$skip={$skip}&$top={$top}&includeStatuses={includeStatuses}&api-version=7.1
URI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
organization
|
path | True |
string |
Azure DevOps 組織の名前。 |
|
repository
|
path | True |
string |
リポジトリの名前または ID。 |
|
project
|
path |
string |
プロジェクト ID またはプロジェクト名 |
|
|
api-version
|
query | True |
string |
使用する API のバージョン。 このバージョンの API を使用するには、これを '7.1' に設定する必要があります。 |
|
$skip
|
query |
integer (int32) |
スキップするコミットの数。 値は 3,000,000 を超えることはできません。 |
|
|
$top
|
query |
integer (int32) |
返されるコミットの最大数。 値は 50,000 を超えることはできません。 |
|
|
include
|
query |
boolean |
True を指定すると、追加のコミット状態情報が含まれます。 |
要求本文
| 名前 | 型 | 説明 |
|---|---|---|
| $skip |
integer (int32) |
スキップするエントリの数 |
| $top |
integer (int32) |
取得するエントリの最大数 |
| author |
string |
作成者の別名または表示名 |
| compareVersion |
ItemVersion が指定されている場合にのみ適用されます。 指定された場合は、このコミットから歩く履歴を開始します。 |
|
| excludeDeletes |
boolean |
itemPath が指定されている場合にのみ適用されます。 これにより、指定したパスの削除エントリを除外するかどうかを決定します。 |
| fromCommitId |
string |
指定した場合、コミットをフィルター処理するための下限がアルファベット順に表示されます |
| fromDate |
string |
指定した場合は、この日付より後に作成された履歴エントリのみを含めます (文字列) |
| historyMode |
使用する必要がある Git 履歴モード。 これは、ID が null で itemPath が指定されている場合にのみ検索条件に適用されます。 |
|
| ids |
string[] |
指定した場合は、フェッチするコミットの正確なコミット ID を指定します。 他のパラメーターと組み合わせて使用することはできません。 |
| includeLinks |
boolean |
浅い参照に_links フィールドを含めるかどうか |
| includePushData |
boolean |
プッシュ情報を含めるかどうか |
| includeUserImageUrl |
boolean |
コミッターと作成者の画像 URL を含めるかどうか |
| includeWorkItems |
boolean |
リンクされた作業項目を含めるかどうか |
| itemPath |
string |
検索する項目のパス |
| itemVersion |
指定した場合は、検索するコミットまたはブランチを識別します |
|
| showOldestCommitsFirst |
boolean |
有効にした場合、このオプションは itemVersion パラメーターと compareVersion パラメーターを無視します |
| toCommitId |
string |
指定した場合、コミットをフィルター処理するための上限がアルファベット順に表示されます。 |
| toDate |
string |
指定した場合は、この日付より前に作成された履歴エントリのみを含めます (文字列) |
| user |
string |
コミッターの別名または表示名 |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 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 | コミット、変更セット、ブランチ、およびその他のバージョン管理成果物に関するソース コードとメタデータを読み取る機能を付与します。 また、コードを検索し、サービス フックを使用してバージョン管理イベントに関する通知を受け取る機能も付与されます。 |
例
| Commits between two versions |
| Commits by a list of commit IDs |
Commits between two versions
要求のサンプル
POST https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/commitsbatch?api-version=7.1
{
"itemVersion": {
"versionType": "branch",
"version": "develop"
},
"compareVersion": {
"versionType": "branch",
"version": "master"
}
}
応答のサンプル
{
"count": 17,
"value": [
{
"commitId": "23d0bc5b128a10056dc68afece360d8a0fabb014",
"author": {
"name": "Norman Paulk",
"email": "Fabrikamfiber16@hotmail.com",
"date": "2014-06-30T18:10:55Z"
},
"committer": {
"name": "Norman Paulk",
"email": "Fabrikamfiber16@hotmail.com",
"date": "2014-06-30T18:10:55Z"
},
"comment": "Better description for hello world",
"changeCounts": {
"Edit": 1
},
"url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/commits/23d0bc5b128a10056dc68afece360d8a0fabb014",
"remoteUrl": "https://dev.azure.com/fabrikam/_git/Fabrikam-Fiber-Git/commit/23d0bc5b128a10056dc68afece360d8a0fabb014"
},
{
"commitId": "fe17a84cc2dfe0ea3a2202ab4dbac0706058e41f",
"author": {
"name": "Norman Paulk",
"email": "Fabrikamfiber16@hotmail.com",
"date": "2014-06-30T17:51:09Z"
},
"committer": {
"name": "Norman Paulk",
"email": "Fabrikamfiber16@hotmail.com",
"date": "2014-06-30T17:51:09Z"
},
"comment": "Better description for hello world",
"changeCounts": {
"Edit": 1
},
"url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/commits/fe17a84cc2dfe0ea3a2202ab4dbac0706058e41f",
"remoteUrl": "https://dev.azure.com/fabrikam/_git/Fabrikam-Fiber-Git/commit/fe17a84cc2dfe0ea3a2202ab4dbac0706058e41f"
},
{
"commitId": "0360c963d7d86d040e9c33bba836feab14da4ad3",
"author": {
"name": "Norman Paulk",
"email": "Fabrikamfiber16@hotmail.com",
"date": "2014-06-10T19:42:13Z"
},
"committer": {
"name": "Norman Paulk",
"email": "Fabrikamfiber16@hotmail.com",
"date": "2014-06-10T19:42:13Z"
},
"comment": "Fix for hello world class",
"changeCounts": {
"Edit": 1
},
"url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/commits/0360c963d7d86d040e9c33bba836feab14da4ad3",
"remoteUrl": "https://dev.azure.com/fabrikam/_git/Fabrikam-Fiber-Git/commit/0360c963d7d86d040e9c33bba836feab14da4ad3"
},
{
"commitId": "097d82b8aeabe493bf4c3553d320ae2529bba591",
"author": {
"name": "Chuck Reinhart",
"email": "fabrikamfiber3@hotmail.com",
"date": "2014-06-09T21:43:25Z"
},
"committer": {
"name": "Chuck Reinhart",
"email": "fabrikamfiber3@hotmail.com",
"date": "2014-06-09T21:43:25Z"
},
"comment": "fix registration page",
"changeCounts": {
"Edit": 1
},
"url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/commits/097d82b8aeabe493bf4c3553d320ae2529bba591",
"remoteUrl": "https://dev.azure.com/fabrikam/_git/Fabrikam-Fiber-Git/commit/097d82b8aeabe493bf4c3553d320ae2529bba591"
},
{
"commitId": "33b55f7cb7e7e245323987634f960cf4a6e6bc74",
"author": {
"name": "Will Smythe",
"email": "wismythe@microsoft.com",
"date": "2014-05-02T19:17:05Z"
},
"committer": {
"name": "Will Smythe",
"email": "wismythe@microsoft.com",
"date": "2014-05-02T19:17:05Z"
},
"comment": "Fixed bug in web.config file",
"changeCounts": {
"Edit": 1
},
"url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/commits/33b55f7cb7e7e245323987634f960cf4a6e6bc74",
"remoteUrl": "https://dev.azure.com/fabrikam/_git/Fabrikam-Fiber-Git/commit/33b55f7cb7e7e245323987634f960cf4a6e6bc74"
},
{
"commitId": "aad331d8d3b131fa9ae03cf5e53965b51942618a",
"author": {
"name": "Howie Hilliker",
"email": "hhill@microsoft.com",
"date": "2014-04-14T21:34:52Z"
},
"committer": {
"name": "Howie Hilliker",
"email": "hhill@microsoft.com",
"date": "2014-04-14T21:34:52Z"
},
"comment": "Fixed bug for address validation.",
"changeCounts": {
"Edit": 1
},
"url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/commits/aad331d8d3b131fa9ae03cf5e53965b51942618a",
"remoteUrl": "https://dev.azure.com/fabrikam/_git/Fabrikam-Fiber-Git/commit/aad331d8d3b131fa9ae03cf5e53965b51942618a"
},
{
"commitId": "7c18355d8c2d946c5e1ce7a56f49653854445a1a",
"author": {
"name": "Howie Hilliker",
"email": "hhill@microsoft.com",
"date": "2014-03-28T17:05:58Z"
},
"committer": {
"name": "Howie Hilliker",
"email": "hhill@microsoft.com",
"date": "2014-03-28T17:05:58Z"
},
"comment": "Added validation logic.",
"changeCounts": {
"Edit": 1
},
"url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/commits/7c18355d8c2d946c5e1ce7a56f49653854445a1a",
"remoteUrl": "https://dev.azure.com/fabrikam/_git/Fabrikam-Fiber-Git/commit/7c18355d8c2d946c5e1ce7a56f49653854445a1a"
},
{
"commitId": "cdaeef70a358ede7b4dc7b4a089f3853f37a6d2c",
"author": {
"name": "Howie Hilliker",
"email": "hhill@microsoft.com",
"date": "2014-03-27T19:51:11Z"
},
"committer": {
"name": "Howie Hilliker",
"email": "hhill@microsoft.com",
"date": "2014-03-27T19:51:11Z"
},
"comment": "Added validation logic for zip code.",
"changeCounts": {
"Edit": 1
},
"url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/commits/cdaeef70a358ede7b4dc7b4a089f3853f37a6d2c",
"remoteUrl": "https://dev.azure.com/fabrikam/_git/Fabrikam-Fiber-Git/commit/cdaeef70a358ede7b4dc7b4a089f3853f37a6d2c"
},
{
"commitId": "ef837766c5eb3ae81a4c663d36bf95a8aed91312",
"author": {
"name": "Howie Hilliker",
"email": "hhill@microsoft.com",
"date": "2014-03-26T20:25:39Z"
},
"committer": {
"name": "Howie Hilliker",
"email": "hhill@microsoft.com",
"date": "2014-03-26T20:25:39Z"
},
"comment": "Add validation code for zip code values.",
"changeCounts": {
"Edit": 1
},
"url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/commits/ef837766c5eb3ae81a4c663d36bf95a8aed91312",
"remoteUrl": "https://dev.azure.com/fabrikam/_git/Fabrikam-Fiber-Git/commit/ef837766c5eb3ae81a4c663d36bf95a8aed91312"
},
{
"commitId": "bd73638408daff89bcdac549a5a3396c9a7ce9dd",
"author": {
"name": "Howie Hilliker",
"email": "hhill@microsoft.com",
"date": "2014-03-26T18:56:21Z"
},
"committer": {
"name": "Howie Hilliker",
"email": "hhill@microsoft.com",
"date": "2014-03-26T18:56:21Z"
},
"comment": "Added validation logic for zip code values.",
"changeCounts": {
"Edit": 1
},
"url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/commits/bd73638408daff89bcdac549a5a3396c9a7ce9dd",
"remoteUrl": "https://dev.azure.com/fabrikam/_git/Fabrikam-Fiber-Git/commit/bd73638408daff89bcdac549a5a3396c9a7ce9dd"
},
{
"commitId": "03bea1cebffa5726da0e3c0bc1487796d0dd0ee8",
"author": {
"name": "Howie Hilliker",
"email": "hhill@microsoft.com",
"date": "2014-03-26T18:42:24Z"
},
"committer": {
"name": "Howie Hilliker",
"email": "hhill@microsoft.com",
"date": "2014-03-26T18:42:24Z"
},
"comment": "Added validation logic for address values.",
"changeCounts": {
"Edit": 1
},
"url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/commits/03bea1cebffa5726da0e3c0bc1487796d0dd0ee8",
"remoteUrl": "https://dev.azure.com/fabrikam/_git/Fabrikam-Fiber-Git/commit/03bea1cebffa5726da0e3c0bc1487796d0dd0ee8"
},
{
"commitId": "c093714168cdd190c1e171a803e996d685454352",
"author": {
"name": "Howie Hilliker",
"email": "hhill@microsoft.com",
"date": "2014-03-26T18:37:32Z"
},
"committer": {
"name": "Howie Hilliker",
"email": "hhill@microsoft.com",
"date": "2014-03-26T18:37:32Z"
},
"comment": "Added validation logic for zip code values.",
"changeCounts": {
"Edit": 1
},
"url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/commits/c093714168cdd190c1e171a803e996d685454352",
"remoteUrl": "https://dev.azure.com/fabrikam/_git/Fabrikam-Fiber-Git/commit/c093714168cdd190c1e171a803e996d685454352"
},
{
"commitId": "3d203ea73427cec36b77a3a5a2e4f1f8ba7de170",
"author": {
"name": "Howie Hilliker",
"email": "hhill@microsoft.com",
"date": "2014-03-26T18:00:14Z"
},
"committer": {
"name": "Howie Hilliker",
"email": "hhill@microsoft.com",
"date": "2014-03-26T18:00:14Z"
},
"comment": "Added code.",
"changeCounts": {
"Edit": 1
},
"url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/commits/3d203ea73427cec36b77a3a5a2e4f1f8ba7de170",
"remoteUrl": "https://dev.azure.com/fabrikam/_git/Fabrikam-Fiber-Git/commit/3d203ea73427cec36b77a3a5a2e4f1f8ba7de170"
},
{
"commitId": "1eea03b2ad9f14a5e7297c1307e36c980eb910ea",
"author": {
"name": "Howie Hilliker",
"email": "hhill@microsoft.com",
"date": "2014-03-26T16:17:11Z"
},
"committer": {
"name": "Howie Hilliker",
"email": "hhill@microsoft.com",
"date": "2014-03-26T16:17:11Z"
},
"comment": "Added code.",
"changeCounts": {
"Edit": 1
},
"url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/commits/1eea03b2ad9f14a5e7297c1307e36c980eb910ea",
"remoteUrl": "https://dev.azure.com/fabrikam/_git/Fabrikam-Fiber-Git/commit/1eea03b2ad9f14a5e7297c1307e36c980eb910ea"
},
{
"commitId": "c40b5ceb9c77096b9f59e6a9193dae527bda79d9",
"author": {
"name": "Howie Hilliker",
"email": "hhill@microsoft.com",
"date": "2014-03-10T20:54:10Z"
},
"committer": {
"name": "Howie Hilliker",
"email": "hhill@microsoft.com",
"date": "2014-03-10T20:54:10Z"
},
"comment": "Added method for submitting new customer addrress.",
"changeCounts": {
"Edit": 2
},
"url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/commits/c40b5ceb9c77096b9f59e6a9193dae527bda79d9",
"remoteUrl": "https://dev.azure.com/fabrikam/_git/Fabrikam-Fiber-Git/commit/c40b5ceb9c77096b9f59e6a9193dae527bda79d9"
},
{
"commitId": "6ff5e8f6256cc58aa062dbb1e096c1e3b3435ebe",
"author": {
"name": "Howie Hilliker",
"email": "hhill@microsoft.com",
"date": "2014-03-10T20:50:08Z"
},
"committer": {
"name": "Howie Hilliker",
"email": "hhill@microsoft.com",
"date": "2014-03-10T20:50:08Z"
},
"comment": "Adding customer address module project",
"changeCounts": {
"Add": 12
},
"url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/commits/6ff5e8f6256cc58aa062dbb1e096c1e3b3435ebe",
"remoteUrl": "https://dev.azure.com/fabrikam/_git/Fabrikam-Fiber-Git/commit/6ff5e8f6256cc58aa062dbb1e096c1e3b3435ebe"
},
{
"commitId": "03b1b831e41df536d836c95e2f68a42db4f3e0db",
"author": {
"name": "Chuck Reinhart",
"email": "fabrikamfiber3@hotmail.com",
"date": "2014-02-10T21:52:47Z"
},
"committer": {
"name": "Chuck Reinhart",
"email": "fabrikamfiber3@hotmail.com",
"date": "2014-02-10T21:52:47Z"
},
"comment": "Add Hello World to TFS",
"changeCounts": {
"Add": 5
},
"url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/commits/03b1b831e41df536d836c95e2f68a42db4f3e0db",
"remoteUrl": "https://dev.azure.com/fabrikam/_git/Fabrikam-Fiber-Git/commit/03b1b831e41df536d836c95e2f68a42db4f3e0db"
}
]
}
Commits by a list of commit IDs
要求のサンプル
POST https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/commitsbatch?api-version=7.1
{
"ids": [
"23d0bc5b128a10056dc68afece360d8a0fabb014",
"fe17a84cc2dfe0ea3a2202ab4dbac0706058e41f"
]
}
応答のサンプル
{
"count": 2,
"value": [
{
"commitId": "23d0bc5b128a10056dc68afece360d8a0fabb014",
"author": {
"name": "Norman Paulk",
"email": "Fabrikamfiber16@hotmail.com",
"date": "2014-06-30T18:10:55Z"
},
"committer": {
"name": "Norman Paulk",
"email": "Fabrikamfiber16@hotmail.com",
"date": "2014-06-30T18:10:55Z"
},
"comment": "Better description for hello world",
"changeCounts": {
"Edit": 1
},
"url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/commits/23d0bc5b128a10056dc68afece360d8a0fabb014",
"remoteUrl": "https://dev.azure.com/fabrikam/_git/Fabrikam-Fiber-Git/commit/23d0bc5b128a10056dc68afece360d8a0fabb014"
},
{
"commitId": "fe17a84cc2dfe0ea3a2202ab4dbac0706058e41f",
"author": {
"name": "Norman Paulk",
"email": "Fabrikamfiber16@hotmail.com",
"date": "2014-06-30T17:51:09Z"
},
"committer": {
"name": "Norman Paulk",
"email": "Fabrikamfiber16@hotmail.com",
"date": "2014-06-30T17:51:09Z"
},
"comment": "Better description for hello world",
"changeCounts": {
"Edit": 1
},
"url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/commits/fe17a84cc2dfe0ea3a2202ab4dbac0706058e41f",
"remoteUrl": "https://dev.azure.com/fabrikam/_git/Fabrikam-Fiber-Git/commit/fe17a84cc2dfe0ea3a2202ab4dbac0706058e41f"
}
]
}
定義
| 名前 | 説明 |
|---|---|
|
Change |
|
|
Git |
|
|
Git |
Git コミットと関連付けられたメタデータを記述するプロパティを提供します。 |
|
Git |
使用する必要がある Git 履歴モード。 これは、ID が null で itemPath が指定されている場合にのみ検索条件に適用されます。 |
|
Git |
|
|
Git |
|
|
Git |
このクラスには、状態を投稿するサービス/拡張機能のメタデータが含まれています。 |
|
Git |
状態を一意に識別する状態コンテキスト。 |
|
Git |
状態の状態。 |
|
Git |
|
|
Git |
Git 操作のユーザー情報と日付。 |
|
Git |
|
|
Git |
バージョン オプション - バージョンに対して追加の修飾子を指定する (例: Previous) |
|
Git |
バージョンの種類 (ブランチ、タグ、またはコミット)。 ID の解釈方法を決定します |
|
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。 |
GitCommitRef
Git コミットと関連付けられたメタデータを記述するプロパティを提供します。
| 名前 | 型 | 説明 |
|---|---|---|
| _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 |
コミットに追加情報を関連付ける可能性があるサービスと拡張機能からの状態メタデータの一覧。 |
|
| url |
string |
このリソースの REST URL。 |
| workItems |
このコミットに関連付けられている作業項目の一覧。 |
GitHistoryMode
使用する必要がある Git 履歴モード。 これは、ID が null で itemPath が指定されている場合にのみ検索条件に適用されます。
| 値 | 説明 |
|---|---|
| firstParent |
|
| fullHistory |
|
| fullHistorySimplifyMerges |
|
| simplifiedHistory |
|
GitPushRef
| 名前 | 型 | 説明 |
|---|---|---|
| _links |
REST 参照リンクのコレクションを表すクラス。 |
|
| date |
string (date-time) |
|
| pushId |
integer (int32) |
|
| pushedBy | ||
| url |
string |
GitQueryCommitsCriteria
| 名前 | 型 | 説明 |
|---|---|---|
| $skip |
integer (int32) |
スキップするエントリの数 |
| $top |
integer (int32) |
取得するエントリの最大数 |
| author |
string |
作成者の別名または表示名 |
| compareVersion |
ItemVersion が指定されている場合にのみ適用されます。 指定された場合は、このコミットから歩く履歴を開始します。 |
|
| excludeDeletes |
boolean |
itemPath が指定されている場合にのみ適用されます。 これにより、指定したパスの削除エントリを除外するかどうかを決定します。 |
| fromCommitId |
string |
指定した場合、コミットをフィルター処理するための下限がアルファベット順に表示されます |
| fromDate |
string |
指定した場合は、この日付より後に作成された履歴エントリのみを含めます (文字列) |
| historyMode |
使用する必要がある Git 履歴モード。 これは、ID が null で itemPath が指定されている場合にのみ検索条件に適用されます。 |
|
| ids |
string[] |
指定した場合は、フェッチするコミットの正確なコミット ID を指定します。 他のパラメーターと組み合わせて使用することはできません。 |
| includeLinks |
boolean |
浅い参照に_links フィールドを含めるかどうか |
| includePushData |
boolean |
プッシュ情報を含めるかどうか |
| includeUserImageUrl |
boolean |
コミッターと作成者の画像 URL を含めるかどうか |
| includeWorkItems |
boolean |
リンクされた作業項目を含めるかどうか |
| itemPath |
string |
検索する項目のパス |
| itemVersion |
指定した場合は、検索するコミットまたはブランチを識別します |
|
| showOldestCommitsFirst |
boolean |
有効にした場合、このオプションは itemVersion パラメーターと compareVersion パラメーターを無視します |
| toCommitId |
string |
指定した場合、コミットをフィルター処理するための上限がアルファベット順に表示されます。 |
| toDate |
string |
指定した場合は、この日付より前に作成された履歴エントリのみを含めます (文字列) |
| user |
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 操作を実行しているユーザーの名前。 |
GitVersionDescriptor
| 名前 | 型 | 説明 |
|---|---|---|
| version |
string |
バージョン文字列識別子 (タグ/ブランチの名前、コミットの SHA1) |
| versionOptions |
バージョン オプション - バージョンに対して追加の修飾子を指定する (例: Previous) |
|
| versionType |
バージョンの種類 (ブランチ、タグ、またはコミット)。 ID の解釈方法を決定します |
GitVersionOptions
バージョン オプション - バージョンに対して追加の修飾子を指定する (例: Previous)
| 値 | 説明 |
|---|---|
| firstParent |
コミットの最初の親 (HEAD^) |
| none |
指定されていません |
| previousChange |
現在のバージョンより前の変更された項目をコミットする |
GitVersionType
バージョンの種類 (ブランチ、タグ、またはコミット)。 ID の解釈方法を決定します
| 値 | 説明 |
|---|---|
| branch |
バージョンをブランチ名として解釈する |
| commit |
バージョンをコミット ID (SHA1) として解釈する |
| tag |
バージョンをタグ名として解釈する |
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 |