Items - Get

Service:

Git

API Version:

7.1-preview.1

Ottiene i metadati dell'elemento e/o il contenuto per un singolo elemento. Il parametro di download consiste nell'indicare se il contenuto deve essere disponibile come download o inviato come flusso nella risposta. Non si applica al contenuto compresso, che viene sempre restituito come download.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
organization	path	True	string	Nome dell'organizzazione di Azure DevOps.
repositoryId	path	True	string	Nome o ID del repository.
project	path		string	ID progetto o nome del progetto
api-version	query	True	string	Versione dell'API da usare. Deve essere impostato su '7.1-preview.1' per usare questa versione dell'API.
path	query	True	string	Percorso dell'elemento.
$format	query		string	Se specificato, esegue l'override dell'intestazione della richiesta ACCETTA HTTP per restituire 'json' o 'zip'. Se viene specificato $format, anche api-version deve essere specificato come parametro di query.
download	query		boolean	Impostare su true per scaricare la risposta come file. L'impostazione predefinita è false.
includeContent	query		boolean	Impostare su true per includere il contenuto dell'elemento quando si richiede json. L'impostazione predefinita è false.
includeContentMetadata	query		boolean	Impostare su true per includere i metadati del contenuto. L'impostazione predefinita è false.
latestProcessedChange	query		boolean	Impostare su true per includere le modifiche più recenti. L'impostazione predefinita è false.
recursionLevel	query		VersionControlRecursionType	Livello di ricorsione di questa richiesta. Il valore predefinito è 'none', nessuna ricorsione.
resolveLfs	query		boolean	Impostare su true per risolvere i file del puntatore Git LFS per restituire il contenuto effettivo da Git LFS. L'impostazione predefinita è false.
sanitize	query		boolean	Impostare su true per sanificare un file svg e restituirlo come immagine. Utile solo se richiesto per il file svg. L'impostazione predefinita è false.
scopePath	query		string	Ambito del percorso. Il valore predefinito è Null.
versionDescriptor.version	query		string	Identificatore della stringa di versione (nome del tag/ramo, SHA1 del commit)
versionDescriptor.versionOptions	query		GitVersionOptions	Opzioni di versione: specificare modificatori aggiuntivi per la versione (ad esempio Precedente)
versionDescriptor.versionType	query		GitVersionType	Tipo di versione (ramo, tag o commit). Determina la modalità di interpretazione dell'ID

Risposte

Nome	Tipo	Descrizione
200 OK	GitItem	operazione riuscita Media Types: "application/zip", "text/plain", "application/octet-stream", "application/json"

Sicurezza

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

Nome	Descrizione
vso.code	Concede la possibilità di leggere il codice sorgente e i metadati relativi a commit, insiemi di modifiche, rami e altri artefatti del controllo della versione. Concede inoltre la possibilità di cercare il codice e ricevere notifiche sugli eventi di controllo della versione tramite hook del servizio.

Esempio

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

Definizioni

Nome	Descrizione
ChangeCountDictionary
FileContentMetadata
GitChange
GitCommitRef	Fornisce proprietà che descrivono un commit Git e i metadati associati.
GitItem
GitObjectType	Tipo di oggetto (Commit, Albero, BLOB, Tag)
GitPushRef
GitStatus	Questa classe contiene i metadati di un servizio o di un'estensione che registra uno stato.
GitStatusContext	Contesto di stato che identifica in modo univoco lo stato.
GitStatusState	Stato dello stato.
GitTemplate
GitUserDate	Informazioni utente e data per le operazioni Git.
GitVersionOptions	Opzioni di versione: specificare modificatori aggiuntivi per la versione (ad esempio Precedente)
GitVersionType	Tipo di versione (ramo, tag o commit). Determina la modalità di interpretazione dell'ID
IdentityRef
ItemContent
ItemContentType
ReferenceLinks	Classe per rappresentare una raccolta di collegamenti di riferimento REST.
ResourceRef
VersionControlChangeType	Tipo di modifica apportata all'elemento.
VersionControlRecursionType	Specifica se includere elementi figlio (OneLevel), tutti i discendenti (completo) o Nessuno

ChangeCountDictionary

FileContentMetadata

Nome	Tipo	Descrizione
contentType	string
encoding	integer
extension	string
fileName	string
isBinary	boolean
isImage	boolean
vsLink	string

GitChange

Nome	Tipo	Descrizione
changeId	integer	ID della modifica all'interno del gruppo di modifiche.
changeType	VersionControlChangeType	Tipo di modifica apportata all'elemento.
item	string	Versione corrente.
newContent	ItemContent	Contenuto dell'elemento dopo la modifica.
newContentTemplate	GitTemplate	Nuovo modello di contenuto da usare durante il push di nuove modifiche.
originalPath	string	Percorso originale dell'elemento se diverso dal percorso corrente.
sourceServerItem	string	Percorso dell'elemento nel server.
url	string	URL per recuperare l'elemento.

GitCommitRef

Fornisce proprietà che descrivono un commit Git e i metadati associati.

Nome	Tipo	Descrizione
_links	ReferenceLinks	Raccolta di collegamenti di riferimento REST correlati.
author	GitUserDate	Autore del commit.
changeCounts	ChangeCountDictionary	Conteggi dei tipi di modifiche (modifiche, eliminazioni e così via) inclusi nel commit.
changes	GitChange[]	Enumerazione delle modifiche incluse nel commit.
comment	string	Commento o messaggio del commit.
commentTruncated	boolean	Indica se il commento viene troncato dal messaggio di commento del commit Git completo.
commitId	string	ID (SHA-1) del commit.
commitTooManyChanges	boolean	Indica che il commit contiene troppe modifiche da visualizzare
committer	GitUserDate	Commiter del commit.
parents	string[]	Enumerazione degli ID commit padre per questo commit.
push	GitPushRef	Push associato a questo commit.
remoteUrl	string	Percorso URL remoto per il commit.
statuses	GitStatus[]	Elenco di metadati di stato dai servizi e dalle estensioni che possono associare informazioni aggiuntive al commit.
url	string	URL REST per questa risorsa.
workItems	ResourceRef[]	Elenco di elementi di lavoro associati al commit.

GitItem

Nome	Tipo	Descrizione
_links	ReferenceLinks	Classe per rappresentare una raccolta di collegamenti di riferimento REST.
commitId	string	SHA1 dell'elemento di commit è stato recuperato in
content	string
contentMetadata	FileContentMetadata
gitObjectType	GitObjectType	Tipo di oggetto (Commit, Albero, BLOB, Tag, ...)
isFolder	boolean
isSymLink	boolean
latestProcessedChange	GitCommitRef	Riferimento superficiale per eseguire il commit dell'ultimo elemento modificato solo se è richiesto latestProcessedChange Potrebbe non essere accurato se la modifica più recente non è ancora memorizzata nella cache
objectId	string	ID oggetto Git
originalObjectId	string	ID oggetto Git
path	string
url	string

GitObjectType

Tipo di oggetto (Commit, Albero, BLOB, Tag)

Nome	Tipo	Descrizione
bad	string
blob	string
commit	string
ext2	string
ofsDelta	string
refDelta	string
tag	string
tree	string

GitPushRef

Nome	Tipo	Descrizione
_links	ReferenceLinks	Classe per rappresentare una raccolta di collegamenti di riferimento REST.
date	string
pushId	integer
pushedBy	IdentityRef
url	string

GitStatus

Questa classe contiene i metadati di un servizio o di un'estensione che registra uno stato.

Nome	Tipo	Descrizione
_links	ReferenceLinks	Collegamenti di riferimento.
context	GitStatusContext	Contesto dello stato.
createdBy	IdentityRef	Identità che ha creato lo stato.
creationDate	string	Data e ora di creazione dello stato.
description	string	Descrizione dello stato. Descrive in genere lo stato corrente dello stato.
id	integer	Identificatore di stato.
state	GitStatusState	Stato dello stato.
targetUrl	string	URL con i dettagli sullo stato.
updatedDate	string	Data e ora dell'ultimo aggiornamento dello stato.

GitStatusContext

Contesto di stato che identifica in modo univoco lo stato.

Nome	Tipo	Descrizione
genre	string	Genere dello stato. In genere, il nome del servizio o dello strumento che genera lo stato può essere vuoto.
name	string	L'identificatore del nome dello stato non può essere null o vuoto.

GitStatusState

Stato dello stato.

Nome	Tipo	Descrizione
error	string	Stato con un errore.
failed	string	Stato non riuscito.
notApplicable	string	Lo stato non è applicabile all'oggetto di destinazione.
notSet	string	Stato non impostato. Stato predefinito.
pending	string	Stato in sospeso.
succeeded	string	Stato completato.

GitTemplate

Nome	Tipo	Descrizione
name	string	Nome del modello
type	string	Tipo di modello

GitUserDate

Informazioni utente e data per le operazioni Git.

Nome	Tipo	Descrizione
date	string	Data dell'operazione Git.
email	string	Email indirizzo dell'utente che esegue l'operazione Git.
imageUrl	string	URL dell'avatar dell'utente.
name	string	Nome dell'utente che esegue l'operazione Git.

GitVersionOptions

Opzioni di versione: specificare modificatori aggiuntivi per la versione (ad esempio Precedente)

Nome	Tipo	Descrizione
firstParent	string	Primo elemento padre del commit (HEAD^)
none	string	Non specificato
previousChange	string	Eseguire il commit dell'elemento modificato prima della versione corrente

GitVersionType

Tipo di versione (ramo, tag o commit). Determina la modalità di interpretazione dell'ID

Nome	Tipo	Descrizione
branch	string	Interpretare la versione come nome di ramo
commit	string	Interpretare la versione come ID commit (SHA1)
tag	string	Interpretare la versione come nome di tag

IdentityRef

Nome	Tipo	Descrizione
_links	ReferenceLinks	Questo campo contiene zero o più collegamenti interessanti sull'oggetto del grafico. Questi collegamenti possono essere richiamati per ottenere relazioni aggiuntive o informazioni più dettagliate su questo oggetto grafico.
descriptor	string	Il descrittore è il modo principale per fare riferimento all'oggetto del grafo mentre il sistema è in esecuzione. Questo campo identificherà in modo univoco lo stesso oggetto grafico in account e organizzazioni.
directoryAlias	string	Deprecato: può essere recuperato eseguendo una query sull'utente graph a cui si fa riferimento nella voce "self" del dizionario "_links" IdentityRef
displayName	string	Si tratta del nome visualizzato non univoco dell'oggetto del grafico. Per modificare questo campo, è necessario modificarne il valore nel provider di origine.
id	string
imageUrl	string	Deprecato : disponibile nella voce "avatar" del dizionario IdentityRef "_links"
inactive	boolean	Deprecato: può essere recuperato eseguendo una query sullo stato di appartenenza graph a cui si fa riferimento nella voce "membershipState" del dizionario GraphUser "_links"
isAadIdentity	boolean	Deprecato: può essere dedotto dal tipo di soggetto del descrittore (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Deprecato: può essere dedotto dal tipo di soggetto del descrittore (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Deprecato: non in uso nella maggior parte delle implementazioni preesistenti di ToIdentityRef
uniqueName	string	Deprecato: usare invece Domain+PrincipalName
url	string	Questo URL è la route completa alla risorsa di origine di questo oggetto grafico.

ItemContent

Nome	Tipo	Descrizione
content	string
contentType	ItemContentType

ItemContentType

Nome	Tipo	Descrizione
base64Encoded	string
rawText	string

ReferenceLinks

Classe per rappresentare una raccolta di collegamenti di riferimento REST.

Nome	Tipo	Descrizione
links	object	Visualizzazione di sola lettura dei collegamenti. Poiché i collegamenti di riferimento sono di sola lettura, è consigliabile esporli solo come di sola lettura.

ResourceRef

Nome	Tipo	Descrizione
id	string
url	string

VersionControlChangeType

Tipo di modifica apportata all'elemento.

Nome	Tipo	Descrizione
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

Specifica se includere elementi figlio (OneLevel), tutti i discendenti (completo) o Nessuno

Nome	Tipo	Descrizione
full	string	Restituisce l'elemento specificato e tutti i discendenti
none	string	Restituisce solo l'elemento specificato.
oneLevel	string	Restituisce l'elemento specificato e i relativi elementi figlio diretti.
oneLevelPlusNestedEmptyFolders	string	Restituisce l'elemento specificato e i relativi elementi figlio diretti, nonché catene ricorsive di cartelle figlio nidificate che contengono solo una singola cartella.