Repositories - Get

Referência

Serviço:: Git

Versão da API:: 4.1

Recuperar um repositório git.

GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}?api-version=4.1

Com parâmetros opcionais:

GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}?includeParent={includeParent}&api-version=4.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 '4.1' para usar esta versão da API.
includeParent	query		boolean	[opcional] True para incluir o repositório pai. O valor padrão é false.

Respostas

Nome	Tipo	Description
200 OK	GitRepository	operação bem-sucedida

Segurança

oauth2

Tipo: oauth2
Flow: accessCode
URL de Autorização: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL do Token: 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

Escopos

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 ser notificado sobre eventos de controle de versão por meio de ganchos de serviço.

Exemplos

Get a repository by remote URL

Get a repository by repositoryId

Get a repository by remote URL

Solicitação de exemplo

HTTP

GET https://dev.azure.com/fabrikam/_apis/git/repositories/{repositoryId}?api-version=4.1

Resposta de exemplo

Código de status:: 200

{
  "serverUrl": "https://dev.azure.com/fabrikam",
  "collection": {
    "id": "e22ddea7-989e-455d-b46a-67e991b04714",
    "name": "fabrikam",
    "url": "https://dev.azure.com/fabrikam/_apis/projectCollections/e22ddea7-989e-455d-b46a-67e991b04714"
  },
  "repository": {
    "id": "2f3d611a-f012-4b39-b157-8db63f380226",
    "name": "FabrikamCloud",
    "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/2f3d611a-f012-4b39-b157-8db63f380226",
    "project": {
      "id": "3b3ae425-0079-421f-9101-bcf15d6df041",
      "name": "FabrikamCloud",
      "url": "https://dev.azure.com/fabrikam/_apis/projects/3b3ae425-0079-421f-9101-bcf15d6df041",
      "state": 1,
      "revision": 411518573
    },
    "remoteUrl": "https://dev.azure.com/fabrikam/FabrikamCloud/_git/FabrikamCloud"
  }
}

Get a repository by repositoryId

Solicitação de exemplo

HTTP

GET https://dev.azure.com/fabrikam/_apis/git/repositories/5febef5a-833d-4e14-b9c0-14cb638f91e6?api-version=4.1

Resposta de exemplo

Código de status:: 200

{
  "id": "5febef5a-833d-4e14-b9c0-14cb638f91e6",
  "name": "AnotherRepository",
  "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/5febef5a-833d-4e14-b9c0-14cb638f91e6",
  "project": {
    "id": "6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c",
    "name": "Fabrikam-Fiber-Git",
    "url": "https://dev.azure.com/fabrikam/_apis/projects/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c",
    "state": "wellFormed",
    "revision": 293012730
  },
  "defaultBranch": "refs/heads/master",
  "remoteUrl": "https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_git/AnotherRepository",
  "_links": {
    "self": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/5febef5a-833d-4e14-b9c0-14cb638f91e6"
    },
    "project": {
      "href": "vstfs:///Classification/TeamProject/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c"
    },
    "web": {
      "href": "https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_git/AnotherRepository"
    },
    "commits": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/5febef5a-833d-4e14-b9c0-14cb638f91e6/commits"
    },
    "refs": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/5febef5a-833d-4e14-b9c0-14cb638f91e6/refs"
    },
    "pullRequests": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/5febef5a-833d-4e14-b9c0-14cb638f91e6/pullRequests"
    },
    "items": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/5febef5a-833d-4e14-b9c0-14cb638f91e6/items"
    },
    "pushes": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/5febef5a-833d-4e14-b9c0-14cb638f91e6/pushes"
    }
  }
}

Definições

Nome	Description
GitRepository
GitRepositoryRef
ProjectState	Estado do projeto.
ProjectVisibility	Visibilidade do projeto.
ReferenceLinks	A classe para representar uma coleção de links de referência REST.
TeamProjectCollectionReference	Objeto de referência para um TeamProjectCollection.
TeamProjectReference	Representa uma referência superficial a um TeamProject.

GitRepository

Object

Nome	Tipo	Description
_links	ReferenceLinks	A classe para representar uma coleção de links de referência REST.
defaultBranch	string
id	string
isFork	boolean	True se o repositório foi criado como um fork
name	string
parentRepository	GitRepositoryRef
project	TeamProjectReference	Representa uma referência superficial a um TeamProject.
remoteUrl	string
sshUrl	string
url	string
validRemoteUrls	string[]

GitRepositoryRef

Object

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

ProjectState

Enumeration

Estado do projeto.

Valor	Description
all	Todos os projetos, independentemente do estado.
createPending	O projeto foi enfileirado para criação, mas o processo ainda não foi iniciado.
deleted	O projeto foi excluído.
deleting	O Project está em processo de exclusão.
new	O projeto está em processo de criação.
unchanged	O projeto não foi alterado.
wellFormed	O project é completamente criado e pronto para uso.

ProjectVisibility

Enumeration

Visibilidade do projeto.

Valor	Description
private	O projeto só é visível para usuários com acesso explícito.
public	O projeto é visível para todos.

ReferenceLinks

Object

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.

TeamProjectCollectionReference

Object

Objeto de referência para um TeamProjectCollection.

Nome	Tipo	Description
id	string	ID da coleção.
name	string	Nome da Coleção.
url	string	URL REST da coleção.

TeamProjectReference

Object

Representa uma referência superficial a um TeamProject.

Nome	Tipo	Description
abbreviation	string	Abreviação do projeto.
description	string	A descrição do projeto (se houver).
id	string	Identificador 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.

Compartilhar via

Repositories - Get

Parâmetros de URI

Respostas

Segurança

oauth2

Escopos

Exemplos

Get a repository by remote URL

Solicitação de exemplo

Resposta de exemplo

Get a repository by repositoryId

Solicitação de exemplo

Resposta de exemplo

Definições

GitRepository

GitRepositoryRef

ProjectState

ProjectVisibility

ReferenceLinks

TeamProjectCollectionReference

TeamProjectReference