Items - Get

Service:

Tfvc

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

Nazwa	W	Wymagane	Typ	Opis
organization	path	True	string	Nazwa organizacji usługi Azure DevOps.
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 kontroli wersji pojedynczego elementu do zwrócenia.
download	query		boolean	Jeśli to prawda, utwórz załącznik do pobrania.
fileName	query		string	zwrócona nazwa pliku elementu.
includeContent	query		boolean	Ustaw wartość true, aby uwzględnić zawartość elementu podczas żądania json. Wartość domyślna to false.
recursionLevel	query		VersionControlRecursionType	Brak (tylko element) lub OneLevel (zawartość folderu).
scopePath	query		string	Ścieżka kontroli wersji folderu w celu zwrócenia wielu elementów.
versionDescriptor.version	query		string	Obiekt wersji.
versionDescriptor.versionOption	query		TfvcVersionOption	Deskryptor wersji. Wartość domyślna to null.
versionDescriptor.versionType	query		TfvcVersionType	Deskryptor wersji. Wartość domyślna to null.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	TfvcItem	operacja zakończona powodzeniem Media Types: "text/plain", "application/octet-stream", "application/zip", "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

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

Definicje

Nazwa	Opis
FileContentMetadata
ReferenceLinks	Klasa reprezentująca kolekcję linków referencyjnych REST.
TfvcItem	Metadane elementu.
TfvcVersionOption	Domyślnie wartość Brak.
TfvcVersionType	Wartość domyślna to Latest (Najnowsza).
VersionControlRecursionType	Wartość domyślna to OneLevel.

FileContentMetadata

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

TfvcItem

Metadane elementu.

Nazwa	Typ	Opis
_links	ReferenceLinks	Klasa reprezentująca kolekcję linków referencyjnych REST.
changeDate	string	Element zmienił datę/godzinę.
content	string
contentMetadata	FileContentMetadata
deletionId	integer	Więcej niż 0, jeśli element zostanie usunięty.
encoding	integer	Kodowanie plików z bazy danych, -1 reprezentuje dane binarne.
hashValue	string	Skrót MD5 jako ciąg podstawowy 64 dotyczy tylko plików.
isBranch	boolean	Prawda, jeśli element jest gałęzią.
isFolder	boolean
isPendingChange	boolean	Wartość True, jeśli istnieje oczekująca zmiana.
isSymLink	boolean
path	string
size	integer	Rozmiar pliku, jeśli ma to zastosowanie.
url	string
version	integer	Identyfikator wersji zestawu zmian.

TfvcVersionOption

Domyślnie wartość Brak.

Nazwa	Typ	Opis
none	string	Brak.
previous	string	Zwróć poprzednią wersję.
useRename	string	Tylko możliwe do użycia z wersją versiontype MergeSource i integer używa identyfikatora RenameSource zamiast identyfikatora scalania.

TfvcVersionType

Wartość domyślna to Latest (Najnowsza).

Nazwa	Typ	Opis
change	string	Wersja jest traktowana jako zmiana.
changeset	string	Wersja jest traktowana jako identyfikator ChangesetId.
date	string	Wersja jest traktowana jako data.
latest	string	Jeśli zostanie zdefiniowana wersja najnowsza z tej wersji, jeśli nie zdefiniowano żadnej wersji, zostanie użyta najnowsza wartość ChangesetId.
mergeSource	string	Wersja będzie traktowana jako źródło scalania.
none	string	Wersja jest traktowana jako identyfikator ChangesetId.
shelveset	string	Wersja jest traktowana jako nazwa zestawu półek i właściciel.
tip	string	Wersja będzie traktowana jako porada, jeśli nie zdefiniowano najnowszej wersji, zostanie użyta.

VersionControlRecursionType

Wartość domyślna to OneLevel.

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.