Dashboards - Replace Dashboard
Ersetzen Sie die Konfiguration für das angegebene Dashboard. Ersetzt die Widget-Liste im Dashboard nur, wenn die Eigenschaft angegeben wird.
PUT https://dev.azure.com/{organization}/{project}/{team}/_apis/dashboard/dashboards/{dashboardId}?api-version=7.1-preview.3URI-Parameter
| Name | In | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
dashboard
|
path | True |
string (uuid) |
ID des zu ersetzenden Dashboards. |
|
organization
|
path | True |
string |
Der Name der Azure DevOps-Organisation. |
|
project
|
path | True |
string |
Projekt-ID oder Projektname |
|
team
|
path |
string |
Team-ID oder Teamname |
|
|
api-version
|
query | True |
string |
Version der zu verwendenden API. Dies sollte auf "7.1-preview.3" festgelegt werden, um diese Version der API zu verwenden. |
Anforderungstext
| Name | Typ | Beschreibung |
|---|---|---|
| _links |
Die Klasse, die eine Auflistung von REST-Referenzverknüpfungslinks darstellt. |
|
| dashboardScope |
Entität, auf die das Dashboard abzielt. |
|
| description |
string |
Beschreibung des Dashboards. |
| eTag |
string |
Serverdefinierter Versionsverfolgungswert, der zum Bearbeiten der Kollisionserkennung verwendet wird. |
| groupId |
string (uuid) |
ID der Gruppe für ein Dashboard. Bei Dashboards mit Teambereich ist dies der eindeutige Bezeichner für das Team, das dem Dashboard zugeordnet ist. Bei projektbezogenen Dashboards ist diese Eigenschaft leer. |
| id |
string (uuid) |
ID des Dashboards. Zur Erstellungszeit vom Dienst bereitgestellt. |
| lastAccessedDate |
string (date-time) |
Datum des letzten Zugriffs auf das Dashboard. |
| modifiedBy |
string (uuid) |
ID der Person, die das Dashboard geändert hat. |
| modifiedDate |
string (date-time) |
Das Datum der letzten Änderung des Dashboards. |
| name |
string |
Name des Dashboards. |
| ownerId |
string (uuid) |
ID des Besitzers für ein Dashboard. Bei Dashboards mit Teambereich ist dies der eindeutige Bezeichner für das Team, das dem Dashboard zugeordnet ist. Bei projektbezogenen Dashboards ist dies der eindeutige Bezeichner für die Benutzeridentität, die dem Dashboard zugeordnet ist. |
| position |
integer (int32) |
Position des Dashboards innerhalb einer Dashboardgruppe. Wenn die Position zur Erstellungszeit nicht festgelegt wird, wird die Position vom Dienst entschieden. |
| refreshInterval |
integer (int32) |
Intervall für den Client, um das Dashboard automatisch zu aktualisieren. Ausgedrückt in Minuten. |
| url |
string |
|
| widgets |
Widget[] |
Die Gruppe von Widgets im Dashboard. |
Antworten
| Name | Typ | Beschreibung |
|---|---|---|
| 200 OK |
Erfolgreicher Vorgang |
Sicherheit
oauth2
Typ:
oauth2
Ablauf:
accessCode
Autorisierungs-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
Bereiche
| Name | Beschreibung |
|---|---|
| vso.dashboards_manage | Gewährt die Möglichkeit, Team-Dashboardinformationen zu verwalten |
Definitionen
| Name | Beschreibung |
|---|---|
| Dashboard |
Modell eines Dashboards. |
|
Dashboard |
Dashboardbereich. Kann entweder Project oder Project_Team sein |
|
Lightbox |
Lightbox-Konfiguration |
|
Reference |
Die Klasse, die eine Auflistung von REST-Referenzverknüpfungslinks darstellt. |
|
Semantic |
Versionsverwaltung für ein Artefakt wie unter: http://semver.org/, des Formulars "major.minor.patch". |
| Widget |
Widgetdaten |
|
Widget |
|
|
Widget |
Dashboard
Modell eines Dashboards.
| Name | Typ | Beschreibung |
|---|---|---|
| _links |
Die Klasse, die eine Auflistung von REST-Referenzverknüpfungslinks darstellt. |
|
| dashboardScope |
Entität, auf die das Dashboard abzielt. |
|
| description |
string |
Beschreibung des Dashboards. |
| eTag |
string |
Serverdefinierter Versionsverfolgungswert, der zum Bearbeiten der Kollisionserkennung verwendet wird. |
| groupId |
string (uuid) |
ID der Gruppe für ein Dashboard. Bei Dashboards mit Teambereich ist dies der eindeutige Bezeichner für das Team, das dem Dashboard zugeordnet ist. Bei projektbezogenen Dashboards ist diese Eigenschaft leer. |
| id |
string (uuid) |
ID des Dashboards. Zur Erstellungszeit vom Dienst bereitgestellt. |
| lastAccessedDate |
string (date-time) |
Datum des letzten Zugriffs auf das Dashboard. |
| modifiedBy |
string (uuid) |
ID der Person, die das Dashboard geändert hat. |
| modifiedDate |
string (date-time) |
Das Datum der letzten Änderung des Dashboards. |
| name |
string |
Name des Dashboards. |
| ownerId |
string (uuid) |
ID des Besitzers für ein Dashboard. Bei Dashboards mit Teambereich ist dies der eindeutige Bezeichner für das Team, das dem Dashboard zugeordnet ist. Bei projektbezogenen Dashboards ist dies der eindeutige Bezeichner für die Benutzeridentität, die dem Dashboard zugeordnet ist. |
| position |
integer (int32) |
Position des Dashboards innerhalb einer Dashboardgruppe. Wenn die Position zur Erstellungszeit nicht festgelegt wird, wird die Position vom Dienst entschieden. |
| refreshInterval |
integer (int32) |
Intervall für den Client, um das Dashboard automatisch zu aktualisieren. Ausgedrückt in Minuten. |
| url |
string |
|
| widgets |
Widget[] |
Die Gruppe von Widgets im Dashboard. |
DashboardScope
Dashboardbereich. Kann entweder Project oder Project_Team sein
| Wert | Beschreibung |
|---|---|
| collection_User |
[VERALTET] Das Dashboard ist auf den Sammlungsbenutzer eingegrenzt. |
| project |
Das Dashboard ist auf das Projekt eingegrenzt. |
| project_Team |
Das Dashboard ist auf das Team eingegrenzt. |
LightboxOptions
Lightbox-Konfiguration
| Name | Typ | Beschreibung |
|---|---|---|
| height |
integer (int32) |
Höhe des gewünschten Lightbox-Steuerelements in Pixel |
| resizable |
boolean |
True, um die Größe des Lightbox-Steuerelements zuzulassen, false, um die Größe des Lightbox-Steuerelements zu verbieten, standardmäßig auf "false". |
| width |
integer (int32) |
Breite des gewünschten Lightboxfelds in Pixel |
ReferenceLinks
Die Klasse, die eine Auflistung von REST-Referenzverknüpfungslinks darstellt.
| Name | Typ | Beschreibung |
|---|---|---|
| links |
object |
Die schreibgeschützte Ansicht der Links. Da Referenzlinks schreibgeschützt sind, möchten wir sie nur als schreibgeschützt verfügbar machen. |
SemanticVersion
Versionsverwaltung für ein Artefakt wie unter: http://semver.org/, des Formulars "major.minor.patch".
| Name | Typ | Beschreibung |
|---|---|---|
| major |
integer (int32) |
Hauptversion, wenn Sie inkompatible API-Änderungen vornehmen |
| minor |
integer (int32) |
Nebenversion, wenn Sie Funktionen abwärtskompatibel hinzufügen |
| patch |
integer (int32) |
Patchversion, wenn Sie abwärtskompatible Fehlerkorrekturen vornehmen |
Widget
Widgetdaten
| Name | Typ | Beschreibung |
|---|---|---|
| _links |
Die Klasse, die eine Auflistung von REST-Referenzverknüpfungslinks darstellt. |
|
| allowedSizes |
Bezieht sich auf die zulässigen Größen für das Widget. Dies wird aufgefüllt, wenn der Benutzer das Widget konfigurieren möchte |
|
| areSettingsBlockedForUser |
boolean |
Read-Only Eigenschaft vom Dashboarddienst. Gibt an, ob Einstellungen für den aktuellen Benutzer blockiert werden. |
| artifactId |
string |
Bezieht sich auf einen eindeutigen Bezeichner eines Featureartefaktes. Wird zum Anheften und Lösen eines bestimmten Artefakts verwendet. |
| configurationContributionId |
string |
|
| configurationContributionRelativeId |
string |
|
| contentUri |
string |
|
| contributionId |
string |
Die ID des zugrunde liegenden Beitrags, der die angegebene Widgetkonfiguration definiert. |
| dashboard |
Optionaler Teildashboardinhalt zur Unterstützung des Austauschs von Version ETag auf Dashboardebene für APIs auf Widgetebene |
|
| eTag |
string |
|
| id |
string (uuid) |
|
| isEnabled |
boolean |
|
| isNameConfigurable |
boolean |
|
| lightboxOptions |
Lightbox-Konfiguration |
|
| loadingImageUrl |
string |
|
| name |
string |
|
| position | ||
| settings |
string |
|
| settingsVersion |
Versionsverwaltung für ein Artefakt wie unter: http://semver.org/, des Formulars "major.minor.patch". |
|
| size | ||
| typeId |
string |
|
| url |
string |
WidgetPosition
| Name | Typ | Beschreibung |
|---|---|---|
| column |
integer (int32) |
|
| row |
integer (int32) |
WidgetSize
| Name | Typ | Beschreibung |
|---|---|---|
| columnSpan |
integer (int32) |
Die Breite des Widgets, ausgedrückt in Dashboardrasterspalten. |
| rowSpan |
integer (int32) |
Die Höhe des Widgets, ausgedrückt in Dashboardrasterzeilen. |