Items - Get

Referenz

Service:: Git

API Version:: 7.1-preview.1

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/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

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-preview.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 wird, sollte api-version auch als Abfrageparameter angegeben werden.
download	query		boolean	Legen Sie auf true fest, um die Antwort als Datei herunterzuladen. Der Standardwert ist "false".
includeContent	query		boolean	Legen Sie auf true fest, um Elementinhalt beim Anfordern von JSON einzuschließen. Der Standardwert ist "false".
includeContentMetadata	query		boolean	Legen Sie auf true fest, um Inhaltsmetadaten einzuschließen. Der Standardwert ist "false".
latestProcessedChange	query		boolean	Legen Sie auf true fest, um die neuesten Änderungen einzubeziehen. Der Standardwert ist "false".
recursionLevel	query		VersionControlRecursionType	Die Rekursionsebene dieser Anforderung. Der Standardwert ist "none", keine Rekursion.
resolveLfs	query		boolean	Legen Sie 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 auf true fest, um eine svg-Datei zu bereinigen und als Bild zurückzugeben. Nur nützlich, wenn für die 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/Branch, SHA1 des Commits)
versionDescriptor.versionOptions	query		GitVersionOptions	Versionsoptionen: Geben Sie zusätzliche Modifizierer für die Version an (z. B. Vorherige)
versionDescriptor.versionType	query		GitVersionType	Versionstyp (Branch, 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

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

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

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, die eine status.
GitStatusContext	Statuskontext, der die status eindeutig identifiziert.
GitStatusState	Zustand des status.
GitTemplate
GitUserDate	Benutzerinformationen und Datum für Git-Vorgänge.
GitVersionOptions	Versionsoptionen: Geben Sie zusätzliche Modifizierer für die Version an (z. B. Vorherige)
GitVersionType	Versionstyp (Branch, Tag oder Commit). Bestimmt, wie die ID interpretiert wird.
IdentityRef
ItemContent
ItemContentType
ReferenceLinks	Die Klasse, die eine Auflistung von REST-Verweislinks darstellt.
ResourceRef
VersionControlChangeType	Der Typ der Änderung, die am Element vorgenommen wurde.
VersionControlRecursionType	Gibt an, ob untergeordnete Elemente (OneLevel), alle abhängigen Elemente (Full) oder None eingeschlossen werden sollen.

ChangeCountDictionary

FileContentMetadata

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

GitChange

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

GitCommitRef

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

Name	Typ	Beschreibung
_links	ReferenceLinks	Eine Sammlung verwandter REST-Verweislinks.
author	GitUserDate	Autor des Commits.
changeCounts	ChangeCountDictionary	Anzahl der Im Commit enthaltenen Änderungstypen (Bearbeitungen, Löschvorgänge usw.).
changes	GitChange[]	Eine Enumeration der im Commit enthaltenen Änderungen.
comment	string	Kommentar oder Meldung des Commits.
commentTruncated	boolean	Gibt an, ob der Kommentar aus der vollständigen Git-Commitkommentarnachricht abgeschnitten wird.
commitId	string	ID (SHA-1) des Commits.
commitTooManyChanges	boolean	Gibt an, dass commit zu viele Änderungen enthält, die angezeigt werden können.
committer	GitUserDate	Committer des Commits.
parents	string[]	Eine Enumeration der übergeordneten Commit-IDs für diesen Commit.
push	GitPushRef	Der diesem Commit zugeordnete Push.
remoteUrl	string	Remote-URL-Pfad zum Commit.
statuses	GitStatus[]	Eine Liste mit status Metadaten von Diensten und Erweiterungen, die dem Commit möglicherweise zusätzliche Informationen zuordnen.
url	string	REST-URL für diese Ressource.
workItems	ResourceRef[]	Eine Liste von Arbeitselementen, die diesem Commit zugeordnet sind.

GitItem

Name	Typ	Beschreibung
_links	ReferenceLinks	Die Klasse, die eine Auflistung von REST-Verweislinks darstellt.
commitId	string	SHA1 des Commitelements wurde unter abgerufen
content	string
contentMetadata	FileContentMetadata
gitObjectType	GitObjectType	Objekttyp (Commit, Struktur, Blob, Tag, ...)
isFolder	boolean
isSymLink	boolean
latestProcessedChange	GitCommitRef	Flacher Verweis zum Commit, der dieses Element zuletzt geändert hat Nur aufgefüllt, wenn latestProcessedChange angefordert wird Möglicherweise nicht richtig, wenn die letzte Änderung noch nicht zwischengespeichert ist
objectId	string	Git-Objekt-ID
originalObjectId	string	Git-Objekt-ID
path	string
url	string

GitObjectType

Objekttyp (Commit, Struktur, Blob, Tag)

Name	Typ	Beschreibung
bad	string
blob	string
commit	string
ext2	string
ofsDelta	string
refDelta	string
tag	string
tree	string

GitPushRef

Name	Typ	Beschreibung
_links	ReferenceLinks	Die Klasse, die eine Auflistung von REST-Verweislinks darstellt.
date	string
pushId	integer
pushedBy	IdentityRef
url	string

GitStatus

Diese Klasse enthält die Metadaten eines Diensts/einer Erweiterung, die eine status.

Name	Typ	Beschreibung
_links	ReferenceLinks	Verweislinks.
context	GitStatusContext	Kontext des status.
createdBy	IdentityRef	Identität, die den status erstellt hat.
creationDate	string	Erstellungsdatum und -uhrzeit des status.
description	string	Statusbeschreibung. Beschreibt in der Regel den aktuellen Zustand des status.
id	integer	Statusbezeichner.
state	GitStatusState	Zustand des status.
targetUrl	string	URL mit status Details.
updatedDate	string	Datum und Uhrzeit der letzten Aktualisierung des status.

GitStatusContext

Statuskontext, der die status eindeutig identifiziert.

Name	Typ	Beschreibung
genre	string	Genre der status. In der Regel kann der Name des Diensts/Tools, der die status generiert, leer sein.
name	string	Der Namensbezeichner des status darf nicht NULL oder leer sein.

GitStatusState

Zustand des status.

Name	Typ	Beschreibung
error	string	Status mit einem Fehler.
failed	string	Fehler beim Status.
notApplicable	string	Der Status gilt nicht für das Zielobjekt.
notSet	string	Statusstatus nicht festgelegt. Standardzustand.
pending	string	Status ausstehend.
succeeded	string	Status erfolgreich.

GitTemplate

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

GitUserDate

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

Name	Typ	Beschreibung
date	string	Datum des Git-Vorgangs.
email	string	Email Adresse des Benutzers, der den Git-Vorgang ausführt.
imageUrl	string	URL für den Avatar des Benutzers.
name	string	Name des Benutzers, der den Git-Vorgang ausführt.

GitVersionOptions

Versionsoptionen: Geben Sie zusätzliche Modifizierer für die Version an (z. B. Vorherige)

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

GitVersionType

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

Name	Typ	Beschreibung
branch	string	Interpretieren der Version als Branchname
commit	string	Interpretieren der Version als Commit-ID (SHA1)
tag	string	Interpretieren der Version als Tagname

IdentityRef

Name	Typ	Beschreibung
_links	ReferenceLinks	Dieses Feld enthält null oder interessantere Links zum Diagrammthema. Diese Links können aufgerufen werden, um zusätzliche Beziehungen oder ausführlichere Informationen zu diesem Graph-Thema zu erhalten.
descriptor	string	Der Deskriptor ist die primäre Möglichkeit, auf den Graphengegenstand zu verweisen, während das System ausgeführt wird. In diesem Feld wird derselbe Graph-Betreff sowohl für Konten als auch für Organisationen eindeutig identifiziert.
directoryAlias	string	Veraltet: Kann abgerufen werden, indem der Graph-Benutzer abgefragt wird, auf den im Eintrag "selbst" des IdentityRef-Wörterbuchs "_links" verwiesen wird.
displayName	string	Dies ist der nicht eindeutige Anzeigename des Diagrammsubjekts. Um dieses Feld zu ändern, müssen Sie seinen Wert im Quellanbieter ändern.
id	string
imageUrl	string	Veraltet: Verfügbar im Eintrag "avatar" des IdentityRef-Wörterbuchs "_links"
inactive	boolean	Veraltet: Kann durch Abfragen des Graph-Mitgliedschaftsstatus abgerufen werden, 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: Wird in den meisten bereits vorhandenen Implementierungen von ToIdentityRef nicht verwendet.
uniqueName	string	Veraltet: Verwenden Sie stattdessen Domain+PrincipalName.
url	string	Diese URL ist die vollständige Route zur Quellressource dieses Graph-Betreffs.

ItemContent

Name	Typ	Beschreibung
content	string
contentType	ItemContentType

ItemContentType

Name	Typ	Beschreibung
base64Encoded	string
rawText	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.

ResourceRef

Name	Typ	Beschreibung
id	string
url	string

VersionControlChangeType

Der Typ der Änderung, die am Element vorgenommen wurde.

Name	Typ	Beschreibung
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

Gibt an, ob untergeordnete Elemente (OneLevel), alle abhängigen Elemente (Full) oder None eingeschlossen werden sollen.

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.

Freigeben über

Items - Get

URI-Parameter

Antworten

Sicherheit

oauth2

Scopes

Beispiele

Download

Sample Request

Sample Response

Get metadata

Sample Request

Sample Response

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