Compartilhar via


Projects - List

Obtenha todos os projetos na organização aos quais o usuário autenticado tem acesso.

GET https://dev.azure.com/{organization}/_apis/projects?api-version=7.1-preview.4
GET https://dev.azure.com/{organization}/_apis/projects?stateFilter={stateFilter}&$top={$top}&$skip={$skip}&continuationToken={continuationToken}&getDefaultTeamImageUrl={getDefaultTeamImageUrl}&api-version=7.1-preview.4

Parâmetros de URI

Nome Em Obrigatório Tipo Description
organization
path True

string

O nome da organização do Azure DevOps.

api-version
query True

string

Versão da API a ser usada. Isso deve ser definido como '7.1-preview.4' para usar essa versão da api.

$skip
query

integer

int32
$top
query

integer

int32
continuationToken
query

integer

int32

Ponteiro que mostra quantos projetos já foram buscados.

getDefaultTeamImageUrl
query

boolean

stateFilter
query

ProjectState

Filtre projetos de equipe em um estado de projeto de equipe específico (padrão: WellFormed).

Respostas

Nome Tipo Description
200 OK

TeamProjectReference[]

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.profile Concede a capacidade de ler seu perfil, contas, coleções, projetos, equipes e outros artefatos organizacionais de nível superior.
vso.project Concede a capacidade de ler projetos e equipes.

Exemplos

Sample Request

GET https://dev.azure.com/fabrikam/_apis/projects?api-version=7.1-preview.4

Sample Response

{
  "count": 3,
  "value": [
    {
      "id": "eb6e4656-77fc-42a1-9181-4c6d8e9da5d1",
      "name": "Fabrikam-Fiber-TFVC",
      "description": "Team Foundation Version Control projects.",
      "url": "https://dev.azure.com/fabrikam/_apis/projects/eb6e4656-77fc-42a1-9181-4c6d8e9da5d1",
      "state": "wellFormed"
    },
    {
      "id": "6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c",
      "name": "Fabrikam-Fiber-Git",
      "description": "Git projects",
      "url": "https://dev.azure.com/fabrikam/_apis/projects/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c",
      "state": "wellFormed"
    },
    {
      "id": "281f9a5b-af0d-49b4-a1df-fe6f5e5f84d0",
      "name": "TestGit",
      "url": "https://dev.azure.com/fabrikam/_apis/projects/281f9a5b-af0d-49b4-a1df-fe6f5e5f84d0",
      "state": "wellFormed"
    }
  ]
}

Definições

Nome Description
ProjectState

O estado atual do projeto.

ProjectVisibility

Indica para quem o projeto está visível.

TeamProjectReference

Representa uma referência superficial a um TeamProject.

ProjectState

O estado atual 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 projeto é completamente criado e pronto para uso.

ProjectVisibility

Indica para quem o projeto está visível.

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.

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