共用方式為


Items - Get

取得單一專案的專案中繼資料和/或內容。 下載參數是指出內容是否應該以下載的形式提供,或只是以回應中的資料流程的形式傳送。 不適用於壓縮的內容,一律會以下載的形式傳回。

GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/items?path={path}&api-version=7.1-preview.1
GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/items?path={path}&scopePath={scopePath}&recursionLevel={recursionLevel}&includeContentMetadata={includeContentMetadata}&latestProcessedChange={latestProcessedChange}&download={download}&$format={$format}&versionDescriptor.version={versionDescriptor.version}&versionDescriptor.versionOptions={versionDescriptor.versionOptions}&versionDescriptor.versionType={versionDescriptor.versionType}&includeContent={includeContent}&resolveLfs={resolveLfs}&sanitize={sanitize}&api-version=7.1-preview.1

URI 參數

名稱 位於 必要 類型 Description
organization
path True

string

Azure DevOps 組織的名稱。

repositoryId
path True

string

存放庫的名稱或識別碼。

project
path

string

專案識別碼或專案名稱

api-version
query True

string

要使用的 API 版本。 這應該設定為 '7.1-preview.1' 以使用此版本的 API。

path
query True

string

專案路徑。

$format
query

string

如果指定,這會覆寫 HTTP Accept 要求標頭,以傳回 'json' 或 'zip'。 如果指定$format,則 api-version 也應該指定為查詢參數。

download
query

boolean

設定為 true,以將回應下載為檔案。 預設值為 false。

includeContent
query

boolean

設定為 true,以在要求 json 時包含專案內容。 預設值為 false。

includeContentMetadata
query

boolean

設定為 true 以包含內容中繼資料。 預設值為 false。

latestProcessedChange
query

boolean

設定為 true 以包含最新的變更。 預設值為 false。

recursionLevel
query

VersionControlRecursionType

此要求的遞迴層級。 預設值為 'none',沒有遞迴。

resolveLfs
query

boolean

設定為 true 以解析 Git LFS 指標檔案,以從 Git LFS 傳回實際內容。 預設值為 false。

sanitize
query

boolean

設定為 true 以清理 svg 檔案,並將其傳回為影像。 只有在要求 svg 檔案時才有用。 預設值為 false。

scopePath
query

string

路徑範圍。 預設值是 null。

versionDescriptor.version
query

string

版本字串識別碼 (標記/分支的名稱、認可) 的 SHA1

versionDescriptor.versionOptions
query

GitVersionOptions

版本選項 - 指定版本 (的其他修飾詞,例如上一個)

versionDescriptor.versionType
query

GitVersionType

版本類型 (分支、標記或認可) 。 決定如何解譯識別碼

回應

名稱 類型 Description
200 OK

GitItem

成功作業

Media Types: "application/zip", "text/plain", "application/octet-stream", "application/json"

安全性

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 授與讀取有關認可、變更集、分支和其他版本控制成品之原始程式碼和中繼資料的能力。 也授與搜尋程式碼的能力,並透過服務勾點取得版本控制事件的通知。

範例

Download
Get metadata

Download

Sample Request

GET https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/items?scopePath=/MyWebSite/MyWebSite/Views/Home/_Home.cshtml&download=true&api-version=7.1-preview.1

Sample Response

{
  "count": 1,
  "value": [
    {
      "objectId": "61a86fdaa79e5c6f5fb6e4026508489feb6ed92c",
      "gitObjectType": "blob",
      "commitId": "23d0bc5b128a10056dc68afece360d8a0fabb014",
      "path": "/MyWebSite/MyWebSite/Views/Home/_Home.cshtml",
      "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/items/MyWebSite/MyWebSite/Views/Home/_Home.cshtml?versionType=Branch&versionOptions=None"
    }
  ]
}

Get metadata

Sample Request

GET https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/items?scopePath=/MyWebSite/MyWebSite/Views/Home/_Home.cshtml&api-version=7.1-preview.1

Sample Response

{
  "count": 1,
  "value": [
    {
      "objectId": "61a86fdaa79e5c6f5fb6e4026508489feb6ed92c",
      "gitObjectType": "blob",
      "commitId": "23d0bc5b128a10056dc68afece360d8a0fabb014",
      "path": "/MyWebSite/MyWebSite/Views/Home/_Home.cshtml",
      "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/items/MyWebSite/MyWebSite/Views/Home/_Home.cshtml?versionType=Branch&versionOptions=None"
    }
  ]
}

定義

名稱 Description
ChangeCountDictionary
FileContentMetadata
GitChange
GitCommitRef

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

GitItem
GitObjectType

物件類型 (Commit、Tree、Blob、Tag)

GitPushRef
GitStatus

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

GitStatusContext

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

GitStatusState

狀態的狀態。

GitTemplate
GitUserDate

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

GitVersionOptions

版本選項 - 指定版本 (的其他修飾詞,例如上一個)

GitVersionType

版本類型 (分支、標記或認可) 。 決定如何解譯識別碼

IdentityRef
ItemContent
ItemContentType
ReferenceLinks

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

ResourceRef
VersionControlChangeType

對專案所做的變更類型。

VersionControlRecursionType

指定是否要包含 OneLevel) (子系、所有子系 (Full) 或 None

ChangeCountDictionary

FileContentMetadata

名稱 類型 Description
contentType

string

encoding

integer

extension

string

fileName

string

isBinary

boolean

isImage

boolean

vsLink

string

GitChange

名稱 類型 Description
changeId

integer

變更群組內的變更識別碼。

changeType

VersionControlChangeType

對專案所做的變更類型。

item

string

目前版本。

newContent

ItemContent

變更之後的專案內容。

newContentTemplate

GitTemplate

推送新變更時要使用的新內容範本。

originalPath

string

與目前路徑不同的專案原始路徑。

sourceServerItem

string

伺服器上的專案路徑。

url

string

要擷取專案的 URL。

GitCommitRef

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

名稱 類型 Description
_links

ReferenceLinks

相關 REST 參考連結的集合。

author

GitUserDate

認可作者。

changeCounts

ChangeCountDictionary

認可隨附的變更類型 (編輯、刪除等) 計數。

changes

GitChange[]

認可中包含的變更列舉。

comment

string

認可批註或訊息。

commentTruncated

boolean

指出批註是否從完整的 Git 認可批註訊息截斷。

commitId

string

認可 (SHA-1 識別碼) 。

commitTooManyChanges

boolean

表示認可包含太多變更無法顯示

committer

GitUserDate

認可者。

parents

string[]

這個認可之父認可識別碼的列舉。

push

GitPushRef

與此認可相關聯的推送。

remoteUrl

string

認可遠端 URL 路徑。

statuses

GitStatus[]

服務與延伸模組的狀態中繼資料清單,可將其他資訊與認可產生關聯。

url

string

此資源的 REST URL。

workItems

ResourceRef[]

與此認可相關聯的工作專案清單。

GitItem

名稱 類型 Description
_links

ReferenceLinks

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

commitId

string

已擷取認可專案的 SHA1

content

string

contentMetadata

FileContentMetadata

gitObjectType

GitObjectType

物件類型 (Commit、Tree、Blob、Tag、...)

isFolder

boolean

isSymLink

boolean

latestProcessedChange

GitCommitRef

淺層 ref 認可上次變更此專案只有在要求 latestProcessedChange 時才會填入,如果尚未快取最新的變更,可能不正確

objectId

string

Git 物件識別碼

originalObjectId

string

Git 物件識別碼

path

string

url

string

GitObjectType

物件類型 (Commit、Tree、Blob、Tag)

名稱 類型 Description
bad

string

blob

string

commit

string

ext2

string

ofsDelta

string

refDelta

string

tag

string

tree

string

GitPushRef

名稱 類型 Description
_links

ReferenceLinks

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

date

string

pushId

integer

pushedBy

IdentityRef

url

string

GitStatus

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

名稱 類型 Description
_links

ReferenceLinks

參考連結。

context

GitStatusContext

狀態的內容。

createdBy

IdentityRef

建立狀態的身分識別。

creationDate

string

建立狀態的日期和時間。

description

string

狀態原因。 通常描述狀態的目前狀態。

id

integer

狀態識別碼。

state

GitStatusState

狀態的狀態。

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 作業的日期。

email

string

執行 Git 作業的使用者Email位址。

imageUrl

string

使用者的虛擬人偶 URL。

name

string

執行 Git 作業的使用者名稱。

GitVersionOptions

版本選項 - 指定版本 (的其他修飾詞,例如上一個)

名稱 類型 Description
firstParent

string

認可的第一個父代 (HEAD^)

none

string

未指定

previousChange

string

認可目前版本之前已變更的專案

GitVersionType

版本類型 (分支、標記或認可) 。 決定如何解譯識別碼

名稱 類型 Description
branch

string

將版本解譯為分支名稱

commit

string

將版本解譯為 SHA1 (認可識別碼)

tag

string

將版本解譯為標籤名稱

IdentityRef

名稱 類型 Description
_links

ReferenceLinks

此欄位包含圖表主旨的相關零或更多有趣連結。 您可以叫用這些連結來取得其他關聯性,或取得此圖表主體的詳細資訊。

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

已被取代 - 可以從描述元的主旨類型推斷 (描述元.IsAadUserType/Descriptor.IsAadGroupType)

isContainer

boolean

已被取代 - 可以從描述元的主旨類型推斷 (描述元.IsGroupType)

isDeletedInOrigin

boolean

profileUrl

string

已被取代 - 不在 ToIdentityRef 的大部分預先存在實作中使用

uniqueName

string

已被取代 - 請改用 Domain+PrincipalName

url

string

此 URL 是此圖形主體來源資源的完整路由。

ItemContent

名稱 類型 Description
content

string

contentType

ItemContentType

ItemContentType

名稱 類型 Description
base64Encoded

string

rawText

string

表示 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

VersionControlRecursionType

指定是否要包含 OneLevel) (子系、所有子系 (Full) 或 None

名稱 類型 Description
full

string

傳回指定的專案和所有子代

none

string

只傳回指定的專案。

oneLevel

string

傳回指定的專案及其直接子系。

oneLevelPlusNestedEmptyFolders

string

傳回指定的專案及其直接子系,以及只包含單一資料夾的巢狀子資料夾遞迴鏈結。