Items - Get

Odwołanie

Usługa:: Git

Wersja interfejsu API:: 7.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

Z parametrami opcjonalnymi:

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

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. Należy ustawić wartość "7.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 ciągu "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 pliku 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 odczyścić 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. Wartość domyślna to 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 identyfikator jest interpretowany

Odpowiedzi

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

Nazwa

Typ

Opis

200 OK

GitItem

operacja zakończona powodzeniem

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

Zabezpieczenia

oauth2

Typ: oauth2
Flow: accessCode
Adres URL autoryzacji: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Adres URL tokenu: 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

Zakresy

Nazwa	Opis
vso.code	Przyznaje możliwość odczytywania 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

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 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

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 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 identyfikator jest interpretowany
IdentityRef
ItemContent
ItemContentType
ReferenceLinks	Klasa reprezentująca kolekcję linków referencyjnych REST.
ResourceRef
VersionControlChangeType	Typ zmiany wprowadzonej w elemencie.
VersionControlRecursionType	Określa, czy mają być uwzględniane elementy podrzędne (OneLevel), wszystkie elementy potomne (pełne) lub Brak

ChangeCountDictionary

Objekt

FileContentMetadata

Objekt

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

GitChange

Objekt

Nazwa	Typ	Opis
changeId	integer (int32)	Identyfikator zmiany w grupie zmian.
changeType	VersionControlChangeType	Typ zmiany wprowadzonej w elemencie.
item	string (T)	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 pobierania elementu.

GitCommitRef

Objekt

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.) uwzględnionych w zatwierdzeniu.
changes	GitChange[]	Wyliczenie zmian uwzględnionych w zatwierdzeniu.
comment	string	Komentarz lub wiadomość zatwierdzenia.
commentTruncated	boolean	Wskazuje, czy komentarz jest 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	Zatwierdzanie 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

Objekt

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łytkie odwołanie do zatwierdzenia, że ostatnio zmieniono ten element tylko wtedy, gdy zażądano najnowszegoprocessedChange może nie być dokładne, jeśli najnowsza zmiana nie jest jeszcze buforowana
objectId	string	Identyfikator obiektu Git
originalObjectId	string	Identyfikator obiektu Git
path	string
url	string

GitObjectType

Wyliczanie

Typ obiektu (Commit, Tree, Blob, Tag)

Wartość	Opis
bad
blob
commit
ext2
ofsDelta
refDelta
tag
tree

GitPushRef

Objekt

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

GitStatus

Objekt

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 (date-time)	Data i godzina utworzenia stanu.
description	string	Opis stanu. Zazwyczaj opisuje bieżący stan stanu.
id	integer (int32)	Identyfikator stanu.
state	GitStatusState	Stan stanu.
targetUrl	string	Adres URL ze szczegółami stanu.
updatedDate	string (date-time)	Data i godzina ostatniej aktualizacji stanu.

GitStatusContext

Objekt

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

Wyliczanie

Stan stanu.

Wartość	Opis
error	Stan z błędem.
failed	Stan nie powiódł się.
notApplicable	Stan nie ma zastosowania do obiektu docelowego.
notSet	Stan nie jest ustawiony. Stan domyślny.
pending	Oczekiwanie na stan.
succeeded	Stan zakończył się pomyślnie.

GitTemplate

Objekt

Nazwa	Typ	Opis
name	string	Nazwa szablonu
type	string	Typ szablonu

GitUserDate

Objekt

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

Nazwa	Typ	Opis
date	string (date-time)	Data operacji git.
email	string	Adres e-mail użytkownika wykonującego operację Git.
imageUrl	string	Adres URL awatara użytkownika.
name	string	Nazwa użytkownika wykonującego operację Git.

GitVersionOptions

Wyliczanie

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

Wartość	Opis
firstParent	Pierwszy element nadrzędny zatwierdzenia (HEAD^)
none	Nie określono
previousChange	Zatwierdzanie zmienionego elementu przed bieżącą wersją

GitVersionType

Wyliczanie

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

Wartość	Opis
branch	Interpretowanie wersji jako nazwy gałęzi
commit	Interpretowanie wersji jako identyfikatora zatwierdzenia (SHA1)
tag	Interpretowanie wersji jako nazwy tagu

IdentityRef

Objekt

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 go pobrać, wykonując zapytanie względem użytkownika programu Graph, do których odwołuje się wpis "self" słownika IdentityRef "_links"
displayName	string	Jest to unikatowa nazwa wyświetlana podmiotu grafu. Aby zmienić to pole, musisz zmienić jego wartość u dostawcy źródłowego.
id	string
imageUrl	string	Przestarzałe — dostępne we wpisie "avatar" słownika IdentityRef "_links"
inactive	boolean	Przestarzałe — można pobrać, wykonując zapytanie dotyczące 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 elementu ToIdentityRef
uniqueName	string	Przestarzałe — zamiast tego użyj nazwy głównej i domeny
url	string	Ten adres URL jest pełną trasą do zasobu źródłowego tego tematu grafu.

ItemContent

Objekt

Nazwa	Typ	Opis
content	string
contentType	ItemContentType

ItemContentType

Wyliczanie

Wartość	Opis
base64Encoded
rawText

ReferenceLinks

Objekt

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

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

ResourceRef

Objekt

Nazwa	Typ	Opis
id	string
url	string

VersionControlChangeType

Wyliczanie

Typ zmiany wprowadzonej w elemencie.

Wartość	Opis
add
all
branch
delete
edit
encoding
lock
merge
none
property
rename
rollback
sourceRename
targetRename
undelete

VersionControlRecursionType

Wyliczanie

Określa, czy mają być uwzględniane elementy podrzędne (OneLevel), wszystkie elementy potomne (pełne) lub Brak

Wartość	Opis
full	Zwraca określony element i wszystkie elementy podrzędne
none	Zwróć tylko określony element.
oneLevel	Zwróć określony element i jego bezpośrednie elementy podrzędne.
oneLevelPlusNestedEmptyFolders	Zwróć określony element i jego bezpośrednie elementy podrzędne, a także cyklicznych łańcuchów zagnieżdżonych folderów podrzędnych, które zawierają tylko jeden folder.

Udostępnij przez

Items - Get

Parametry identyfikatora URI

Odpowiedzi

Zabezpieczenia

oauth2

Zakresy

Przykłady

Download

Przykładowe żądanie

Przykładowa odpowiedź

Get metadata

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

ChangeCountDictionary

FileContentMetadata

GitChange

GitCommitRef

GitItem

GitObjectType

GitPushRef

GitStatus

GitStatusContext

GitStatusState

GitTemplate

GitUserDate

GitVersionOptions

GitVersionType

IdentityRef

ItemContent

ItemContentType

ReferenceLinks

ResourceRef

VersionControlChangeType

VersionControlRecursionType