Items - Get

Service:

Tfvc

API Version:

7.1-preview.1

Получение метаданных элемента и (или) содержимого для одного элемента. Параметр скачивания указывает, должно ли содержимое быть доступным в ответе как скачивание или просто отправлено в виде потока. Не применяется к zip-содержимому, которое всегда возвращается при скачивании.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
organization	path	True	string	Название организации Azure DevOps.
project	path		string	Идентификатор проекта или имя проекта
api-version	query	True	string	Используемая версия API. Для использования этой версии API необходимо задать значение 7.1-preview.1.
path	query	True	string	Путь к элементу управления версиями отдельного возвращаемого элемента.
download	query		boolean	Если значение равно true, создайте скачиваемое вложение.
fileName	query		string	имя возвращаемого элемента.
includeContent	query		boolean	Задайте значение true, чтобы включить содержимое элемента при запросе JSON. Значение по умолчанию — false.
recursionLevel	query		VersionControlRecursionType	None (только элемент) или OneLevel (содержимое папки).
scopePath	query		string	Путь управления версиями к папке для возврата нескольких элементов.
versionDescriptor.version	query		string	Объект версии.
versionDescriptor.versionOption	query		TfvcVersionOption	Дескриптор версии. Значением по умолчанию является NULL.
versionDescriptor.versionType	query		TfvcVersionType	Дескриптор версии. Значением по умолчанию является NULL.

Ответы

Имя	Тип	Описание
200 OK	TfvcItem	успешная операция Media Types: "text/plain", "application/octet-stream", "application/zip", "application/json"

Безопасность

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

Имя	Описание
vso.code	Предоставляет возможность чтения исходного кода и метаданных о фиксациях, наборах изменений, ветвях и других артефактах управления версиями. Также предоставляет возможность поиска кода и получения уведомлений о событиях управления версиями с помощью перехватчиков служб.

Примеры

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

Определения

Имя	Описание
FileContentMetadata
ReferenceLinks	Класс, представляющий коллекцию ссылок REST.
TfvcItem	Метаданные для элемента.
TfvcVersionOption	Значение по умолчанию — None (Нет).
TfvcVersionType	Значение по умолчанию — Последняя.
VersionControlRecursionType	По умолчанию — OneLevel.

FileContentMetadata

Имя	Тип	Описание
contentType	string
encoding	integer
extension	string
fileName	string
isBinary	boolean
isImage	boolean
vsLink	string

ReferenceLinks

Класс, представляющий коллекцию ссылок REST.

Имя	Тип	Описание
links	object	Представление ссылок только для чтения. Так как ссылочные ссылки доступны только для чтения, мы хотим предоставить их только для чтения.

TfvcItem

Метаданные для элемента.

Имя	Тип	Описание
_links	ReferenceLinks	Класс, представляющий коллекцию ссылок REST.
changeDate	string	Дата и время изменения элемента.
content	string
contentMetadata	FileContentMetadata
deletionId	integer	Больше 0, если элемент удален.
encoding	integer	Кодировка файла из базы данных, -1 представляет двоичный файл.
hashValue	string	Хэш MD5 в виде строки base 64 применяется только к файлам.
isBranch	boolean	Значение true, если item является ветвью.
isFolder	boolean
isPendingChange	boolean	Значение true, если ожидается изменение.
isSymLink	boolean
path	string
size	integer	Размер файла, если применимо.
url	string
version	integer	Идентификатор версии набора изменений.

TfvcVersionOption

Значение по умолчанию — None (Нет).

Имя	Тип	Описание
none	string	Нет.
previous	string	Возвращает предыдущую версию.
useRename	string	Только для использования с типом версии MergeSource и целочисленными версиями используется идентификатор RenameSource вместо идентификатора слияния.

TfvcVersionType

Значение по умолчанию — Последняя.

Имя	Тип	Описание
change	string	Версия обрабатывается как изменение.
changeset	string	Версия обрабатывается как ChangesetId.
date	string	Версия обрабатывается как дата.
latest	string	Если версия определена, будет использоваться последняя из этой версии, если версия не определена, будет использоваться последний ChangesetId.
mergeSource	string	Версия будет рассматриваться как MergeSource.
none	string	Версия обрабатывается как ChangesetId.
shelveset	string	Версия рассматривается как имя и владелец набора полок.
tip	string	Версия будет рассматриваться как подсказка, если не определена последняя версия, будет использоваться.

VersionControlRecursionType

По умолчанию — OneLevel.

Имя	Тип	Описание
full	string	Возврат указанного элемента и всех потомков
none	string	Возвращает только указанный элемент.
oneLevel	string	Возвращает указанный элемент и его прямые дочерние элементы.
oneLevelPlusNestedEmptyFolders	string	Возвращает указанный элемент и его прямые дочерние элементы, а также рекурсивные цепочки вложенных дочерних папок, содержащих только одну папку.