Items - Get

Service:

Git

API Version:

7.1-preview.1

Získejte metadata nebo obsah položky pro jednu položku. Parametr download označuje, jestli má být obsah v odpovědi dostupný jako soubor ke stažení, nebo jako datový proud. Nevztahuje se na komprimovaný obsah, který se vždy vrátí jako stažený obsah.

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 identifikátoru URI

Name	V	Vyžadováno	Typ	Description
organization	path	True	string	Název organizace Azure DevOps.
repositoryId	path	True	string	Název nebo ID úložiště.
project	path		string	ID projektu nebo název projektu
api-version	query	True	string	Verze rozhraní API, která se má použít. Aby se tato verze rozhraní API používala, měla by být nastavená na 7.1-preview.1.
path	query	True	string	Cesta k položce
$format	query		string	Pokud je tato možnost zadána, přepíše hlavičku požadavku HTTP Accept tak, aby vracela buď json, nebo zip. Pokud je zadaný $format, měl by být jako parametr dotazu zadán také parametr api-version.
download	query		boolean	Nastavte na hodnotu true, aby se odpověď stáhla jako soubor. Výchozí hodnota je false.
includeContent	query		boolean	Pokud chcete zahrnout obsah položky při žádosti o json, nastavte na hodnotu true. Výchozí hodnota je false.
includeContentMetadata	query		boolean	Pokud chcete zahrnout metadata obsahu, nastavte na hodnotu true. Výchozí hodnota je false.
latestProcessedChange	query		boolean	Pokud chcete zahrnout nejnovější změny, nastavte na hodnotu true. Výchozí hodnota je false.
recursionLevel	query		VersionControlRecursionType	Rekurzivní úroveň tohoto požadavku. Výchozí hodnota je žádná, žádná rekurze.
resolveLfs	query		boolean	Nastavte na hodnotu true, pokud chcete přeložit soubory ukazatele Git LFS, aby se vrátil skutečný obsah z Git LFS. Výchozí hodnota je false.
sanitize	query		boolean	Nastavte na hodnotu true, pokud chcete soubor svg defikovat a vrátit ho jako obrázek. Užitečné pouze v případě, že je požadován soubor svg. Výchozí hodnota je false.
scopePath	query		string	Obor cesty. Výchozí hodnota je null.
versionDescriptor.version	query		string	Identifikátor řetězce verze (název značky nebo větve, SHA1 potvrzení)
versionDescriptor.versionOptions	query		GitVersionOptions	Možnosti verze – Zadejte další modifikátory verze (např. Předchozí).
versionDescriptor.versionType	query		GitVersionType	Typ verze (větev, značka nebo potvrzení). Určuje, jak se ID interpretuje.

Odpovědi

Name	Typ	Description
200 OK	GitItem	úspěšná operace Media Types: "application/zip", "text/plain", "application/octet-stream", "application/json"

Zabezpečení

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	Description
vso.code	Umožňuje číst zdrojový kód a metadata o potvrzeních, sadách změn, větvích a dalších artefaktech správy verzí. Umožňuje také prohledávat kód a dostávat oznámení o událostech správy verzí prostřednictvím služby Hooks.

Příklady

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

Definice

Name	Description
ChangeCountDictionary
FileContentMetadata
GitChange
GitCommitRef	Poskytuje vlastnosti, které popisují potvrzení Gitu a přidružená metadata.
GitItem
GitObjectType	Typ objektu (Commit, Tree, Blob, Tag)
GitPushRef
GitStatus	Tato třída obsahuje metadata služby nebo rozšíření, které publikuje stav.
GitStatusContext	Kontext stavu, který jednoznačně identifikuje stav.
GitStatusState	Stav stavu.
GitTemplate
GitUserDate	Informace o uživateli a datum pro operace Gitu
GitVersionOptions	Možnosti verze – Zadejte další modifikátory verze (např. Předchozí).
GitVersionType	Typ verze (větev, značka nebo potvrzení). Určuje, jak se ID interpretuje.
IdentityRef
ItemContent
ItemContentType
ReferenceLinks	Třída představující kolekci odkazů REST.
ResourceRef
VersionControlChangeType	Typ změny, která byla provedena u položky.
VersionControlRecursionType	Určuje, jestli se mají zahrnout podřízené položky (OneLevel), všichni potomci (úplní) nebo žádný.

ChangeCountDictionary

FileContentMetadata

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

GitChange

Name	Typ	Description
changeId	integer	ID změny v rámci skupiny změn
changeType	VersionControlChangeType	Typ změny, která byla provedena u položky.
item	string	Aktuální verze.
newContent	ItemContent	Obsah položky po změně.
newContentTemplate	GitTemplate	Nová šablona obsahu, která se má použít při vkládání nových změn.
originalPath	string	Původní cesta k položce, pokud se liší od aktuální cesty.
sourceServerItem	string	Cesta k položce na serveru.
url	string	Adresa URL pro načtení položky

GitCommitRef

Poskytuje vlastnosti, které popisují potvrzení Gitu a přidružená metadata.

Name	Typ	Description
_links	ReferenceLinks	Kolekce souvisejících odkazů rest.
author	GitUserDate	Autor potvrzení.
changeCounts	ChangeCountDictionary	Počítá typy změn (úpravy, odstranění atd.), které jsou součástí potvrzení.
changes	GitChange[]	Výčet změn zahrnutých v potvrzení.
comment	string	Komentář nebo zpráva potvrzení
commentTruncated	boolean	Označuje, jestli je komentář zkrácený od úplné zprávy o potvrzení Gitu.
commitId	string	ID (SHA-1) potvrzení.
commitTooManyChanges	boolean	Označuje, že potvrzení obsahuje příliš mnoho změn, které se dají zobrazit.
committer	GitUserDate	Committer potvrzení.
parents	string[]	Výčet ID nadřazeného potvrzení pro toto potvrzení.
push	GitPushRef	Nabízené oznámení přidružené k tomuto potvrzení.
remoteUrl	string	Vzdálená cesta URL k potvrzení.
statuses	GitStatus[]	Seznam metadat stavu ze služeb a rozšíření, která můžou k potvrzení přidružit další informace.
url	string	Adresa URL REST pro tento prostředek.
workItems	ResourceRef[]	Seznam pracovních položek přidružených k tomuto potvrzení.

GitItem

Name	Typ	Description
_links	ReferenceLinks	Třída představující kolekci odkazů REST.
commitId	string	SHA1 položky potvrzení se načte v
content	string
contentMetadata	FileContentMetadata
gitObjectType	GitObjectType	Typ objektu (Commit, Tree, Blob, Tag, ...)
isFolder	boolean
isSymLink	boolean
latestProcessedChange	GitCommitRef	Shallow ref to commit that last change this item Only if latestProcessedChange is requested May be not přesné if latest change is not cached
objectId	string	ID objektu Gitu
originalObjectId	string	ID objektu Gitu
path	string
url	string

GitObjectType

Typ objektu (Commit, Tree, Blob, Tag)

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

GitPushRef

Name	Typ	Description
_links	ReferenceLinks	Třída představující kolekci odkazů REST.
date	string
pushId	integer
pushedBy	IdentityRef
url	string

GitStatus

Tato třída obsahuje metadata služby nebo rozšíření, které publikuje stav.

Name	Typ	Description
_links	ReferenceLinks	Odkazy.
context	GitStatusContext	Kontext stavu.
createdBy	IdentityRef	Identita, která vytvořila stav.
creationDate	string	Datum a čas vytvoření stavu.
description	string	Popis stavu. Obvykle popisuje aktuální stav stavu.
id	integer	Identifikátor stavu.
state	GitStatusState	Stav stavu.
targetUrl	string	Adresa URL s podrobnostmi o stavu
updatedDate	string	Datum a čas poslední aktualizace stavu.

GitStatusContext

Kontext stavu, který jednoznačně identifikuje stav.

Name	Typ	Description
genre	string	Žánr stavu. Název služby nebo nástroje, který generuje stav, může být obvykle prázdný.
name	string	Identifikátor názvu stavu nesmí být null nebo prázdný.

GitStatusState

Stav stavu.

Name	Typ	Description
error	string	Stav s chybou.
failed	string	Stav selhal.
notApplicable	string	Stav se nevztahuje na cílový objekt.
notSet	string	Stav není nastavený. Výchozí stav.
pending	string	Stav čeká na vyřízení.
succeeded	string	Stav byl úspěšný.

GitTemplate

Name	Typ	Description
name	string	Název šablony
type	string	Typ šablony

GitUserDate

Informace o uživateli a datum pro operace Gitu

Name	Typ	Description
date	string	Datum operace Git.
email	string	Email adresu uživatele provádějícího operaci Git.
imageUrl	string	Adresa URL avatara uživatele
name	string	Jméno uživatele, který provádí operaci Git.

GitVersionOptions

Možnosti verze – Zadejte další modifikátory verze (např. Předchozí).

Name	Typ	Description
firstParent	string	První nadřazený prvek potvrzení (HEAD^)
none	string	Nezadá se
previousChange	string	Potvrzení změněné položky před aktuální verzí

GitVersionType

Typ verze (větev, značka nebo potvrzení). Určuje, jak se ID interpretuje.

Name	Typ	Description
branch	string	Interpretace verze jako názvu větve
commit	string	Interpretace verze jako ID potvrzení (SHA1)
tag	string	Interpretace verze jako názvu značky

IdentityRef

Name	Typ	Description
_links	ReferenceLinks	Toto pole obsahuje nula nebo více zajímavých odkazů o předmětu grafu. Tyto odkazy mohou být vyvolány za účelem získání dalších relací nebo podrobnějších informací o tomto předmětu grafu.
descriptor	string	Popisovač je primárním způsobem, jak odkazovat na předmět grafu, když je systém spuštěný. Toto pole jednoznačně identifikuje stejný předmět grafu napříč účty i organizacemi.
directoryAlias	string	Zastaralé – lze načíst dotazem uživatele Graphu, na který odkazuje položka "self" slovníku IdentityRef "_links".
displayName	string	Toto je jedinečný zobrazovaný název předmětu grafu. Pokud chcete toto pole změnit, musíte změnit jeho hodnotu ve zdrojovém poskytovateli.
id	string
imageUrl	string	Zastaralé – k dispozici v položce avatar ve slovníku IdentityRef "_links".
inactive	boolean	Zastaralé – lze načíst dotazem na stav členství graphu, na který odkazuje položka membershipState slovníku GraphUser "_links".
isAadIdentity	boolean	Zastaralé – lze odvodit z typu předmětu popisovače (Descriptor.IsAadUserType/Descriptor.IsAadGroupType).
isContainer	boolean	Zastaralé – lze odvodit z typu předmětu popisovače (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Zastaralé – nepoužívá se ve většině existujících implementací ToIdentityRef
uniqueName	string	Zastaralé – místo toho použijte Domain+PrincipalName.
url	string	Tato adresa URL je úplná trasa ke zdrojovému prostředku tohoto předmětu grafu.

ItemContent

Name	Typ	Description
content	string
contentType	ItemContentType

ItemContentType

Name	Typ	Description
base64Encoded	string
rawText	string

ReferenceLinks

Třída představující kolekci odkazů REST.

Name	Typ	Description
links	object	Zobrazení odkazů jen pro čtení. Vzhledem k tomu, že odkazy jsou jen pro čtení, chceme je zveřejnit jenom jako jen pro čtení.

ResourceRef

Name	Typ	Description
id	string
url	string

VersionControlChangeType

Typ změny, která byla provedena u položky.

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

Určuje, jestli se mají zahrnout podřízené položky (OneLevel), všichni potomci (úplní) nebo žádný.

Name	Typ	Description
full	string	Vrácení zadané položky a všech potomků
none	string	Vrátí pouze zadanou položku.
oneLevel	string	Vrátí zadanou položku a její přímé podřízené položky.
oneLevelPlusNestedEmptyFolders	string	Vrátí zadanou položku a její přímé podřízené položky a také rekurzivní řetězce vnořených podřízených složek, které obsahují pouze jednu složku.