Projects - List

Referencia

Service:: Core

API Version:: 7.1-preview.4

Obtenga todos los proyectos de la organización a los que el usuario autenticado tiene acceso.

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

With optional parameters:

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 identificador URI

Nombre	En	Requerido	Tipo	Description
organization	path	True	string	El nombre de la organización de Azure DevOps.
api-version	query	True	string	Versión de la API que se va a usar. Debe establecerse en "7.1-preview.4" para usar esta versión de la API.
$skip	query		integer int32
$top	query		integer int32
continuationToken	query		integer int32	Puntero que muestra cuántos proyectos ya se han capturado.
getDefaultTeamImageUrl	query		boolean
stateFilter	query		ProjectState	Filtre los proyectos de equipo en un estado de proyecto de equipo específico (valor predeterminado: WellFormed).

Respuestas

Nombre	Tipo	Description
200 OK	TeamProjectReference[]	operación correcta

Seguridad

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

Nombre	Description
vso.profile	Concede la capacidad de leer el perfil, las cuentas, las colecciones, los proyectos, los equipos y otros artefactos organizativos de nivel superior.
vso.project	Concede la capacidad de leer proyectos y equipos.

Ejemplos

Sample Request

HTTP

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

Sample Response

Status code:: 200

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

Definiciones

Nombre	Description
ProjectState	Estado actual del proyecto.
ProjectVisibility	Indica a quién está visible el proyecto.
TeamProjectReference	Representa una referencia superficial a un TeamProject.

ProjectState

Estado actual del proyecto.

Nombre	Tipo	Description
all	string	Todos los proyectos independientemente del estado excepto Eliminado.
createPending	string	El proyecto se ha puesto en cola para su creación, pero el proceso aún no se ha iniciado.
deleted	string	Se ha eliminado el proyecto.
deleting	string	El proyecto está en proceso de eliminación.
new	string	El proyecto está en proceso de creación.
unchanged	string	No se ha cambiado el proyecto.
wellFormed	string	El proyecto se crea completamente y está listo para usarse.

ProjectVisibility

Indica a quién está visible el proyecto.

Nombre	Tipo	Description
private	string	El proyecto solo es visible para los usuarios con acceso explícito.
public	string	El proyecto es visible para todos.

TeamProjectReference

Representa una referencia superficial a un TeamProject.

Nombre	Tipo	Description
abbreviation	string	Abreviatura del proyecto.
defaultTeamImageUrl	string	Dirección URL a la imagen de identidad de equipo predeterminada.
description	string	Descripción del proyecto (si existe).
id	string	Identificador del proyecto.
lastUpdateTime	string	Hora de la última actualización del proyecto.
name	string	Nombre del proyecto.
revision	integer	Revisión del proyecto.
state	ProjectState	Estado del proyecto.
url	string	Dirección URL a la versión completa del objeto.
visibility	ProjectVisibility	Visibilidad del proyecto.

Compartir a través de