Items - Get

Ссылка

Служба:: Git

Версия API:: 7.1

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

GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/items?path={path}&api-version=7.1

С использованием необязательных параметров:

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
organization	path	True	string	Имя организации Azure DevOps.
repositoryId	path	True	string	Имя или идентификатор репозитория.
project	path		string	Идентификатор проекта или имя проекта
api-version	query	True	string	Используемая версия API. Для использования этой версии API необходимо задать значение "7.1".
path	query	True	string	Путь к элементу.
$format	query		string	Если задано, это переопределяет заголовок запроса HTTP Accept, чтобы вернуть json или zip. Если указан $format, то в качестве параметра запроса также следует указать версию API.
download	query		boolean	Задайте значение true, чтобы скачать ответ в виде файла. Значение по умолчанию — false.
includeContent	query		boolean	Задайте значение true, чтобы включить содержимое элемента при запросе json. Значение по умолчанию — false.
includeContentMetadata	query		boolean	Задайте значение true, чтобы включить метаданные содержимого. Значение по умолчанию — false.
latestProcessedChange	query		boolean	Установите значение true, чтобы включить последние изменения. Значение по умолчанию — false.
recursionLevel	query		VersionControlRecursionType	Уровень рекурсии этого запроса. Значение по умолчанию — none, рекурсия не выполняется.
resolveLfs	query		boolean	Задайте значение true, чтобы разрешить файлы указателя Git LFS, чтобы вернуть фактическое содержимое из Git LFS. Значение по умолчанию — false.
sanitize	query		boolean	Задайте значение true для очистки svg-файла и возврата его в виде изображения. Полезно только в том случае, если запрашивается svg-файл. Значение по умолчанию — false.
scopePath	query		string	Область пути. Значение по умолчанию равно NULL.
versionDescriptor.version	query		string	Идентификатор строки версии (имя тега или ветви, SHA1 фиксации)
versionDescriptor.versionOptions	query		GitVersionOptions	Параметры версии— укажите дополнительные модификаторы в версию (например, Назад)
versionDescriptor.versionType	query		GitVersionType	Тип версии (ветвь, тег или фиксация). Определяет, как интерпретируется идентификатор

Ответы

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

Имя

Тип

Описание

200 OK

GitItem

успешная операция

Media Types: "application/zip", "text/plain", "application/octet-stream", "application/json"

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

oauth2

Тип: oauth2
Flow: accessCode
URL-адрес авторизации: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
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

Области

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

Имя

Описание

vso.code

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

Примеры

Download

Get metadata

Download

Образец запроса

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

Пример ответа

Код состояния:: 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

Образец запроса

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

Пример ответа

Код состояния:: 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"
    }
  ]
}

Определения

Имя	Описание
ChangeCountDictionary
FileContentMetadata
GitChange
GitCommitRef	Предоставляет свойства, описывающие фиксацию Git и связанные метаданные.
GitItem
GitObjectType	Тип объекта (Commit, Tree, BLOB-объект, Tag)
GitPushRef
GitStatus	Этот класс содержит метаданные службы или расширения, публикующих состояние.
GitStatusContext	Контекст состояния, который однозначно идентифицирует состояние.
GitStatusState	Состояние состояния.
GitTemplate
GitUserDate	Сведения о пользователе и датах операций Git.
GitVersionOptions	Параметры версии— укажите дополнительные модификаторы в версию (например, Назад)
GitVersionType	Тип версии (ветвь, тег или фиксация). Определяет, как интерпретируется идентификатор
IdentityRef
ItemContent
ItemContentType
ReferenceLinks	Класс, представляющий коллекцию ссылок REST.
ResourceRef
VersionControlChangeType	Тип изменений, внесенных в элемент.
VersionControlRecursionType	Указывает, следует ли включать дочерние элементы (OneLevel), все потомки (Full) или None

ChangeCountDictionary

Object

FileContentMetadata

Object

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

GitChange

Object

Имя	Тип	Описание
changeId	integer (int32)	Идентификатор изменения в группе изменений.
changeType	VersionControlChangeType	Тип изменений, внесенных в элемент.
item	string (T)	Текущая версия.
newContent	ItemContent	Содержимое элемента после изменения.
newContentTemplate	GitTemplate	Новый шаблон контента, используемый при отправке новых изменений.
originalPath	string	Исходный путь элемента, если отличается от текущего пути.
sourceServerItem	string	Путь к элементу на сервере.
url	string	URL-адрес для получения элемента.

GitCommitRef

Object

Предоставляет свойства, описывающие фиксацию Git и связанные метаданные.

Имя	Тип	Описание
_links	ReferenceLinks	Коллекция связанных ссылок REST.
author	GitUserDate	Автор фиксации.
changeCounts	ChangeCountDictionary	Количество типов изменений (правки, удаления и т. д.), включенных в фиксацию.
changes	GitChange[]	Перечисление изменений, включенных в фиксацию.
comment	string	Комментарий или сообщение фиксации.
commentTruncated	boolean	Указывает, усечен ли комментарий из полного сообщения о фиксации Git.
commitId	string	Идентификатор (SHA-1) фиксации.
commitTooManyChanges	boolean	Указывает, что фиксация содержит слишком много изменений для отображения
committer	GitUserDate	Фиксация фиксации.
parents	string[]	Перечисление идентификаторов родительских фиксаций для этой фиксации.
push	GitPushRef	Отправка, связанная с этой фиксацией.
remoteUrl	string	Удаленный путь URL-адреса к фиксации.
statuses	GitStatus[]	Список метаданных состояния из служб и расширений, которые могут связывать дополнительные сведения с фиксацией.
url	string	REST URL-адрес для этого ресурса.
workItems	ResourceRef[]	Список рабочих элементов, связанных с этой фиксацией.

GitItem

Object

Имя	Тип	Описание
_links	ReferenceLinks	Класс, представляющий коллекцию ссылок REST.
commitId	string	SHA1 элемента фиксации извлекался по адресу
content	string
contentMetadata	FileContentMetadata
gitObjectType	GitObjectType	Тип объекта (Commit, Tree, Blob, Tag, ...)
isFolder	boolean
isSymLink	boolean
latestProcessedChange	GitCommitRef	Неглубокое ссылка на фиксацию, которая в последний раз изменила этот элемент, заполняется только в том случае, если запрашивается последняя обработкаProcessedChange может не быть точной, если последнее изменение еще не кэшировано
objectId	string	Идентификатор объекта Git
originalObjectId	string	Идентификатор объекта Git
path	string
url	string

GitObjectType

Перечисление

Тип объекта (Commit, Tree, BLOB-объект, Tag)

Значение	Описание
bad
blob
commit
ext2
ofsDelta
refDelta
tag
tree

GitPushRef

Object

Имя	Тип	Описание
_links	ReferenceLinks	Класс, представляющий коллекцию ссылок REST.
date	string (date-time)
pushId	integer (int32)
pushedBy	IdentityRef
url	string

GitStatus

Object

Этот класс содержит метаданные службы или расширения, публикующих состояние.

Имя	Тип	Описание
_links	ReferenceLinks	Справочные ссылки.
context	GitStatusContext	Контекст состояния.
createdBy	IdentityRef	Удостоверение, создающее состояние.
creationDate	string (date-time)	Дата и время создания состояния.
description	string	Описание состояния. Обычно описывает текущее состояние состояния.
id	integer (int32)	Идентификатор состояния.
state	GitStatusState	Состояние состояния.
targetUrl	string	URL-адрес со сведениями о состоянии.
updatedDate	string (date-time)	Дата последнего обновления и время состояния.

GitStatusContext

Object

Контекст состояния, который однозначно идентифицирует состояние.

Имя	Тип	Описание
genre	string	Жанр состояния. Обычно имя службы или инструмента, создающего состояние, может быть пустым.
name	string	Идентификатор имени состояния не может быть пустым или пустым.

GitStatusState

Перечисление

Состояние состояния.

Значение	Описание
error	Состояние с ошибкой.
failed	Сбой состояния.
notApplicable	Состояние не применимо к целевому объекту.
notSet	Состояние состояния не задано. Состояние по умолчанию.
pending	Состояние ожидается.
succeeded	Состояние выполнено успешно.

GitTemplate

Object

Имя	Тип	Описание
name	string	Имя шаблона
type	string	Тип шаблона

GitUserDate

Object

Сведения о пользователе и датах операций Git.

Имя	Тип	Описание
date	string (date-time)	Дата операции Git.
email	string	Адрес электронной почты пользователя, выполняющего операцию Git.
imageUrl	string	URL-адрес аватара пользователя.
name	string	Имя пользователя, выполняющего операцию Git.

GitVersionOptions

Перечисление

Параметры версии— укажите дополнительные модификаторы в версию (например, Назад)

Значение	Описание
firstParent	Первый родительский элемент фиксации (HEAD^)
none	Не указано
previousChange	Фиксация измененного элемента до текущей версии

GitVersionType

Перечисление

Тип версии (ветвь, тег или фиксация). Определяет, как интерпретируется идентификатор

Значение	Описание
branch	Интерпретирует версию как имя ветви
commit	Интерпретируйте версию как идентификатор фиксации (SHA1)
tag	Интерпретирует версию как имя тега

IdentityRef

Object

Имя	Тип	Описание
_links	ReferenceLinks	Это поле содержит нулевые или более интересные ссылки на тему графа. Эти ссылки могут вызываться для получения дополнительных связей или более подробных сведений об этой теме графа.
descriptor	string	Дескриптор является основным способом ссылки на тему графа во время выполнения системы. Это поле однозначно определяет одну и ту же тему графа как в учетных записях, так и в организациях.
directoryAlias	string	Нерекомендуемое. Можно получить, запросив пользователя Graph, на который ссылается пользователь Graph в записи "self" словаря IdentityRef "_links"
displayName	string	Это не уникальное отображаемое имя субъекта графа. Чтобы изменить это поле, необходимо изменить его значение в исходном поставщике.
id	string
imageUrl	string	Не рекомендуется . Доступно в записи "аватар" словаря IdentityRef "_links"
inactive	boolean	Нерекомендуемый — можно получить, запросив состояние членства Graph, на которое ссылается запись "membershipState" словаря GraphUser "_links"
isAadIdentity	boolean	Нерекомендуемый — можно выводить из типа субъекта дескриптора (descriptor.IsAadUserType/descriptor.IsAadGroupType)
isContainer	boolean	Нерекомендуемый — можно выводить из типа субъекта дескриптора (descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Не рекомендуется — не используется в большинстве стандартных реализаций ToIdentityRef
uniqueName	string	Не рекомендуется — вместо этого используйте domain+PrincipalName
url	string	Этот URL-адрес является полным маршрутом к исходному ресурсу данного субъекта графа.

ItemContent

Object

Имя	Тип	Описание
content	string
contentType	ItemContentType

ItemContentType

Перечисление

Значение	Описание
base64Encoded
rawText

ReferenceLinks

Object

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

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

ResourceRef

Object

Имя	Тип	Описание
id	string
url	string

VersionControlChangeType

Перечисление

Тип изменений, внесенных в элемент.

Значение	Описание
add
all
branch
delete
edit
encoding
lock
merge
none
property
rename
rollback
sourceRename
targetRename
undelete

VersionControlRecursionType

Перечисление

Указывает, следует ли включать дочерние элементы (OneLevel), все потомки (Full) или None

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

Поделиться через

Items - Get

Параметры URI

Ответы

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

oauth2

Области

Примеры

Download

Образец запроса

Пример ответа

Get metadata

Образец запроса

Пример ответа

Определения

ChangeCountDictionary

FileContentMetadata

GitChange

GitCommitRef

GitItem

GitObjectType

GitPushRef

GitStatus

GitStatusContext

GitStatusState

GitTemplate

GitUserDate

GitVersionOptions

GitVersionType

IdentityRef

ItemContent

ItemContentType

ReferenceLinks

ResourceRef

VersionControlChangeType

VersionControlRecursionType

Дополнительные ресурсы