Items - Get

Service:

Tfvc

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 vrací jako stažený obsah.

GET https://dev.azure.com/{organization}/{project}/_apis/tfvc/items?path={path}&api-version=7.1-preview.1

With optional parameters:

GET https://dev.azure.com/{organization}/{project}/_apis/tfvc/items?path={path}&fileName={fileName}&download={download}&scopePath={scopePath}&recursionLevel={recursionLevel}&versionDescriptor.version={versionDescriptor.version}&versionDescriptor.versionOption={versionDescriptor.versionOption}&versionDescriptor.versionType={versionDescriptor.versionType}&includeContent={includeContent}&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.
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 správy verzí jednotlivé položky, která se má vrátit.
download	query		boolean	Pokud ano, vytvořte přílohu ke stažení.
fileName	query		string	název souboru vrácené položky.
includeContent	query		boolean	Pokud chcete zahrnout obsah položky při žádosti o json, nastavte na hodnotu true. Výchozí hodnota je false.
recursionLevel	query		VersionControlRecursionType	Žádný (jenom položka) nebo OneLevel (obsah složky).
scopePath	query		string	Cesta správy verzí složky pro vrácení více položek.
versionDescriptor.version	query		string	Objekt Verze.
versionDescriptor.versionOption	query		TfvcVersionOption	Popisovač verze. Výchozí hodnota je null.
versionDescriptor.versionType	query		TfvcVersionType	Popisovač verze. Výchozí hodnota je null.

Odpovědi

Name	Typ	Description
200 OK	TfvcItem	úspěšná operace Media Types: "text/plain", "application/octet-stream", "application/zip", "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

GET item metadata and/or content for a single item.

Sample Request

HTTP

GET https://dev.azure.com/{organization}/_apis/tfvc/items?path=$/MyFirstProject/ExampleFolder/TestFile01.txt&api-version=7.1-preview.1

Sample Response

Status code:

200

{
  "version": 10,
  "changeDate": "2019-05-29T18:00:23.457Z",
  "size": 4,
  "hashValue": "CY9rzUYh03PK3k6DJie09g==",
  "encoding": 65001,
  "path": "$/MyFirstProject/ExampleFolder/TestFile01.txt",
  "contentMetadata": {
    "encoding": 65001,
    "contentType": "text/plain",
    "fileName": "TestFile01.txt",
    "extension": ".txt",
    "vsLink": "vsweb://vs/?Product=Visual_Studio&Gen=2013&EncFormat=UTF8&tfslink=dnN0ZnM6Ly8vVmVyc2lvbkNvbnRyb2wvTGF1bmNoTGF0ZXN0VmVyc2lvbmVkSXRlbS8lMjQlMmZNeUZpcnN0UHJvamVjdCUyZkV4YW1wbGVGb2xkZXIlMmZUZXN0RmlsZTAxLnR4dD9wcm9qZWN0PTg3NDQ2MjJkLTdmMGUtNDZlZi04ZjViLWUxNzk2MjNhNGI1YyZ1cmw9aHR0cHMlM0ElMkYlMkZjb2RlZGV2Lm1zJTJGa2V2aW5tY3B6NDIwJTJG"
  },
  "url": "https://codedev.ms/fabrikam/_apis/tfvc/items/$/MyFirstProject/ExampleFolder/TestFile01.txt?versionType=Latest&versionOptions=None",
  "_links": {
    "self": {
      "href": "https://codedev.ms/fabrikam/_apis/tfvc/items/$/MyFirstProject/ExampleFolder/TestFile01.txt?versionType=Changeset&version=10"
    }
  }
}

Definice

Name	Description
FileContentMetadata
ReferenceLinks	Třída představující kolekci odkazů REST.
TfvcItem	Metadata položky.
TfvcVersionOption	Výchozí hodnota je Žádná.
TfvcVersionType	Výchozí hodnota je Nejnovější.
VersionControlRecursionType	Výchozí hodnota je OneLevel.

FileContentMetadata

Name	Typ	Description
contentType	string
encoding	integer
extension	string
fileName	string
isBinary	boolean
isImage	boolean
vsLink	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í.

TfvcItem

Metadata položky.

Name	Typ	Description
_links	ReferenceLinks	Třída představující kolekci odkazů REST.
changeDate	string	Položka změnila datum a čas.
content	string
contentMetadata	FileContentMetadata
deletionId	integer	Větší než 0, pokud je položka odstraněna.
encoding	integer	Kódování souboru z databáze, -1 představuje binární.
hashValue	string	Hodnota hash MD5 jako základní řetězec 64 se vztahuje pouze na soubory.
isBranch	boolean	Hodnota True, pokud je položka větev.
isFolder	boolean
isPendingChange	boolean	True, pokud se čeká na změnu.
isSymLink	boolean
path	string
size	integer	Velikost souboru, pokud je k dispozici.
url	string
version	integer	ID verze sady změn.

TfvcVersionOption

Výchozí hodnota je Žádná.

Name	Typ	Description
none	string	Žádné
previous	string	Vrátí předchozí verzi.
useRename	string	Použitelné pouze s versiontype MergeSource a celočíselnými verzemi, používá identifikátor RenameSource místo identifikátoru sloučení.

TfvcVersionType

Výchozí hodnota je Nejnovější.

Name	Typ	Description
change	string	Verze se považuje za změnu.
changeset	string	Verze se považuje za Id sady změn.
date	string	Verze se považuje za datum.
latest	string	Pokud je definována verze, použije se nejnovější verze této verze, pokud není definována žádná verze, použije se nejnovější Id sady změn.
mergeSource	string	Verze bude považována za MergeSource.
none	string	Verze se považuje za Id sady změn.
shelveset	string	Verze se považuje za název a vlastníka sady odložených odložených odkládacích adres.
tip	string	Verze bude považována za tip, pokud není definována žádná verze, použije se nejnovější verze.

VersionControlRecursionType

Výchozí hodnota je OneLevel.

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.