Lire en anglais

Partager via


Dashboards - Replace Dashboard

Remplacez la configuration du tableau de bord spécifié. Remplace la liste de widgets dans 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.3

Paramètres URI

Nom Dans Obligatoire Type Description
dashboardId
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

ReferenceLinks

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

dashboardScope

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 de collision de modification.

groupId

string

ID du groupe pour un tableau de bord. Pour les tableaux de bord à portée d’équipe, il s’agit de l’identificateur unique de l’équipe associée au tableau de bord. Pour les tableaux de bord dans l’étendue du 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 de la dernière consultation du tableau de bord.

modifiedBy

string

ID de la personne qui a modifié le tableau de bord.

modifiedDate

string

Date de 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 à portée d’équipe, il s’agit de l’identificateur unique de l’équipe associée au tableau de bord. Pour les tableaux de bord dans l’étendue du 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é en minutes.

url

string

widgets

Widget[]

Ensemble de widgets sur le tableau de bord.

Réponses

Nom Type Description
200 OK

Dashboard

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_manage Octroie 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.

DashboardScope

Étendue du tableau de bord. Il peut s’agir d’un projet ou d’un 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/, sous la forme 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 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 de collision de modification.

groupId

string

ID du groupe pour un tableau de bord. Pour les tableaux de bord à portée d’équipe, il s’agit de l’identificateur unique de l’équipe associée au tableau de bord. Pour les tableaux de bord dans l’étendue du 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 de la dernière consultation du tableau de bord.

modifiedBy

string

ID de la personne qui a modifié le tableau de bord.

modifiedDate

string

Date de 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 à portée d’équipe, il s’agit de l’identificateur unique de l’équipe associée au tableau de bord. Pour les tableaux de bord dans l’étendue du 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é en minutes.

url

string

widgets

Widget[]

Ensemble de widgets sur le tableau de bord.

DashboardScope

Étendue du tableau de bord. Il peut s’agir d’un projet ou d’un 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

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 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 à l’adresse : http://semver.org/, sous la forme major.minor.patch.

Nom Type Description
major

integer

Version majeure lorsque vous apportez des modifications d’API incompatibles

minor

integer

Version mineure lorsque vous ajoutez des fonctionnalités de manière rétrocompatible

patch

integer

Version corrective lorsque vous apportez des correctifs de bogues rétrocompatibles

Widget

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 opération est remplie lorsque l’utilisateur souhaite configurer le widget

areSettingsBlockedForUser

boolean

Read-Only propriété du service Tableau de bord. 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 l’é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 fournie.

dashboard

Dashboard

Contenu de tableau de bord partiel facultatif, pour prendre en charge l’échange de la version ETag au niveau du tableau de bord 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/, sous la forme 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 de tableau de bord.

rowSpan

integer

Hauteur du widget, exprimée en lignes de grille de tableau de bord.