Items - Get

Service:

Git

API Version:

7.1-preview.1

Pobierz metadane elementu i/lub zawartość dla pojedynczego elementu. Parametr pobierania wskazuje, czy zawartość powinna być dostępna jako pobieranie, czy po prostu wysłana jako strumień w odpowiedzi. Nie ma zastosowania do spakowanej zawartości, która jest zawsze zwracana jako pobieranie.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
organization	path	True	string	Nazwa organizacji usługi Azure DevOps.
repositoryId	path	True	string	Nazwa lub identyfikator repozytorium.
project	path		string	Identyfikator projektu lub nazwa projektu
api-version	query	True	string	Wersja interfejsu API do użycia. Powinno to być ustawione na wartość "7.1-preview.1", aby używać tej wersji interfejsu API.
path	query	True	string	Ścieżka elementu.
$format	query		string	Jeśli zostanie określony, spowoduje to zastąpienie nagłówka żądania akceptowania HTTP w celu zwrócenia "json" lub "zip". Jeśli określono $format, należy również określić wersję interfejsu API jako parametr zapytania.
download	query		boolean	Ustaw wartość true, aby pobrać odpowiedź jako plik. Wartość domyślna to false.
includeContent	query		boolean	Ustaw wartość true, aby uwzględnić zawartość elementu podczas żądania json. Wartość domyślna to false.
includeContentMetadata	query		boolean	Ustaw wartość true, aby uwzględnić metadane zawartości. Wartość domyślna to false.
latestProcessedChange	query		boolean	Ustaw wartość true, aby uwzględnić najnowsze zmiany. Wartość domyślna to false.
recursionLevel	query		VersionControlRecursionType	Poziom rekursji tego żądania. Wartość domyślna to "none", brak rekursji.
resolveLfs	query		boolean	Ustaw wartość true, aby rozpoznać pliki wskaźnika LFS usługi Git w celu zwrócenia rzeczywistej zawartości z usługi Git LFS. Wartość domyślna to false.
sanitize	query		boolean	Ustaw wartość true, aby usunąć plik svg i zwrócić go jako obraz. Przydatne tylko wtedy, gdy zażądano pliku svg. Wartość domyślna to false.
scopePath	query		string	Zakres ścieżki. Domyślny ma wartość null.
versionDescriptor.version	query		string	Identyfikator ciągu wersji (nazwa tagu/gałęzi, SHA1 zatwierdzenia)
versionDescriptor.versionOptions	query		GitVersionOptions	Opcje wersji — określ dodatkowe modyfikatory do wersji (np. Poprzednie)
versionDescriptor.versionType	query		GitVersionType	Typ wersji (gałąź, tag lub zatwierdzenie). Określa, jak jest interpretowany identyfikator

Odpowiedzi

Nazwa	Typ	Opis
200 OK	GitItem	operacja zakończona powodzeniem Media Types: "application/zip", "text/plain", "application/octet-stream", "application/json"

Zabezpieczenia

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

Nazwa	Opis
vso.code	Umożliwia odczytywanie kodu źródłowego i metadanych dotyczących zatwierdzeń, zestawów zmian, gałęzi i innych artefaktów kontroli wersji. Umożliwia również wyszukiwanie kodu i otrzymywanie powiadomień o zdarzeniach kontroli wersji za pośrednictwem punktów zaczepienia usługi.

Przykłady

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

Definicje

Nazwa	Opis
ChangeCountDictionary
FileContentMetadata
GitChange
GitCommitRef	Zawiera właściwości opisujące zatwierdzenie usługi Git i skojarzone metadane.
GitItem
GitObjectType	Typ obiektu (Commit, Tree, Blob, Tag)
GitPushRef
GitStatus	Ta klasa zawiera metadane usługi/rozszerzenia publikujące stan.
GitStatusContext	Kontekst stanu, który jednoznacznie identyfikuje stan.
GitStatusState	Stan stanu.
GitTemplate
GitUserDate	Informacje o użytkowniku i data operacji usługi Git.
GitVersionOptions	Opcje wersji — określ dodatkowe modyfikatory do wersji (np. Poprzednie)
GitVersionType	Typ wersji (gałąź, tag lub zatwierdzenie). Określa, jak jest interpretowany identyfikator
IdentityRef
ItemContent
ItemContentType
ReferenceLinks	Klasa reprezentująca kolekcję linków referencyjnych REST.
ResourceRef
VersionControlChangeType	Typ zmiany wprowadzonej w elemencie.
VersionControlRecursionType	Określa, czy należy uwzględnić elementy podrzędne (OneLevel), wszystkie elementy podrzędne (pełne) lub Brak

ChangeCountDictionary

FileContentMetadata

Nazwa	Typ	Opis
contentType	string
encoding	integer
extension	string
fileName	string
isBinary	boolean
isImage	boolean
vsLink	string

GitChange

Nazwa	Typ	Opis
changeId	integer	Identyfikator zmiany w grupie zmian.
changeType	VersionControlChangeType	Typ zmiany wprowadzonej w elemencie.
item	string	Bieżąca wersja.
newContent	ItemContent	Zawartość elementu po zmianie.
newContentTemplate	GitTemplate	Nowy szablon zawartości do użycia podczas wypychania nowych zmian.
originalPath	string	Oryginalna ścieżka elementu, jeśli różni się od bieżącej ścieżki.
sourceServerItem	string	Ścieżka elementu na serwerze.
url	string	Adres URL umożliwiający pobranie elementu.

GitCommitRef

Zawiera właściwości opisujące zatwierdzenie usługi Git i skojarzone metadane.

Nazwa	Typ	Opis
_links	ReferenceLinks	Kolekcja powiązanych linków referencyjnych REST.
author	GitUserDate	Autor zatwierdzenia.
changeCounts	ChangeCountDictionary	Liczba typów zmian (edycji, usuwania itp.) dołączonych do zatwierdzenia.
changes	GitChange[]	Wyliczenie zmian uwzględnionych w zatwierdzaniu.
comment	string	Komentarz lub wiadomość zatwierdzenia.
commentTruncated	boolean	Wskazuje, czy komentarz został obcięty z pełnego komunikatu komentarza zatwierdzenia usługi Git.
commitId	string	Identyfikator (SHA-1) zatwierdzenia.
commitTooManyChanges	boolean	Wskazuje, że zatwierdzenie zawiera zbyt wiele zmian do wyświetlenia
committer	GitUserDate	Zatwierdzacz zatwierdzenia.
parents	string[]	Wyliczenie identyfikatorów zatwierdzeń nadrzędnych dla tego zatwierdzenia.
push	GitPushRef	Wypychanie skojarzone z tym zatwierdzeniem.
remoteUrl	string	Zdalna ścieżka adresu URL do zatwierdzenia.
statuses	GitStatus[]	Lista metadanych stanu z usług i rozszerzeń, które mogą kojarzyć dodatkowe informacje z zatwierdzeniem.
url	string	Adres URL REST dla tego zasobu.
workItems	ResourceRef[]	Lista elementów roboczych skojarzonych z tym zatwierdzeniem.

GitItem

Nazwa	Typ	Opis
_links	ReferenceLinks	Klasa reprezentująca kolekcję linków referencyjnych REST.
commitId	string	Sha1 elementu zatwierdzenia został pobrany pod adresem
content	string
contentMetadata	FileContentMetadata
gitObjectType	GitObjectType	Typ obiektu (Commit, Tree, Blob, Tag, ...)
isFolder	boolean
isSymLink	boolean
latestProcessedChange	GitCommitRef	Płytki ref w celu zatwierdzenia, że ostatnio zmieniono ten element, wypełnione tylko wtedy, gdy zażądano najnowszegoProcessedChange może nie być dokładne, jeśli najnowsza zmiana nie jest jeszcze buforowana
objectId	string	Identyfikator obiektu usługi Git
originalObjectId	string	Identyfikator obiektu usługi Git
path	string
url	string

GitObjectType

Typ obiektu (Commit, Tree, Blob, Tag)

Nazwa	Typ	Opis
bad	string
blob	string
commit	string
ext2	string
ofsDelta	string
refDelta	string
tag	string
tree	string

GitPushRef

Nazwa	Typ	Opis
_links	ReferenceLinks	Klasa reprezentująca kolekcję linków referencyjnych REST.
date	string
pushId	integer
pushedBy	IdentityRef
url	string

GitStatus

Ta klasa zawiera metadane usługi/rozszerzenia publikujące stan.

Nazwa	Typ	Opis
_links	ReferenceLinks	Linki referencyjne.
context	GitStatusContext	Kontekst stanu.
createdBy	IdentityRef	Tożsamość, która utworzyła stan.
creationDate	string	Data i godzina utworzenia stanu.
description	string	Opis stanu. Zazwyczaj opisuje bieżący stan stanu.
id	integer	Identyfikator stanu.
state	GitStatusState	Stan stanu.
targetUrl	string	Adres URL ze szczegółami stanu.
updatedDate	string	Data i godzina ostatniej aktualizacji stanu.

GitStatusContext

Kontekst stanu, który jednoznacznie identyfikuje stan.

Nazwa	Typ	Opis
genre	string	Gatunek stanu. Zazwyczaj nazwa usługi/narzędzia generującego stan może być pusta.
name	string	Identyfikator nazwy stanu nie może mieć wartości null ani być pusty.

GitStatusState

Stan stanu.

Nazwa	Typ	Opis
error	string	Stan z błędem.
failed	string	Stan nie powiodło się.
notApplicable	string	Stan nie ma zastosowania do obiektu docelowego.
notSet	string	Stan nie jest ustawiony. Stan domyślny.
pending	string	Stan oczekujący.
succeeded	string	Stan zakończył się pomyślnie.

GitTemplate

Nazwa	Typ	Opis
name	string	Nazwa szablonu
type	string	Typ szablonu

GitUserDate

Informacje o użytkowniku i data operacji usługi Git.

Nazwa	Typ	Opis
date	string	Data operacji git.
email	string	Email adres użytkownika wykonującego operację Git.
imageUrl	string	Adres URL awatara użytkownika.
name	string	Nazwa użytkownika wykonującego operację Git.

GitVersionOptions

Opcje wersji — określ dodatkowe modyfikatory do wersji (np. Poprzednie)

Nazwa	Typ	Opis
firstParent	string	Pierwszy element nadrzędny zatwierdzenia (HEAD^)
none	string	Nie określono
previousChange	string	Zatwierdź, który zmienił element przed bieżącą wersją

GitVersionType

Typ wersji (gałąź, tag lub zatwierdzenie). Określa, jak jest interpretowany identyfikator

Nazwa	Typ	Opis
branch	string	Interpretowanie wersji jako nazwy gałęzi
commit	string	Interpretowanie wersji jako identyfikatora zatwierdzenia (SHA1)
tag	string	Interpretowanie wersji jako nazwy tagu

IdentityRef

Nazwa	Typ	Opis
_links	ReferenceLinks	To pole zawiera zero lub więcej interesujących linków dotyczących tematu grafu. Te linki mogą być wywoływane w celu uzyskania dodatkowych relacji lub bardziej szczegółowych informacji na temat tego tematu grafu.
descriptor	string	Deskryptor jest podstawowym sposobem odwołowania się do tematu grafu podczas działania systemu. To pole będzie jednoznacznie identyfikować ten sam temat grafu zarówno w ramach kont, jak i organizacji.
directoryAlias	string	Przestarzałe — można pobrać, wysyłając zapytanie do użytkownika programu Graph przywoływanego w wpisie "self" słownika IdentityRef "_links"
displayName	string	Jest to unikatowa nazwa wyświetlana tematu grafu. Aby zmienić to pole, musisz zmienić jego wartość u dostawcy źródłowego.
id	string
imageUrl	string	Przestarzałe — dostępne w wpisie "avatar" słownika IdentityRef "_links"
inactive	boolean	Przestarzałe — można pobrać, wysyłając zapytanie do stanu członkostwa programu Graph, do których odwołuje się wpis "membershipState" słownika GraphUser "_links"
isAadIdentity	boolean	Przestarzałe — można wywnioskować z typu podmiotu deskryptora (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Przestarzałe — można wywnioskować z typu podmiotu deskryptora (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Przestarzałe — nie jest używane w większości istniejących implementacji toIdentityRef
uniqueName	string	Przestarzałe — zamiast tego użyj nazwy Domain+PrincipalName
url	string	Ten adres URL jest pełną trasą do zasobu źródłowego tego tematu grafu.

ItemContent

Nazwa	Typ	Opis
content	string
contentType	ItemContentType

ItemContentType

Nazwa	Typ	Opis
base64Encoded	string
rawText	string

ReferenceLinks

Klasa reprezentująca kolekcję linków referencyjnych REST.

Nazwa	Typ	Opis
links	object	Czytelny widok linków. Ponieważ linki referencyjne są czytelne, chcemy uwidocznić je tylko jako tylko do odczytu.

ResourceRef

Nazwa	Typ	Opis
id	string
url	string

VersionControlChangeType

Typ zmiany wprowadzonej w elemencie.

Nazwa	Typ	Opis
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

Określa, czy należy uwzględnić elementy podrzędne (OneLevel), wszystkie elementy podrzędne (pełne) lub Brak

Nazwa	Typ	Opis
full	string	Zwracanie określonego elementu i wszystkich elementów potomnych
none	string	Zwracany jest tylko określony element.
oneLevel	string	Zwróć określony element i jego bezpośrednie elementy podrzędne.
oneLevelPlusNestedEmptyFolders	string	Zwróć określony element i jego bezpośrednie elementy podrzędne, a także cykliczne łańcuchy zagnieżdżonych folderów podrzędnych, które zawierają tylko jeden folder.