Commits - Get Push Commits

Referência

Service:: Git

API Version:: 7.1-preview.1

Recupere uma lista de commits associados a um push específico.

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

With optional parameters:

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
organization	path	True	string	O nome da organização do Azure DevOps.
repositoryId	path	True	string	O ID ou o nome amigável do repositório. Para usar o nome amigável, projectId também deve ser especificado.
project	path		string	ID do projeto ou nome do projeto
api-version	query	True	string	Versão da API a ser usada. Isso deve ser definido como '7.1-preview.1' para usar essa versão da api.
pushId	query	True	integer int32	A ID do push.
includeLinks	query		boolean	Defina como false para evitar incluir links de URL REST para recursos. O padrão é verdadeiro.
skip	query		integer int32	O número de commits a serem ignoradas.
top	query		integer int32	O número máximo de commits a serem retornados ("obter os principais x commits").

Respostas

Nome	Tipo	Description
200 OK	GitCommitRef[]	operação bem-sucedida

Segurança

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

Nome	Description
vso.code	Concede a capacidade de ler código-fonte e metadados sobre commits, conjuntos de alterações, branches e outros artefatos de controle de versão. Também concede a capacidade de pesquisar código e ser notificado sobre eventos de controle de versão por meio de ganchos de serviço.

Exemplos

Sample Request

HTTP

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

Sample Response

Status code:: 200

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

Definições

Nome	Description
ChangeCountDictionary
GitChange
GitCommitRef	Fornece propriedades que descrevem um commit do Git e metadados associados.
GitPushRef
GitStatus	Essa classe contém os metadados de um serviço/extensão postando um status.
GitStatusContext	Contexto de status que identifica exclusivamente o status.
GitStatusState	Estado do status.
GitTemplate
GitUserDate	Informações do usuário e data das operações do Git.
IdentityRef
ItemContent
ItemContentType
ReferenceLinks	A classe para representar uma coleção de links de referência REST.
ResourceRef
VersionControlChangeType	O tipo de alteração feita no item.

ChangeCountDictionary

GitChange

Nome	Tipo	Description
changeId	integer	ID da alteração no grupo de alterações.
changeType	VersionControlChangeType	O tipo de alteração feita no item.
item	string	Versão atual.
newContent	ItemContent	Conteúdo do item após a alteração.
newContentTemplate	GitTemplate	Novo modelo de conteúdo a ser usado ao enviar novas alterações por push.
originalPath	string	Caminho original do item se diferente do caminho atual.
sourceServerItem	string	Caminho do item no servidor.
url	string	URL para recuperar o item.

GitCommitRef

Fornece propriedades que descrevem um commit do Git e metadados associados.

Nome	Tipo	Description
_links	ReferenceLinks	Uma coleção de links de referência REST relacionados.
author	GitUserDate	Autor do commit.
changeCounts	ChangeCountDictionary	Contagens dos tipos de alterações (edições, exclusões etc.) incluídas no commit.
changes	GitChange[]	Uma enumeração das alterações incluídas no commit.
comment	string	Comentário ou mensagem do commit.
commentTruncated	boolean	Indica se o comentário está truncado da mensagem de comentário de confirmação completa do Git.
commitId	string	ID (SHA-1) do commit.
commitTooManyChanges	boolean	Indica que commit contém muitas alterações a serem exibidas
committer	GitUserDate	Committer do commit.
parents	string[]	Uma enumeração das IDs de commit pai para esse commit.
push	GitPushRef	O push associado a esse commit.
remoteUrl	string	Caminho da URL remota para o commit.
statuses	GitStatus[]	Uma lista de status metadados de serviços e extensões que podem associar informações adicionais ao commit.
url	string	URL REST para esse recurso.
workItems	ResourceRef[]	Uma lista de workitems associados a esse commit.

GitPushRef

Nome	Tipo	Description
_links	ReferenceLinks	A classe para representar uma coleção de links de referência REST.
date	string
pushId	integer
pushedBy	IdentityRef
url	string

GitStatus

Essa classe contém os metadados de um serviço/extensão postando um status.

Nome	Tipo	Description
_links	ReferenceLinks	Links de referência.
context	GitStatusContext	Contexto do status.
createdBy	IdentityRef	Identidade que criou o status.
creationDate	string	Data e hora da criação do status.
description	string	Descrição do status. Normalmente descreve o estado atual do status.
id	integer	Identificador de status.
state	GitStatusState	Estado do status.
targetUrl	string	URL com status detalhes.
updatedDate	string	Data e hora da última atualização do status.

GitStatusContext

Contexto de status que identifica exclusivamente o status.

Nome	Tipo	Description
genre	string	Gênero do status. Normalmente, o nome do serviço/ferramenta que gera o status pode estar vazio.
name	string	O identificador de nome do status não pode ser nulo ou vazio.

GitStatusState

Estado do status.

Nome	Tipo	Description
error	string	Status com um erro.
failed	string	Falha no status.
notApplicable	string	O status não é aplicável ao objeto de destino.
notSet	string	Estado de status não definido. Estado padrão.
pending	string	Status pendente.
succeeded	string	Status bem-sucedido.

GitTemplate

Nome	Tipo	Description
name	string	Nome do modelo
type	string	Tipo do modelo

GitUserDate

Informações do usuário e data das operações do Git.

Nome	Tipo	Description
date	string	Data da operação do Git.
email	string	Email endereço do usuário que está executando a operação git.
imageUrl	string	Url para o avatar do usuário.
name	string	Nome do usuário que está executando a operação git.

IdentityRef

Nome	Tipo	Description
_links	ReferenceLinks	Esse campo contém zero ou mais links interessantes sobre o assunto do grafo. Esses links podem ser invocados para obter relações adicionais ou informações mais detalhadas sobre esse assunto do grafo.
descriptor	string	O descritor é a principal maneira de referenciar o assunto do grafo enquanto o sistema está em execução. Esse campo identificará exclusivamente o mesmo assunto de grafo entre contas e organizações.
directoryAlias	string	Preterido – pode ser recuperado consultando o usuário do Graph referenciado na entrada "self" do dicionário IdentityRef "_links"
displayName	string	Esse é o nome de exibição não exclusivo do assunto do grafo. Para alterar esse campo, você deve alterar seu valor no provedor de origem.
id	string
imageUrl	string	Preterido – Disponível na entrada "avatar" do dicionário IdentityRef "_links"
inactive	boolean	Preterido – pode ser recuperado consultando o estado de associação do Graph referenciado na entrada "membershipState" do dicionário "_links" do GraphUser
isAadIdentity	boolean	Preterido – pode ser inferido do tipo de assunto do descritor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Preterido – pode ser inferido do tipo de assunto do descritor (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Preterido – não em uso na maioria das implementações preexistir de ToIdentityRef
uniqueName	string	Preterido – use Domain+PrincipalName em vez disso
url	string	Essa URL é a rota completa para o recurso de origem desta entidade de grafo.

ItemContent

Nome	Tipo	Description
content	string
contentType	ItemContentType

ItemContentType

Nome	Tipo	Description
base64Encoded	string
rawText	string

ReferenceLinks

A classe para representar uma coleção de links de referência REST.

Nome	Tipo	Description
links	object	A exibição somente leitura dos links. Como os links de referência são somente leitura, só queremos expô-los como somente leitura.

ResourceRef

Nome	Tipo	Description
id	string
url	string

VersionControlChangeType

O tipo de alteração feita no item.

Nome	Tipo	Description
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

Compartilhar via