Dashboards - Replace Dashboards

Referenz

Dienst:: Dashboard

API-Version:: 7.1-preview.3

Aktualisieren Sie den Namen und die Position von Dashboards in der angegebenen Gruppe, und entfernen Sie ausgelassene Dashboards. Ändert den Dashboardinhalt nicht.

PUT https://dev.azure.com/{organization}/{project}/{team}/_apis/dashboard/dashboards?api-version=7.1-preview.3

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
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	ReferenceLinks	Die Klasse, die eine Auflistung von REST-Referenzverknüpfungslinks darstellt.
dashboardEntries	DashboardGroupEntry[]	Eine Liste der Dashboards, die von der Dashboardgruppe gehalten werden
permission	GroupMemberPermission	Veraltet: Das alte Berechtigungsmodell, das die Berechtigungsstufe für das aktuelle Team beschreibt. Pre-M125.
teamDashboardPermission	TeamDashboardPermission	Eine Bitmaske für Berechtigungen, die die Sicherheitsberechtigungen des aktuellen Teams für Dashboards beschreibt. Wenn diese Berechtigung der Wert "None" ist, verwenden Sie "GroupMemberPermission". Berechtigungen werden basierend auf dem Vorhandensein eines anderen Werts als "None" ausgewertet, andernfalls wird die GroupMemberPermission gespeichert.
url	string

Antworten

Name	Typ	Beschreibung
200 OK	DashboardGroup	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

Beispiele

Beispielanforderung

HTTP

PUT https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/dashboard/dashboards?api-version=7.1-preview.3

{
  "widgets": []
}

Beispiel für eine Antwort

Statuscode:: 200

{
  "widgets": [],
  "url": "https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/Dashboard/groups/999EF3B4-93E1-4086-86C2-5E8BD24512C7/Dashboards/7562562a-4f9f-4258-94a9-b048b1c817cf",
  "_links": {
    "self": {
      "href": "https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/Dashboard/groups/999EF3B4-93E1-4086-86C2-5E8BD24512C7/Dashboards/7562562a-4f9f-4258-94a9-b048b1c817cf"
    },
    "group": {
      "href": "https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/Dashboard/Groups/999ef3b4-93e1-4086-86c2-5e8bd24512c7"
    }
  },
  "id": "7562562a-4f9f-4258-94a9-b048b1c817cf",
  "name": "Dashboard98",
  "position": 2,
  "refreshInterval": 5
}

Definitionen

Name	Beschreibung
Dashboard	Modell eines Dashboards.
DashboardGroup	Beschreibt eine Liste der Dashboards, die einem Besitzer zugeordnet sind. Derzeit besitzen Teams eigene Dashboardgruppen.
DashboardGroupEntry	Dashboardgruppeneintrag, Umbruch im Dashboard (erforderlich?)
DashboardScope	Dashboardbereich. Kann entweder Project oder Project_Team sein
GroupMemberPermission	Veraltet: Das alte Berechtigungsmodell, das die Berechtigungsstufe für das aktuelle Team beschreibt. Pre-M125.
LightboxOptions	Lightbox-Konfiguration
ReferenceLinks	Die Klasse, die eine Auflistung von REST-Referenzverknüpfungslinks darstellt.
SemanticVersion	Versionsverwaltung für ein Artefakt wie unter: http://semver.org/, des Formulars "major.minor.patch".
TeamDashboardPermission	Eine Bitmaske für Berechtigungen, die die Sicherheitsberechtigungen des aktuellen Teams für Dashboards beschreibt. Wenn diese Berechtigung der Wert "None" ist, verwenden Sie "GroupMemberPermission". Berechtigungen werden basierend auf dem Vorhandensein eines anderen Werts als "None" ausgewertet, andernfalls wird die GroupMemberPermission gespeichert.
Widget	Widgetdaten
WidgetPosition
WidgetSize

Dashboard

Objekt

Modell eines Dashboards.

Name	Typ	Beschreibung
_links	ReferenceLinks	Die Klasse, die eine Auflistung von REST-Referenzverknüpfungslinks darstellt.
dashboardScope	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.

DashboardGroup

Objekt

Beschreibt eine Liste der Dashboards, die einem Besitzer zugeordnet sind. Derzeit besitzen Teams eigene Dashboardgruppen.

Name	Typ	Beschreibung
_links	ReferenceLinks	Die Klasse, die eine Auflistung von REST-Referenzverknüpfungslinks darstellt.
dashboardEntries	DashboardGroupEntry[]	Eine Liste der Dashboards, die von der Dashboardgruppe gehalten werden
permission	GroupMemberPermission	Veraltet: Das alte Berechtigungsmodell, das die Berechtigungsstufe für das aktuelle Team beschreibt. Pre-M125.
teamDashboardPermission	TeamDashboardPermission	Eine Bitmaske für Berechtigungen, die die Sicherheitsberechtigungen des aktuellen Teams für Dashboards beschreibt. Wenn diese Berechtigung der Wert "None" ist, verwenden Sie "GroupMemberPermission". Berechtigungen werden basierend auf dem Vorhandensein eines anderen Werts als "None" ausgewertet, andernfalls wird die GroupMemberPermission gespeichert.
url	string

DashboardGroupEntry

Objekt

Dashboardgruppeneintrag, Umbruch im Dashboard (erforderlich?)

Name	Typ	Beschreibung
_links	ReferenceLinks	Die Klasse, die eine Auflistung von REST-Referenzverknüpfungslinks darstellt.
dashboardScope	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

Enumeration

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.

GroupMemberPermission

Enumeration

Veraltet: Das alte Berechtigungsmodell, das die Berechtigungsstufe für das aktuelle Team beschreibt. Pre-M125.

Wert	Beschreibung
edit
manage
managePermissions
none

LightboxOptions

Objekt

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

Objekt

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

Objekt

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

TeamDashboardPermission

Enumeration

Eine Bitmaske für Berechtigungen, die die Sicherheitsberechtigungen des aktuellen Teams für Dashboards beschreibt. Wenn diese Berechtigung der Wert "None" ist, verwenden Sie "GroupMemberPermission". Berechtigungen werden basierend auf dem Vorhandensein eines anderen Werts als "None" ausgewertet, andernfalls wird die GroupMemberPermission gespeichert.

Wert	Beschreibung
create
delete
edit
managePermissions
none
read

Objekt

Widgetdaten

Name	Typ	Beschreibung
_links	ReferenceLinks	Die Klasse, die eine Auflistung von REST-Referenzverknüpfungslinks darstellt.
allowedSizes	WidgetSize[]	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	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	LightboxOptions	Lightbox-Konfiguration
loadingImageUrl	string
name	string
position	WidgetPosition
settings	string
settingsVersion	SemanticVersion	Versionsverwaltung für ein Artefakt wie unter: http://semver.org/, des Formulars "major.minor.patch".
size	WidgetSize
typeId	string
url	string

WidgetPosition

Objekt

Name	Typ	Beschreibung
column	integer (int32)
row	integer (int32)

WidgetSize

Objekt

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.

Freigeben über

Dashboards - Replace Dashboards

URI-Parameter

Anforderungstext

Antworten

Sicherheit

oauth2

Bereiche

Beispiele

Beispielanforderung

Beispiel für eine Antwort

Definitionen

Dashboard

DashboardGroup

DashboardGroupEntry

DashboardScope

GroupMemberPermission

LightboxOptions

ReferenceLinks

SemanticVersion

TeamDashboardPermission

Widget

WidgetPosition

WidgetSize