Dashboards - List
Rufen Sie eine Liste der Dashboards unter einem Projekt ab.
GET 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. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
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
GET https://dev.azure.com/fabrikam/{project}/_apis/dashboard/dashboards?api-version=7.1-preview.3
Sample Response
{
"count": 2,
"value": [
{
"id": "29653dd2-c18a-4d19-8333-e556c5b8d025",
"name": "Overview",
"refreshInterval": 0,
"position": 1,
"groupId": "091a34b6-9a63-40fd-acae-7716353dde05",
"ownerId": "091a34b6-9a63-40fd-acae-7716353dde05",
"dashboardScope": "project_Team",
"url": "https://dev.azure.com/fabrikam/99755c45-cb33-4ab4-9f36-e5920cec7ba9/_apis/Dashboard/Dashboards/29653dd2-c18a-4d19-8333-e556c5b8d025",
"_links": {
"self": {
"href": "https://dev.azure.com/fabrikam/99755c45-cb33-4ab4-9f36-e5920cec7ba9/_apis/Dashboard/Dashboards/29653dd2-c18a-4d19-8333-e556c5b8d025"
},
"group": {
"href": "https://dev.azure.com/fabrikam/99755c45-cb33-4ab4-9f36-e5920cec7ba9/_apis/Dashboard/Dashboards"
}
}
},
{
"id": "48ab8210-0463-48b7-aa0f-75d74fdfee95",
"name": "p2",
"refreshInterval": 0,
"position": 2,
"eTag": "1",
"ownerId": "99c3b95a-7504-4652-8609-59af5637d920",
"dashboardScope": "project",
"url": "https://dev.azure.com/fabrikam/99755c45-cb33-4ab4-9f36-e5920cec7ba9/_apis/Dashboard/Dashboards/ad633947-f99b-4813-bfc6-b67b7e687b0e",
"_links": {
"self": {
"href": "https://dev.azure.com/fabrikam/99755c45-cb33-4ab4-9f36-e5920cec7ba9/_apis/Dashboard/Dashboards/ad633947-f99b-4813-bfc6-b67b7e687b0e"
},
"group": {
"href": "https://dev.azure.com/fabrikam/99755c45-cb33-4ab4-9f36-e5920cec7ba9/_apis/Dashboard/Dashboards"
}
}
}
]
}
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-Verweislinks darstellt. |
Semantic |
Versionsverwaltung für ein Artefakt, wie unter beschrieben: http://semver.org/, der Form major.minor.patch. |
Widget |
Widgetdaten |
Widget |
|
Widget |
Dashboard
Modell eines Dashboards.
Name | Typ | Beschreibung |
---|---|---|
_links |
Die Klasse, die eine Auflistung von REST-Verweislinks darstellt. |
|
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. |
lastAccessedDate |
string |
Datum des letzten Zugriffs im Dashboard. |
modifiedBy |
string |
Id der Person, die das Dashboard geändert hat. |
modifiedDate |
string |
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. 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. |
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 |
ReferenceLinks
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 |
Widget
Widgetdaten
Name | Typ | Beschreibung |
---|---|---|
_links |
Die Klasse, die eine Auflistung von REST-Verweislinks darstellt. |
|
allowedSizes |
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 |
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 |
Lightbox-Konfiguration |
|
loadingImageUrl |
string |
|
name |
string |
|
position | ||
settings |
string |
|
settingsVersion |
Versionsverwaltung für ein Artefakt, wie unter beschrieben: http://semver.org/, der Form major.minor.patch. |
|
size | ||
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. |
Feedback
https://aka.ms/ContentUserFeedback.
Bald verfügbar: Im Laufe des Jahres 2024 werden wir GitHub-Issues stufenweise als Feedbackmechanismus für Inhalte abbauen und durch ein neues Feedbacksystem ersetzen. Weitere Informationen finden Sie unterFeedback senden und anzeigen für