Pushes - Get

Ссылка

Service:: Git

API Version:: 5.0

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

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

With optional parameters:

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

Параметры 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 необходимо задать значение "5.0".
includeCommits	query		integer int32	Количество фиксаций, включаемых в результат.
includeRefUpdates	query		boolean	Если задано значение true, включите список ссылок, которые были обновлены при отправке.

Ответы

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

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

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

Имя

Описание

vso.code

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

Примеры

Just the push

Sample Request

HTTP

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

Sample Response

Status code:: 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

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) фиксации.
committer	GitUserDate	Фиксация фиксации.
parents	string[]	Перечисление идентификаторов родительской фиксации для этой фиксации.
push	GitPushRef	Отправка, связанная с этой фиксацией.
remoteUrl	string	Удаленный URL-путь к фиксации.
statuses	GitStatus[]	Список метаданных состояния из служб и расширений, которые могут связывать дополнительные сведения с фиксацией.
url	string	URL-адрес REST для этого ресурса.
workItems	ResourceRef[]	Список рабочих элементов, связанных с этой фиксацией.

GitPush

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

GitPushRef

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

GitRefUpdate

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

GitRepository

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

GitRepositoryRef

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

IdentityRef

Имя	Тип	Описание
_links	ReferenceLinks	Это поле содержит ноль или более интересных ссылок на тему графа. Эти ссылки можно вызвать для получения дополнительных связей или более подробных сведений об этой теме графа.
descriptor	string	Дескриптор является основным способом ссылки на субъект графа во время работы системы. Это поле однозначно идентифицирует одну и ту же тему графа как в учетных записях, так и в организациях.
directoryAlias	string
displayName	string	Это неуникальное отображаемое имя субъекта графа. Чтобы изменить это поле, необходимо изменить его значение в поставщике источника.
id	string
imageUrl	string
inactive	boolean
isAadIdentity	boolean
isContainer	boolean
isDeletedInOrigin	boolean
profileUrl	string
uniqueName	string
url	string	Этот URL-адрес представляет собой полный маршрут к исходному ресурсу этого субъекта графа.

ItemContent

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

ItemContentType

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

ProjectState

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

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

ProjectVisibility

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

Имя	Тип	Описание
private	string	Проект виден только пользователям с явным доступом.
public	string	Проект виден всем.

ReferenceLinks

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

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

ResourceRef

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

TeamProjectCollectionReference

Объект ссылки для TeamProjectCollection.

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

TeamProjectReference

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

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

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

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