Freigeben über

Items - Get

  • Referenz
Dienst:
Tfvc
API-Version:
7.1

Dient zum Abrufen von Elementmetadaten und/oder Inhalten für ein einzelnes Element. Der Downloadparameter besteht darin, anzugeben, ob der Inhalt als Download verfügbar sein soll 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=7.1
Mit optionalen Parametern: 
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

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. Dies sollte auf "7.1" festgelegt werden, um diese Version der API zu verwenden.
path
 query True

string

Versionssteuerungspfad eines einzelnen Elements, das zurückgegeben werden soll.
download
 query

boolean

Wenn true, erstellen Sie eine herunterladbare Anlage.
fileName
 query

string

Der Dateiname des zurückgegebenen Elements.
includeContent
 query

boolean

Auf "true" festlegen, um Elementinhalte 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

Versionssteuerungspfad eines Ordners, um mehrere Elemente zurückzugeben.
versionDescriptor.version
 query

string

Version-Objekt.
versionDescriptor.versionOption
 query

TfvcVersionOption

Versionsdeskriptor. Der Standardwert ist NULL.
versionDescriptor.versionType
 query

TfvcVersionType

Versionsdeskriptor. Der Standardwert ist NULL.

Antworten

Name Typ Beschreibung
200 OK

TfvcItem

Erfolgreicher Vorgang

Media Types: "text/plain", "application/octet-stream", "application/zip", "application/json"

Sicherheit

oauth2

Typ: oauth2
Ablauf: accessCode
Autorisierungs-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

Bereiche

Name Beschreibung
vso.code Gewährt die Möglichkeit, Quellcode und Metadaten zu Commits, Changesets, Verzweigungen und anderen Versionskontrollartefakten zu lesen. Gewährt außerdem die Möglichkeit, Code zu durchsuchen und über Dienst-Hooks über Versionssteuerungsereignisse benachrichtigt zu werden.

Beispiele

GET item metadata and/or content for a single item.

Beispielanforderung

GET https://dev.azure.com/{organization}/_apis/tfvc/items?path=$/MyFirstProject/ExampleFolder/TestFile01.txt&api-version=7.1

Beispiel für eine Antwort

Statuscode:
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-Referenzverknüpfungslinks darstellt.
TfvcItem

Metadaten für ein Element.
TfvcVersionOption

Der Standardwert ist "None".
TfvcVersionType

Der Standardwert ist "Neueste".
VersionControlRecursionType

Der Standardwert ist "OneLevel".

FileContentMetadata

Objekt
Name Typ Beschreibung
contentType

string

encoding

integer (int32)

extension

string

fileName

string

isBinary

boolean

isImage

boolean

vsLink

string

Objekt

Die Klasse, die eine Auflistung von REST-Referenzverknüpfungslinks darstellt.

Name Typ Beschreibung
links

object

Die schreibgeschützte Ansicht der Links. Da Referenzlinks schreibgeschützt sind, möchten wir sie nur als schreibgeschützt verfügbar machen.

TfvcItem

Objekt

Metadaten für ein Element.

Name Typ Beschreibung
_links

ReferenceLinks

Die Klasse, die eine Auflistung von REST-Referenzverknüpfungslinks darstellt.
changeDate

string (date-time)

Element hat datumstime geändert.
content

string

contentMetadata

FileContentMetadata

deletionId

integer (int32)

Größer als 0, wenn das Element gelöscht wird.
encoding

integer (int32)

Dateicodierung aus Datenbank, -1 stellt binär dar.
hashValue

string

MD5-Hash als Base64-Zeichenfolge gilt nur für Dateien.
isBranch

boolean

True, wenn Element eine Verzweigung ist.
isFolder

boolean

isPendingChange

boolean

True, wenn eine Änderung aussteht.
isSymLink

boolean

path

string

size

integer (int64)

Die Größe der Datei, falls zutreffend.
url

string

version

integer (int32)

Changeset-Versions-ID.

TfvcVersionOption

Enumeration

Der Standardwert ist "None".

Wert Beschreibung
none

Nichts.
previous

Gibt die vorherige Version zurück.
useRename

Nur mit versionstyp MergeSource und ganzzahligen Versionen usuierbar, verwendet RenameSource-Bezeichner anstelle des Seriendruckbezeichners.

TfvcVersionType

Enumeration

Der Standardwert ist "Neueste".

Wert Beschreibung
change

Die Version wird als Änderung behandelt.
changeset

Die Version wird als ChangesetId behandelt.
date

Version wird als Datum behandelt.
latest

Wenn version definiert ist, wird die neueste Version dieser Version verwendet, wenn keine Version definiert ist, die neueste ChangesetId verwendet wird.
mergeSource

Die Version wird als MergeSource behandelt.
none

Die Version wird als ChangesetId behandelt.
shelveset

Die Version wird als Regaletname und Besitzer behandelt.
tip

Die Version wird als Tipp behandelt, wenn keine Neueste Version definiert wird.

VersionControlRecursionType

Enumeration

Der Standardwert ist "OneLevel".

Wert Beschreibung
full

Zurückgeben des angegebenen Elements und aller Untergeordneten Elemente
none

Gibt nur das angegebene Element zurück.
oneLevel

Gibt das angegebene Element und seine direkten untergeordneten Elemente zurück.
oneLevelPlusNestedEmptyFolders

Gibt das angegebene Element und seine direkten untergeordneten Elemente sowie rekursive Ketten von geschachtelten untergeordneten Ordnern zurück, die nur einen einzelnen Ordner enthalten.