Plans - Get
获取指定计划的信息
GET https://dev.azure.com/{organization}/{project}/_apis/work/plans/{id}?api-version=7.1URI 参数
| 名称 | 在 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
id
|
path | True |
string |
计划的标识符 |
|
organization
|
path | True |
string |
Azure DevOps 组织的名称。 |
|
project
|
path | True |
string |
项目 ID 或项目名称 |
|
api-version
|
query | True |
string |
要使用的 API 版本。 这应设置为“7.1”才能使用此版本的 API。 |
响应
| 名称 | 类型 | 说明 |
|---|---|---|
| 200 OK |
成功作 |
安全性
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.work | 授予读取工作项、查询、版块、区域和迭代路径以及其他工作项跟踪相关元数据的能力。 此外，还授予执行查询、搜索工作项以及通过服务挂钩接收有关工作项事件的通知的能力。 |
定义
| 名称 | 说明 |
|---|---|
|
Identity |
|
| Plan |
计划定义的数据协定 |
|
Plan |
要创建的计划类型。 |
|
Plan |
指示用户对计划拥有的权限集的位标志。 |
|
Reference |
表示 REST 引用链接集合的类。 |
IdentityRef
| 名称 | 类型 | 说明 |
|---|---|---|
| _links |
此字段包含有关图形主题的零个或多个有趣的链接。 可以调用这些链接以获取有关此图形主题的其他关系或更详细的信息。 |
|
| descriptor |
string |
描述符是在系统运行时引用图形主题的主要方法。 此字段将唯一标识帐户和组织中的同一图形主题。 |
| directoryAlias |
string |
已弃用 - 可以通过查询 IdentityRef“_links”字典的“self”条目中引用的 Graph 用户来检索 |
| displayName |
string |
这是图形主题的非唯一显示名称。 若要更改此字段，必须在源提供程序中更改其值。 |
| id |
string |
|
| imageUrl |
string |
已弃用 - 在 IdentityRef“_links”字典的“虚拟形象”条目中可用 |
| inactive |
boolean |
已弃用 - 可以通过查询 GraphUser“_links”字典的“membershipState”条目中引用的 Graph 成员身份状态来检索 |
| isAadIdentity |
boolean |
已弃用 - 可以从描述符的主题类型推断（Descriptor.IsAadUserType/Descriptor.IsAadGroupType） |
| isContainer |
boolean |
已弃用 - 可以从描述符的主题类型推断（描述符.IsGroupType） |
| isDeletedInOrigin |
boolean |
|
| profileUrl |
string |
已弃用 - 不在 ToIdentityRef 的大多数预先存在的实现中使用 |
| uniqueName |
string |
已弃用 - 请改用 Domain+PrincipalName |
| url |
string |
此 URL 是指向此图形主题的源资源的完整路由。 |
Plan
计划定义的数据协定
| 名称 | 类型 | 说明 |
|---|---|---|
| createdByIdentity |
创建此计划的标识。 升级到 ScaledAgileViewComponent4 之前，记录默认为 null。 |
|
| createdDate |
string (date-time) |
创建计划的日期 |
| description |
string |
计划的说明 |
| id |
string (uuid) |
计划的 ID |
| lastAccessed |
string (date-time) |
上次访问计划时的日期。 默认值为 null。 |
| modifiedByIdentity |
上次修改此计划的标识。 升级到 ScaledAgileViewComponent4 之前，记录默认为 null。 |
|
| modifiedDate |
string (date-time) |
上次修改计划的日期。 首次创建计划时，默认为 CreatedDate。 |
| name |
string |
计划的名称 |
| properties |
object |
与计划关联的 PlanPropertyCollection 实例。 这些依赖于计划的类型。 例如，DeliveryTimelineView 的类型为 DeliveryViewPropertyCollection。 |
| revision |
integer (int32) |
计划的修订。 用于保护用户免受彼此的更改的覆盖。 |
| type |
计划的类型 |
|
| url |
string |
用于通过 rest API 查找计划的资源 URL |
| userPermissions |
指示用户对计划拥有的权限集的位标志。 |
PlanType
要创建的计划类型。
| 值 | 说明 |
|---|---|
| deliveryTimelineView |
PlanUserPermissions
指示用户对计划拥有的权限集的位标志。
| 值 | 说明 |
|---|---|
| allPermissions |
此计划的完全控制权限。 |
| delete |
删除此计划的权限。 |
| edit |
更新此计划的权限。 |
| manage |
管理此计划的权限。 |
| none |
没有 |
| view |
查看此计划的权限。 |
ReferenceLinks
表示 REST 引用链接集合的类。
| 名称 | 类型 | 说明 |
|---|---|---|
| links |
object |
链接的只读视图。 由于引用链接是只读的，因此我们只想将其公开为只读链接。 |