Projects - List

Служба:
Core
Версия API:
7.1

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

GET https://dev.azure.com/{organization}/_apis/projects?api-version=7.1
С использованием необязательных параметров: 
GET https://dev.azure.com/{organization}/_apis/projects?stateFilter={stateFilter}&$top={$top}&$skip={$skip}&continuationToken={continuationToken}&getDefaultTeamImageUrl={getDefaultTeamImageUrl}&api-version=7.1

Параметры URI

Имя В Обязательно Тип Описание
organization
 path True

string

Имя организации Azure DevOps.
api-version
 query True

string

Используемая версия API. Для использования этой версии API необходимо задать значение "7.1".
$skip
 query

integer (int32)

$top
 query

integer (int32)

continuationToken
 query

integer (int32)

Указатель, показывающий, сколько проектов уже было выполнено.
getDefaultTeamImageUrl
 query

boolean

stateFilter
 query

ProjectState

Фильтрация по командным проектам в определенном состоянии командного проекта (по умолчанию: WellFormed).

Ответы

Имя Тип Описание
200 OK

TeamProjectReference[]

успешная операция

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

oauth2

Тип: oauth2
Flow: accessCode
URL-адрес авторизации: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
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

Области

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

Примеры

Образец запроса

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

Пример ответа

Код состояния:
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

Перечисление

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

Значение Описание
deleting

Проект находится в процессе удаления.
new

Проект находится в процессе создания.
wellFormed

Проект полностью создан и готов к использованию.
createPending

Проект был поставлен в очередь для создания, но процесс еще не запущен.
all

Все проекты независимо от состояния, кроме deleted.
unchanged

Проект не был изменен.
deleted

Проект удален.

ProjectVisibility

Перечисление

Указывает, кому отображается проект.

Значение Описание
private

Проект отображается только пользователям с явным доступом.
public

Проект виден всем.

TeamProjectReference

Объект

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

Имя Тип Описание
abbreviation

string

Сокращение проекта.
defaultTeamImageUrl

string

URL-адрес образа удостоверения группы по умолчанию.
description

string

Описание проекта (если таковой есть).
id

string (uuid)

Идентификатор проекта.
lastUpdateTime

string (date-time)

Время последнего обновления проекта.
name

string

Имя проекта.
revision

integer (int64)

Редакция проекта.
state

ProjectState

Состояние проекта.
url

string

URL-адрес полной версии объекта.
visibility

ProjectVisibility

Видимость проекта.