Projects - Get

获取具有指定 ID 或名称的项目,(可选)包括功能。

GET https://dev.azure.com/{organization}/_apis/projects/{projectId}?api-version=7.1-preview.4
GET https://dev.azure.com/{organization}/_apis/projects/{projectId}?includeCapabilities={includeCapabilities}&includeHistory={includeHistory}&api-version=7.1-preview.4

URI 参数

名称 必需 类型 说明
organization
path True

string

Azure DevOps 组织的名称。

projectId
path True

string

api-version
query True

string

要使用的 API 版本。 应将其设置为“7.1-preview.4”才能使用此版本的 API。

includeCapabilities
query

boolean

在团队项目结果中包含 (功能(如源代码管理) ), (默认值:false) 。

includeHistory
query

boolean

在重命名的项目中搜索 (,这些项目在过去) 中具有此类名称。

响应

名称 类型 说明
200 OK

TeamProject

成功的操作

安全性

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 授予读取项目和团队的能力。

定义

名称 说明
ProjectState

项目的当前状态。

ProjectVisibility

指示项目对谁可见。

ReferenceLinks

表示 REST 引用链接集合的类。

TeamProject

表示团队项目对象。

WebApiTeamRef

ProjectState

项目的当前状态。

名称 类型 说明
all

string

除“已删除”之外的所有项目,而不考虑状态。

createPending

string

项目已排队等待创建,但该过程尚未启动。

deleted

string

已删除项目。

deleting

string

正在删除项目。

new

string

项目正在创建中。

unchanged

string

项目尚未更改。

wellFormed

string

项目已完全创建并可供使用。

ProjectVisibility

指示项目对谁可见。

名称 类型 说明
private

string

项目仅对具有显式访问权限的用户可见。

public

string

该项目对所有人都可见。

表示 REST 引用链接集合的类。

名称 类型 说明
links

object

链接的只读视图。 由于引用链接是只读的,因此我们只想将其公开为只读。

TeamProject

表示团队项目对象。

名称 类型 说明
_links

ReferenceLinks

指向与此对象相关的其他对象的链接。

abbreviation

string

项目缩写。

capabilities

object

此项目具有 (的功能集,例如过程模板 & 版本控制) 。

defaultTeam

WebApiTeamRef

默认团队的浅层引用。

defaultTeamImageUrl

string

默认团队标识图像的 URL。

description

string

如果有任何) ,则 (项目的说明。

id

string

项目标识符。

lastUpdateTime

string

项目上次更新时间。

name

string

项目名称。

revision

integer

项目修订。

state

ProjectState

项目状态。

url

string

对象完整版本的 URL。

visibility

ProjectVisibility

项目可见性。

WebApiTeamRef

名称 类型 说明
id

string

Team (Identity) Guid。 Team Foundation ID。

name

string

球队名称

url

string

团队 REST API URL