Items - Get

Service:

Git

API Version:

7.1-preview.1

Obter metadados de item e/ou conteúdo para um único item. O parâmetro de download é indicar se o conteúdo deve estar disponível como um download ou apenas enviado como um fluxo na resposta. Não se aplica ao conteúdo compactado, que sempre é retornado como um download.

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

With optional parameters:

GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/items?path={path}&scopePath={scopePath}&recursionLevel={recursionLevel}&includeContentMetadata={includeContentMetadata}&latestProcessedChange={latestProcessedChange}&download={download}&$format={$format}&versionDescriptor.version={versionDescriptor.version}&versionDescriptor.versionOptions={versionDescriptor.versionOptions}&versionDescriptor.versionType={versionDescriptor.versionType}&includeContent={includeContent}&resolveLfs={resolveLfs}&sanitize={sanitize}&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 nome ou a ID do repositório.
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.
path	query	True	string	O caminho do item.
$format	query		string	Se especificado, isso substitui o cabeçalho de solicitação HTTP Accept para retornar 'json' ou 'zip'. Se $format for especificado, a api-version também deverá ser especificada como um parâmetro de consulta.
download	query		boolean	Defina como true para baixar a resposta como um arquivo. O padrão é false.
includeContent	query		boolean	Defina como true para incluir o conteúdo do item ao solicitar json. O padrão é false.
includeContentMetadata	query		boolean	Defina como true para incluir metadados de conteúdo. O padrão é false.
latestProcessedChange	query		boolean	Defina como true para incluir as alterações mais recentes. O padrão é false.
recursionLevel	query		VersionControlRecursionType	O nível de recursão dessa solicitação. O padrão é 'none', sem recursão.
resolveLfs	query		boolean	Defina como true para resolve arquivos de ponteiro do Git LFS para retornar o conteúdo real do Git LFS. O padrão é false.
sanitize	query		boolean	Defina como true para limpar um arquivo svg e devolvê-lo como imagem. Útil somente se solicitado para o arquivo svg. O padrão é false.
scopePath	query		string	O escopo do caminho. O padrão é nulo.
versionDescriptor.version	query		string	Identificador de cadeia de caracteres de versão (nome da marca/branch, SHA1 de commit)
versionDescriptor.versionOptions	query		GitVersionOptions	Opções de versão – especificar modificadores adicionais para a versão (por exemplo, Anterior)
versionDescriptor.versionType	query		GitVersionType	Tipo de versão (branch, marca ou commit). Determina como a ID é interpretada

Respostas

Nome	Tipo	Description
200 OK	GitItem	operação bem-sucedida Media Types: "application/zip", "text/plain", "application/octet-stream", "application/json"

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.

Exemplos

Download

Get metadata

Download

Sample Request

HTTP

GET https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/items?scopePath=/MyWebSite/MyWebSite/Views/Home/_Home.cshtml&download=true&api-version=7.1-preview.1

Sample Response

Status code:

200

{
  "count": 1,
  "value": [
    {
      "objectId": "61a86fdaa79e5c6f5fb6e4026508489feb6ed92c",
      "gitObjectType": "blob",
      "commitId": "23d0bc5b128a10056dc68afece360d8a0fabb014",
      "path": "/MyWebSite/MyWebSite/Views/Home/_Home.cshtml",
      "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/items/MyWebSite/MyWebSite/Views/Home/_Home.cshtml?versionType=Branch&versionOptions=None"
    }
  ]
}

Get metadata

Sample Request

HTTP

GET https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/items?scopePath=/MyWebSite/MyWebSite/Views/Home/_Home.cshtml&api-version=7.1-preview.1

Sample Response

Status code:

200

{
  "count": 1,
  "value": [
    {
      "objectId": "61a86fdaa79e5c6f5fb6e4026508489feb6ed92c",
      "gitObjectType": "blob",
      "commitId": "23d0bc5b128a10056dc68afece360d8a0fabb014",
      "path": "/MyWebSite/MyWebSite/Views/Home/_Home.cshtml",
      "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/items/MyWebSite/MyWebSite/Views/Home/_Home.cshtml?versionType=Branch&versionOptions=None"
    }
  ]
}

Definições

Nome	Description
ChangeCountDictionary
FileContentMetadata
GitChange
GitCommitRef	Fornece propriedades que descrevem uma confirmação do Git e metadados associados.
GitItem
GitObjectType	Tipo de objeto (Commit, Tree, Blob, Tag)
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.
GitVersionOptions	Opções de versão – especifique modificadores adicionais para a versão (por exemplo, Anterior)
GitVersionType	Tipo de versão (branch, marca ou confirmação). Determina como a ID é interpretada
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.
VersionControlRecursionType	Especifica se os filhos devem ser incluídos (OneLevel), todos os descendentes (Completo) ou Nenhum

ChangeCountDictionary

FileContentMetadata

Nome	Tipo	Description
contentType	string
encoding	integer
extension	string
fileName	string
isBinary	boolean
isImage	boolean
vsLink	string

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.

GitItem

Nome	Tipo	Description
_links	ReferenceLinks	A classe para representar uma coleção de links de referência REST.
commitId	string	SHA1 do item de confirmação foi buscado em
content	string
contentMetadata	FileContentMetadata
gitObjectType	GitObjectType	Tipo de objeto (Commit, Tree, Blob, Tag, ...)
isFolder	boolean
isSymLink	boolean
latestProcessedChange	GitCommitRef	Ref superficial para confirmar que alterou pela última vez este item Somente preenchido se latestProcessedChange for solicitado Pode não ser preciso se a última alteração ainda não estiver armazenada em cache
objectId	string	ID do objeto Git
originalObjectId	string	ID do objeto Git
path	string
url	string

GitObjectType

Tipo de objeto (Commit, Tree, Blob, Tag)

Nome	Tipo	Description
bad	string
blob	string
commit	string
ext2	string
ofsDelta	string
refDelta	string
tag	string
tree	string

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

GitVersionOptions

Opções de versão – especifique modificadores adicionais para a versão (por exemplo, Anterior)

Nome	Tipo	Description
firstParent	string	Primeiro pai do commit (HEAD^)
none	string	Não especificado
previousChange	string	Confirmar o item alterado antes da versão atual

GitVersionType

Tipo de versão (branch, marca ou confirmação). Determina como a ID é interpretada

Nome	Tipo	Description
branch	string	Interpretar a versão como um nome de branch
commit	string	Interpretar a versão como um SHA1 (ID do commit)
tag	string	Interpretar a versão como um nome de marca

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.

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

VersionControlRecursionType

Especifica se os filhos devem ser incluídos (OneLevel), todos os descendentes (Completo) ou Nenhum

Nome	Tipo	Description
full	string	Retornar item especificado e todos os descendentes
none	string	Retornar apenas o item especificado.
oneLevel	string	Retornar o item especificado e seus filhos diretos.
oneLevelPlusNestedEmptyFolders	string	Retornar o item especificado e seus filhos diretos, bem como cadeias recursivas de pastas filho aninhadas que contêm apenas uma única pasta.