Projects - List

Referenz

Service:: Core

API Version:: 7.1-preview.4

Rufen Sie alle Projekte in der Organisation ab, auf die der authentifizierte Benutzer Zugriff hat.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
organization	path	True	string	Der Name der Azure DevOps-Organisation.
api-version	query	True	string	Version der zu verwendenden API. Dies sollte auf "7.1-preview.4" festgelegt werden, um diese Version der API zu verwenden.
$skip	query		integer int32
$top	query		integer int32
continuationToken	query		integer int32	Zeiger, der angibt, wie viele Projekte bereits abgerufen wurden.
getDefaultTeamImageUrl	query		boolean
stateFilter	query		ProjectState	Filtern Sie nach Teamprojekten in einem bestimmten Teamprojektstatus (Standard: WellFormed).

Antworten

Name	Typ	Beschreibung
200 OK	TeamProjectReference[]	Erfolgreicher Vorgang

Sicherheit

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

Name	Beschreibung
vso.profile	Ermöglicht das Lesen Ihres Profils, Ihrer Konten, Sammlungen, Projekte, Teams und anderer Artefakte auf oberster Ebene.
vso.project	Ermöglicht das Lesen von Projekten und Teams.

Beispiele

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

Definitionen

Name	Beschreibung
ProjectState	Der aktuelle Status des Projekts.
ProjectVisibility	Gibt an, für wen das Projekt sichtbar ist.
TeamProjectReference	Stellt einen flachen Verweis auf ein TeamProject dar.

ProjectState

Der aktuelle Status des Projekts.

Name	Typ	Beschreibung
all	string	Alle Projekte unabhängig vom Zustand außer Gelöscht.
createPending	string	Project wurde für die Erstellung in die Warteschlange gestellt, aber der Prozess wurde noch nicht gestartet.
deleted	string	Project wurde gelöscht.
deleting	string	Project wird gerade gelöscht.
new	string	Das Projekt wird gerade erstellt.
unchanged	string	Project wurde nicht geändert.
wellFormed	string	Project ist vollständig erstellt und einsatzbereit.

ProjectVisibility

Gibt an, für wen das Projekt sichtbar ist.

Name	Typ	Beschreibung
private	string	Das Projekt ist nur für Benutzer mit explizitem Zugriff sichtbar.
public	string	Das Projekt ist für alle sichtbar.

TeamProjectReference

Stellt einen flachen Verweis auf ein TeamProject dar.

Name	Typ	Beschreibung
abbreviation	string	Projektkürzel.
defaultTeamImageUrl	string	URL zum Standardmäßigen Teamidentitätsimage.
description	string	Die Projektbeschreibung (falls vorhanden).
id	string	Projektbezeichner.
lastUpdateTime	string	Zeitpunkt der letzten Aktualisierung des Projekts.
name	string	Der Projektname.
revision	integer	Projektrevision.
state	ProjectState	Projektstatus.
url	string	URL zur Vollversion des Objekts.
visibility	ProjectVisibility	Projektsichtbarkeit.

Share via