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 のバージョン。 このバージョンの API を使用するには、これを '7.1-preview.3' に設定する必要があります。 |
要求本文
| 名前 | 型 | 説明 |
|---|---|---|
| _links |
REST 参照リンクのコレクションを表す クラス。 |
|
| dashboardScope |
ダッシュボードのスコープが設定されているエンティティ。 |
|
| description |
string |
ダッシュボードの説明。 |
| eTag |
string |
競合検出の編集に使用されるサーバー定義のバージョン追跡値。 |
| groupId |
string |
ダッシュボードのグループの ID。 チーム スコープのダッシュボードの場合、これはダッシュボードに関連付けられているチームの一意の識別子です。 プロジェクト スコープのダッシュボードの場合、このプロパティは空です。 |
| id |
string |
ダッシュボードの ID。 作成時にサービスによって提供されます。 |
| lastAccessedDate |
string |
ダッシュボードの最終アクセス日。 |
| modifiedBy |
string |
ダッシュボードを変更したユーザーの ID。 |
| modifiedDate |
string |
ダッシュボードの最終変更日。 |
| name |
string |
ダッシュボードの名前。 |
| ownerId |
string |
ダッシュボードの所有者の ID。 チーム スコープのダッシュボードの場合、これはダッシュボードに関連付けられているチームの一意の識別子です。 プロジェクト スコープのダッシュボードの場合、これはダッシュボードに関連付けられているユーザー ID の一意の識別子です。 |
| position |
integer |
ダッシュボード グループ内でのダッシュボードの位置。 作成時に設定を解除すると、サービスによって位置が決定されます。 |
| refreshInterval |
integer |
クライアントがダッシュボードを自動的に更新する間隔。 分単位で表されます。 |
| url |
string |
|
| widgets |
Widget[] |
ダッシュボード上のウィジェットのセット。 |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 200 OK |
成功した操作 |
セキュリティ
oauth2
型:
oauth2
フロー:
accessCode
Authorization URL (承認 URL):
https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL (トークン 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 |
ライトボックスの構成 |
|
Reference |
REST 参照リンクのコレクションを表す クラス。 |
|
Semantic |
major.minor.patch 形式の 成果物 http://semver.org/のバージョン管理。 |
| Widget |
ウィジェット データ |
|
Widget |
|
|
Widget |
Dashboard
ダッシュボードのモデル。
| 名前 | 型 | 説明 |
|---|---|---|
| _links |
REST 参照リンクのコレクションを表す クラス。 |
|
| dashboardScope |
ダッシュボードのスコープが設定されているエンティティ。 |
|
| description |
string |
ダッシュボードの説明。 |
| eTag |
string |
競合検出の編集に使用されるサーバー定義のバージョン追跡値。 |
| groupId |
string |
ダッシュボードのグループの ID。 チーム スコープのダッシュボードの場合、これはダッシュボードに関連付けられているチームの一意の識別子です。 プロジェクト スコープのダッシュボードの場合、このプロパティは空です。 |
| id |
string |
ダッシュボードの ID。 作成時にサービスによって提供されます。 |
| lastAccessedDate |
string |
ダッシュボードの最終アクセス日。 |
| modifiedBy |
string |
ダッシュボードを変更したユーザーの ID。 |
| modifiedDate |
string |
ダッシュボードの最終変更日。 |
| name |
string |
ダッシュボードの名前。 |
| ownerId |
string |
ダッシュボードの所有者の ID。 チーム スコープのダッシュボードの場合、これはダッシュボードに関連付けられているチームの一意の識別子です。 プロジェクト スコープのダッシュボードの場合、これはダッシュボードに関連付けられているユーザー ID の一意の識別子です。 |
| position |
integer |
ダッシュボード グループ内でのダッシュボードの位置。 作成時に設定を解除すると、サービスによって位置が決定されます。 |
| refreshInterval |
integer |
クライアントがダッシュボードを自動的に更新する間隔。 分単位で表されます。 |
| url |
string |
|
| widgets |
Widget[] |
ダッシュボード上のウィジェットのセット。 |
DashboardScope
ダッシュボードのスコープ。 Project または Project_Team のいずれかを指定できます
| 値 | 説明 |
|---|---|
| collection_User |
[非推奨]ダッシュボードのスコープはコレクション ユーザーです。 |
| project |
ダッシュボードのスコープはプロジェクトです。 |
| project_Team |
ダッシュボードはチームにスコープが設定されます。 |
LightboxOptions
ライトボックスの構成
| 名前 | 型 | 説明 |
|---|---|---|
| height |
integer |
必要なライトボックスの高さ (ピクセル単位) |
| resizable |
boolean |
ライトボックスのサイズ変更を許可する場合は True、ライトボックスのサイズ変更を許可しない場合は false、既定値は false です。 |
| width |
integer |
目的のライトボックスの幅 (ピクセル単位) |
ReferenceLinks
REST 参照リンクのコレクションを表す クラス。
| 名前 | 型 | 説明 |
|---|---|---|
| links |
object |
リンクの読み取り専用ビュー。 参照リンクは読み取り専用であるため、参照リンクは読み取り専用として公開する必要があります。 |
SemanticVersion
major.minor.patch 形式の 成果物 http://semver.org/のバージョン管理。
| 名前 | 型 | 説明 |
|---|---|---|
| major |
integer |
互換性のない API 変更を行うときのメジャー バージョン |
| minor |
integer |
下位互換性のある方法で機能を追加する場合のマイナー バージョン |
| patch |
integer |
下位互換性のあるバグ修正を行うときのパッチ バージョン |
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 |
|
| isEnabled |
boolean |
|
| isNameConfigurable |
boolean |
|
| lightboxOptions |
ライトボックスの構成 |
|
| loadingImageUrl |
string |
|
| name |
string |
|
| position | ||
| settings |
string |
|
| settingsVersion |
major.minor.patch 形式の 成果物 http://semver.org/のバージョン管理。 |
|
| size | ||
| typeId |
string |
|
| url |
string |
WidgetPosition
| 名前 | 型 | 説明 |
|---|---|---|
| column |
integer |
|
| row |
integer |
WidgetSize
| 名前 | 型 | 説明 |
|---|---|---|
| columnSpan |
integer |
ダッシュボード グリッド列で表されるウィジェットの幅。 |
| rowSpan |
integer |
ダッシュボード グリッド行で表されるウィジェットの高さ。 |