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


Items - Get

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

GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/items?path={path}&api-version=7.1-preview.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-preview.1

Параметры URI

Имя В Обязательно Тип Описание
organization
path True

string

Название организации Azure DevOps.

repositoryId
path True

string

Имя или идентификатор репозитория.

project
path

string

Идентификатор проекта или имя проекта

api-version
query True

string

Используемая версия API. Для использования этой версии API необходимо задать значение 7.1-preview.1.

path
query True

string

Путь к элементу.

$format
query

string

Если этот параметр указан, он переопределяет заголовок HTTP-запроса Accept, чтобы он возвращал json или zip. Если указано $format, в качестве параметра запроса также следует указать api-version.

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 для возврата фактического содержимого из LFS Git. Значение по умолчанию — 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"

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

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 Предоставляет возможность чтения исходного кода и метаданных о фиксациях, наборах изменений, ветвях и других артефактах управления версиями. Также предоставляет возможность поиска кода и получения уведомлений о событиях управления версиями с помощью перехватчиков служб.

Примеры

Download
Get metadata

Download

Sample Request

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-preview.1

Sample Response

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

Sample Request

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-preview.1

Sample Response

{
  "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), все потомки (Полный) или None.

ChangeCountDictionary

FileContentMetadata

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

string

encoding

integer

extension

string

fileName

string

isBinary

boolean

isImage

boolean

vsLink

string

GitChange

Имя Тип Описание
changeId

integer

Идентификатор изменения в группе изменений.

changeType

VersionControlChangeType

Тип изменения, внесенного в элемент.

item

string

Текущая версия.

newContent

ItemContent

Содержимое элемента после изменения.

newContentTemplate

GitTemplate

Новый шаблон содержимого, используемый при отправке новых изменений.

originalPath

string

Исходный путь к элементу, если он отличается от текущего пути.

sourceServerItem

string

Путь к элементу на сервере.

url

string

URL-адрес для получения элемента.

GitCommitRef

Предоставляет свойства, описывающие фиксацию 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

URL-адрес REST для этого ресурса.

workItems

ResourceRef[]

Список рабочих элементов, связанных с этой фиксацией.

GitItem

Имя Тип Описание
_links

ReferenceLinks

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

commitId

string

SHA1 элемента фиксации был возвращен в

content

string

contentMetadata

FileContentMetadata

gitObjectType

GitObjectType

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

isFolder

boolean

isSymLink

boolean

latestProcessedChange

GitCommitRef

Мелкий ссылка на фиксацию последнего изменения этого элемента, заполняется, только если запрашивается latestProcessedChange Может быть неточным, если последнее изменение еще не кэшировано

objectId

string

Идентификатор объекта Git

originalObjectId

string

Идентификатор объекта Git

path

string

url

string

GitObjectType

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

Имя Тип Описание
bad

string

blob

string

commit

string

ext2

string

ofsDelta

string

refDelta

string

tag

string

tree

string

GitPushRef

Имя Тип Описание
_links

ReferenceLinks

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

date

string

pushId

integer

pushedBy

IdentityRef

url

string

GitStatus

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

Имя Тип Описание
_links

ReferenceLinks

Ссылки на справочные материалы.

context

GitStatusContext

Контекст состояния.

createdBy

IdentityRef

Удостоверение, создающее состояние.

creationDate

string

Дата и время создания состояния.

description

string

Описание состояния. Обычно описывает текущее состояние состояния.

id

integer

Идентификатор состояния.

state

GitStatusState

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

targetUrl

string

URL-адрес со сведениями о состоянии.

updatedDate

string

Дата и время последнего обновления состояния.

GitStatusContext

Контекст состояния, однозначно определяющий состояние.

Имя Тип Описание
genre

string

Жанр состояния. Как правило, имя службы или средства, создающего состояние, может быть пустым.

name

string

Идентификатор имени состояния, не может быть пустым или пустым.

GitStatusState

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

Имя Тип Описание
error

string

Состояние с ошибкой.

failed

string

Сбой состояния.

notApplicable

string

Состояние неприменимо к целевому объекту.

notSet

string

Состояние состояния не задано. Состояние по умолчанию.

pending

string

Состояние ожидания.

succeeded

string

Состояние выполнено успешно.

GitTemplate

Имя Тип Описание
name

string

Имя шаблона

type

string

Тип шаблона

GitUserDate

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

Имя Тип Описание
date

string

Дата операции Git.

email

string

Email адрес пользователя, выполняющего операцию Git.

imageUrl

string

URL-адрес аватара пользователя.

name

string

Имя пользователя, выполняющего операцию Git.

GitVersionOptions

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

Имя Тип Описание
firstParent

string

Первый родительский элемент фиксации (HEAD^)

none

string

Не указано

previousChange

string

Фиксация измененного элемента до текущей версии

GitVersionType

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

Имя Тип Описание
branch

string

Интерпретировать версию как имя ветви

commit

string

Интерпретация версии как ИД фиксации (SHA1)

tag

string

Интерпретация версии как имени тега

IdentityRef

Имя Тип Описание
_links

ReferenceLinks

Это поле содержит ноль или более интересных ссылок на тему графа. Эти ссылки можно вызвать для получения дополнительных связей или более подробных сведений об этой теме графа.

descriptor

string

Дескриптор является основным способом ссылки на субъект графа во время работы системы. Это поле однозначно идентифицирует одну и ту же тему графа как в учетных записях, так и в организациях.

directoryAlias

string

Нерекомендуемый — можно получить, запросив пользователя 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

Нерекомендуемый — используйте вместо этого домен+имя_субъекта

url

string

Этот URL-адрес является полным маршрутом к исходному ресурсу этого субъекта графа.

ItemContent

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

string

contentType

ItemContentType

ItemContentType

Имя Тип Описание
base64Encoded

string

rawText

string

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

Имя Тип Описание
links

object

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

ResourceRef

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

string

url

string

VersionControlChangeType

Тип изменения, внесенного в элемент.

Имя Тип Описание
add

string

all

string

branch

string

delete

string

edit

string

encoding

string

lock

string

merge

string

none

string

property

string

rename

string

rollback

string

sourceRename

string

targetRename

string

undelete

string

VersionControlRecursionType

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

Имя Тип Описание
full

string

Возврат указанного элемента и всех потомков

none

string

Возвращает только указанный элемент.

oneLevel

string

Возвращает указанный элемент и его прямые дочерние элементы.

oneLevelPlusNestedEmptyFolders

string

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