Dashboards - Replace Dashboard
Remplacez la configuration du tableau de bord spécifié. Remplace la liste des widgets sur le tableau de bord, uniquement si la propriété est fournie.
PUT https://dev.azure.com/{organization}/{project}/{team}/_apis/dashboard/dashboards/{dashboardId}?api-version=7.1-preview.3Paramètres URI
| Nom | Dans | Obligatoire | Type | Description |
|---|---|---|---|---|
|
dashboard
|
path | True |
string (uuid) |
ID du tableau de bord à remplacer. |
|
organization
|
path | True |
string |
Nom de l’organisation Azure DevOps. |
|
project
|
path | True |
string |
ID de projet ou nom du projet |
|
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.3 » pour utiliser cette version de l’API. |
Corps de la demande
| Nom | Type | Description |
|---|---|---|
| _links |
Classe à représenter une collection de liens de référence REST. |
|
| dashboardScope |
Entité à laquelle le tableau de bord est délimité. |
|
| 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 (uuid) |
ID du groupe pour un tableau de bord. Pour les tableaux de bord étendus à 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 par le projet, cette propriété est vide. |
| id |
string (uuid) |
ID du tableau de bord. Fourni par le service au moment de la création. |
| lastAccessedDate |
string (date-time) |
Date du dernier accès au tableau de bord. |
| modifiedBy |
string (uuid) |
ID de la personne qui a modifié le tableau de bord. |
| modifiedDate |
string (date-time) |
Date de dernière modification du tableau de bord. |
| name |
string |
Nom du tableau de bord. |
| ownerId |
string (uuid) |
ID du propriétaire d’un tableau de bord. Pour les tableaux de bord étendus à l’équipe, il s’agit de l’identificateur unique de l’équipe associée au tableau de bord. Pour les tableaux de bord au niveau du projet, il s’agit de l’identificateur unique de l’identité utilisateur associée au tableau de bord. |
| position |
integer (int32) |
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éfinie par le service. |
| refreshInterval |
integer (int32) |
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. |
Réponses
| Nom | Type | Description |
|---|---|---|
| 200 OK |
opération réussie |
Sécurité
oauth2
Type:
oauth2
Flux:
accessCode
URL d’autorisation:
https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL du jeton:
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
Étendues
| Nom | Description |
|---|---|
| vso.dashboards_manage | Accorde la possibilité de gérer les informations du tableau de bord d’équipe |
Définitions
| Nom | Description |
|---|---|
| Dashboard |
Modèle d’un tableau de bord. |
|
Dashboard |
Étendue du tableau de bord. Peut être Project ou Project_Team |
|
Lightbox |
Configuration de Lightbox |
|
Reference |
Classe à représenter une collection de liens de référence REST. |
|
Semantic |
contrôle de version d’un artefact comme décrit à : http://semver.org/, de la forme major.minor.patch. |
| Widget |
Données de widget |
|
Widget |
|
|
Widget |
Dashboard
Modèle d’un tableau de bord.
| Nom | Type | Description |
|---|---|---|
| _links |
Classe à représenter une collection de liens de référence REST. |
|
| dashboardScope |
Entité à laquelle le tableau de bord est délimité. |
|
| 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 (uuid) |
ID du groupe pour un tableau de bord. Pour les tableaux de bord étendus à 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 par le projet, cette propriété est vide. |
| id |
string (uuid) |
ID du tableau de bord. Fourni par le service au moment de la création. |
| lastAccessedDate |
string (date-time) |
Date du dernier accès au tableau de bord. |
| modifiedBy |
string (uuid) |
ID de la personne qui a modifié le tableau de bord. |
| modifiedDate |
string (date-time) |
Date de dernière modification du tableau de bord. |
| name |
string |
Nom du tableau de bord. |
| ownerId |
string (uuid) |
ID du propriétaire d’un tableau de bord. Pour les tableaux de bord étendus à l’équipe, il s’agit de l’identificateur unique de l’équipe associée au tableau de bord. Pour les tableaux de bord au niveau du projet, il s’agit de l’identificateur unique de l’identité utilisateur associée au tableau de bord. |
| position |
integer (int32) |
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éfinie par le service. |
| refreshInterval |
integer (int32) |
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
| Valeur | Description |
|---|---|
| collection_User |
[DÉCONSEILLÉ] Le tableau de bord est limité à l’utilisateur de collection. |
| project |
Le tableau de bord est limité au projet. |
| project_Team |
Le tableau de bord est étendu à l’équipe. |
LightboxOptions
Configuration de Lightbox
| Nom | Type | Description |
|---|---|---|
| height |
integer (int32) |
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, la valeur par défaut est false. |
| width |
integer (int32) |
Largeur de la zone de lumière souhaitée, en pixels |
ReferenceLinks
Classe à 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 de 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 à : http://semver.org/, de la forme major.minor.patch.
| Nom | Type | Description |
|---|---|---|
| major |
integer (int32) |
Version majeure lorsque vous apportez des modifications d’API incompatibles |
| minor |
integer (int32) |
Version mineure lorsque vous ajoutez des fonctionnalités de manière rétrocompatible |
| patch |
integer (int32) |
Version de correctif lorsque vous effectuez des correctifs de bogues compatibles avec les versions descendantes |
Widget
Données de widget
| Nom | Type | Description |
|---|---|---|
| _links |
Classe à représenter une collection de liens de référence REST. |
|
| allowedSizes |
Fait référence aux tailles autorisées pour le widget. Cette opération est remplie lorsque l’utilisateur souhaite configurer le widget |
|
| areSettingsBlockedForUser |
boolean |
Read-Only Propriété à partir du service De tableau de bord. Indique si les paramètres sont bloqués pour l’utilisateur actuel. |
| artifactId |
string |
Fait référence à un identificateur unique d’un artefact de fonctionnalité. Utilisé pour épingler+dissocier un artefact spécifique. |
| configurationContributionId |
string |
|
| configurationContributionRelativeId |
string |
|
| contentUri |
string |
|
| contributionId |
string |
ID de la contribution sous-jacente définissant la configuration du widget fournie. |
| dashboard |
Contenu de tableau de bord partiel facultatif, pour prendre en charge l’échange d’ETag de version au niveau du tableau de bord pour les API au niveau du widget |
|
| eTag |
string |
|
| id |
string (uuid) |
|
| isEnabled |
boolean |
|
| isNameConfigurable |
boolean |
|
| lightboxOptions |
Configuration de Lightbox |
|
| loadingImageUrl |
string |
|
| name |
string |
|
| position | ||
| settings |
string |
|
| settingsVersion |
contrôle de version d’un artefact comme décrit à : http://semver.org/, de la forme major.minor.patch. |
|
| size | ||
| typeId |
string |
|
| url |
string |
WidgetPosition
| Nom | Type | Description |
|---|---|---|
| column |
integer (int32) |
|
| row |
integer (int32) |
WidgetSize
| Nom | Type | Description |
|---|---|---|
| columnSpan |
integer (int32) |
Largeur du widget, exprimée dans les colonnes de grille de tableau de bord. |
| rowSpan |
integer (int32) |
Hauteur du widget, exprimée dans les lignes de la grille de tableau de bord. |