Items - Get

Service:

Tfvc

API Version:

7.1-preview.1

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

GET https://dev.azure.com/{organization}/{project}/_apis/tfvc/items?path={path}&api-version=7.1-preview.1

With optional parameters:

GET https://dev.azure.com/{organization}/{project}/_apis/tfvc/items?path={path}&fileName={fileName}&download={download}&scopePath={scopePath}&recursionLevel={recursionLevel}&versionDescriptor.version={versionDescriptor.version}&versionDescriptor.versionOption={versionDescriptor.versionOption}&versionDescriptor.versionType={versionDescriptor.versionType}&includeContent={includeContent}&api-version=7.1-preview.1

URI 參數

名稱	位於	必要	類型	Description
organization	path	True	string	Azure DevOps 組織的名稱。
project	path		string	專案識別碼或專案名稱
api-version	query	True	string	要使用的 API 版本。 這應該設定為 '7.1-preview.1' 以使用此版本的 API。
path	query	True	string	要傳回之個別專案的版本控制路徑。
download	query		boolean	如果為 true，請建立可下載的附件。
fileName	query		string	傳回專案的檔案名。
includeContent	query		boolean	設定為 true，以在要求 json 時包含專案內容。 預設值為 false。
recursionLevel	query		VersionControlRecursionType	無 (只) 或 OneLevel (資料夾) 的內容。
scopePath	query		string	要傳回多個專案的資料夾版本控制路徑。
versionDescriptor.version	query		string	版本物件。
versionDescriptor.versionOption	query		TfvcVersionOption	版本描述元。 預設為 Null。
versionDescriptor.versionType	query		TfvcVersionType	版本描述元。 預設為 Null。

回應

名稱	類型	Description
200 OK	TfvcItem	成功作業 Media Types: "text/plain", "application/octet-stream", "application/zip", "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	授與讀取有關認可、變更集、分支和其他版本控制成品之原始程式碼和中繼資料的能力。 也授與搜尋程式碼的能力，並透過服務勾點取得版本控制事件的通知。

範例

GET item metadata and/or content for a single item.

Sample Request

HTTP

GET https://dev.azure.com/{organization}/_apis/tfvc/items?path=$/MyFirstProject/ExampleFolder/TestFile01.txt&api-version=7.1-preview.1

Sample Response

Status code:

200

{
  "version": 10,
  "changeDate": "2019-05-29T18:00:23.457Z",
  "size": 4,
  "hashValue": "CY9rzUYh03PK3k6DJie09g==",
  "encoding": 65001,
  "path": "$/MyFirstProject/ExampleFolder/TestFile01.txt",
  "contentMetadata": {
    "encoding": 65001,
    "contentType": "text/plain",
    "fileName": "TestFile01.txt",
    "extension": ".txt",
    "vsLink": "vsweb://vs/?Product=Visual_Studio&Gen=2013&EncFormat=UTF8&tfslink=dnN0ZnM6Ly8vVmVyc2lvbkNvbnRyb2wvTGF1bmNoTGF0ZXN0VmVyc2lvbmVkSXRlbS8lMjQlMmZNeUZpcnN0UHJvamVjdCUyZkV4YW1wbGVGb2xkZXIlMmZUZXN0RmlsZTAxLnR4dD9wcm9qZWN0PTg3NDQ2MjJkLTdmMGUtNDZlZi04ZjViLWUxNzk2MjNhNGI1YyZ1cmw9aHR0cHMlM0ElMkYlMkZjb2RlZGV2Lm1zJTJGa2V2aW5tY3B6NDIwJTJG"
  },
  "url": "https://codedev.ms/fabrikam/_apis/tfvc/items/$/MyFirstProject/ExampleFolder/TestFile01.txt?versionType=Latest&versionOptions=None",
  "_links": {
    "self": {
      "href": "https://codedev.ms/fabrikam/_apis/tfvc/items/$/MyFirstProject/ExampleFolder/TestFile01.txt?versionType=Changeset&version=10"
    }
  }
}

定義

名稱	Description
FileContentMetadata
ReferenceLinks	表示 REST 參考連結集合的類別。
TfvcItem	專案的中繼資料。
TfvcVersionOption	預設值為 [無]。
TfvcVersionType	預設為 [最新]。
VersionControlRecursionType	預設為 OneLevel。

FileContentMetadata

名稱	類型	Description
contentType	string
encoding	integer
extension	string
fileName	string
isBinary	boolean
isImage	boolean
vsLink	string

ReferenceLinks

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

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

TfvcItem

專案的中繼資料。

名稱	類型	Description
_links	ReferenceLinks	表示 REST 參考連結集合的類別。
changeDate	string	專案變更日期時間。
content	string
contentMetadata	FileContentMetadata
deletionId	integer	如果刪除專案，則大於 0。
encoding	integer	從資料庫進行檔案編碼，-1 代表二進位。
hashValue	string	MD5 雜湊作為基底 64 字串，僅適用于檔案。
isBranch	boolean	如果專案是分支，則為 True。
isFolder	boolean
isPendingChange	boolean	如果變更擱置中，則為 True。
isSymLink	boolean
path	string
size	integer	如果適用，則為檔案的大小。
url	string
version	integer	變更集版本識別碼。

TfvcVersionOption

預設值為 [無]。

名稱	類型	Description
none	string	無。
previous	string	傳回舊版。
useRename	string	只有 versiontype MergeSource 和整數版本才能使用，請使用 RenameSource 識別碼，而不是合併識別碼。

TfvcVersionType

預設為 [最新]。

名稱	類型	Description
change	string	版本會被視為變更。
changeset	string	版本會被視為 ChangesetId。
date	string	版本會被視為日期。
latest	string	如果已定義 Version 的最新版本，則如果未定義任何版本，則會使用最新的 ChangesetId。
mergeSource	string	版本將會被視為 MergeSource。
none	string	版本會被視為 ChangesetId。
shelveset	string	版本會被視為擱置集名稱和擁有者。
tip	string	若未定義最新版本，版本將會被視為提示。

VersionControlRecursionType

預設為 OneLevel。

名稱	類型	Description
full	string	傳回指定的專案和所有子代
none	string	只傳回指定的專案。
oneLevel	string	傳回指定的專案及其直接子系。
oneLevelPlusNestedEmptyFolders	string	傳回指定的專案及其直接子系，以及只包含單一資料夾的巢狀子資料夾遞迴鏈結。