Bagikan melalui


Items - Get

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/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

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
organization
path True

string

Nama organisasi Azure DevOps.

repositoryId
path True

string

Nama atau ID repositori.

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 item.

$format
query

string

Jika ditentukan, ini mengambil alih header permintaan PENERIMAAN HTTP untuk mengembalikan 'json' atau 'zip'. Jika $format ditentukan, maka versi api juga harus ditentukan sebagai parameter kueri.

download
query

boolean

Atur ke true untuk mengunduh respons sebagai file. Defaultnya adalah false.

includeContent
query

boolean

Atur ke true untuk menyertakan konten item saat meminta json. Defaultnya adalah false.

includeContentMetadata
query

boolean

Atur ke true untuk menyertakan metadata konten. Defaultnya adalah false.

latestProcessedChange
query

boolean

Atur ke true untuk menyertakan perubahan terbaru. Defaultnya adalah false.

recursionLevel
query

VersionControlRecursionType

Tingkat rekursi permintaan ini. Defaultnya adalah 'none', tidak ada rekursi.

resolveLfs
query

boolean

Atur ke true untuk menyelesaikan file penunjuk Git LFS untuk mengembalikan konten aktual dari Git LFS. Defaultnya adalah false.

sanitize
query

boolean

Atur ke true untuk membersihkan file svg dan mengembalikannya sebagai gambar. Hanya berguna jika diminta untuk file svg. Defaultnya adalah false.

scopePath
query

string

Cakupan jalur. Standarnya adalah null.

versionDescriptor.version
query

string

Pengidentifikasi string versi (nama tag/cabang, SHA1 penerapan)

versionDescriptor.versionOptions
query

GitVersionOptions

Opsi versi - Tentukan pengubah tambahan ke versi (misalnya Sebelumnya)

versionDescriptor.versionType
query

GitVersionType

Jenis versi (cabang, tag, atau penerapan). Menentukan bagaimana Id ditafsirkan

Respons

Nama Jenis Deskripsi
200 OK

GitItem

operasi berhasil

Media Types: "application/zip", "text/plain", "application/octet-stream", "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

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

Definisi

Nama Deskripsi
ChangeCountDictionary
FileContentMetadata
GitChange
GitCommitRef

Menyediakan properti yang menjelaskan penerapan Git dan metadata terkait.

GitItem
GitObjectType

Jenis objek (Penerapan, Pohon, Blob, Tag)

GitPushRef
GitStatus

Kelas ini berisi metadata layanan/ekstensi yang memposting status.

GitStatusContext

Konteks status yang secara unik mengidentifikasi status.

GitStatusState

Status status.

GitTemplate
GitUserDate

Info dan tanggal pengguna untuk operasi Git.

GitVersionOptions

Opsi versi - Tentukan pengubah tambahan ke versi (misalnya Sebelumnya)

GitVersionType

Jenis versi (cabang, tag, atau penerapan). Menentukan bagaimana Id ditafsirkan

IdentityRef
ItemContent
ItemContentType
ReferenceLinks

Kelas untuk mewakili kumpulan tautan referensi REST.

ResourceRef
VersionControlChangeType

Tipe perubahan yang dibuat pada item.

VersionControlRecursionType

Menentukan apakah akan menyertakan turunan (OneLevel), semua turunan (Penuh), atau Tidak Ada

ChangeCountDictionary

FileContentMetadata

Nama Jenis Deskripsi
contentType

string

encoding

integer

extension

string

fileName

string

isBinary

boolean

isImage

boolean

vsLink

string

GitChange

Nama Jenis Deskripsi
changeId

integer

ID perubahan dalam grup perubahan.

changeType

VersionControlChangeType

Tipe perubahan yang dibuat pada item.

item

string

Versi saat ini.

newContent

ItemContent

Konten item setelah perubahan.

newContentTemplate

GitTemplate

Templat Konten Baru yang akan digunakan saat mendorong perubahan baru.

originalPath

string

Jalur asli item jika berbeda dari jalur saat ini.

sourceServerItem

string

Jalur item di server.

url

string

URL untuk mengambil item.

GitCommitRef

Menyediakan properti yang menjelaskan penerapan Git dan metadata terkait.

Nama Jenis Deskripsi
_links

ReferenceLinks

Kumpulan tautan referensi REST terkait.

author

GitUserDate

Penulis penerapan.

changeCounts

ChangeCountDictionary

Jumlah jenis perubahan (pengeditan, penghapusan, dll.) yang disertakan dengan penerapan.

changes

GitChange[]

Enumerasi perubahan yang disertakan dengan penerapan.

comment

string

Komentar atau pesan penerapan.

commentTruncated

boolean

Menunjukkan apakah komentar dipotong dari pesan komentar penerapan Git lengkap.

commitId

string

ID (SHA-1) penerapan.

commitTooManyChanges

boolean

Menunjukkan bahwa penerapan berisi terlalu banyak perubahan yang akan ditampilkan

committer

GitUserDate

Committer dari penerapan.

parents

string[]

Enumerasi ID penerapan induk untuk penerapan ini.

push

GitPushRef

Dorongan yang terkait dengan penerapan ini.

remoteUrl

string

Jalur URL jarak jauh ke penerapan.

statuses

GitStatus[]

Daftar metadata status dari layanan dan ekstensi yang dapat mengaitkan informasi tambahan ke penerapan.

url

string

URL REST untuk sumber daya ini.

workItems

ResourceRef[]

Daftar lokasi kerja yang terkait dengan penerapan ini.

GitItem

Nama Jenis Deskripsi
_links

ReferenceLinks

Kelas untuk mewakili kumpulan tautan referensi REST.

commitId

string

SHA1 item penerapan diambil di

content

string

contentMetadata

FileContentMetadata

gitObjectType

GitObjectType

Jenis objek (Penerapan, Pohon, Blob, Tag, ...)

isFolder

boolean

isSymLink

boolean

latestProcessedChange

GitCommitRef

Ref dangkal untuk menerapkan yang terakhir mengubah item ini Hanya diisi jika latestProcessedChange diminta Mungkin tidak akurat jika perubahan terbaru belum di-cache

objectId

string

Id objek Git

originalObjectId

string

Id objek Git

path

string

url

string

GitObjectType

Jenis objek (Penerapan, Pohon, Blob, Tag)

Nama Jenis Deskripsi
bad

string

blob

string

commit

string

ext2

string

ofsDelta

string

refDelta

string

tag

string

tree

string

GitPushRef

Nama Jenis Deskripsi
_links

ReferenceLinks

Kelas untuk mewakili kumpulan tautan referensi REST.

date

string

pushId

integer

pushedBy

IdentityRef

url

string

GitStatus

Kelas ini berisi metadata layanan/ekstensi yang memposting status.

Nama Jenis Deskripsi
_links

ReferenceLinks

Tautan referensi.

context

GitStatusContext

Konteks status.

createdBy

IdentityRef

Identitas yang membuat status.

creationDate

string

Tanggal pembuatan dan waktu status.

description

string

Deskripsi status. Biasanya menjelaskan status status saat ini.

id

integer

Pengidentifikasi status.

state

GitStatusState

Status status.

targetUrl

string

URL dengan detail status.

updatedDate

string

Tanggal dan waktu pembaruan terakhir status.

GitStatusContext

Konteks status yang secara unik mengidentifikasi status.

Nama Jenis Deskripsi
genre

string

Genre status. Biasanya nama layanan/alat yang menghasilkan status, bisa kosong.

name

string

Pengidentifikasi nama status, tidak boleh null atau kosong.

GitStatusState

Status status.

Nama Jenis Deskripsi
error

string

Status dengan kesalahan.

failed

string

Status gagal.

notApplicable

string

Status tidak berlaku untuk objek target.

notSet

string

Status status tidak diatur. Status default.

pending

string

Status tertunda.

succeeded

string

Status berhasil.

GitTemplate

Nama Jenis Deskripsi
name

string

Nama Templat

type

string

Jenis Templat

GitUserDate

Info dan tanggal pengguna untuk operasi Git.

Nama Jenis Deskripsi
date

string

Tanggal operasi Git.

email

string

Email alamat pengguna yang melakukan operasi Git.

imageUrl

string

Url untuk avatar pengguna.

name

string

Nama pengguna yang melakukan operasi Git.

GitVersionOptions

Opsi versi - Tentukan pengubah tambahan ke versi (misalnya Sebelumnya)

Nama Jenis Deskripsi
firstParent

string

Induk pertama penerapan (HEAD^)

none

string

Tidak ditentukan

previousChange

string

Terapkan item yang diubah sebelum versi saat ini

GitVersionType

Jenis versi (cabang, tag, atau penerapan). Menentukan bagaimana Id ditafsirkan

Nama Jenis Deskripsi
branch

string

Menginterpretasikan versi sebagai nama cabang

commit

string

Menginterpretasikan versi sebagai ID penerapan (SHA1)

tag

string

Menginterpretasikan versi sebagai nama tag

IdentityRef

Nama Jenis Deskripsi
_links

ReferenceLinks

Bidang ini berisi nol atau lebih tautan menarik tentang subjek grafik. Tautan ini dapat dipanggil untuk mendapatkan hubungan tambahan atau informasi lebih rinci tentang subjek grafik ini.

descriptor

string

Deskriptor adalah cara utama untuk mereferensikan subjek grafik saat sistem berjalan. Bidang ini akan mengidentifikasi subjek grafik yang sama secara unik di seluruh Akun dan Organisasi.

directoryAlias

string

Tidak digunakan lagi - Dapat diambil dengan mengkueri pengguna Graph yang direferensikan dalam entri "mandiri" kamus IdentityRef "_links"

displayName

string

Ini adalah nama tampilan subjek grafik yang tidak unik. Untuk mengubah bidang ini, Anda harus mengubah nilainya di penyedia sumber.

id

string

imageUrl

string

Tidak digunakan lagi - Tersedia dalam entri "avatar" kamus IdentityRef "_links"

inactive

boolean

Tidak digunakan lagi - Dapat diambil dengan mengkueri status keanggotaan Graph yang direferensikan dalam entri "membershipState" kamus "_links" GraphUser

isAadIdentity

boolean

Tidak digunakan lagi - Dapat disimpulkan dari jenis subjek deskriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)

isContainer

boolean

Tidak digunakan lagi - Dapat disimpulkan dari jenis subjek deskriptor (Descriptor.IsGroupType)

isDeletedInOrigin

boolean

profileUrl

string

Tidak digunakan lagi - tidak digunakan dalam sebagian besar implementasi ToIdentityRef yang sudah ada sebelumnya

uniqueName

string

Tidak digunakan lagi - gunakan Domain+PrincipalName sebagai gantinya

url

string

Url ini adalah rute lengkap ke sumber daya sumber subjek grafik ini.

ItemContent

Nama Jenis Deskripsi
content

string

contentType

ItemContentType

ItemContentType

Nama Jenis Deskripsi
base64Encoded

string

rawText

string

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.

ResourceRef

Nama Jenis Deskripsi
id

string

url

string

VersionControlChangeType

Tipe perubahan yang dibuat pada item.

Nama Jenis Deskripsi
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

Menentukan apakah akan menyertakan turunan (OneLevel), semua turunan (Penuh), atau Tidak Ada

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.