Pushes - Get

參考

服務:: Git

API 版本:: 5.0

擷取特定的推播。

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

含選擇性參數:

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

URI 參數

名稱	位於	必要	類型	Description
organization	path	True	string	Azure DevOps 組織的名稱。
pushId	path	True	integer int32	推送的識別碼。
repositoryId	path	True	string	存放庫的名稱或識別碼。
project	path		string	專案識別碼或專案名稱
api-version	query	True	string	要使用的 API 版本。這應該設定為 '5.0' 以使用此版本的 API。
includeCommits	query		integer int32	要包含在結果中的認可數目。
includeRefUpdates	query		boolean	如果為 true，請包含推播所更新的 ref 清單。

回應

名稱	類型	Description
200 OK	GitPush	成功作業

安全性

oauth2

類型: oauth2
Flow: accessCode
授權 URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
權杖 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

範圍

名稱	Description
vso.code	授與讀取有關認可、變更集、分支和其他版本控制成品之原始程式碼和中繼資料的能力。也授與搜尋程式碼的能力，並透過服務勾點取得版本控制事件的通知。

範例

Just the push

範例要求

HTTP

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

範例回覆

狀態碼:: 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"
    }
  }
}

定義

名稱	Description
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

Object

GitChange

Object

名稱	類型	Description
changeId	integer	變更群組內的變更識別碼。
changeType	VersionControlChangeType	對專案所做的變更類型。
item	string	目前版本。
newContent	ItemContent	變更之後的專案內容。
newContentTemplate	GitTemplate	推送新變更時要使用的新內容範本。
originalPath	string	與目前路徑不同的專案原始路徑。
sourceServerItem	string	伺服器上的專案路徑。
url	string	要擷取專案的 URL。

GitCommitRef

Object

提供描述 Git 認可和相關聯中繼資料的屬性。

名稱	類型	Description
_links	ReferenceLinks	相關 REST 參考連結的集合。
author	GitUserDate	認可作者。
changeCounts	ChangeCountDictionary	認可 (編輯、刪除等) 變更類型的計數。
changes	GitChange[]	認可中包含的變更列舉。
comment	string	認可批註或訊息。
commentTruncated	boolean	指出批註是否從完整的 Git 認可批註訊息截斷。
commitId	string	認可 (SHA-1) 識別碼。
committer	GitUserDate	認可者。
parents	string[]	這個認可之父認可識別碼的列舉。
push	GitPushRef	與此認可相關聯的推送。
remoteUrl	string	認可的遠端 URL 路徑。
statuses	GitStatus[]	來自服務和延伸模組的狀態中繼資料清單，可將其他資訊與認可產生關聯。
url	string	此資源的 REST URL。
workItems	ResourceRef[]	與此認可相關聯的工作專案清單。

GitPush

Object

名稱	類型	Description
_links	ReferenceLinks	表示 REST 參考連結集合的類別。
commits	GitCommitRef[]	提供描述 Git 認可和相關聯中繼資料的屬性。
date	string
pushId	integer
pushedBy	IdentityRef
refUpdates	GitRefUpdate[]
repository	GitRepository
url	string

GitPushRef

Object

名稱	類型	Description
_links	ReferenceLinks	表示 REST 參考連結集合的類別。
date	string
pushId	integer
pushedBy	IdentityRef
url	string

GitRefUpdate

Object

名稱	類型	Description
isLocked	boolean
name	string
newObjectId	string
oldObjectId	string
repositoryId	string

GitRepository

Object

名稱	類型	Description
_links	ReferenceLinks	表示 REST 參考連結集合的類別。
defaultBranch	string
id	string
isFork	boolean	True 是表示如果儲存機制已建立為分叉
name	string
parentRepository	GitRepositoryRef
project	TeamProjectReference	表示 TeamProject 的淺層參考。
remoteUrl	string
size	integer	存放庫的壓縮大小 (位元組) 。
sshUrl	string
url	string
validRemoteUrls	string[]

GitRepositoryRef

Object

名稱	類型	Description
collection	TeamProjectCollectionReference	這個分支所在的 Team 專案集合
id	string
isFork	boolean	True 是表示如果儲存機制已建立為分叉
name	string
project	TeamProjectReference	表示 TeamProject 的淺層參考。
remoteUrl	string
sshUrl	string
url	string

GitStatus

Object

這個類別包含張貼狀態之服務/延伸模組的中繼資料。

名稱	類型	Description
_links	ReferenceLinks	參考連結。
context	GitStatusContext	狀態的內容。
createdBy	IdentityRef	建立狀態的身分識別。
creationDate	string	狀態的建立日期和時間。
description	string	狀態原因。通常描述狀態的目前狀態。
id	integer	狀態識別碼。
state	GitStatusState	狀態的狀態。
targetUrl	string	具有狀態詳細資料的 URL。
updatedDate	string	狀態的上次更新日期和時間。

GitStatusContext

Object

可唯一識別狀態的狀態內容。

名稱	類型	Description
genre	string	狀態的內容類型。通常產生狀態的服務/工具名稱可以是空的。
name	string	狀態的名稱識別碼不可以是 Null 或空白。

GitStatusState

Enumeration

狀態的狀態。

值	Description
error	發生錯誤的狀態。
failed	狀態失敗。
notApplicable	狀態不適用於目標物件。
notSet	未設定狀態。預設狀態。
pending	狀態擱置中。
succeeded	狀態成功。

GitTemplate

Object

名稱	類型	Description
name	string	範本的名稱
type	string	範本的類型

GitUserDate

Object

Git 作業的使用者資訊和日期。

名稱	類型	Description
date	string	Git 作業的日期。
email	string	執行 Git 作業的使用者Email位址。
imageUrl	string	使用者虛擬人偶的 URL。
name	string	執行 Git 作業的使用者名稱。

IdentityRef

Object

名稱	類型	Description
_links	ReferenceLinks	此欄位包含有關圖表主旨的零個或多個有趣連結。您可以叫用這些連結來取得其他關聯性，或取得此圖表主體的詳細資訊。
descriptor	string	描述項是在系統執行時參考圖形主旨的主要方式。此欄位可唯一識別帳戶和組織之間的相同圖表主旨。
directoryAlias	string
displayName	string	這是圖表主旨的非唯一顯示名稱。若要變更此欄位，您必須在來源提供者中變更其值。
id	string
imageUrl	string
inactive	boolean
isAadIdentity	boolean
isContainer	boolean
isDeletedInOrigin	boolean
profileUrl	string
uniqueName	string
url	string	此 URL 是此圖表主體來源資源的完整路由。

ItemContent

Object

名稱	類型	Description
content	string
contentType	ItemContentType

ItemContentType

Enumeration

值	Description
base64Encoded
rawText

ProjectState

Enumeration

專案狀態。

值	Description
all	不論狀態為何，所有專案。
createPending	Project 已排入佇列以供建立，但程式尚未啟動。
deleted	專案已刪除。
deleting	Project 正在刪除。
new	Project 正在建立中。
unchanged	Project 尚未變更。
wellFormed	專案已完全建立且可供使用。

ProjectVisibility

Enumeration

專案可見度。

值	Description
private	只有具有明確存取權的使用者才能看到專案。
public	所有專案都可以看到。

ReferenceLinks

Object

表示 REST 參考連結集合的類別。

名稱	類型	Description
links	object	連結的唯讀檢視。因為參考連結是唯讀的，所以我們只想要將它們公開為唯讀。

ResourceRef

Object

名稱	類型	Description
id	string
url	string

TeamProjectCollectionReference

Object

TeamProjectCollection 的參考物件。

名稱	類型	Description
id	string	集合識別碼。
name	string	集合名稱。
url	string	集合 REST URL。

TeamProjectReference

Object

表示 TeamProject 的淺層參考。

名稱	類型	Description
abbreviation	string	專案縮寫。
defaultTeamImageUrl	string	預設小組身分識別影像的 URL。
description	string	如果有任何) ，專案的描述 (。
id	string	專案識別碼。
name	string	專案名稱。
revision	integer	專案修訂。
state	ProjectState	專案狀態。
url	string	物件完整版本的 URL。
visibility	ProjectVisibility	專案可見度。

VersionControlChangeType

Enumeration

對專案所做的變更類型。

值	Description
add
all
branch
delete
edit
encoding
lock
merge
none
property
rename
rollback
sourceRename
targetRename
undelete

共用方式為

Pushes - Get

URI 參數

回應

安全性

oauth2

範圍

範例

Just the push

範例要求

範例回覆

定義

ChangeCountDictionary

GitChange

GitCommitRef

GitPush

GitPushRef

GitRefUpdate

GitRepository

GitRepositoryRef

GitStatus

GitStatusContext

GitStatusState

GitTemplate

GitUserDate

IdentityRef

ItemContent

ItemContentType

ProjectState

ProjectVisibility

ReferenceLinks

ResourceRef

TeamProjectCollectionReference

TeamProjectReference

VersionControlChangeType