Items - Get

Service:

Tfvc

API Version:

6.0

Abrufen von Elementmetadaten und/oder Inhalt für ein einzelnes Element. Der Downloadparameter gibt an, ob der Inhalt als Download verfügbar oder einfach als Stream in der Antwort gesendet werden soll. Gilt nicht für gezippten Inhalt, der immer als Download zurückgegeben wird.

GET https://dev.azure.com/{organization}/{project}/_apis/tfvc/items?path={path}&api-version=6.0

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=6.0

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
organization	path	True	string	Der Name der Azure DevOps-Organisation.
project	path		string	Projekt-ID oder Projektname
api-version	query	True	string	Version der zu verwendenden API. Diese sollte auf 6.0 festgelegt werden, um diese Version der API zu verwenden.
path	query	True	string	Versionsverwaltungspfad eines einzelnen Elements, das zurückgegeben werden soll.
download	query		boolean	Wenn true, erstellen Sie eine herunterladbare Anlage.
fileName	query		string	Dateiname des zurückgegebenen Elements.
includeContent	query		boolean	Legen Sie auf true fest, um Elementinhalt beim Anfordern von JSON einzuschließen. Der Standardwert ist "false".
recursionLevel	query		VersionControlRecursionType	Keine (nur das Element) oder OneLevel (Inhalt eines Ordners).
scopePath	query		string	Versionsverwaltungspfad eines Ordners, um mehrere Elemente zurückzugeben.
versionDescriptor.version	query		string	Versionsobjekt.
versionDescriptor.versionOption	query		TfvcVersionOption	Versionsdeskriptor. Der Standardwert lautet null.
versionDescriptor.versionType	query		TfvcVersionType	Versionsdeskriptor. Der Standardwert lautet null.

Antworten

Name	Typ	Beschreibung
200 OK	TfvcItem	Erfolgreicher Vorgang Media Types: "text/plain", "application/octet-stream", "application/zip", "application/json"

Sicherheit

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	Beschreibung
vso.code	Ermöglicht das Lesen von Quellcode und Metadaten zu Commits, Changesets, Branches und anderen Versionskontrollartefakten. Ermöglicht außerdem die Suche nach Code und die Benachrichtigung über Versionskontrollereignisse über Diensthaken.

Beispiele

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=6.0

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

Definitionen

Name	Beschreibung
FileContentMetadata
ReferenceLinks	Die Klasse, die eine Auflistung von REST-Verweislinks darstellt.
TfvcItem	Metadaten für ein Element.
TfvcVersionOption	Der Standardwert ist „None“.
TfvcVersionType	Die Standardwerte sind "Neueste".
VersionControlRecursionType	Standardmäßig wird OneLevel verwendet.

FileContentMetadata

Name	Typ	Beschreibung
contentType	string
encoding	integer
extension	string
fileName	string
isBinary	boolean
isImage	boolean
vsLink	string

ReferenceLinks

Die Klasse, die eine Auflistung von REST-Verweislinks darstellt.

Name	Typ	Beschreibung
links	object	Die schreibgeschützte Ansicht der Links. Da Verweislinks schreibgeschützt sind, möchten wir sie nur als schreibgeschützt verfügbar machen.

TfvcItem

Metadaten für ein Element.

Name	Typ	Beschreibung
_links	ReferenceLinks	Die Klasse, die eine Auflistung von REST-Verweislinks darstellt.
changeDate	string	Element hat datetime geändert.
content	string
contentMetadata	FileContentMetadata
deletionId	integer	Größer als 0, wenn das Element gelöscht wird.
encoding	integer	Dateicodierung aus Der Datenbank stellt -1 binär dar.
hashValue	string	MD5-Hash als Basis-64-Zeichenfolge gilt nur für Dateien.
isBranch	boolean	True, wenn das Element ein Branch ist.
isFolder	boolean
isPendingChange	boolean	True, wenn eine Änderung aussteht.
isSymLink	boolean
path	string
size	integer	Die Größe der Datei, falls zutreffend.
url	string
version	integer	Changeset-Versions-ID.

TfvcVersionOption

Der Standardwert ist „None“.

Name	Typ	Beschreibung
none	string	Keine.
previous	string	Gibt die vorherige Version zurück.
useRename	string	Nur mit MergeSource-Versionstyp und ganzzahligen Versionen verfügbar, verwendet den RenameSource-Bezeichner anstelle des Merge-Bezeichners.

TfvcVersionType

Die Standardwerte sind "Neueste".

Name	Typ	Beschreibung
change	string	Version wird als Änderung behandelt.
changeset	string	Version wird als ChangesetId behandelt.
date	string	Version wird als Datum behandelt.
latest	string	Wenn Version definiert ist, wird die neueste Version dieser Version verwendet, wenn keine Version definiert ist, wird die neueste ChangesetId verwendet.
mergeSource	string	Version wird als MergeSource behandelt.
none	string	Version wird als ChangesetId behandelt.
shelveset	string	Version wird als Shelvesetname und Besitzer behandelt.
tip	string	Die Version wird als Tipp behandelt, wenn keine Version definiert ist, wird neueste verwendet.

VersionControlRecursionType

Standardmäßig wird OneLevel verwendet.

Name	Typ	Beschreibung
full	string	Zurückgeben des angegebenen Elements und aller abhängigen Elemente
none	string	Gibt nur das angegebene Element zurück.
oneLevel	string	Gibt das angegebene Element und seine direkten untergeordneten Elemente zurück.
oneLevelPlusNestedEmptyFolders	string	Gibt das angegebene Element und seine direkten untergeordneten Elemente sowie rekursive Ketten geschachtelter untergeordneter Ordner zurück, die nur einen einzelnen Ordner enthalten.