Widgets - Get Widget

Service:

Dashboard

API Version:

7.1-preview.2

Ruft den aktuellen Zustand des angegebenen Widgets ab.

GET https://dev.azure.com/{organization}/{project}/{team}/_apis/dashboard/dashboards/{dashboardId}/widgets/{widgetId}?api-version=7.1-preview.2

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
dashboardId	path	True	string uuid	ID der Dashboard, die das Widget enthält.
organization	path	True	string	Der Name der Azure DevOps-Organisation.
project	path	True	string	Projekt-ID oder Projektname
widgetId	path	True	string uuid	ID des zu lesenden Widgets.
team	path		string	Team-ID oder Teamname
api-version	query	True	string	Version der zu verwendenden API. Dies sollte auf "7.1-preview.2" festgelegt werden, um diese Version der API zu verwenden.

Antworten

Name	Typ	Beschreibung
200 OK	Widget	Erfolgreicher Vorgang

Sicherheit

oauth2

Type: oauth2
Flow: accessCode
Authorization 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

Scopes

Name	Beschreibung
vso.dashboards	Ermöglicht das Lesen von Team-Dashboard Informationen

Beispiele

Sample Request

HTTP

GET https://dev.azure.com/fabrikam/{project}/_apis/dashboard/dashboards/e17c2ae9-c35c-4ddd-9d4b-6aa47aa4d01a/widgets/69f6c5b7-0eb0-4067-b75f-6edff74d0fcf?api-version=7.1-preview.2

Sample Response

Status code:

200

{
  "id": "69f6c5b7-0eb0-4067-b75f-6edff74d0fcf",
  "eTag": "5",
  "name": "Other Links",
  "position": {
    "row": 1,
    "column": 1
  },
  "size": {
    "rowSpan": 1,
    "columnSpan": 2
  },
  "settings": null,
  "settingsVersion": {
    "major": 1,
    "minor": 0,
    "patch": 0
  },
  "dashboard": {
    "eTag": "18"
  },
  "contributionId": "ms.vss-dashboards-web.Microsoft.VisualStudioOnline.Dashboards.OtherLinksWidget",
  "url": "https://dev.azure.com/fabrikam/6c9633e5-5633-4b1d-8081-02b35e39258e/8b69d2eb-2e18-4c75-a1ca-4c1820800e2e/_apis/Dashboard/Dashboards/e17c2ae9-c35c-4ddd-9d4b-6aa47aa4d01a/widgets/69f6c5b7-0eb0-4067-b75f-6edff74d0fcf",
  "_links": {
    "self": {
      "href": "https://dev.azure.com/fabrikam/6c9633e5-5633-4b1d-8081-02b35e39258e/8b69d2eb-2e18-4c75-a1ca-4c1820800e2e/_apis/Dashboard/Dashboards/e17c2ae9-c35c-4ddd-9d4b-6aa47aa4d01a/widgets/69f6c5b7-0eb0-4067-b75f-6edff74d0fcf"
    },
    "group": {
      "href": "https://dev.azure.com/fabrikam/6c9633e5-5633-4b1d-8081-02b35e39258e/8b69d2eb-2e18-4c75-a1ca-4c1820800e2e/_apis/Dashboard/Dashboards/e17c2ae9-c35c-4ddd-9d4b-6aa47aa4d01a/widgets"
    },
    "dashboard": {
      "href": "https://dev.azure.com/fabrikam/6c9633e5-5633-4b1d-8081-02b35e39258e/8b69d2eb-2e18-4c75-a1ca-4c1820800e2e/_apis/Dashboard/Dashboards/e17c2ae9-c35c-4ddd-9d4b-6aa47aa4d01a"
    }
  }
}

Definitionen

Name	Beschreibung
Dashboard	Modell eines Dashboards.
DashboardScope	Dashboardbereich. Kann entweder Project oder Project_Team sein.
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".
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, auf die der bereichsbezogene Dashboard.
description	string	Beschreibung des Dashboard.
eTag	string	Serverdefinierter Versionsnachverfolgungswert, der zum Bearbeiten der Kollisionserkennung verwendet wird.
groupId	string	ID der Gruppe für eine Dashboard. Bei Dashboards im Teambereich ist dies der eindeutige Bezeichner für das Team, das dem Dashboard zugeordnet ist. Bei Projektbereichsdashboards ist diese Eigenschaft leer.
id	string	ID des Dashboards. Wird zum Zeitpunkt der Erstellung vom Dienst bereitgestellt.
lastAccessedDate	string	Dashboarddatum des letzten Zugriffs.
modifiedBy	string	ID der Person, die das Dashboard geändert hat.
modifiedDate	string	Das Datum der letzten Änderung des Dashboards.
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. Bei Dashboards im Projektbereich 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 Zeitpunkt der Erstellung nicht festgelegt wird, wird die Position vom Dienst festgelegt.
refreshInterval	integer	Intervall, in dem der Client die Dashboard automatisch aktualisiert. Ausgedrückt in Minuten.
url	string
widgets	Widget[]	Der Satz von Widgets auf der 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.

LightboxOptions

Lightbox-Konfiguration

Name	Typ	Beschreibung
height	integer	Höhe des gewünschten Lightboxfelds in Pixel
resizable	boolean	True, um die Größe von Lightboxen zu ändern, false, um die Größe des Lightboxs nicht zuzulassen, standardwertlich auf false.
width	integer	Breite des gewünschten Lightboxfelds in Pixel

ReferenceLinks

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

Name	Typ	Beschreibung
links	object	Die schreibgeschützte Ansicht der Links. Da Verweislinks schreibgeschützter Sind, möchten wir sie nur als schreibgeschützter Link 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, wenn Sie Funktionen abwärtskompatibel hinzufügen
patch	integer	Patchversion bei abwärtskompatiblen Fehlerbehebungen

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 des Dashboarddiensts. 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 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 Teilinhalt Dashboard, um den Austausch Dashboard Version ETag 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.