Pushes - Get

Ссылка

Служба:: Git

Версия API:: 7.1

Извлекает определенную отправку.

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

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

GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pushes/{pushId}?includeCommits={includeCommits}&includeRefUpdates={includeRefUpdates}&api-version=7.1

Параметры URI

Имя	В	Обязательно	Тип	Описание
organization	path	True	string	Имя организации Azure DevOps.
pushId	path	True	integer (int32)	Идентификатор принудительной отправки.
repositoryId	path	True	string	Имя или идентификатор репозитория.
project	path		string	Идентификатор проекта или имя проекта
api-version	query	True	string	Используемая версия API. Для использования этой версии API необходимо задать значение "7.1".
includeCommits	query		integer (int32)	Число фиксаций, включаемых в результат.
includeRefUpdates	query		boolean	Если значение true, добавьте список ссылок, которые были обновлены push-отправкой.

Ответы

Имя	Тип	Описание
200 OK	GitPush	успешная операция

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

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

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

Примеры

Just the push

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

HTTP

GET https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/pushes/23?api-version=7.1

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

Код состояния:: 200

{
  "commits": [],
  "pushedBy": {
    "id": "d6245f20-2af8-44f4-9451-8107cb2767db",
    "displayName": "Normal Paulk",
    "uniqueName": "fabrikamfiber16@hotmail.com",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d6245f20-2af8-44f4-9451-8107cb2767db",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d6245f20-2af8-44f4-9451-8107cb2767db"
  },
  "pushId": 23,
  "date": "2014-06-30T18:11:18.0929091Z",
  "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/pushes/23",
  "_links": {
    "self": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/pushes/23"
    },
    "repository": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249"
    },
    "commits": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/pushes/23/commits"
    },
    "pusher": {
      "href": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d6245f20-2af8-44f4-9451-8107cb2767db"
    }
  }
}

Определения

Имя	Описание
ChangeCountDictionary
GitChange
GitCommitRef	Предоставляет свойства, описывающие фиксацию Git и связанные метаданные.
GitPush
GitPushRef
GitRefUpdate
GitRepository
GitRepositoryRef
GitStatus	Этот класс содержит метаданные службы или расширения, публикующих состояние.
GitStatusContext	Контекст состояния, который однозначно идентифицирует состояние.
GitStatusState	Состояние состояния.
GitTemplate
GitUserDate	Сведения о пользователе и датах операций Git.
IdentityRef
ItemContent
ItemContentType
ProjectState	Состояние проекта.
ProjectVisibility	Видимость проекта.
ReferenceLinks	Класс, представляющий коллекцию ссылок REST.
ResourceRef
TeamProjectCollectionReference	Ссылочный объект для TeamProjectCollection.
TeamProjectReference	Представляет неглубокую ссылку на TeamProject.
VersionControlChangeType	Тип изменений, внесенных в элемент.

ChangeCountDictionary

Object

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[]	Список рабочих элементов, связанных с этой фиксацией.

GitPush

Object

Имя	Тип	Описание
_links	ReferenceLinks	Класс, представляющий коллекцию ссылок REST.
commits	GitCommitRef[]	Предоставляет свойства, описывающие фиксацию Git и связанные метаданные.
date	string (date-time)
pushId	integer (int32)
pushedBy	IdentityRef
refUpdates	GitRefUpdate[]
repository	GitRepository
url	string

GitPushRef

Object

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

GitRefUpdate

Object

Имя	Тип	Описание
isLocked	boolean
name	string
newObjectId	string
oldObjectId	string
repositoryId	string (uuid)

GitRepository

Object

Имя	Тип	Описание
_links	ReferenceLinks	Класс, представляющий коллекцию ссылок REST.
defaultBranch	string
id	string (uuid)
isDisabled	boolean	Значение true, если репозиторий отключен. Значение false. В противном случае.
isFork	boolean	Значение True, если репозиторий был создан в качестве вилки.
isInMaintenance	boolean	Значение true, если репозиторий находится в обслуживании. Значение false. В противном случае.
name	string
parentRepository	GitRepositoryRef
project	TeamProjectReference	Представляет неглубокую ссылку на TeamProject.
remoteUrl	string
size	integer (int64)	Сжатый размер (байт) репозитория.
sshUrl	string
url	string
validRemoteUrls	string[]
webUrl	string

GitRepositoryRef

Object

Имя	Тип	Описание
collection	TeamProjectCollectionReference	Коллекция командных проектов, в которой находится этот вил
id	string (uuid)
isFork	boolean	Значение true, если репозиторий был создан в качестве вилки
name	string
project	TeamProjectReference	Представляет неглубокую ссылку на TeamProject.
remoteUrl	string
sshUrl	string
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.

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

ProjectState

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

Состояние проекта.

Значение	Описание
all	Все проекты независимо от состояния, кроме deleted.
createPending	Проект был поставлен в очередь для создания, но процесс еще не запущен.
deleted	Проект удален.
deleting	Проект находится в процессе удаления.
new	Проект находится в процессе создания.
unchanged	Проект не был изменен.
wellFormed	Проект полностью создан и готов к использованию.

ProjectVisibility

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

Видимость проекта.

Значение	Описание
private	Проект отображается только пользователям с явным доступом.
public	Проект виден всем.

ReferenceLinks

Object

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

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

ResourceRef

Object

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

TeamProjectCollectionReference

Object

Ссылочный объект для TeamProjectCollection.

Имя	Тип	Описание
avatarUrl	string	URL-адрес аватара коллекции.
id	string (uuid)	Идентификатор коллекции.
name	string	Имя коллекции.
url	string	URL-адрес REST коллекции.

TeamProjectReference

Object

Представляет неглубокую ссылку на TeamProject.

Имя	Тип	Описание
abbreviation	string	Сокращение проекта.
defaultTeamImageUrl	string	URL-адрес образа удостоверения группы по умолчанию.
description	string	Описание проекта (если таковой есть).
id	string (uuid)	Идентификатор проекта.
lastUpdateTime	string (date-time)	Время последнего обновления проекта.
name	string	Имя проекта.
revision	integer (int64)	Редакция проекта.
state	ProjectState	Состояние проекта.
url	string	URL-адрес полной версии объекта.
visibility	ProjectVisibility	Видимость проекта.

VersionControlChangeType

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

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

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

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

Pushes - Get

Параметры URI

Ответы

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

oauth2

Области

Примеры

Just the push

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

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

Определения

ChangeCountDictionary

GitChange

GitCommitRef

GitPush

GitPushRef

GitRefUpdate

GitRepository

GitRepositoryRef

GitStatus

GitStatusContext

GitStatusState

GitTemplate

GitUserDate

IdentityRef

ItemContent

ItemContentType

ProjectState

ProjectVisibility

ReferenceLinks

ResourceRef

TeamProjectCollectionReference

TeamProjectReference

VersionControlChangeType

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