Items - Get

Service:

Tfvc

API Version:

7.1-preview.1

Ottenere metadati dell'elemento e/o 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/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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
organization	path	True	string	Nome dell'organizzazione di Azure DevOps.
project	path		string	ID progetto o nome progetto
api-version	query	True	string	Versione dell'API da usare. Questa opzione deve essere impostata su '7.1-preview.1' per usare questa versione dell'API.
path	query	True	string	Percorso di controllo della versione di un singolo elemento da restituire.
download	query		boolean	Se true, creare un allegato scaricabile.
fileName	query		string	nome file dell'elemento restituito.
includeContent	query		boolean	Impostare su true per includere il contenuto dell'elemento durante la richiesta di json. L'impostazione predefinita è false.
recursionLevel	query		VersionControlRecursionType	Nessuno (solo l'elemento) o OneLevel (contenuto di una cartella).
scopePath	query		string	Percorso del controllo della versione di una cartella per restituire più elementi.
versionDescriptor.version	query		string	Oggetto versione.
versionDescriptor.versionOption	query		TfvcVersionOption	Descrittore della versione. Il valore predefinito è null.
versionDescriptor.versionType	query		TfvcVersionType	Descrittore della versione. Il valore predefinito è null.

Risposte

Nome	Tipo	Descrizione
200 OK	TfvcItem	operazione riuscita Media Types: "text/plain", "application/octet-stream", "application/zip", "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 codice sorgente e metadati relativi a commit, set di modifiche, rami e altri artefatti di controllo della versione. Concede inoltre la possibilità di cercare codice e ricevere notifiche sugli eventi di controllo della versione tramite gli hook del servizio.

Esempio

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

Definizioni

Nome	Descrizione
FileContentMetadata
ReferenceLinks	Classe da rappresentare una raccolta di collegamenti di riferimento REST.
TfvcItem	Metadati per un elemento.
TfvcVersionOption	Il valore predefinito è Nessuna.
TfvcVersionType	Per impostazione predefinita, è più recente.
VersionControlRecursionType	Impostazione predefinita in OneLevel.

FileContentMetadata

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

ReferenceLinks

Classe da rappresentare una raccolta di collegamenti di riferimento REST.

Nome	Tipo	Descrizione
links	object	Visualizzazione di lettura dei collegamenti. Poiché i collegamenti di riferimento sono in sola lettura, si vuole esporre solo i collegamenti di riferimento come sola lettura.

TfvcItem

Metadati per un elemento.

Nome	Tipo	Descrizione
_links	ReferenceLinks	Classe da rappresentare una raccolta di collegamenti di riferimento REST.
changeDate	string	Elemento modificato datetime.
content	string
contentMetadata	FileContentMetadata
deletionId	integer	Maggiore di 0 se l'elemento viene eliminato.
encoding	integer	La codifica dei file dal database , -1 rappresenta il file binario.
hashValue	string	L'hash MD5 come stringa base 64 si applica solo ai file.
isBranch	boolean	True se l'elemento è un ramo.
isFolder	boolean
isPendingChange	boolean	True se è presente una modifica in sospeso.
isSymLink	boolean
path	string
size	integer	Dimensioni del file, se applicabile.
url	string
version	integer	ID versione del set di modifiche.

TfvcVersionOption

Il valore predefinito è Nessuna.

Nome	Tipo	Descrizione
none	string	Nessuno.
previous	string	Restituire la versione precedente.
useRename	string	Solo utilizzabile con versioni mergesource e integer di tipo versiontype, usa l'identificatore RenameSource anziché l'identificatore merge.

TfvcVersionType

Per impostazione predefinita, è più recente.

Nome	Tipo	Descrizione
change	string	La versione viene considerata come modifica.
changeset	string	La versione viene considerata come Un oggetto ChangesetId.
date	string	La versione viene considerata come data.
latest	string	Se la versione è definita l'ultima versione di tale versione, se non viene definita alcuna versione, verrà usato l'ultimo oggetto ChangesetId.
mergeSource	string	La versione verrà considerata come MergeSource.
none	string	La versione viene considerata come Un oggetto ChangesetId.
shelveset	string	La versione viene considerata come nome e proprietario del set di scaffali.
tip	string	La versione verrà considerata come suggerimento, se non verrà usata alcuna versione più recente.

VersionControlRecursionType

Impostazione predefinita in OneLevel.

Nome	Tipo	Descrizione
full	string	Restituire 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 annidate che contengono solo una singola cartella.