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


Commits - Get

Получение определенной фиксации.

GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/commits/{commitId}?api-version=7.1-preview.1
GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/commits/{commitId}?changeCount={changeCount}&api-version=7.1-preview.1

Параметры URI

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

string

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

organization
path True

string

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

repositoryId
path True

string

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

project
path

string

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

api-version
query True

string

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

changeCount
query

integer

int32

Количество изменений, включаемых в результат.

Ответы

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

GitCommit

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

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

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

Примеры

Get by ID
With limited changes

Get by ID

Sample Request

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

Sample Response

{
  "parents": [],
  "treeId": "7fa1a3523ffef51c525ea476bffff7d648b8cb3d",
  "push": {
    "pushedBy": {
      "id": "8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
      "displayName": "Chuck Reinhart",
      "uniqueName": "fabrikamfiber3@hotmail.com",
      "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
      "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d"
    },
    "pushId": 1,
    "date": "2014-01-29T23:33:15.2434002Z"
  },
  "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\n",
  "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"
    },
    "changes": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/commits/be67f8871a4d2c75f13a51c1d3c30ac0d74d4ef4/changes"
    },
    "web": {
      "href": "https://dev.azure.com/fabrikam/_git/Fabrikam-Fiber-Git/commit/be67f8871a4d2c75f13a51c1d3c30ac0d74d4ef4"
    },
    "tree": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/trees/7fa1a3523ffef51c525ea476bffff7d648b8cb3d"
    }
  }
}

With limited changes

Sample Request

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

Sample Response

{
  "parents": [],
  "treeId": "7fa1a3523ffef51c525ea476bffff7d648b8cb3d",
  "push": {
    "pushedBy": {
      "id": "8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
      "displayName": "Chuck Reinhart",
      "uniqueName": "fabrikamfiber3@hotmail.com",
      "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
      "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d"
    },
    "pushId": 1,
    "date": "2014-01-29T23:33:15.2434002Z"
  },
  "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\n",
  "changeCounts": {
    "Add": 456
  },
  "changes": [
    {
      "item": {
        "gitObjectType": "blob",
        "path": "/.gitattributes",
        "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/items/.gitattributes?versionType=Commit"
      },
      "changeType": "add"
    },
    {
      "item": {
        "gitObjectType": "blob",
        "path": "/.gitignore",
        "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/items/.gitignore?versionType=Commit"
      },
      "changeType": "add"
    },
    {
      "item": {
        "gitObjectType": "tree",
        "path": "/MyWebSite",
        "isFolder": true,
        "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/items/MyWebSite?versionType=Commit"
      },
      "changeType": "add"
    },
    {
      "item": {
        "gitObjectType": "tree",
        "path": "/MyWebSite/MyWebSite",
        "isFolder": true,
        "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/items/MyWebSite/MyWebSite?versionType=Commit"
      },
      "changeType": "add"
    },
    {
      "item": {
        "gitObjectType": "blob",
        "path": "/MyWebSite/MyWebSite.sln",
        "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/items/MyWebSite/MyWebSite.sln?versionType=Commit"
      },
      "changeType": "add"
    },
    {
      "item": {
        "gitObjectType": "tree",
        "path": "/MyWebSite/packages",
        "isFolder": true,
        "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/items/MyWebSite/packages?versionType=Commit"
      },
      "changeType": "add"
    },
    {
      "item": {
        "gitObjectType": "tree",
        "path": "/MyWebSite/MyWebSite/App_Start",
        "isFolder": true,
        "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/items/MyWebSite/MyWebSite/App_Start?versionType=Commit"
      },
      "changeType": "add"
    },
    {
      "item": {
        "gitObjectType": "tree",
        "path": "/MyWebSite/MyWebSite/Areas",
        "isFolder": true,
        "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/items/MyWebSite/MyWebSite/Areas?versionType=Commit"
      },
      "changeType": "add"
    },
    {
      "item": {
        "gitObjectType": "tree",
        "path": "/MyWebSite/MyWebSite/Content",
        "isFolder": true,
        "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/items/MyWebSite/MyWebSite/Content?versionType=Commit"
      },
      "changeType": "add"
    },
    {
      "item": {
        "gitObjectType": "tree",
        "path": "/MyWebSite/MyWebSite/Controllers",
        "isFolder": true,
        "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/items/MyWebSite/MyWebSite/Controllers?versionType=Commit"
      },
      "changeType": "add"
    }
  ],
  "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"
    },
    "changes": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/commits/be67f8871a4d2c75f13a51c1d3c30ac0d74d4ef4/changes"
    },
    "web": {
      "href": "https://dev.azure.com/fabrikam/_git/Fabrikam-Fiber-Git/commit/be67f8871a4d2c75f13a51c1d3c30ac0d74d4ef4"
    },
    "tree": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/trees/7fa1a3523ffef51c525ea476bffff7d648b8cb3d"
    }
  }
}

Определения

Имя Описание
ChangeCountDictionary
GitChange
GitCommit
GitPushRef
GitStatus

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

GitStatusContext

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

GitStatusState

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

GitTemplate
GitUserDate

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

IdentityRef
ItemContent
ItemContentType
ReferenceLinks

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

ResourceRef
VersionControlChangeType

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

ChangeCountDictionary

GitChange

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

integer

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

changeType

VersionControlChangeType

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

item

string

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

newContent

ItemContent

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

newContentTemplate

GitTemplate

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

originalPath

string

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

sourceServerItem

string

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

url

string

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

GitCommit

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

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

treeId

string

url

string

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

workItems

ResourceRef[]

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

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.

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