Commits - Get Commits Batch
擷取符合搜尋準則的專案 Git 認可
POST https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/commitsbatch?api-version=7.1-preview.1
POST https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/commitsbatch?$skip={$skip}&$top={$top}&includeStatuses={includeStatuses}&api-version=7.1-preview.1
URI 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
organization
|
path | True |
string |
Azure DevOps 組織的名稱。 |
repository
|
path | True |
string |
存放庫的名稱或標識碼。 |
project
|
path |
string |
項目識別碼或項目名稱 |
|
api-version
|
query | True |
string |
要使用的 API 版本。 這應該設定為 『7.1-preview.1』 以使用此版本的 API。 |
$skip
|
query |
integer int32 |
要略過的認可數目。 此值不能超過 3,000,000。 |
|
$top
|
query |
integer int32 |
要傳回的認可數目上限。 此值不能超過 50,000。 |
|
include
|
query |
boolean |
True 是表示 包含其他認可狀態資訊。 |
要求本文
名稱 | 類型 | Description |
---|---|---|
$skip |
integer |
要略過的項目數目 |
$top |
integer |
要擷取的項目數目上限 |
author |
string |
作者的別名或顯示名稱 |
compareVersion |
僅適用於指定 ItemVersion 時。 如果提供,請從此認可開始開始進行逐步記錄。 |
|
excludeDeletes |
boolean |
只有在指定 itemPath 時才適用。 這會決定是否要排除指定路徑的刪除專案。 |
fromCommitId |
string |
如果提供,篩選的下限會依字母順序認可 |
fromDate |
string |
如果提供,請只包含在此日期之後建立的歷程記錄專案, (字串) |
historyMode |
應使用 Git 歷程記錄模式。 這隻適用於 Ids = null 且指定 itemPath 時的搜尋準則。 |
|
ids |
string[] |
如果提供,請指定要擷取之認可的完整認可標識碼。 可能不會與其他參數結合。 |
includeLinks |
boolean |
是否要在淺層參考中包含_links欄位 |
includePushData |
boolean |
是否要包含推播資訊 |
includeUserImageUrl |
boolean |
是否要包含認可者和作者的影像URL |
includeWorkItems |
boolean |
是否要包含連結的工作專案 |
itemPath |
string |
要搜尋的項目路徑 |
itemVersion |
如果提供,則會識別要搜尋的認可或分支 |
|
showOldestCommitsFirst |
boolean |
如果啟用,此選項將會忽略 itemVersion 和 compareVersion 參數 |
toCommitId |
string |
如果提供,篩選的上限會依字母順序認可 |
toDate |
string |
如果提供,請只包含在此日期之前建立的歷程記錄專案, (字串) |
user |
string |
認可者的別名或顯示名稱 |
回應
名稱 | 類型 | Description |
---|---|---|
200 OK |
成功的作業 |
安全性
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
名稱 | Description |
---|---|
vso.code | 授與讀取認可、變更集、分支和其他版本控制成品之原始程式碼和元數據的能力。 也授與搜尋程式代碼的能力,並透過服務勾點取得版本控制事件的通知。 |
範例
Commits between two versions |
Commits by a list of commit IDs |
Commits between two versions
Sample Request
POST https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/commitsbatch?api-version=7.1-preview.1
{
"itemVersion": {
"versionType": "branch",
"version": "develop"
},
"compareVersion": {
"versionType": "branch",
"version": "master"
}
}
Sample Response
{
"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
Sample Request
POST https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/commitsbatch?api-version=7.1-preview.1
{
"ids": [
"23d0bc5b128a10056dc68afece360d8a0fabb014",
"fe17a84cc2dfe0ea3a2202ab4dbac0706058e41f"
]
}
Sample Response
{
"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"
}
]
}
定義
名稱 | Description |
---|---|
Change |
|
Git |
|
Git |
提供描述 Git 認可和相關聯元數據的屬性。 |
Git |
應使用 Git 歷程記錄模式。 這隻適用於 Ids = null 且指定 itemPath 時的搜尋準則。 |
Git |
|
Git |
|
Git |
這個類別包含張貼狀態之服務/延伸模組的元數據。 |
Git |
可唯一識別狀態的狀態內容。 |
Git |
狀態的狀態。 |
Git |
|
Git |
Git 作業的使用者資訊和日期。 |
Git |
|
Git |
版本選項 - 指定版本 (的其他修飾詞,例如上一個) |
Git |
版本類型 (分支、標記或認可) 。 決定如何解譯標識碼 |
Identity |
|
Item |
|
Item |
|
Reference |
表示 REST 參考連結集合的類別。 |
Resource |
|
Version |
對專案所做的變更類型。 |
ChangeCountDictionary
GitChange
名稱 | 類型 | Description |
---|---|---|
changeId |
integer |
變更群組內的變更標識碼。 |
changeType |
對專案所做的變更類型。 |
|
item |
string |
目前版本。 |
newContent |
變更之後的項目內容。 |
|
newContentTemplate |
推送新變更時要使用的新內容範本。 |
|
originalPath |
string |
與目前路徑不同的專案原始路徑。 |
sourceServerItem |
string |
伺服器上的項目路徑。 |
url |
string |
要擷取專案的URL。 |
GitCommitRef
提供描述 Git 認可和相關聯元數據的屬性。
名稱 | 類型 | Description |
---|---|---|
_links |
相關 REST 參考連結的集合。 |
|
author |
認可作者。 |
|
changeCounts |
認可 (編輯、刪除等 ) 變更類型的計數。 |
|
changes |
認可中包含的變更列舉。 |
|
comment |
string |
認可批註或訊息。 |
commentTruncated |
boolean |
指出批註是否從完整的 Git 認可批注訊息截斷。 |
commitId |
string |
認可 (SHA-1) 標識符。 |
commitTooManyChanges |
boolean |
表示認可包含太多變更無法顯示 |
committer |
認可者。 |
|
parents |
string[] |
這個認可之父認可標識碼的列舉。 |
push |
與此認可相關聯的推送。 |
|
remoteUrl |
string |
認可的遠端 URL 路徑。 |
statuses |
來自服務和延伸模塊的狀態元數據清單,可將其他資訊與認可產生關聯。 |
|
url |
string |
此資源的 REST URL。 |
workItems |
與此認可相關聯的工作項目清單。 |
GitHistoryMode
應使用 Git 歷程記錄模式。 這隻適用於 Ids = null 且指定 itemPath 時的搜尋準則。
名稱 | 類型 | Description |
---|---|---|
firstParent |
string |
所使用的歷程記錄模式 |
fullHistory |
string |
所使用的歷程記錄模式 |
fullHistorySimplifyMerges |
string |
所使用的歷程記錄模式 |
simplifiedHistory |
string |
所使用的 |
GitPushRef
名稱 | 類型 | Description |
---|---|---|
_links |
表示 REST 參考連結集合的類別。 |
|
date |
string |
|
pushId |
integer |
|
pushedBy | ||
url |
string |
GitQueryCommitsCriteria
名稱 | 類型 | Description |
---|---|---|
$skip |
integer |
要略過的項目數目 |
$top |
integer |
要擷取的項目數目上限 |
author |
string |
作者的別名或顯示名稱 |
compareVersion |
僅適用於指定 ItemVersion 時。 如果提供,請從此認可開始開始進行逐步記錄。 |
|
excludeDeletes |
boolean |
只有在指定 itemPath 時才適用。 這會決定是否要排除指定路徑的刪除專案。 |
fromCommitId |
string |
如果提供,篩選的下限會依字母順序認可 |
fromDate |
string |
如果提供,請只包含在此日期之後建立的歷程記錄專案, (字串) |
historyMode |
應使用 Git 歷程記錄模式。 這隻適用於 Ids = null 且指定 itemPath 時的搜尋準則。 |
|
ids |
string[] |
如果提供,請指定要擷取之認可的完整認可標識碼。 可能不會與其他參數結合。 |
includeLinks |
boolean |
是否要在淺層參考中包含_links欄位 |
includePushData |
boolean |
是否要包含推播資訊 |
includeUserImageUrl |
boolean |
是否要包含認可者和作者的影像URL |
includeWorkItems |
boolean |
是否要包含連結的工作專案 |
itemPath |
string |
要搜尋的項目路徑 |
itemVersion |
如果提供,則會識別要搜尋的認可或分支 |
|
showOldestCommitsFirst |
boolean |
如果啟用,此選項將會忽略 itemVersion 和 compareVersion 參數 |
toCommitId |
string |
如果提供,篩選的上限會依字母順序認可 |
toDate |
string |
如果提供,請只包含在此日期之前建立的歷程記錄專案, (字串) |
user |
string |
認可者的別名或顯示名稱 |
GitStatus
這個類別包含張貼狀態之服務/延伸模組的元數據。
名稱 | 類型 | Description |
---|---|---|
_links |
參考連結。 |
|
context |
狀態的內容。 |
|
createdBy |
建立狀態的身分識別。 |
|
creationDate |
string |
狀態的建立日期和時間。 |
description |
string |
狀態描述。 通常描述狀態的目前狀態。 |
id |
integer |
狀態標識碼。 |
state |
狀態的狀態。 |
|
targetUrl |
string |
具有狀態詳細數據的 URL。 |
updatedDate |
string |
狀態的上次更新日期和時間。 |
GitStatusContext
可唯一識別狀態的狀態內容。
名稱 | 類型 | Description |
---|---|---|
genre |
string |
狀態的內容類型。 通常產生狀態的服務/工具名稱可以是空的。 |
name |
string |
狀態的名稱識別碼不可以是 Null 或空白。 |
GitStatusState
狀態的狀態。
名稱 | 類型 | Description |
---|---|---|
error |
string |
發生錯誤的狀態。 |
failed |
string |
狀態失敗。 |
notApplicable |
string |
狀態不適用於目標物件。 |
notSet |
string |
未設定狀態。 默認狀態。 |
pending |
string |
狀態擱置中。 |
succeeded |
string |
狀態成功。 |
GitTemplate
名稱 | 類型 | Description |
---|---|---|
name |
string |
範本的名稱 |
type |
string |
範本的類型 |
GitUserDate
Git 作業的使用者資訊和日期。
名稱 | 類型 | Description |
---|---|---|
date |
string |
Git 作業的日期。 |
string |
執行 Git 作業的使用者 Email 位址。 |
|
imageUrl |
string |
用戶虛擬人偶的 URL。 |
name |
string |
執行 Git 作業的用戶名稱。 |
GitVersionDescriptor
名稱 | 類型 | Description |
---|---|---|
version |
string |
版本字串標識碼 (標記/分支的名稱、認可) 的 SHA1 |
versionOptions |
版本選項 - 指定版本 (的其他修飾詞,例如上一個) |
|
versionType |
版本類型 (分支、標記或認可) 。 決定如何解譯標識碼 |
GitVersionOptions
版本選項 - 指定版本 (的其他修飾詞,例如上一個)
名稱 | 類型 | Description |
---|---|---|
firstParent |
string |
認可的第一個父代 (HEAD^) |
none |
string |
未指定 |
previousChange |
string |
認可在目前版本之前變更的專案 |
GitVersionType
版本類型 (分支、標記或認可) 。 決定如何解譯標識碼
名稱 | 類型 | Description |
---|---|---|
branch |
string |
將版本解譯為分支名稱 |
commit |
string |
將版本解譯為SHA1 (認可標識碼) |
tag |
string |
將版本解譯為標籤名稱 |
IdentityRef
名稱 | 類型 | Description |
---|---|---|
_links |
此欄位包含有關圖表主旨的零個或多個有趣連結。 您可以叫用這些連結來取得其他關聯性,或取得此圖表主體的詳細資訊。 |
|
descriptor |
string |
描述項是在系統執行時參考圖形主旨的主要方式。 此欄位可唯一識別帳戶和組織之間的相同圖表主旨。 |
directoryAlias |
string |
已淘汰 - 藉由查詢 IdentityRef “_links” 字典之 “self” 項目中參考的 Graph 使用者,即可擷取 |
displayName |
string |
這是圖表主旨的非唯一顯示名稱。 若要變更此欄位,您必須在來源提供者中變更其值。 |
id |
string |
|
imageUrl |
string |
已淘汰 - 可在 IdentityRef “_links” 字典的 “avatar” 專案中使用 |
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
名稱 | 類型 | Description |
---|---|---|
content |
string |
|
contentType |
ItemContentType
名稱 | 類型 | Description |
---|---|---|
base64Encoded |
string |
|
rawText |
string |
ReferenceLinks
表示 REST 參考連結集合的類別。
名稱 | 類型 | Description |
---|---|---|
links |
object |
連結的只讀檢視。 因為參考連結是只讀的,所以我們只想要將它們公開為只讀。 |
ResourceRef
名稱 | 類型 | Description |
---|---|---|
id |
string |
|
url |
string |
VersionControlChangeType
對專案所做的變更類型。
名稱 | 類型 | Description |
---|---|---|
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 |
意見反應
https://aka.ms/ContentUserFeedback。
即將登場:在 2024 年,我們將逐步淘汰 GitHub 問題作為內容的意見反應機制,並將它取代為新的意見反應系統。 如需詳細資訊,請參閱:提交並檢視相關的意見反應