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
フロー: accessCode
Authorization URL (承認 URL): https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL (トークン 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	プロジェクトとチームを読み取る機能を付与します。

例

要求のサンプル

HTTP

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

列挙

プロジェクトの現在の状態。

値	説明
all	[削除済み] を除く、状態に関係なく、すべてのプロジェクト。
createPending	プロジェクトは作成のためにキューに登録されていますが、プロセスはまだ開始されていません。
deleted	プロジェクトが削除されました。
deleting	プロジェクトは削除中です。
new	プロジェクトは作成中です。
unchanged	プロジェクトは変更されていません。
wellFormed	プロジェクトが完全に作成され、使用する準備が整いました。

ProjectVisibility

列挙

プロジェクトが表示されるユーザーを示します。

値	説明
private	プロジェクトは、明示的なアクセス権を持つユーザーにのみ表示されます。
public	プロジェクトはすべてのユーザーに表示されます。

TeamProjectReference

Object

TeamProject への浅い参照を表します。

名前	型	説明
abbreviation	string	プロジェクトの省略形。
defaultTeamImageUrl	string	既定のチーム ID イメージの URL。
description	string	プロジェクトの説明 (ある場合)。
id	string (uuid)	プロジェクト識別子。
lastUpdateTime	string (date-time)	プロジェクトの最終更新時刻。
name	string	プロジェクト名。
revision	integer (int64)	プロジェクトのリビジョン。
state	ProjectState	プロジェクトの状態。
url	string	オブジェクトの完全なバージョンへの URL。
visibility	ProjectVisibility	プロジェクトの可視性。

次の方法で共有