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


Commits - Get Push Commits

Получение списка фиксаций, связанных с определенной отправкой.

GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/commits?pushId={pushId}&api-version=7.1
GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/commits?pushId={pushId}&top={top}&skip={skip}&includeLinks={includeLinks}&api-version=7.1

Параметры URI

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

string

Имя организации Azure DevOps.

repositoryId
path True

string

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

project
path

string

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

api-version
query True

string

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

pushId
query True

integer (int32)

Идентификатор push-отправки.

includeLinks
query

boolean

Установите значение false, чтобы избежать включения ссылок URL-адреса REST для ресурсов. По умолчанию имеет значение true.

skip
query

integer (int32)

Количество пропускаемых фиксаций.

top
query

integer (int32)

Максимальное количество возвращаемых фиксаций ("получение верхних зафиксов x").

Ответы

Имя Тип Описание
200 OK

GitCommitRef[]

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

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

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

Примеры

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

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

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

{
  "count": 1,
  "value": [
    {
      "commitId": "be67f8871a4d2c75f13a51c1d3c30ac0d74d4ef4",
      "author": {
        "name": "Chuck Reinhart",
        "email": "fabrikamfiber3@hotmail.com",
        "date": "2014-01-29T23:32:09Z"
      },
      "committer": {
        "name": "Chuck Reinhart",
        "email": "fabrikamfiber3@hotmail.com",
        "date": "2014-01-29T23:32:09Z"
      },
      "comment": "First cut",
      "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/commits/be67f8871a4d2c75f13a51c1d3c30ac0d74d4ef4",
      "remoteUrl": "https://dev.azure.com/fabrikam/_git/Fabrikam-Fiber-Git/commit/be67f8871a4d2c75f13a51c1d3c30ac0d74d4ef4",
      "_links": {
        "self": {
          "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/commits/be67f8871a4d2c75f13a51c1d3c30ac0d74d4ef4"
        },
        "repository": {
          "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249"
        },
        "web": {
          "href": "https://dev.azure.com/fabrikam/_git/Fabrikam-Fiber-Git/commit/be67f8871a4d2c75f13a51c1d3c30ac0d74d4ef4"
        },
        "changes": {
          "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/commits/be67f8871a4d2c75f13a51c1d3c30ac0d74d4ef4/changes"
        }
      }
    }
  ]
}

Определения

Имя Описание
ChangeCountDictionary
GitChange
GitCommitRef

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

GitPushRef
GitStatus

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

GitStatusContext

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

GitStatusState

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

GitTemplate
GitUserDate

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

IdentityRef
ItemContent
ItemContentType
ReferenceLinks

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

ResourceRef
VersionControlChangeType

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

ChangeCountDictionary

GitChange

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

integer (int32)

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

changeType

VersionControlChangeType

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

item

string (T)

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

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

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

workItems

ResourceRef[]

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

GitPushRef

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

ReferenceLinks

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

date

string (date-time)

pushId

integer (int32)

pushedBy

IdentityRef

url

string

GitStatus

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

Имя Тип Описание
_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

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

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

string

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

name

string

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

GitStatusState

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

Значение Описание
error

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

failed

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

notApplicable

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

notSet

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

pending

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

succeeded

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

GitTemplate

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

string

Имя шаблона

type

string

Тип шаблона

GitUserDate

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

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

string (date-time)

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

email

string

Адрес электронной почты пользователя, выполняющего операцию Git.

imageUrl

string

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

name

string

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

IdentityRef

Имя Тип Описание
_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

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

string

contentType

ItemContentType

ItemContentType

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

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

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

object

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

ResourceRef

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

string

url

string

VersionControlChangeType

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

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