Items - Get

Service:

Tfvc

API Version:

7.1-preview.1

Dapatkan Metadata Item dan/atau Konten untuk satu item. Parameter unduhan adalah untuk menunjukkan apakah konten harus tersedia sebagai unduhan atau hanya dikirim sebagai aliran dalam respons. Tidak berlaku untuk konten zip yang selalu dikembalikan sebagai unduhan.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
organization	path	True	string	Nama organisasi Azure DevOps.
project	path		string	ID proyek atau nama proyek
api-version	query	True	string	Versi API yang akan digunakan. Ini harus diatur ke '7.1-preview.1' untuk menggunakan versi api ini.
path	query	True	string	Jalur kontrol versi item individual yang akan dikembalikan.
download	query		boolean	Jika true, buat lampiran yang dapat diunduh.
fileName	query		string	nama file item yang dikembalikan.
includeContent	query		boolean	Atur ke true untuk menyertakan konten item saat meminta json. Defaultnya adalah false.
recursionLevel	query		VersionControlRecursionType	Tidak ada (hanya item), atau OneLevel (konten folder).
scopePath	query		string	Jalur kontrol versi folder untuk mengembalikan beberapa item.
versionDescriptor.version	query		string	Objek versi.
versionDescriptor.versionOption	query		TfvcVersionOption	Pendeskripsi versi. Defaultnya adalah null.
versionDescriptor.versionType	query		TfvcVersionType	Pendeskripsi versi. Defaultnya adalah null.

Respons

Nama	Jenis	Deskripsi
200 OK	TfvcItem	operasi berhasil Media Types: "text/plain", "application/octet-stream", "application/zip", "application/json"

Keamanan

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

Nama	Deskripsi
vso.code	Memberikan kemampuan untuk membaca kode sumber dan metadata tentang penerapan, set perubahan, cabang, dan artefak kontrol versi lainnya. Juga memberikan kemampuan untuk mencari kode dan mendapatkan pemberitahuan tentang peristiwa kontrol versi melalui hook layanan.

Contoh

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"
    }
  }
}

Definisi

Nama	Deskripsi
FileContentMetadata
ReferenceLinks	Kelas untuk mewakili kumpulan tautan referensi REST.
TfvcItem	Metadata untuk item.
TfvcVersionOption	Default ke Tidak Ada.
TfvcVersionType	Default ke Terbaru.
VersionControlRecursionType	Default ke OneLevel.

FileContentMetadata

Nama	Jenis	Deskripsi
contentType	string
encoding	integer
extension	string
fileName	string
isBinary	boolean
isImage	boolean
vsLink	string

ReferenceLinks

Kelas untuk mewakili kumpulan tautan referensi REST.

Nama	Jenis	Deskripsi
links	object	Tampilan baca-saja dari tautan. Karena tautan Referensi dibaca saja, kami hanya ingin mengeksposnya sebagai baca-saja.

TfvcItem

Metadata untuk item.

Nama	Jenis	Deskripsi
_links	ReferenceLinks	Kelas untuk mewakili kumpulan tautan referensi REST.
changeDate	string	Item mengubah tanggalwaktu.
content	string
contentMetadata	FileContentMetadata
deletionId	integer	Lebih besar dari 0 jika item dihapus.
encoding	integer	Pengodean file dari database, -1 mewakili biner.
hashValue	string	Hash MD5 sebagai string dasar 64, hanya berlaku untuk file.
isBranch	boolean	Benar jika item adalah cabang.
isFolder	boolean
isPendingChange	boolean	True jika ada perubahan yang tertunda.
isSymLink	boolean
path	string
size	integer	Ukuran file, jika berlaku.
url	string
version	integer	Id versi changeset.

TfvcVersionOption

Default ke Tidak Ada.

Nama	Jenis	Deskripsi
none	string	Tidak ada.
previous	string	Mengembalikan versi sebelumnya.
useRename	string	Hanya dapat digunakan dengan versitipe MergeSource dan versi bilangan bulat, menggunakan pengidentifikasi RenameSource alih-alih Pengidentifikasi penggabungan.

TfvcVersionType

Default ke Terbaru.

Nama	Jenis	Deskripsi
change	string	Versi diperlakukan sebagai Perubahan.
changeset	string	Versi diperlakukan sebagai ChangesetId.
date	string	Versi diperlakukan sebagai Tanggal.
latest	string	Jika Versi ditentukan, Versi Terbaru dari Versi tersebut akan digunakan, jika tidak ada versi yang ditentukan, ChangesetId terbaru akan digunakan.
mergeSource	string	Versi akan diperlakukan sebagai MergeSource.
none	string	Versi diperlakukan sebagai ChangesetId.
shelveset	string	Versi diperlakukan sebagai nama dan pemilik Shelveset.
tip	string	Versi akan diperlakukan sebagai Tip, jika tidak ada versi yang ditentukan terbaru yang akan digunakan.

VersionControlRecursionType

Default ke OneLevel.

Nama	Jenis	Deskripsi
full	string	Mengembalikan item yang ditentukan dan semua turunan
none	string	Hanya mengembalikan item yang ditentukan.
oneLevel	string	Mengembalikan item yang ditentukan dan turunan langsungnya.
oneLevelPlusNestedEmptyFolders	string	Mengembalikan item yang ditentukan dan turunan langsungnya, serta rantai rekursif folder anak berlapis yang hanya berisi satu folder.