Udostępnij przez

Items - Get

  • Odwołanie
Usługa:
Tfvc
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/tfvc/items?path={path}&api-version=7.1
Z parametrami opcjonalnymi: 
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

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. Należy ustawić wartość "7.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 pliku 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

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

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

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:
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 ma wartość Brak.
TfvcVersionType

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

Wartość domyślna to OneLevel.

FileContentMetadata

Objekt
Nazwa Typ Opis
contentType

string

encoding

integer (int32)

extension

string

fileName

string

isBinary

boolean

isImage

boolean

vsLink

string

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.

TfvcItem

Objekt

Metadane elementu.

Nazwa Typ Opis
_links

ReferenceLinks

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

string (date-time)

Element zmienił datę/godzinę.
content

string

contentMetadata

FileContentMetadata

deletionId

integer (int32)

Więcej niż 0, jeśli element zostanie usunięty.
encoding

integer (int32)

Kodowanie plików z bazy danych -1 reprezentuje dane binarne.
hashValue

string

Skrót MD5 jako podstawowy ciąg 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 (int64)

Rozmiar pliku, jeśli ma to zastosowanie.
url

string

version

integer (int32)

Identyfikator wersji zestawu zmian.

TfvcVersionOption

Wyliczanie

Domyślnie ma wartość Brak.

Wartość Opis
none

Żaden.
previous

Zwróć poprzednią wersję.
useRename

Tylko z wersji versiontype MergeSource i integer używa identyfikatora RenameSource zamiast identyfikatora scalania.

TfvcVersionType

Wyliczanie

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

Wartość Opis
change

Wersja jest traktowana jako zmiana.
changeset

Wersja jest traktowana jako identyfikator ChangesetId.
date

Wersja jest traktowana jako data.
latest

Jeśli zostanie zdefiniowana wersja najnowsza z tej wersji, jeśli nie zdefiniowano żadnej wersji, zostanie użyta najnowsza wartość ChangesetId.
mergeSource

Wersja będzie traktowana jako źródło scalania.
none

Wersja jest traktowana jako identyfikator ChangesetId.
shelveset

Wersja jest traktowana jako nazwa zestawu na półce i właściciel.
tip

Wersja będzie traktowana jako porada, jeśli nie zdefiniowano najnowszej wersji, zostanie użyta.

VersionControlRecursionType

Wyliczanie

Wartość domyślna to OneLevel.

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.