Items - Get

Service:

Git

API Version:

7.1-preview.1

Tek bir öğe için Öğe Meta Verileri ve/veya İçerik alma. İndirme parametresi, içeriğin indirme olarak mı yoksa yalnızca yanıtta akış olarak mı gönderileceğini belirtmektir. Her zaman indirme olarak döndürülen sıkıştırılmış içerik için geçerli değildir.

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

With optional parameters:

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 Parametreleri

Name	İçinde	Gerekli	Tür	Description
organization	path	True	string	Azure DevOps kuruluşunun adı.
repositoryId	path	True	string	Deponun adı veya kimliği.
project	path		string	Proje Kimliği veya proje adı
api-version	query	True	string	Kullanılacak API'nin sürümü. Bu, api'nin bu sürümünü kullanmak için '7.1-preview.1' olarak ayarlanmalıdır.
path	query	True	string	Öğe yolu.
$format	query		string	Belirtilirse, bu, 'json' veya 'zip' döndürmek için HTTP Accept istek üst bilgisini geçersiz kılar. $format belirtilirse api sürümü de sorgu parametresi olarak belirtilmelidir.
download	query		boolean	Yanıtı dosya olarak indirmek için true olarak ayarlayın. Varsayılan değer false’tur.
includeContent	query		boolean	JSON isteğinde bulunurken öğe içeriğini eklemek için true olarak ayarlayın. Varsayılan değer false’tur.
includeContentMetadata	query		boolean	İçerik meta verilerini eklemek için true olarak ayarlayın. Varsayılan değer false’tur.
latestProcessedChange	query		boolean	En son değişiklikleri eklemek için true olarak ayarlayın. Varsayılan değer false’tur.
recursionLevel	query		VersionControlRecursionType	Bu isteğin özyineleme düzeyi. Varsayılan değer 'yok', özyineleme yok.
resolveLfs	query		boolean	Git LFS işaretçi dosyalarını Git LFS'den gerçek içerik döndürecek şekilde çözümlemek için true olarak ayarlayın. Varsayılan değer false’tur.
sanitize	query		boolean	Svg dosyasını temizleyip görüntü olarak döndürmek için true olarak ayarlayın. Yalnızca svg dosyası için istenirse kullanışlıdır. Varsayılan değer false’tur.
scopePath	query		string	Yol kapsamı. Varsayılan olarak null'dur.
versionDescriptor.version	query		string	Sürüm dizesi tanımlayıcısı (etiket/dal adı, işlemenin SHA1'i)
versionDescriptor.versionOptions	query		GitVersionOptions	Sürüm seçenekleri - Sürüm için ek değiştiriciler belirtin (örneğin, Önceki)
versionDescriptor.versionType	query		GitVersionType	Sürüm türü (dal, etiket veya işleme). Kimliğin nasıl yorumleneceğini belirler

Yanıtlar

Name	Tür	Description
200 OK	GitItem	başarılı işlem Media Types: "application/zip", "text/plain", "application/octet-stream", "application/json"

Güvenlik

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

Name	Description
vso.code	İşlemeler, değişiklik kümeleri, dallar ve diğer sürüm denetimi yapıtları hakkında kaynak kodu ve meta verileri okuma yeteneği verir. Ayrıca hizmet kancaları aracılığıyla kod arama ve sürüm denetimi olayları hakkında bildirim alma olanağı sağlar.

Örnekler

Download

Get metadata

Download

Sample Request

HTTP

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

Status code:

200

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

HTTP

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

Status code:

200

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

Tanımlar

Name	Description
ChangeCountDictionary
FileContentMetadata
GitChange
GitCommitRef	Git işleme ve ilişkili meta verileri açıklayan özellikler sağlar.
GitItem
GitObjectType	Nesne türü (İşleme, Ağaç, Blob, Etiket)
GitPushRef
GitStatus	Bu sınıf, durum gönderen bir hizmetin/uzantının meta verilerini içerir.
GitStatusContext	Durumu benzersiz olarak tanımlayan durum bağlamı.
GitStatusState	Durumun durumu.
GitTemplate
GitUserDate	Git işlemleri için kullanıcı bilgileri ve tarih.
GitVersionOptions	Sürüm seçenekleri - Sürüm için ek değiştiriciler belirtin (örneğin, Önceki)
GitVersionType	Sürüm türü (dal, etiket veya işleme). Kimliğin nasıl yorumleneceğini belirler
IdentityRef
ItemContent
ItemContentType
ReferenceLinks	REST başvuru bağlantıları koleksiyonunu temsil eden sınıf.
ResourceRef
VersionControlChangeType	Öğede yapılan değişikliğin türü.
VersionControlRecursionType	Alt öğeleri (OneLevel), tüm alt öğeleri (Tam) veya Yok'un dahil edilip edilmeyeceğini belirtir

ChangeCountDictionary

FileContentMetadata

Name	Tür	Description
contentType	string
encoding	integer
extension	string
fileName	string
isBinary	boolean
isImage	boolean
vsLink	string

GitChange

Name	Tür	Description
changeId	integer	Değişiklik grubu içindeki değişikliğin kimliği.
changeType	VersionControlChangeType	Öğede yapılan değişikliğin türü.
item	string	Geçerli sürüm.
newContent	ItemContent	Değişiklik sonrasında öğenin içeriği.
newContentTemplate	GitTemplate	Yeni değişiklikler gönderildiğinde kullanılacak yeni İçerik şablonu.
originalPath	string	Geçerli yoldan farklıysa öğenin özgün yolu.
sourceServerItem	string	Sunucudaki öğenin yolu.
url	string	Öğeyi almak için URL.

GitCommitRef

Git işleme ve ilişkili meta verileri açıklayan özellikler sağlar.

Name	Tür	Description
_links	ReferenceLinks	İlgili REST başvuru bağlantılarından oluşan bir koleksiyon.
author	GitUserDate	İşlemenin yazarı.
changeCounts	ChangeCountDictionary	İşlemeye dahil edilen değişiklik türlerinin (düzenleme, silme vb.) sayısı.
changes	GitChange[]	İşlemeye dahil edilen değişikliklerin sabit listesi.
comment	string	İşlemenin açıklaması veya iletisi.
commentTruncated	boolean	Açıklamanın tam Git işleme açıklama iletisinden kesilip kesilmediğini gösterir.
commitId	string	İşlemenin kimliği (SHA-1).
commitTooManyChanges	boolean	İşlemenin görüntülenemeyecek kadar çok değişiklik içerdiğini gösterir
committer	GitUserDate	İşlemenin commiter'i.
parents	string[]	Bu işleme için üst işleme kimliklerinin sabit listesi.
push	GitPushRef	Bu işlemeyle ilişkili gönderim.
remoteUrl	string	İşlemenin uzak URL yolu.
statuses	GitStatus[]	Ek bilgileri işlemeyle ilişkilendirebilecek hizmet ve uzantılardan gelen durum meta verilerinin listesi.
url	string	Bu kaynağın REST URL'si.
workItems	ResourceRef[]	Bu işlemeyle ilişkili iş öğeleri listesi.

GitItem

Name	Tür	Description
_links	ReferenceLinks	REST başvuru bağlantıları koleksiyonunu temsil eden sınıf.
commitId	string	İşleme öğesinin SHA1'inin getirildiği yer
content	string
contentMetadata	FileContentMetadata
gitObjectType	GitObjectType	Nesne türü (İşleme, Ağaç, Blob, Etiket, ...)
isFolder	boolean
isSymLink	boolean
latestProcessedChange	GitCommitRef	Bu öğeyi son değiştiren işlemeye uygun başvuru Yalnızca latestProcessedChange istenirse doldurulur En son değişiklik henüz önbelleğe alınmadıysa doğru olmayabilir
objectId	string	Git nesne kimliği
originalObjectId	string	Git nesne kimliği
path	string
url	string

GitObjectType

Nesne türü (İşleme, Ağaç, Blob, Etiket)

Name	Tür	Description
bad	string
blob	string
commit	string
ext2	string
ofsDelta	string
refDelta	string
tag	string
tree	string

GitPushRef

Name	Tür	Description
_links	ReferenceLinks	REST başvuru bağlantıları koleksiyonunu temsil eden sınıf.
date	string
pushId	integer
pushedBy	IdentityRef
url	string

GitStatus

Bu sınıf, durum gönderen bir hizmetin/uzantının meta verilerini içerir.

Name	Tür	Description
_links	ReferenceLinks	Başvuru bağlantıları.
context	GitStatusContext	Durumun bağlamı.
createdBy	IdentityRef	Durumu oluşturan kimlik.
creationDate	string	Durumun oluşturulma tarihi ve saati.
description	string	Durum açıklaması. Genellikle durumun geçerli durumunu açıklar.
id	integer	Durum tanımlayıcısı.
state	GitStatusState	Durumun durumu.
targetUrl	string	Durum ayrıntılarını içeren URL.
updatedDate	string	Durumun son güncelleştirme tarihi ve saati.

GitStatusContext

Durumu benzersiz olarak tanımlayan durum bağlamı.

Name	Tür	Description
genre	string	Durumun türü. Genellikle durumu oluşturan hizmetin/aracın adı boş olabilir.
name	string	Durumun ad tanımlayıcısı null veya boş olamaz.

GitStatusState

Durumun durumu.

Name	Tür	Description
error	string	Hata içeren durum.
failed	string	Durum başarısız oldu.
notApplicable	string	Durum hedef nesne için geçerli değil.
notSet	string	Durum durumu ayarlanmadı. Varsayılan durum.
pending	string	Durum bekleniyor.
succeeded	string	Durum başarılı oldu.

GitTemplate

Name	Tür	Description
name	string	Şablonun Adı
type	string	Şablonun Türü

GitUserDate

Git işlemleri için kullanıcı bilgileri ve tarih.

Name	Tür	Description
date	string	Git işleminin tarihi.
email	string	Git işlemini gerçekleştiren kullanıcının adresini Email.
imageUrl	string	Kullanıcının avatarı url'si.
name	string	Git işlemini gerçekleştiren kullanıcının adı.

GitVersionOptions

Sürüm seçenekleri - Sürüm için ek değiştiriciler belirtin (örneğin, Önceki)

Name	Tür	Description
firstParent	string	İşlemenin ilk üst öğesi (HEAD^)
none	string	Belirtilmemiş
previousChange	string	Değiştirilen öğeyi geçerli sürümden önce işleme

GitVersionType

Sürüm türü (dal, etiket veya işleme). Kimliğin nasıl yorumleneceğini belirler

Name	Tür	Description
branch	string	Sürümü dal adı olarak yorumlama
commit	string	Sürümü işleme kimliği (SHA1) olarak yorumlama
tag	string	Sürümü etiket adı olarak yorumlama

IdentityRef

Name	Tür	Description
_links	ReferenceLinks	Bu alan, grafik konusu hakkında sıfır veya daha fazla ilgi çekici bağlantı içerir. Bu bağlantılar, bu grafik konusu hakkında daha fazla ilişki veya daha ayrıntılı bilgi edinmek için çağrılabilir.
descriptor	string	Tanımlayıcı, sistem çalışırken graf konusuna başvurmanın birincil yoludur. Bu alan, hem Hesaplar hem de Kuruluşlar genelinde aynı graf konusunu benzersiz olarak tanımlar.
directoryAlias	string	Kullanım dışı - IdentityRef "_links" sözlüğündeki "self" girişinde başvuruda bulunılan Graph kullanıcısı sorgulanarak alınabilir
displayName	string	Bu, grafik konusunun benzersiz olmayan görünen adıdır. Bu alanı değiştirmek için kaynak sağlayıcıdaki değerini değiştirmeniz gerekir.
id	string
imageUrl	string	Kullanım dışı - IdentityRef "_links" sözlüğün "avatar" girişinde kullanılabilir
inactive	boolean	Kullanım dışı - GraphUser "_links" sözlüğün "membershipState" girişinde başvurulan Graph üyelik durumu sorgulanarak alınabilir
isAadIdentity	boolean	Kullanım dışı - Tanımlayıcının konu türünden çıkarılabilir (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Kullanım dışı - Tanımlayıcının konu türünden çıkarılabilir (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Kullanım dışı - ToIdentityRef'in önceden var olan uygulamalarının çoğunda kullanımda değil
uniqueName	string	Kullanım dışı - bunun yerine Domain+PrincipalName kullanın
url	string	Bu URL, bu grafik konusunun kaynak kaynağına giden tam yoldur.

ItemContent

Name	Tür	Description
content	string
contentType	ItemContentType

ItemContentType

Name	Tür	Description
base64Encoded	string
rawText	string

ReferenceLinks

REST başvuru bağlantıları koleksiyonunu temsil eden sınıf.

Name	Tür	Description
links	object	Bağlantıların salt okunur görünümü. Başvuru bağlantıları salt okunur olduğundan, bunları yalnızca salt okunur olarak göstermek istiyoruz.

ResourceRef

Name	Tür	Description
id	string
url	string

VersionControlChangeType

Öğede yapılan değişikliğin türü.

Name	Tür	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

Alt öğeleri (OneLevel), tüm alt öğeleri (Tam) veya Yok'un dahil edilip edilmeyeceğini belirtir

Name	Tür	Description
full	string	Belirtilen öğeyi ve tüm alt öğeleri döndür
none	string	Yalnızca belirtilen öğeyi döndür.
oneLevel	string	Belirtilen öğeyi ve doğrudan alt öğelerini döndürür.
oneLevelPlusNestedEmptyFolders	string	Belirtilen öğeyi ve doğrudan alt öğelerinin yanı sıra yalnızca tek bir klasör içeren iç içe alt klasörlerin özyinelemeli zincirlerini döndürür.