Dashboards - Replace Dashboard
替换指定仪表板的配置。 仅当提供属性时，才会替换仪表板上的小组件列表。
PUT https://dev.azure.com/{organization}/{project}/{team}/_apis/dashboard/dashboards/{dashboardId}?api-version=7.1-preview.3URI 参数
| 名称 | 在 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
dashboard
|
path | True |
string (uuid) |
要替换的仪表板的 ID。 |
|
organization
|
path | True |
string |
Azure DevOps 组织的名称。 |
|
project
|
path | True |
string |
项目 ID 或项目名称 |
|
team
|
path |
string |
团队 ID 或团队名称 |
|
|
api-version
|
query | True |
string |
要使用的 API 版本。 这应设置为“7.1-preview.3”才能使用此版本的 API。 |
请求正文
| 名称 | 类型 | 说明 |
|---|---|---|
| _links |
表示 REST 引用链接集合的类。 |
|
| dashboardScope |
仪表板的作用域为实体。 |
|
| description |
string |
仪表板的说明。 |
| eTag |
string |
服务器定义的版本跟踪值，用于编辑碰撞检测。 |
| groupId |
string (uuid) |
仪表板组的 ID。 对于团队范围的仪表板，这是与仪表板关联的团队的唯一标识符。 对于项目范围的仪表板，此属性为空。 |
| id |
string (uuid) |
仪表板的 ID。 创建时由服务提供。 |
| lastAccessedDate |
string (date-time) |
仪表板上次访问日期。 |
| modifiedBy |
string (uuid) |
修改仪表板的人员的 ID。 |
| modifiedDate |
string (date-time) |
仪表板的上次修改日期。 |
| name |
string |
仪表板的名称。 |
| ownerId |
string (uuid) |
仪表板所有者的 ID。 对于团队范围的仪表板，这是与仪表板关联的团队的唯一标识符。 对于项目范围的仪表板，这是与仪表板关联的用户标识的唯一标识符。 |
| position |
integer (int32) |
仪表板的位置，位于仪表板组中。 如果在创建时未设置，则位置由服务决定。 |
| refreshInterval |
integer (int32) |
客户端自动刷新仪表板的间隔。 以分钟为单位表示。 |
| url |
string |
|
| widgets |
Widget[] |
仪表板上的小组件集。 |
响应
| 名称 | 类型 | 说明 |
|---|---|---|
| 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.dashboards_manage | 授予管理团队仪表板信息的能力 |
定义
| 名称 | 说明 |
|---|---|
| Dashboard |
仪表板的模型。 |
|
Dashboard |
仪表板范围。 可以是 Project 或 Project_Team |
|
Lightbox |
Lightbox 配置 |
|
Reference |
表示 REST 引用链接集合的类。 |
|
Semantic |
项目的版本控制，如以下文章所述：http://semver.org/，窗体 major.minor.patch。 |
| Widget |
小组件数据 |
|
Widget |
|
|
Widget |
Dashboard
仪表板的模型。
| 名称 | 类型 | 说明 |
|---|---|---|
| _links |
表示 REST 引用链接集合的类。 |
|
| dashboardScope |
仪表板的作用域为实体。 |
|
| description |
string |
仪表板的说明。 |
| eTag |
string |
服务器定义的版本跟踪值，用于编辑碰撞检测。 |
| groupId |
string (uuid) |
仪表板组的 ID。 对于团队范围的仪表板，这是与仪表板关联的团队的唯一标识符。 对于项目范围的仪表板，此属性为空。 |
| id |
string (uuid) |
仪表板的 ID。 创建时由服务提供。 |
| lastAccessedDate |
string (date-time) |
仪表板上次访问日期。 |
| modifiedBy |
string (uuid) |
修改仪表板的人员的 ID。 |
| modifiedDate |
string (date-time) |
仪表板的上次修改日期。 |
| name |
string |
仪表板的名称。 |
| ownerId |
string (uuid) |
仪表板所有者的 ID。 对于团队范围的仪表板，这是与仪表板关联的团队的唯一标识符。 对于项目范围的仪表板，这是与仪表板关联的用户标识的唯一标识符。 |
| position |
integer (int32) |
仪表板的位置，位于仪表板组中。 如果在创建时未设置，则位置由服务决定。 |
| refreshInterval |
integer (int32) |
客户端自动刷新仪表板的间隔。 以分钟为单位表示。 |
| url |
string |
|
| widgets |
Widget[] |
仪表板上的小组件集。 |
DashboardScope
仪表板范围。 可以是 Project 或 Project_Team
| 值 | 说明 |
|---|---|
| collection_User |
[已弃用]仪表板的范围限定为集合用户。 |
| project |
仪表板的范围限定为项目。 |
| project_Team |
仪表板的范围限定为团队。 |
LightboxOptions
Lightbox 配置
| 名称 | 类型 | 说明 |
|---|---|---|
| height |
integer (int32) |
所需灯箱的高度（以像素为单位） |
| resizable |
boolean |
如果为 True，则允许灯箱大小调整，false 禁止重设灯箱大小，默认值为 false。 |
| width |
integer (int32) |
所需灯箱的宽度（以像素为单位） |
ReferenceLinks
表示 REST 引用链接集合的类。
| 名称 | 类型 | 说明 |
|---|---|---|
| links |
object |
链接的只读视图。 由于引用链接是只读的，因此我们只想将其公开为只读链接。 |
SemanticVersion
项目的版本控制，如以下文章所述：http://semver.org/，窗体 major.minor.patch。
| 名称 | 类型 | 说明 |
|---|---|---|
| major |
integer (int32) |
进行不兼容的 API 更改时的主要版本 |
| minor |
integer (int32) |
以向后兼容的方式添加功能时的次要版本 |
| patch |
integer (int32) |
进行向后兼容的 bug 修复时修补版本 |
Widget
小组件数据
| 名称 | 类型 | 说明 |
|---|---|---|
| _links |
表示 REST 引用链接集合的类。 |
|
| allowedSizes |
指小组件允许的大小。 当用户想要配置小组件时，会填充此内容 |
|
| areSettingsBlockedForUser |
boolean |
Read-Only 仪表板服务中的属性。 指示当前用户是否阻止了设置。 |
| artifactId |
string |
指功能项目的唯一标识符。 用于固定+取消固定特定项目。 |
| configurationContributionId |
string |
|
| configurationContributionRelativeId |
string |
|
| contentUri |
string |
|
| contributionId |
string |
定义提供的小组件配置的基础贡献的 ID。 |
| dashboard |
可选部分仪表板内容，以支持交换小组件级 API 的仪表板级版本 ETag |
|
| eTag |
string |
|
| id |
string (uuid) |
|
| isEnabled |
boolean |
|
| isNameConfigurable |
boolean |
|
| lightboxOptions |
Lightbox 配置 |
|
| loadingImageUrl |
string |
|
| name |
string |
|
| position | ||
| settings |
string |
|
| settingsVersion |
项目的版本控制，如以下文章所述：http://semver.org/，窗体 major.minor.patch。 |
|
| size | ||
| typeId |
string |
|
| url |
string |
WidgetPosition
| 名称 | 类型 | 说明 |
|---|---|---|
| column |
integer (int32) |
|
| row |
integer (int32) |
WidgetSize
| 名称 | 类型 | 说明 |
|---|---|---|
| columnSpan |
integer (int32) |
小组件的宽度，以仪表板网格列表示。 |
| rowSpan |
integer (int32) |
小组件的高度，以仪表板网格行表示。 |