Dashboards - Replace Dashboards

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

PUT https://dev.azure.com/{organization}/{project}/{team}/_apis/dashboard/dashboards?api-version=7.0-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.0-preview.3" festgelegt werden, um diese Version der API zu verwenden.

Anforderungstext

Name Typ Beschreibung
_links

ReferenceLinks

Die Klasse, die eine Auflistung von REST-Verweislinks darstellt.

dashboardEntries

DashboardGroupEntry[]

Eine Liste der Dashboards, die von der Dashboardgruppe verwaltet werden

permission

GroupMemberPermission

Veraltet: Das alte Berechtigungsmodell, das die Berechtigungsebene für das aktuelle Team beschreibt. Vor M125.

teamDashboardPermission

TeamDashboardPermission

Eine Berechtigungsbitmaske, 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 groupMemberPermission gespeichert.

url

string

Antworten

Name Typ Beschreibung
200 OK

DashboardGroup

Erfolgreicher Vorgang

Sicherheit

accessToken

Persönliches Zugriffstoken. Verwenden Sie einen beliebigen Wert für den Benutzernamen und das Token als Kennwort.

Type: basic

Beispiele

Sample Request

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

{
  "widgets": []
}

Sample Response

{
  "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 Dashboard Gruppen.

DashboardGroupEntry

Dashboardgruppeneintrag, um das Dashboard umschließen (erforderlich?)

DashboardScope

Dashboardbereich. Kann entweder Project oder Project_Team sein.

GroupMemberPermission

Veraltet: Das alte Berechtigungsmodell, das die Berechtigungsebene für das aktuelle Team beschreibt. Vor M125.

LightboxOptions

Lightbox-Konfiguration

ReferenceLinks

Die Klasse, die eine Auflistung von REST-Verweislinks darstellt.

SemanticVersion

Versionsverwaltung für ein Artefakt, wie unter beschrieben: http://semver.org/, der Form major.minor.patch.

TeamDashboardPermission

Eine Berechtigungsbitmaske, 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 groupMemberPermission gespeichert.

Widget

Widgetdaten

WidgetPosition
WidgetSize

Dashboard

Modell eines Dashboards.

Name Typ Beschreibung
_links

ReferenceLinks

Die Klasse, die eine Auflistung von REST-Verweislinks darstellt.

dashboardScope

DashboardScope

Entität, für die der Dashboard bereichsbezogener Ist.

description

string

Beschreibung des Dashboard.

eTag

string

Serverdefinierter Versionsnachverfolgungswert, der zum Bearbeiten der Kollisionserkennung verwendet wird.

groupId

string

ID der Gruppe für einen Dashboard. Bei Dashboards im Teambereich ist dies der eindeutige Bezeichner für das Team, das dem Dashboard zugeordnet ist. Für projektbezogene Dashboards ist diese Eigenschaft leer.

id

string

ID des Dashboards. Vom Dienst zur Erstellung bereitgestellt.

name

string

Name des Dashboards.

ownerId

string

ID des Besitzers für eine Dashboard. Bei Dashboards im Teambereich ist dies der eindeutige Bezeichner für das Team, das dem Dashboard zugeordnet ist. Für projektbezogene Dashboards ist dies der eindeutige Bezeichner für die Benutzeridentität, die dem Dashboard zugeordnet ist.

position

integer

Position des Dashboard innerhalb einer Dashboard Gruppe. Wenn die Einstellung zum Erstellungszeitpunkt nicht festgelegt wird, wird die Position vom Dienst festgelegt.

refreshInterval

integer

Intervall für den Client, um die Dashboard automatisch zu aktualisieren. Ausgedrückt in Minuten.

url

string

widgets

Widget[]

Der Satz von Widgets auf dem Dashboard.

DashboardGroup

Beschreibt eine Liste der Dashboards, die einem Besitzer zugeordnet sind. Derzeit besitzen Teams Dashboard Gruppen.

Name Typ Beschreibung
_links

ReferenceLinks

Die Klasse, die eine Auflistung von REST-Verweislinks darstellt.

dashboardEntries

DashboardGroupEntry[]

Eine Liste der Dashboards, die von der Dashboardgruppe verwaltet werden

permission

GroupMemberPermission

Veraltet: Das alte Berechtigungsmodell, das die Berechtigungsebene für das aktuelle Team beschreibt. Vor M125.

teamDashboardPermission

TeamDashboardPermission

Eine Berechtigungsbitmaske, 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 groupMemberPermission gespeichert.

url

string

DashboardGroupEntry

Dashboardgruppeneintrag, um das Dashboard umschließen (erforderlich?)

Name Typ Beschreibung
_links

ReferenceLinks

Die Klasse, die eine Auflistung von REST-Verweislinks darstellt.

dashboardScope

DashboardScope

Entität, für die der Dashboard bereichsbezogener Ist.

description

string

Beschreibung des Dashboard.

eTag

string

Serverdefinierter Versionsnachverfolgungswert, der zum Bearbeiten der Kollisionserkennung verwendet wird.

groupId

string

ID der Gruppe für einen Dashboard. Bei Dashboards im Teambereich ist dies der eindeutige Bezeichner für das Team, das dem Dashboard zugeordnet ist. Für projektbezogene Dashboards ist diese Eigenschaft leer.

id

string

ID des Dashboards. Vom Dienst zur Erstellung bereitgestellt.

name

string

Name des Dashboards.

ownerId

string

ID des Besitzers für eine Dashboard. Bei Dashboards im Teambereich ist dies der eindeutige Bezeichner für das Team, das dem Dashboard zugeordnet ist. Für projektbezogene Dashboards ist dies der eindeutige Bezeichner für die Benutzeridentität, die dem Dashboard zugeordnet ist.

position

integer

Position des Dashboard innerhalb einer Dashboard Gruppe. Wenn die Einstellung zum Erstellungszeitpunkt nicht festgelegt wird, wird die Position vom Dienst festgelegt.

refreshInterval

integer

Intervall für den Client, um die Dashboard automatisch zu aktualisieren. Ausgedrückt in Minuten.

url

string

widgets

Widget[]

Der Satz von Widgets auf dem Dashboard.

DashboardScope

Dashboardbereich. Kann entweder Project oder Project_Team sein.

Name Typ Beschreibung
collection_User

string

[VERALTET] Das Dashboard ist auf den Sammlungsbenutzer ausgerichtet.

project

string

Das Dashboard ist auf das Projekt ausgerichtet.

project_Team

string

Das Dashboard ist auf das Team ausgerichtet.

GroupMemberPermission

Veraltet: Das alte Berechtigungsmodell, das die Berechtigungsebene für das aktuelle Team beschreibt. Vor M125.

Name Typ Beschreibung
edit

string

manage

string

managePermissions

string

none

string

LightboxOptions

Lightbox-Konfiguration

Name Typ Beschreibung
height

integer

Höhe der gewünschten Lightbox in Pixel

resizable

boolean

True, um die Größe der Lightbox zuzulassen, false, um die Größe des Leuchtfelds nicht zuzulassen, standardmäßig auf false.

width

integer

Breite des gewünschten Lightboxfelds in Pixel

Die Klasse, die eine Auflistung von REST-Verweislinks darstellt.

Name Typ Beschreibung
links

object

Die schreibgeschützte Ansicht der Links. Da Verweislinks schreibgeschützt sind, möchten wir sie nur als schreibgeschützt verfügbar machen.

SemanticVersion

Versionsverwaltung für ein Artefakt, wie unter beschrieben: http://semver.org/, der Form major.minor.patch.

Name Typ Beschreibung
major

integer

Hauptversion, wenn Sie inkompatible API-Änderungen vornehmen

minor

integer

Nebenversion beim abwärtskompatiblen Hinzufügen von Funktionen

patch

integer

Patchversion bei abwärtskompatiblen Fehlerbehebungen

TeamDashboardPermission

Eine Berechtigungsbitmaske, 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 groupMemberPermission gespeichert.

Name Typ Beschreibung
create

string

delete

string

edit

string

managePermissions

string

none

string

read

string

Widget

Widgetdaten

Name Typ Beschreibung
_links

ReferenceLinks

Die Klasse, die eine Auflistung von REST-Verweislinks darstellt.

allowedSizes

WidgetSize[]

Bezieht sich auf die zulässigen Größen für das Widget. Diese wird aufgefüllt, wenn der Benutzer das Widget konfigurieren möchte.

areSettingsBlockedForUser

boolean

Read-Only Eigenschaft vom Dashboarddienst aus. Gibt an, ob Einstellungen für den aktuellen Benutzer blockiert sind.

artifactId

string

Bezieht sich auf den eindeutigen Bezeichner eines Featureartefakts. Wird zum Anheften und Aufheben 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

Optionale partielle Dashboard Inhalte, um den Austausch von ETag-Versionen auf Dashboard-Ebene gegen APIs auf Widgetebene zu unterstützen

eTag

string

id

string

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 beschrieben: http://semver.org/, der Form major.minor.patch.

size

WidgetSize

typeId

string

url

string

WidgetPosition

Name Typ Beschreibung
column

integer

row

integer

WidgetSize

Name Typ Beschreibung
columnSpan

integer

Die Breite des Widgets, ausgedrückt in Dashboard Rasterspalten.

rowSpan

integer

Die Höhe des Widgets, ausgedrückt in Dashboard Rasterzeilen.