Pull Requests - Get Pull Request

Recuperar uma solicitação de pull.

GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullrequests/{pullRequestId}?api-version=7.1-preview.1
GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullrequests/{pullRequestId}?maxCommentLength={maxCommentLength}&$skip={$skip}&$top={$top}&includeCommits={includeCommits}&includeWorkItemRefs={includeWorkItemRefs}&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.

pullRequestId
path True

integer

int32

A ID da solicitação de pull a ser recuperada.

repositoryId
path True

string

A ID do repositório do branch de destino da solicitação de pull.

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.

$skip
query

integer

int32

Não usado.

$top
query

integer

int32

Não usado.

includeCommits
query

boolean

Se for true, a solicitação de pull será retornada com os commits associados.

includeWorkItemRefs
query

boolean

Se for true, a solicitação de pull será retornada com as referências de item de trabalho associadas.

maxCommentLength
query

integer

int32

Não usado.

Respostas

Nome Tipo Description
200 OK

GitPullRequest

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 o código-fonte e os 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.

Definições

Nome Description
ChangeCountDictionary
GitChange
GitCommitRef

Fornece propriedades que descrevem uma confirmação do Git e metadados associados.

GitForkRef

Informações sobre um ref de bifurcação.

GitPullRequest

Representa todos os dados associados a uma solicitação de pull.

GitPullRequestCompletionOptions

Preferências sobre como a solicitação de pull deve ser concluída.

GitPullRequestMergeOptions

As opções que são usadas quando uma mesclagem de solicitação de pull é criada.

GitPullRequestMergeStrategy

Especifique a estratégia usada para mesclar a solicitação de pull durante a conclusão. Se MergeStrategy não estiver definido como nenhum valor, uma mesclagem no-FF será criada se SquashMerge == false. Se MergeStrategy não estiver definido como nenhum valor, as confirmações de solicitação de pull serão esmagadas se SquashMerge == true. A propriedade SquashMerge foi preterida. É recomendável definir explicitamente MergeStrategy em todos os casos. Se um valor explícito for fornecido para MergeStrategy, a propriedade SquashMerge será ignorada.

GitPushRef
GitRepository
GitRepositoryRef
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
IdentityRefWithVote

Informações de identidade, incluindo uma votação em uma solicitação de pull.

ItemContent
ItemContentType
ProjectState

Estado do projeto.

ProjectVisibility

Visibilidade do projeto.

PullRequestAsyncStatus

O status atual da mesclagem de solicitação de pull.

PullRequestMergeFailureType

O tipo de falha (se houver) da mesclagem de solicitação de pull.

PullRequestStatus

O status da solicitação de pull.

ReferenceLinks

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

ResourceRef
TeamProjectCollectionReference

Objeto de referência para um TeamProjectCollection.

TeamProjectReference

Representa uma referência superficial a um TeamProject.

VersionControlChangeType

O tipo de alteração feita no item.

WebApiTagDefinition

A representação de uma definição de marca que é enviada pela transmissão.

ChangeCountDictionary

GitChange

Nome Tipo Description
changeId

integer

ID da alteração dentro do 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 por push novas alterações.

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 uma confirmação 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 a confirmação 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 este commit.

remoteUrl

string

Caminho da URL remota para a confirmação.

statuses

GitStatus[]

Uma lista de metadados status 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 essa confirmação.

GitForkRef

Informações sobre um ref de bifurcação.

Nome Tipo Description
_links

ReferenceLinks

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

creator

IdentityRef

isLocked

boolean

isLockedBy

IdentityRef

name

string

objectId

string

peeledObjectId

string

repository

GitRepository

A ID do repositório da bifurcação.

statuses

GitStatus[]

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

url

string

GitPullRequest

Representa todos os dados associados a uma solicitação de pull.

Nome Tipo Description
_links

ReferenceLinks

Links para outros objetos relacionados.

artifactId

string

Uma cadeia de caracteres que identifica exclusivamente essa solicitação de pull. Para gerar uma ID de artefato para uma solicitação de pull, use este modelo: vstfs:///Git/PullRequestId/{projectId}/{repositoryId}/{pullRequestId}

autoCompleteSetBy

IdentityRef

Se definido, o preenchimento automático será habilitado para essa solicitação de pull e essa será a identidade que a habilitou.

closedBy

IdentityRef

O usuário que fechou a solicitação de pull.

closedDate

string

A data em que a solicitação de pull foi fechada (concluída, abandonada ou mesclada externamente).

codeReviewId

integer

A ID de revisão de código da solicitação de pull. Usado internamente.

commits

GitCommitRef[]

Os commits contidos na solicitação de pull.

completionOptions

GitPullRequestCompletionOptions

Opções que afetam como a solicitação de pull será mesclada quando for concluída.

completionQueueTime

string

A data mais recente em que a solicitação de pull inseriu a fila a ser concluída. Usado internamente.

createdBy

IdentityRef

A identidade do usuário que criou a solicitação de pull.

creationDate

string

A data em que a solicitação de pull foi criada.

description

string

A descrição da solicitação de pull.

forkSource

GitForkRef

Se essa for uma PR de uma bifurcação, isso conterá informações sobre sua origem.

hasMultipleMergeBases

boolean

Aviso de várias bases de mesclagem

isDraft

boolean

Solicitação de pull de rascunho/WIP.

labels

WebApiTagDefinition[]

Os rótulos associados à solicitação de pull.

lastMergeCommit

GitCommitRef

A confirmação da mesclagem de solicitação de pull mais recente. Se estiver vazia, a mesclagem mais recente estará em andamento ou não teve êxito.

lastMergeSourceCommit

GitCommitRef

O commit no cabeçalho do branch de origem no momento da última mesclagem de solicitação de pull.

lastMergeTargetCommit

GitCommitRef

O commit no cabeçalho do branch de destino no momento da última mesclagem de solicitação de pull.

mergeFailureMessage

string

Se definido, a mesclagem de solicitação de pull falhou por esse motivo.

mergeFailureType

PullRequestMergeFailureType

O tipo de falha (se houver) da mesclagem de solicitação de pull.

mergeId

string

A ID do trabalho usado para executar a mesclagem de solicitação de pull. Usado internamente.

mergeOptions

GitPullRequestMergeOptions

Opções usadas quando a mesclagem de solicitação de pull é executada. Elas são separadas das opções de conclusão, pois a conclusão ocorre apenas uma vez e uma nova mesclagem será executada sempre que o branch de origem da solicitação de pull for alterado.

mergeStatus

PullRequestAsyncStatus

O status atual da mesclagem de solicitação de pull.

pullRequestId

integer

A ID da solicitação de pull.

remoteUrl

string

Usado internamente.

repository

GitRepository

O repositório que contém o branch de destino da solicitação de pull.

reviewers

IdentityRefWithVote[]

Uma lista de revisores na solicitação de pull junto com o estado de seus votos.

sourceRefName

string

O nome do branch de origem da solicitação de pull.

status

PullRequestStatus

O status da solicitação de pull.

supportsIterations

boolean

Se for true, essa solicitação de pull oferecerá suporte a várias iterações. O suporte à iteração significa que os pushes individuais para o branch de origem da solicitação de pull podem ser revisados e os comentários deixados em uma iteração serão acompanhados em iterações futuras.

targetRefName

string

O nome do branch de destino da solicitação de pull.

title

string

O título da solicitação de pull.

url

string

Usado internamente.

workItemRefs

ResourceRef[]

Qualquer referência de item de trabalho associada a essa solicitação de pull.

GitPullRequestCompletionOptions

Preferências sobre como a solicitação de pull deve ser concluída.

Nome Tipo Description
autoCompleteIgnoreConfigIds

integer[]

Lista de IDs de configuração de política que não devem ser concluídas automaticamente. Aplica-se somente a políticas opcionais (isBlocking == false). O preenchimento automático sempre aguarda as políticas necessárias (isBlocking == true).

bypassPolicy

boolean

Se for true, as políticas serão explicitamente ignoradas enquanto a solicitação de pull for concluída.

bypassReason

string

Se as políticas forem ignoradas, esse motivo será armazenado quanto ao motivo pelo qual o bypass foi usado.

deleteSourceBranch

boolean

Se for true, o branch de origem da solicitação de pull será excluído após a conclusão.

mergeCommitMessage

string

Se definido, isso será usado como o mensagem do commit do commit de mesclagem.

mergeStrategy

GitPullRequestMergeStrategy

Especifique a estratégia usada para mesclar a solicitação de pull durante a conclusão. Se MergeStrategy não estiver definido como nenhum valor, uma mesclagem no-FF será criada se SquashMerge == false. Se MergeStrategy não estiver definido como nenhum valor, as confirmações de solicitação de pull serão esmagadas se SquashMerge == true. A propriedade SquashMerge foi preterida. É recomendável definir explicitamente MergeStrategy em todos os casos. Se um valor explícito for fornecido para MergeStrategy, a propriedade SquashMerge será ignorada.

squashMerge

boolean

SquashMerge foi preterido. Você deve definir explicitamente o valor de MergeStrategy. Se MergeStrategy for definido como qualquer valor, o valor SquashMerge será ignorado. Se MergeStrategy não estiver definido, a estratégia de mesclagem não será rápida se esse sinalizador for falso ou combinação por squash se for verdadeiro.

transitionWorkItems

boolean

Se for true, tentaremos fazer a transição de todos os itens de trabalho vinculados à solicitação de pull para o próximo estado lógico (ou seja, Ativo –> Resolvido)

triggeredByAutoComplete

boolean

Se for true, a tentativa de conclusão atual foi disparada por meio do preenchimento automático. Usado internamente.

GitPullRequestMergeOptions

As opções que são usadas quando uma mesclagem de solicitação de pull é criada.

Nome Tipo Description
conflictAuthorshipCommits

boolean

Se for true, as resoluções de conflito aplicadas durante a mesclagem serão colocadas em commits separados para preservar as informações de autoria do git blame etc.

detectRenameFalsePositives

boolean

disableRenames

boolean

Se for true, a detecção de renomeação não será executada durante a mesclagem.

GitPullRequestMergeStrategy

Especifique a estratégia usada para mesclar a solicitação de pull durante a conclusão. Se MergeStrategy não estiver definido como nenhum valor, uma mesclagem no-FF será criada se SquashMerge == false. Se MergeStrategy não estiver definido como nenhum valor, as confirmações de solicitação de pull serão esmagadas se SquashMerge == true. A propriedade SquashMerge foi preterida. É recomendável definir explicitamente MergeStrategy em todos os casos. Se um valor explícito for fornecido para MergeStrategy, a propriedade SquashMerge será ignorada.

Nome Tipo Description
noFastForward

string

Uma mesclagem de dois pais, sem avanço rápido. O branch de origem permanece inalterado. Esse é o comportamento padrão.

rebase

string

Rebasee o branch de origem na parte superior do branch de destino HEAD confirmação e avance rapidamente o branch de destino. O branch de origem é atualizado durante a operação de rebase.

rebaseMerge

string

Recrie o branch de origem na parte superior do branch de destino HEAD confirmar e crie uma mesclagem sem avanço rápido de dois pais. O branch de origem é atualizado durante a operação de rebase.

squash

string

Coloque todas as alterações da solicitação de pull em um commit de pai único.

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

GitRepository

Nome Tipo Description
_links

ReferenceLinks

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

defaultBranch

string

id

string

isDisabled

boolean

True se o repositório estiver desabilitado. De outra forma, falso.

isFork

boolean

True se o repositório foi criado como um fork.

isInMaintenance

boolean

True se o repositório estiver em manutenção. De outra forma, falso.

name

string

parentRepository

GitRepositoryRef

project

TeamProjectReference

Representa uma referência superficial a um TeamProject.

remoteUrl

string

size

integer

Tamanho compactado (bytes) do repositório.

sshUrl

string

url

string

validRemoteUrls

string[]

webUrl

string

GitRepositoryRef

Nome Tipo Description
collection

TeamProjectCollectionReference

Coleção de Projetos de Equipe em que esse Fork reside

id

string

isFork

boolean

True se o repositório foi criado como um fork

name

string

project

TeamProjectReference

Representa uma referência superficial a um TeamProject.

remoteUrl

string

sshUrl

string

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 de 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 da 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 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 do 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 "_links" identityRef

displayName

string

Este é 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 "_links" IdentityRef

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 preexistidas de ToIdentityRef

uniqueName

string

Preterido – use Domain+PrincipalName

url

string

Essa URL é a rota completa para o recurso de origem desta entidade de grafo.

IdentityRefWithVote

Informações de identidade, incluindo uma votação em uma solicitação de pull.

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 do 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 "_links" identityRef

displayName

string

Este é 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.

hasDeclined

boolean

Indica se esse revisor se recusou a examinar essa solicitação de pull.

id

string

imageUrl

string

Preterido - Disponível na entrada "avatar" do dicionário "_links" IdentityRef

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

isFlagged

boolean

Indica se esse revisor está sinalizado para atenção nessa solicitação de pull.

isReapprove

boolean

Indica se essa votação de aprovação ainda deve ser tratada mesmo que a votação não tenha sido alterada.

isRequired

boolean

Indica se este é um revisor necessário para essa solicitação de pull.
Os branches podem ter políticas que exigem revisores específicos para solicitações de pull.

profileUrl

string

Preterido – não em uso na maioria das implementações preexistidas de ToIdentityRef

reviewerUrl

string

URL para recuperar informações sobre essa identidade

uniqueName

string

Preterido – use Domain+PrincipalName

url

string

Essa URL é a rota completa para o recurso de origem desta entidade de grafo.

vote

integer

Vote em uma solicitação de pull:
10 - aprovado 5 - aprovado com sugestões 0 - sem voto -5 - aguardando autor -10 - rejeitado

votedFor

IdentityRefWithVote[]

Grupos ou equipes para os quais este revisor contribuiu.
Grupos e equipes podem ser revisores em solicitações de pull, mas não podem votar diretamente. Quando um membro do grupo ou da equipe vota, essa votação é acumulada no voto do grupo ou da equipe. VotedFor é uma lista desses votos.

ItemContent

Nome Tipo Description
content

string

contentType

ItemContentType

ItemContentType

Nome Tipo Description
base64Encoded

string

rawText

string

ProjectState

Estado do projeto.

Nome Tipo Description
all

string

Todos os projetos, independentemente do estado, exceto Excluídos.

createPending

string

O projeto foi enfileirado para criação, mas o processo ainda não foi iniciado.

deleted

string

O projeto foi excluído.

deleting

string

O Project está em processo de exclusão.

new

string

O projeto está em processo de criação.

unchanged

string

O projeto não foi alterado.

wellFormed

string

O project é completamente criado e pronto para uso.

ProjectVisibility

Visibilidade do projeto.

Nome Tipo Description
private

string

O projeto só é visível para usuários com acesso explícito.

public

string

O projeto é visível para todos.

PullRequestAsyncStatus

O status atual da mesclagem de solicitação de pull.

Nome Tipo Description
conflicts

string

Falha na mesclagem de solicitação de pull devido a conflitos.

failure

string

Falha na mesclagem de solicitação de pull.

notSet

string

O status não está definido. Estado padrão.

queued

string

A mesclagem de solicitação de pull está na fila.

rejectedByPolicy

string

Mesclagem de solicitação de pull rejeitada pela política.

succeeded

string

A mesclagem de solicitação de pull foi bem-sucedida.

PullRequestMergeFailureType

O tipo de falha (se houver) da mesclagem de solicitação de pull.

Nome Tipo Description
caseSensitive

string

Falha na mesclagem de solicitação de pull devido à incompatibilidade de maiúsculas e minúsculas.

none

string

O tipo não está definido. Tipo padrão.

objectTooLarge

string

Falha na mesclagem de solicitação de pull devido a um objeto ser muito grande.

unknown

string

Tipo de falha de mesclagem de solicitação de pull desconhecido.

PullRequestStatus

O status da solicitação de pull.

Nome Tipo Description
abandoned

string

A solicitação de pull foi abandonada.

active

string

A solicitação de pull está ativa.

all

string

Usado em critérios de pesquisa de solicitação de pull para incluir todos os status.

completed

string

A solicitação de pull foi concluída.

notSet

string

Status não definido. Estado padrão.

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

TeamProjectCollectionReference

Objeto de referência para um TeamProjectCollection.

Nome Tipo Description
avatarUrl

string

URL do avatar da coleção.

id

string

ID da coleção.

name

string

Nome da Coleção.

url

string

URL REST da coleção.

TeamProjectReference

Representa uma referência superficial a um TeamProject.

Nome Tipo Description
abbreviation

string

Abreviação do projeto.

defaultTeamImageUrl

string

Url para a imagem de identidade de equipe padrão.

description

string

A descrição do projeto (se houver).

id

string

Identificador do projeto.

lastUpdateTime

string

Hora da última atualização do projeto.

name

string

Nome do projeto.

revision

integer

Revisão do projeto.

state

ProjectState

Estado do projeto.

url

string

URL para a versão completa do objeto.

visibility

ProjectVisibility

Visibilidade do projeto.

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

WebApiTagDefinition

A representação de uma definição de marca que é enviada pela transmissão.

Nome Tipo Description
active

boolean

Se a definição de marca está ativa ou não.

id

string

ID da definição de marca.

name

string

O nome da definição de marca.

url

string

URL do recurso para a definição de marca.