Dashboards - Replace Dashboard
取代指定儀錶板的組態。 只有在提供 屬性時，才會取代儀錶板上的 Widget 清單。
PUT https://dev.azure.com/{organization}/{project}/{team}/_apis/dashboard/dashboards/{dashboardId}?api-version=7.1-preview.3URI 參數
| 名稱 | 位於 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
dashboard
|
path | True |
string (uuid) |
要取代之儀錶板的標識碼。 |
|
organization
|
path | True |
string |
Azure DevOps 組織的名稱。 |
|
project
|
path | True |
string |
項目識別碼或項目名稱 |
|
team
|
path |
string |
小組標識碼或小組名稱 |
|
|
api-version
|
query | True |
string |
要使用的 API 版本。 這應該設定為 『7.1-preview.3』，才能使用此版本的 API。 |
要求本文
| 名稱 | 類型 | Description |
|---|---|---|
| _links |
表示 REST 參考連結集合的類別。 |
|
| dashboardScope |
儀錶板的範圍為的實體。 |
|
| description |
string |
儀錶板的描述。 |
| eTag |
string |
伺服器定義的版本追蹤值，用於編輯衝突偵測。 |
| groupId |
string (uuid) |
儀錶板群組的標識碼。 對於小組範圍的儀錶板，這是與儀錶板相關聯的小組唯一標識符。 對於專案範圍的儀錶板，此屬性是空的。 |
| id |
string (uuid) |
儀錶板的標識碼。 建立時由服務提供。 |
| lastAccessedDate |
string (date-time) |
儀錶板上次存取日期。 |
| modifiedBy |
string (uuid) |
修改儀錶板的人員標識碼。 |
| modifiedDate |
string (date-time) |
儀錶板上次修改日期。 |
| name |
string |
儀錶板的名稱。 |
| ownerId |
string (uuid) |
儀錶板的擁有者標識碼。 對於小組範圍的儀錶板，這是與儀錶板相關聯的小組唯一標識符。 對於專案範圍的儀錶板，這是與儀錶板相關聯的使用者身分識別的唯一標識符。 |
| position |
integer (int32) |
儀錶板在儀錶板群組中的位置。 如果在建立時未設定，服務會決定位置。 |
| refreshInterval |
integer (int32) |
用戶端自動重新整理儀錶板的間隔。 以分鐘為單位表示。 |
| url |
string |
|
| widgets |
Widget[] |
儀錶板上的 Widget 集合。 |
回應
| 名稱 | 類型 | Description |
|---|---|---|
| 200 OK |
成功作業 |
安全性
oauth2
類型:
oauth2
Flow:
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
範圍
| 名稱 | Description |
|---|---|
| vso.dashboards_manage | 授與管理小組儀錶板資訊的能力 |
定義
| 名稱 | Description |
|---|---|
| Dashboard |
儀錶板的模型。 |
|
Dashboard |
儀錶板範圍。 可以是 Project 或 Project_Team |
|
Lightbox |
Lightbox 組態 |
|
Reference |
表示 REST 參考連結集合的類別。 |
|
Semantic |
成品的版本設定，如下列所述：http://semver.org/，格式為 major.minor.patch。 |
| Widget |
小工具數據 |
|
Widget |
|
|
Widget |
Dashboard
儀錶板的模型。
| 名稱 | 類型 | Description |
|---|---|---|
| _links |
表示 REST 參考連結集合的類別。 |
|
| dashboardScope |
儀錶板的範圍為的實體。 |
|
| description |
string |
儀錶板的描述。 |
| eTag |
string |
伺服器定義的版本追蹤值，用於編輯衝突偵測。 |
| groupId |
string (uuid) |
儀錶板群組的標識碼。 對於小組範圍的儀錶板，這是與儀錶板相關聯的小組唯一標識符。 對於專案範圍的儀錶板，此屬性是空的。 |
| id |
string (uuid) |
儀錶板的標識碼。 建立時由服務提供。 |
| lastAccessedDate |
string (date-time) |
儀錶板上次存取日期。 |
| modifiedBy |
string (uuid) |
修改儀錶板的人員標識碼。 |
| modifiedDate |
string (date-time) |
儀錶板上次修改日期。 |
| name |
string |
儀錶板的名稱。 |
| ownerId |
string (uuid) |
儀錶板的擁有者標識碼。 對於小組範圍的儀錶板，這是與儀錶板相關聯的小組唯一標識符。 對於專案範圍的儀錶板，這是與儀錶板相關聯的使用者身分識別的唯一標識符。 |
| position |
integer (int32) |
儀錶板在儀錶板群組中的位置。 如果在建立時未設定，服務會決定位置。 |
| refreshInterval |
integer (int32) |
用戶端自動重新整理儀錶板的間隔。 以分鐘為單位表示。 |
| url |
string |
|
| widgets |
Widget[] |
儀錶板上的 Widget 集合。 |
DashboardScope
儀錶板範圍。 可以是 Project 或 Project_Team
| 值 | Description |
|---|---|
| collection_User |
[已淘汰]儀錶板的範圍設定為集合使用者。 |
| project |
儀錶板的範圍設定為專案。 |
| project_Team |
儀錶板的範圍設定為小組。 |
LightboxOptions
Lightbox 組態
| 名稱 | 類型 | Description |
|---|---|---|
| height |
integer (int32) |
所需燈箱的高度，以像素為單位 |
| resizable |
boolean |
True 是表示 允許 Lightbox 重設大小，false 表示不允許 Lightbox 重設大小，預設為 false。 |
| width |
integer (int32) |
所需燈箱的寬度，以像素為單位 |
ReferenceLinks
表示 REST 參考連結集合的類別。
| 名稱 | 類型 | Description |
|---|---|---|
| links |
object |
連結的只讀檢視。 因為參考連結是只讀的，所以我們只想要將其公開為只讀。 |
SemanticVersion
成品的版本設定，如下列所述：http://semver.org/，格式為 major.minor.patch。
| 名稱 | 類型 | Description |
|---|---|---|
| major |
integer (int32) |
進行不相容 API 變更時的主要版本 |
| minor |
integer (int32) |
當您以回溯相容的方式新增功能時，次要版本 |
| patch |
integer (int32) |
進行回溯相容 Bug 修正時的修補程式版本 |
Widget
小工具數據
| 名稱 | 類型 | Description |
|---|---|---|
| _links |
表示 REST 參考連結集合的類別。 |
|
| allowedSizes |
是指小工具允許的大小。 當使用者想要設定小工具時，就會填入此專案 |
|
| areSettingsBlockedForUser |
boolean |
從儀錶板服務 Read-Only 屬性。 指出目前用戶的設定是否遭到封鎖。 |
| artifactId |
string |
參考功能成品的唯一標識符。 用於釘選+取消釘選特定成品。 |
| configurationContributionId |
string |
|
| configurationContributionRelativeId |
string |
|
| contentUri |
string |
|
| contributionId |
string |
定義所提供 Widget 組態之基礎貢獻的標識碼。 |
| 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
| 名稱 | 類型 | Description |
|---|---|---|
| column |
integer (int32) |
|
| row |
integer (int32) |
WidgetSize
| 名稱 | 類型 | Description |
|---|---|---|
| columnSpan |
integer (int32) |
小工具的寬度，以儀錶板方格數據行表示。 |
| rowSpan |
integer (int32) |
小工具的高度，以儀錶板方格數據列表示。 |