Items - Get

Referenz

Dienst:: Git

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/git/repositories/{repositoryId}/items?path={path}&api-version=7.1

Mit optionalen Parametern:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
organization	path	True	string	Der Name der Azure DevOps-Organisation.
repositoryId	path	True	string	Der Name oder die ID des Repositorys.
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	Der Elementpfad.
$format	query		string	Wenn angegeben, überschreibt dies den HTTP Accept-Anforderungsheader, um entweder "json" oder "zip" zurückzugeben. Wenn $format angegeben ist, sollte die API-Version auch als Abfrageparameter angegeben werden.
download	query		boolean	Legen Sie "true" fest, um die Antwort als Datei herunterzuladen. Der Standardwert ist "false".
includeContent	query		boolean	Auf "true" festlegen, um Elementinhalte beim Anfordern von JSON einzuschließen. Der Standardwert ist "false".
includeContentMetadata	query		boolean	Auf "true" festlegen, um Inhaltsmetadaten einzuschließen. Der Standardwert ist "false".
latestProcessedChange	query		boolean	Auf "true" festlegen, um die neuesten Änderungen einzuschließen. Der Standardwert ist "false".
recursionLevel	query		VersionControlRecursionType	Die Rekursionsebene dieser Anforderung. Der Standardwert ist "none", keine Rekursion.
resolveLfs	query		boolean	Legen Sie den Wert auf "true" fest, um Git LFS-Zeigerdateien aufzulösen, um tatsächlichen Inhalt von Git LFS zurückzugeben. Der Standardwert ist "false".
sanitize	query		boolean	Legen Sie "true" fest, um eine svg-Datei zu sanitieren und als Bild zurückzugeben. Nur nützlich, wenn sie für svg-Datei angefordert wird. Der Standardwert ist "false".
scopePath	query		string	Der Pfadbereich. Der Standardwert ist NULL.
versionDescriptor.version	query		string	Versionszeichenfolgenbezeichner (Name von Tag/Verzweigung, SHA1 des Commits)
versionDescriptor.versionOptions	query		GitVersionOptions	Versionsoptionen – Angeben zusätzlicher Modifizierer zu Version (z. B. Vorherige)
versionDescriptor.versionType	query		GitVersionType	Versionstyp (Verzweigung, Tag oder Commit). Bestimmt, wie die ID interpretiert wird

Antworten

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

Name

Typ

Beschreibung

200 OK

GitItem

Erfolgreicher Vorgang

Media Types: "application/zip", "text/plain", "application/octet-stream", "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

Download

Get metadata

Download

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:: 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

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name	Beschreibung
ChangeCountDictionary
FileContentMetadata
GitChange
GitCommitRef	Stellt Eigenschaften bereit, die einen Git-Commit und zugehörige Metadaten beschreiben.
GitItem
GitObjectType	Objekttyp (Commit, Struktur, Blob, Tag)
GitPushRef
GitStatus	Diese Klasse enthält die Metadaten eines Diensts/einer Erweiterung, der einen Status veröffentlicht.
GitStatusContext	Statuskontext, der den Status eindeutig identifiziert.
GitStatusState	Status des Status.
GitTemplate
GitUserDate	Benutzerinformationen und Datum für Git-Vorgänge.
GitVersionOptions	Versionsoptionen – Angeben zusätzlicher Modifizierer zu Version (z. B. Vorherige)
GitVersionType	Versionstyp (Verzweigung, Tag oder Commit). Bestimmt, wie die ID interpretiert wird
IdentityRef
ItemContent
ItemContentType
ReferenceLinks	Die Klasse, die eine Auflistung von REST-Referenzverknüpfungslinks darstellt.
ResourceRef
VersionControlChangeType	Der Typ der Änderung, die an dem Element vorgenommen wurde.
VersionControlRecursionType	Gibt an, ob untergeordnete Elemente (OneLevel), alle Nachfolger (Vollständig) oder None eingeschlossen werden sollen.

ChangeCountDictionary

Objekt

FileContentMetadata

Objekt

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

GitChange

Objekt

Name	Typ	Beschreibung
changeId	integer (int32)	ID der Änderung innerhalb der Gruppe der Änderungen.
changeType	VersionControlChangeType	Der Typ der Änderung, die an dem Element vorgenommen wurde.
item	string (T)	Aktuelle Version.
newContent	ItemContent	Inhalt des Elements nach der Änderung.
newContentTemplate	GitTemplate	Neue Inhaltsvorlage, die beim Pushen neuer Änderungen verwendet werden soll.
originalPath	string	Ursprünglicher Pfad des Elements, wenn es sich von dem aktuellen Pfad unterscheidet.
sourceServerItem	string	Pfad des Elements auf dem Server.
url	string	URL zum Abrufen des Elements.

GitCommitRef

Objekt

Stellt Eigenschaften bereit, die einen Git-Commit und zugehörige Metadaten beschreiben.

Name	Typ	Beschreibung
_links	ReferenceLinks	Eine Sammlung verwandter REST-Referenzverknüpfungslinks.
author	GitUserDate	Autor des Commits.
changeCounts	ChangeCountDictionary	Zählt die Typen von Änderungen (Bearbeitungen, Löschungen usw.), die im Commit enthalten sind.
changes	GitChange[]	Eine Aufzählung der Änderungen, die im Commit enthalten sind.
comment	string	Kommentar oder Nachricht des Commits.
commentTruncated	boolean	Gibt an, ob der Kommentar aus der vollständigen Git Commit-Kommentarnachricht abgeschnitten wird.
commitId	string	ID (SHA-1) des Commits.
commitTooManyChanges	boolean	Gibt an, dass commit zu viele Änderungen enthält, die angezeigt werden sollen.
committer	GitUserDate	Committer des Commits.
parents	string[]	Eine Aufzählung der übergeordneten Commit-IDs für diesen Commit.
push	GitPushRef	Der Push, der diesem Commit zugeordnet ist.
remoteUrl	string	Remote-URL-Pfad zum Commit.
statuses	GitStatus[]	Eine Liste der Statusmetadaten von Diensten und Erweiterungen, die dem Commit zusätzliche Informationen zuordnen können.
url	string	REST-URL für diese Ressource.
workItems	ResourceRef[]	Eine Liste der Arbeitsaufgaben, die diesem Commit zugeordnet sind.

GitItem

Objekt

Name	Typ	Beschreibung
_links	ReferenceLinks	Die Klasse, die eine Auflistung von REST-Referenzverknüpfungslinks darstellt.
commitId	string	SHA1 des Commitelements wurde abgerufen unter
content	string
contentMetadata	FileContentMetadata
gitObjectType	GitObjectType	Objekttyp (Commit, Struktur, Blob, Tag, ...)
isFolder	boolean
isSymLink	boolean
latestProcessedChange	GitCommitRef	Flacher Verweis, um die zuletzt geänderte Änderung dieses Elements nur aufgefüllt zu haben, wenn "latestProcessedChange" angefordert wird, ist möglicherweise nicht korrekt, wenn die letzte Änderung noch nicht zwischengespeichert wurde.
objectId	string	Git-Objekt-ID
originalObjectId	string	Git-Objekt-ID
path	string
url	string

GitObjectType

Enumeration

Objekttyp (Commit, Struktur, Blob, Tag)

Wert	Beschreibung
bad
blob
commit
ext2
ofsDelta
refDelta
tag
tree

GitPushRef

Objekt

Name	Typ	Beschreibung
_links	ReferenceLinks	Die Klasse, die eine Auflistung von REST-Referenzverknüpfungslinks darstellt.
date	string (date-time)
pushId	integer (int32)
pushedBy	IdentityRef
url	string

GitStatus

Objekt

Diese Klasse enthält die Metadaten eines Diensts/einer Erweiterung, der einen Status veröffentlicht.

Name	Typ	Beschreibung
_links	ReferenceLinks	Referenzlinks.
context	GitStatusContext	Kontext des Status.
createdBy	IdentityRef	Identität, die den Status erstellt hat.
creationDate	string (date-time)	Erstellungsdatum und -uhrzeit des Status.
description	string	Statusbeschreibung. Beschreibt in der Regel den aktuellen Status des Status.
id	integer (int32)	Statusbezeichner.
state	GitStatusState	Status des Status.
targetUrl	string	URL mit Statusdetails.
updatedDate	string (date-time)	Datum und Uhrzeit der letzten Aktualisierung des Status.

GitStatusContext

Objekt

Statuskontext, der den Status eindeutig identifiziert.

Name	Typ	Beschreibung
genre	string	Genre des Status. Normalerweise kann der Name des Diensts/Tools, der den Status generiert, leer sein.
name	string	Der Namensbezeichner des Status darf nicht null oder leer sein.

GitStatusState

Enumeration

Status des Status.

Wert	Beschreibung
error	Status mit einem Fehler.
failed	Fehler beim Status.
notApplicable	Der Status gilt nicht für das Zielobjekt.
notSet	Statusstatus nicht festgelegt. Standardstatus.
pending	Status steht aus.
succeeded	Status erfolgreich.

GitTemplate

Objekt

Name	Typ	Beschreibung
name	string	Name der Vorlage
type	string	Typ der Vorlage

GitUserDate

Objekt

Benutzerinformationen und Datum für Git-Vorgänge.

Name	Typ	Beschreibung
date	string (date-time)	Datum des Git-Vorgangs.
email	string	E-Mail-Adresse des Benutzers, der den Git-Vorgang ausführt.
imageUrl	string	URL für den Avatar des Benutzers.
name	string	Der Name des Benutzers, der den Git-Vorgang ausführt.

GitVersionOptions

Enumeration

Versionsoptionen – Angeben zusätzlicher Modifizierer zu Version (z. B. Vorherige)

Wert	Beschreibung
firstParent	Erstes übergeordnetes Element des Commits (HEAD^)
none	Nicht angegeben
previousChange	Commit für dieses geänderte Element vor der aktuellen Version

GitVersionType

Enumeration

Versionstyp (Verzweigung, Tag oder Commit). Bestimmt, wie die ID interpretiert wird

Wert	Beschreibung
branch	Interpretieren der Version als Verzweigungsname
commit	Interpretieren der Version als Commit-ID (SHA1)
tag	Interpretieren der Version als Tagname

IdentityRef

Objekt

Name	Typ	Beschreibung
_links	ReferenceLinks	Dieses Feld enthält null oder interessantere Links zum Thema Diagramm. Diese Links können aufgerufen werden, um zusätzliche Beziehungen oder ausführlichere Informationen zu diesem Diagrammbetreff zu erhalten.
descriptor	string	Der Deskriptor ist die primäre Möglichkeit, auf den Diagrammbetreff zu verweisen, während das System ausgeführt wird. In diesem Feld wird dasselbe Diagrammthema sowohl in Firmen als auch in Organisationen eindeutig identifiziert.
directoryAlias	string	Veraltet – Kann abgerufen werden, indem der Graph-Benutzer abgefragt wird, auf den im "Self"-Eintrag des IdentityRef -Wörterbuchs "_links" verwiesen wird
displayName	string	Dies ist der nicht eindeutige Anzeigename des Diagrammbetreffs. Um dieses Feld zu ändern, müssen Sie den Wert im Quellanbieter ändern.
id	string
imageUrl	string	Veraltet – Verfügbar im "Avatar"-Eintrag des IdentityRef-Wörterbuchs "_links"
inactive	boolean	Veraltet – Kann abgerufen werden, indem der Graph-Mitgliedschaftsstatus abgefragt wird, auf den im Eintrag "membershipState" des GraphUser-Wörterbuchs "_links" verwiesen wird.
isAadIdentity	boolean	Veraltet – Kann vom Betrefftyp des Deskriptors abgeleitet werden (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Veraltet – Kann vom Betrefftyp des Deskriptors abgeleitet werden (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Veraltet – nicht in den meisten bereits vorhandenen Implementierungen von ToIdentityRef verwendet
uniqueName	string	Veraltet – Verwenden Sie stattdessen "Domain+PrincipalName".
url	string	Diese URL ist die vollständige Route zur Quellressource dieses Graph-Betreffs.

ItemContent

Objekt

Name	Typ	Beschreibung
content	string
contentType	ItemContentType

ItemContentType

Enumeration

Wert	Beschreibung
base64Encoded
rawText

ReferenceLinks

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.

ResourceRef

Objekt

Name	Typ	Beschreibung
id	string
url	string

VersionControlChangeType

Enumeration

Der Typ der Änderung, die an dem Element vorgenommen wurde.

Wert	Beschreibung
add
all
branch
delete
edit
encoding
lock
merge
none
property
rename
rollback
sourceRename
targetRename
undelete

VersionControlRecursionType

Enumeration

Gibt an, ob untergeordnete Elemente (OneLevel), alle Nachfolger (Vollständig) oder None eingeschlossen werden sollen.

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.

Freigeben über

Items - Get

URI-Parameter

Antworten

Sicherheit

oauth2

Bereiche

Beispiele

Download

Beispielanforderung

Beispiel für eine Antwort

Get metadata

Beispielanforderung

Beispiel für eine Antwort

Definitionen

ChangeCountDictionary

FileContentMetadata

GitChange

GitCommitRef

GitItem

GitObjectType

GitPushRef

GitStatus

GitStatusContext

GitStatusState

GitTemplate

GitUserDate

GitVersionOptions

GitVersionType

IdentityRef

ItemContent

ItemContentType

ReferenceLinks

ResourceRef

VersionControlChangeType

VersionControlRecursionType

Zusätzliche Ressourcen