Projects - List

Odwołanie

Service:: Core

API Version:: 7.1-preview.4

Pobierz wszystkie projekty w organizacji, do których ma dostęp uwierzytelniony użytkownik.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
organization	path	True	string	Nazwa organizacji usługi Azure DevOps.
api-version	query	True	string	Wersja interfejsu API do użycia. Ta wartość powinna mieć wartość "7.1-preview.4", aby używać tej wersji interfejsu API.
$skip	query		integer int32
$top	query		integer int32
continuationToken	query		integer int32	Wskaźnik pokazujący, ile projektów zostało już pobranych.
getDefaultTeamImageUrl	query		boolean
stateFilter	query		ProjectState	Filtrowanie projektów zespołowych w określonym stanie projektu zespołowego (ustawienie domyślne: WellFormed).

Odpowiedzi

Nazwa	Typ	Opis
200 OK	TeamProjectReference[]	operacja zakończona powodzeniem

Zabezpieczenia

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

Nazwa	Opis
vso.profile	Umożliwia odczytywanie profilu, kont, kolekcji, projektów, zespołów i innych artefaktów organizacyjnych najwyższego poziomu.
vso.project	Umożliwia odczytywanie projektów i zespołów.

Przykłady

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

Definicje

Nazwa	Opis
ProjectState	Bieżący stan projektu.
ProjectVisibility	Wskazuje, komu projekt jest widoczny.
TeamProjectReference	Reprezentuje płytkie odwołanie do projektu TeamProject.

ProjectState

Bieżący stan projektu.

Nazwa	Typ	Opis
all	string	Wszystkie projekty niezależnie od stanu z wyjątkiem usuniętych.
createPending	string	Projekt został jeszcze w kolejce do utworzenia, ale proces nie został jeszcze uruchomiony.
deleted	string	Projekt został usunięty.
deleting	string	Projekt jest w trakcie usuwania.
new	string	Projekt jest w trakcie tworzenia.
unchanged	string	Projekt nie został zmieniony.
wellFormed	string	Projekt jest całkowicie tworzony i gotowy do użycia.

ProjectVisibility

Wskazuje, komu projekt jest widoczny.

Nazwa	Typ	Opis
private	string	Projekt jest widoczny tylko dla użytkowników z jawnym dostępem.
public	string	Projekt jest widoczny dla wszystkich.

TeamProjectReference

Reprezentuje płytkie odwołanie do projektu TeamProject.

Nazwa	Typ	Opis
abbreviation	string	Skrót projektu.
defaultTeamImageUrl	string	Adres URL domyślnego obrazu tożsamości zespołu.
description	string	Opis projektu (jeśli istnieje).
id	string	Identyfikator projektu.
lastUpdateTime	string	Czas ostatniej aktualizacji projektu.
name	string	Nazwa projektu.
revision	integer	Poprawka projektu.
state	ProjectState	Stan projektu.
url	string	Adres URL do pełnej wersji obiektu.
visibility	ProjectVisibility	Widoczność projektu.

Udostępnij za pośrednictwem