Projects - List

Ссылка

Service:: Core

API Version:: 7.1-preview.4

Получение всех проектов в организации, к которым у пользователя, прошедшего проверку подлинности, есть доступ.

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

Имя	В	Обязательно	Тип	Описание
organization	path	True	string	Название организации Azure DevOps.
api-version	query	True	string	Используемая версия API. Для использования этой версии API необходимо задать значение 7.1-preview.4.
$skip	query		integer int32
$top	query		integer int32
continuationToken	query		integer int32	Указатель, показывающий, сколько проектов уже было возвращено.
getDefaultTeamImageUrl	query		boolean
stateFilter	query		ProjectState	Фильтрация по командным проектам в определенном состоянии командного проекта (по умолчанию — WellFormed).

Ответы

Имя	Тип	Описание
200 OK	TeamProjectReference[]	успешная операция

Безопасность

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

Имя	Описание
vso.profile	Предоставляет возможность читать профиль, учетные записи, коллекции, проекты, команды и другие артефакты организации верхнего уровня.
vso.project	Предоставляет возможность читать проекты и команды.

Примеры

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

Определения

Имя	Описание
ProjectState	Текущее состояние проекта.
ProjectVisibility	Указывает, кому является видимым проект.
TeamProjectReference	Представляет неглубокую ссылку на TeamProject.

ProjectState

Текущее состояние проекта.

Имя	Тип	Описание
all	string	Все проекты независимо от состояния, кроме Deleted.
createPending	string	Проект поставлен в очередь для создания, но процесс еще не запущен.
deleted	string	Проект удален.
deleting	string	Project находится в процессе удаления.
new	string	Проект находится в процессе создания.
unchanged	string	Проект не был изменен.
wellFormed	string	Project полностью создан и готов к использованию.

ProjectVisibility

Указывает, кому является видимым проект.

Имя	Тип	Описание
private	string	Проект виден только пользователям с явным доступом.
public	string	Проект виден всем.

TeamProjectReference

Представляет неглубокую ссылку на TeamProject.

Имя	Тип	Описание
abbreviation	string	Сокращение проекта.
defaultTeamImageUrl	string	URL-адрес для образа удостоверения команды по умолчанию.
description	string	Описание проекта (если таковое есть).
id	string	Идентификатор проекта.
lastUpdateTime	string	Время последнего обновления проекта.
name	string	Имя проекта.
revision	integer	Редакция проекта.
state	ProjectState	Состояние проекта.
url	string	URL-адрес полной версии объекта.
visibility	ProjectVisibility	Видимость проекта.

Поделиться через