Projects - Update

服务:

Core

API 版本:

7.1

更新现有项目的名称、缩写、说明或还原项目。

PATCH https://dev.azure.com/{organization}/_apis/projects/{projectId}?api-version=7.1

URI 参数

名称	在	必需	类型	说明
organization	path	True	string	Azure DevOps 组织的名称。
projectId	path	True	string (uuid)	要更新的项目的项目 ID。
api-version	query	True	string	要使用的 API 版本。 这应设置为“7.1”才能使用此版本的 API。

请求正文

名称	类型	说明
_links	ReferenceLinks	指向与此对象相关的其他对象的链接。
abbreviation	string	项目缩写。
capabilities	object	此项目具有的功能集（如进程模板 & 版本控制）。
defaultTeam	WebApiTeamRef	默认团队的浅层 ref。
defaultTeamImageUrl	string	指向默认团队标识映像的 URL。
description	string	项目的说明（如果有）。
id	string (uuid)	项目标识符。
lastUpdateTime	string (date-time)	上次更新时间的项目。
name	string	项目名称。
revision	integer (int64)	项目修订。
state	ProjectState	项目状态。
url	string	指向对象完整版本的 URL。
visibility	ProjectVisibility	项目可见性。

响应

名称	类型	说明
200 OK	OperationReference	成功作

安全性

oauth2

类型: oauth2
流向: 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.project_write	授予读取和更新项目和团队的能力。

定义

名称	说明
OperationReference	异步作的参考。
OperationStatus	作的当前状态。
ProjectState	项目的当前状态。
ProjectVisibility	指示项目对谁可见。
ReferenceLinks	表示 REST 引用链接集合的类。
TeamProject	表示 Team Project 对象。
WebApiTeamRef

OperationReference

Object

异步作的参考。

名称	类型	说明
id	string (uuid)	作的唯一标识符。
pluginId	string (uuid)	插件的唯一标识符。
status	OperationStatus	作的当前状态。
url	string	用于获取完整作对象的 URL。

OperationStatus

枚举

作的当前状态。

值	说明
cancelled	作已由用户取消。
failed	作已完成，但失败。
inProgress	作正在进行中。
notSet	该作没有状态集。
queued	作已排队。
succeeded	作已成功完成。

ProjectState

枚举

项目的当前状态。

值	说明
all	所有项目，无论状态如何，都已删除。
createPending	项目已排队创建，但该过程尚未启动。
deleted	项目已被删除。
deleting	项目正在删除。
new	正在创建项目。
unchanged	项目尚未更改。
wellFormed	项目已完全创建并可供使用。

ProjectVisibility

枚举

指示项目对谁可见。

值	说明
private	只有具有显式访问权限的用户才能看到该项目。
public	项目对所有人可见。

ReferenceLinks

Object

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

名称	类型	说明
links	object	链接的只读视图。 由于引用链接是只读的，因此我们只想将其公开为只读链接。

TeamProject

Object

表示 Team Project 对象。

名称	类型	说明
_links	ReferenceLinks	指向与此对象相关的其他对象的链接。
abbreviation	string	项目缩写。
capabilities	object	此项目具有的功能集（如进程模板 & 版本控制）。
defaultTeam	WebApiTeamRef	默认团队的浅层 ref。
defaultTeamImageUrl	string	指向默认团队标识映像的 URL。
description	string	项目的说明（如果有）。
id	string (uuid)	项目标识符。
lastUpdateTime	string (date-time)	上次更新时间的项目。
name	string	项目名称。
revision	integer (int64)	项目修订。
state	ProjectState	项目状态。
url	string	指向对象完整版本的 URL。
visibility	ProjectVisibility	项目可见性。

WebApiTeamRef

Object

名称	类型	说明
id	string (uuid)	团队 （标识） Guid。 Team Foundation ID。
name	string	团队名称
url	string	团队 REST API URL