Plans - Create

Service:

Work

API Version:

7.1-preview.1

为团队添加新计划

POST https://dev.azure.com/{organization}/{project}/_apis/work/plans?api-version=7.1-preview.1

URI 参数

名称	在	必需	类型	说明
organization	path	True	string	Azure DevOps 组织的名称。
project	path	True	string	项目 ID 或项目名称
api-version	query	True	string	要使用的 API 版本。 应将其设置为“7.1-preview.1”才能使用此版本的 API。

请求正文

名称	类型	说明
description	string	计划说明
name	string	要创建的计划的名称。
properties	object	计划属性。
type	PlanType	要创建的计划的类型。

响应

名称	类型	说明
200 OK	Plan	成功的操作

安全性

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.work_write	授予读取、创建和更新工作项和查询、更新板元数据、读取区域和迭代路径等工作项跟踪相关元数据、执行查询以及通过服务挂钩接收有关工作项事件的通知的能力。

定义

名称	说明
CreatePlan
IdentityRef
Plan	计划定义的数据协定
PlanType	要创建的计划的类型。
PlanUserPermissions	指示用户对计划拥有的一组权限的位标志。
ReferenceLinks	表示 REST 引用链接集合的类。

CreatePlan

名称	类型	说明
description	string	计划说明
name	string	要创建的计划的名称。
properties	object	计划属性。
type	PlanType	要创建的计划的类型。

IdentityRef

名称	类型	说明
_links	ReferenceLinks	此字段包含有关图形主题的零个或多个相关链接。 可以调用这些链接来获取有关此图主题的其他关系或更多详细信息。
descriptor	string	描述符是在系统运行时引用图形主题的主要方式。 此字段将唯一标识帐户和组织中的同一图形主题。
directoryAlias	string	已弃用 - 可通过查询 IdentityRef“_links”字典的“self”条目中引用的 Graph 用户来检索
displayName	string	这是图形主题的非唯一显示名称。 若要更改此字段，必须在源提供程序中更改其值。
id	string
imageUrl	string	已弃用 - 在 IdentityRef“_links”字典的“头像”条目中可用
inactive	boolean	已弃用 - 可以通过查询 GraphUser“_links”字典的“membershipState”条目中引用的 Graph 成员身份状态来检索
isAadIdentity	boolean	已弃用 - 可以从描述符的主题类型推断 (描述符.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	已弃用 - 可以从描述符的主题类型推断 (描述符.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	已弃用 - 未在 ToIdentityRef 的大多数预先存在的实现中使用
uniqueName	string	已弃用 - 改用 Domain+PrincipalName
url	string	此 URL 是此图主题的源资源的完整路由。

Plan

计划定义的数据协定

名称	类型	说明
createdByIdentity	IdentityRef	创建此计划的标识。 在升级到 ScaledAgileViewComponent4 之前，记录默认为 null。
createdDate	string	计划创建日期
description	string	计划说明
id	string	计划的 ID
lastAccessed	string	上次访问计划的日期。 默认值为 null。
modifiedByIdentity	IdentityRef	上次修改此计划的标识。 在升级到 ScaledAgileViewComponent4 之前，记录默认为 null。
modifiedDate	string	上次修改计划的日期。 首次创建计划时，默认为 CreatedDate。
name	string	计划的名称
properties	object	与计划关联的 PlanPropertyCollection 实例。 这些类型取决于计划的类型。 例如，DeliveryTimelineView 的类型为 DeliveryViewPropertyCollection。
revision	integer	计划的修订。 用于保护用户不覆盖彼此的更改。
type	PlanType	计划的类型
url	string	通过 rest API 查找计划的资源 URL
userPermissions	PlanUserPermissions	指示用户对计划拥有的一组权限的位标志。

PlanType

要创建的计划的类型。

名称	类型	说明
deliveryTimelineView	string

PlanUserPermissions

指示用户对计划拥有的一组权限的位标志。

名称	类型	说明
allPermissions	string	此计划的完全控制权限。
delete	string	删除此计划的权限。
edit	string	更新此计划的权限。
manage	string	管理此计划的权限。
none	string	无
view	string	查看此计划的权限。

ReferenceLinks

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

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