Widgets - Get Widget

Référence

Service:: Dashboard

API Version:: 7.1-preview.2

Obtenez l’état actuel du widget spécifié.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
dashboardId	path	True	string uuid	ID du tableau de bord contenant le widget.
organization	path	True	string	Nom de l’organisation Azure DevOps.
project	path	True	string	ID de projet ou nom du projet
widgetId	path	True	string uuid	ID du widget à lire.
team	path		string	ID d’équipe ou nom de l’équipe
api-version	query	True	string	Version de l’API à utiliser. Cette valeur doit être définie sur « 7.1-preview.2 » pour utiliser cette version de l’API.

Réponses

Nom	Type	Description
200 OK	Widget	opération réussie

Sécurité

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

Nom	Description
vso.dashboards	Accorde la possibilité de lire les informations du tableau de bord d’équipe

Exemples

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"
    }
  }
}

Définitions

Nom	Description
Dashboard	Modèle d’un tableau de bord.
DashboardScope	Étendue du tableau de bord. Peut être Project ou Project_Team
LightboxOptions	Configuration de Lightbox
ReferenceLinks	Classe pour représenter une collection de liens de référence REST.
SemanticVersion	Contrôle de version d’un artefact, comme décrit à l’adresse : http://semver.org/, au format major.minor.patch.
Widget	Données de widget
WidgetPosition
WidgetSize

Dashboard

Modèle d’un tableau de bord.

Nom	Type	Description
_links	ReferenceLinks	Classe pour représenter une collection de liens de référence REST.
dashboardScope	DashboardScope	Entité à laquelle le tableau de bord est étendu.
description	string	Description du tableau de bord.
eTag	string	Valeur de suivi de version définie par le serveur, utilisée pour la détection des collisions de modification.
groupId	string	ID du groupe pour un tableau de bord. Pour les tableaux de bord à l’échelle de l’équipe, il s’agit de l’identificateur unique de l’équipe associée au tableau de bord. Pour les tableaux de bord délimités au projet, cette propriété est vide.
id	string	ID du tableau de bord. Fourni par le service au moment de la création.
lastAccessedDate	string	Date du dernier accès au tableau de bord.
modifiedBy	string	ID de la personne qui a modifié le tableau de bord.
modifiedDate	string	Date de la dernière modification du tableau de bord.
name	string	Nom du tableau de bord.
ownerId	string	ID du propriétaire d’un tableau de bord. Pour les tableaux de bord à l’échelle de l’équipe, il s’agit de l’identificateur unique de l’équipe associée au tableau de bord. Pour les tableaux de bord délimités au projet, il s’agit de l’identificateur unique de l’identité utilisateur associée au tableau de bord.
position	integer	Position du tableau de bord, dans un groupe de tableaux de bord. S’il n’est pas défini au moment de la création, la position est déterminée par le service.
refreshInterval	integer	Intervalle pour que le client actualise automatiquement le tableau de bord. Exprimée en minutes.
url	string
widgets	Widget[]	Ensemble de widgets sur le tableau de bord.

DashboardScope

Étendue du tableau de bord. Peut être Project ou Project_Team

Nom	Type	Description
collection_User	string	[DÉCONSEILLÉ] Le tableau de bord est limité à l’utilisateur de la collection.
project	string	Le tableau de bord est limité au projet.
project_Team	string	Le tableau de bord est limité à l’équipe.

LightboxOptions

Configuration de Lightbox

Nom	Type	Description
height	integer	Hauteur de la zone de lumière souhaitée, en pixels
resizable	boolean	True pour autoriser le redimensionnement de lightbox, false pour interdire le redimensionnement de lightbox, valeur par défaut false.
width	integer	Largeur de la zone de lumière souhaitée, en pixels

ReferenceLinks

Classe pour représenter une collection de liens de référence REST.

Nom	Type	Description
links	object	Vue en lecture seule des liens. Étant donné que les liens référence sont en lecture seule, nous voulons uniquement les exposer en lecture seule.

SemanticVersion

Contrôle de version d’un artefact, comme décrit à l’adresse : http://semver.org/, au format major.minor.patch.

Nom	Type	Description
major	integer	Version majeure lorsque vous apportez des modifications incompatibles à l’API
minor	integer	Version mineure lorsque vous ajoutez des fonctionnalités de manière à compatibilité descendante
patch	integer	Corriger la version lorsque vous apportez des correctifs de bogues à compatibilité descendante

Données de widget

Nom	Type	Description
_links	ReferenceLinks	Classe pour représenter une collection de liens de référence REST.
allowedSizes	WidgetSize[]	Fait référence aux tailles autorisées pour le widget. Cette option est renseignée lorsque l’utilisateur souhaite configurer le widget
areSettingsBlockedForUser	boolean	Read-Only Property from Dashboard Service. Indique si les paramètres sont bloqués pour l’utilisateur actuel.
artifactId	string	Fait référence à l’identificateur unique d’un artefact de fonctionnalité. Utilisé pour l’épinglage et le désépinglage d’un artefact spécifique.
configurationContributionId	string
configurationContributionRelativeId	string
contentUri	string
contributionId	string	ID de la contribution sous-jacente définissant la configuration du widget fourni.
dashboard	Dashboard	Contenu de tableau de bord partiel facultatif, pour prendre en charge l’échange de version au niveau du tableau de bord ETag pour les API au niveau du widget
eTag	string
id	string
isEnabled	boolean
isNameConfigurable	boolean
lightboxOptions	LightboxOptions	Configuration de Lightbox
loadingImageUrl	string
name	string
position	WidgetPosition
settings	string
settingsVersion	SemanticVersion	Contrôle de version d’un artefact, comme décrit à l’adresse : http://semver.org/, au format major.minor.patch.
size	WidgetSize
typeId	string
url	string

WidgetPosition

Nom	Type	Description
column	integer
row	integer

WidgetSize

Nom	Type	Description
columnSpan	integer	Largeur du widget, exprimée dans les colonnes de grille du tableau de bord.
rowSpan	integer	Hauteur du widget, exprimée en lignes de grille de tableau de bord.

Partager via