Dashboards - Replace Dashboards

Riferimento

Servizio:: Dashboard

Versione API:: 7.1-preview.3

Aggiornare il nome e la posizione dei dashboard nel gruppo fornito e rimuovere i dashboard omessi. Non modifica il contenuto del dashboard.

PUT https://dev.azure.com/{organization}/{project}/{team}/_apis/dashboard/dashboards?api-version=7.1-preview.3

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
organization	path	True	string	Nome dell'organizzazione di Azure DevOps.
project	path	True	string	ID progetto o nome progetto
team	path		string	ID team o nome team
api-version	query	True	string	Versione dell'API da usare. Deve essere impostato su '7.1-preview.3' per usare questa versione dell'API.

Corpo della richiesta

Nome	Tipo	Descrizione
_links	ReferenceLinks	Classe per rappresentare una raccolta di collegamenti di riferimento REST.
dashboardEntries	DashboardGroupEntry[]	Elenco di dashboard contenuti nel gruppo di dashboard
permission	GroupMemberPermission	Deprecato: modello di autorizzazione precedente che descrive il livello di autorizzazioni per il team corrente. Pre-M125.
teamDashboardPermission	TeamDashboardPermission	Maschera di bit delle autorizzazioni che descrive le autorizzazioni di sicurezza del team corrente per i dashboard. Quando questa autorizzazione è il valore Nessuno, usare GroupMemberPermission. Le autorizzazioni vengono valutate in base alla presenza di un valore diverso da Nessuno. In caso contrario, verrà salvato GroupMemberPermission.
url	string

Risposte

Nome	Tipo	Descrizione
200 OK	DashboardGroup	operazione riuscita

Sicurezza

oauth2

Tipo: oauth2
Flow: accessCode
URL di autorizzazione: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL token: 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

Ambiti

Nome	Descrizione
vso.dashboards_manage	Concede la possibilità di gestire le informazioni sul dashboard del team

Esempio

Esempio di richiesta

HTTP

PUT https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/dashboard/dashboards?api-version=7.1-preview.3

{
  "widgets": []
}

Risposta di esempio

Codice di stato:: 200

{
  "widgets": [],
  "url": "https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/Dashboard/groups/999EF3B4-93E1-4086-86C2-5E8BD24512C7/Dashboards/7562562a-4f9f-4258-94a9-b048b1c817cf",
  "_links": {
    "self": {
      "href": "https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/Dashboard/groups/999EF3B4-93E1-4086-86C2-5E8BD24512C7/Dashboards/7562562a-4f9f-4258-94a9-b048b1c817cf"
    },
    "group": {
      "href": "https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/Dashboard/Groups/999ef3b4-93e1-4086-86c2-5e8bd24512c7"
    }
  },
  "id": "7562562a-4f9f-4258-94a9-b048b1c817cf",
  "name": "Dashboard98",
  "position": 2,
  "refreshInterval": 5
}

Definizioni

Nome	Descrizione
Dashboard	Modello di un dashboard.
DashboardGroup	Descrive un elenco di dashboard associati a un proprietario. Attualmente, i team possiedono gruppi di dashboard.
DashboardGroupEntry	Voce del gruppo di dashboard, ritorno a capo del dashboard (necessario?)
DashboardScope	Ambito dashboard. Può essere Project o Project_Team
GroupMemberPermission	Deprecato: modello di autorizzazione precedente che descrive il livello di autorizzazioni per il team corrente. Pre-M125.
LightboxOptions	Configurazione di Lightbox
ReferenceLinks	Classe per rappresentare una raccolta di collegamenti di riferimento REST.
SemanticVersion	controllo delle versioni per un artefatto come descritto in: http://semver.org/, del formato major.minor.patch.
TeamDashboardPermission	Maschera di bit delle autorizzazioni che descrive le autorizzazioni di sicurezza del team corrente per i dashboard. Quando questa autorizzazione è il valore Nessuno, usare GroupMemberPermission. Le autorizzazioni vengono valutate in base alla presenza di un valore diverso da Nessuno. In caso contrario, verrà salvato GroupMemberPermission.
Widget	Dati del widget
WidgetPosition
WidgetSize

Dashboard

Object

Modello di un dashboard.

Nome	Tipo	Descrizione
_links	ReferenceLinks	Classe per rappresentare una raccolta di collegamenti di riferimento REST.
dashboardScope	DashboardScope	Entità a cui è limitato l'ambito del dashboard.
description	string	Descrizione del dashboard.
eTag	string	Valore di rilevamento della versione definito dal server, usato per il rilevamento delle collisioni di modifica.
groupId	string (uuid)	ID del gruppo per un dashboard. Per i dashboard con ambito team, si tratta dell'identificatore univoco per il team associato al dashboard. Per i dashboard con ambito progetto questa proprietà è vuota.
id	string (uuid)	ID del dashboard. Fornito dal servizio in fase di creazione.
lastAccessedDate	string (date-time)	Data dell'ultimo accesso al dashboard.
modifiedBy	string (uuid)	ID della persona che ha modificato il dashboard.
modifiedDate	string (date-time)	Data dell'ultima modifica del dashboard.
name	string	Nome del dashboard.
ownerId	string (uuid)	ID del proprietario di un dashboard. Per i dashboard con ambito team, si tratta dell'identificatore univoco per il team associato al dashboard. Per i dashboard con ambito progetto, si tratta dell'identificatore univoco per l'identità utente associata al dashboard.
position	integer (int32)	Posizione del dashboard, all'interno di un gruppo di dashboard. Se non viene impostato in fase di creazione, la posizione viene definita dal servizio.
refreshInterval	integer (int32)	Intervallo per consentire al client di aggiornare automaticamente il dashboard. Espresso in minuti.
url	string
widgets	Widget[]	Set di widget nel dashboard.

DashboardGroup

Object

Descrive un elenco di dashboard associati a un proprietario. Attualmente, i team possiedono gruppi di dashboard.

Nome	Tipo	Descrizione
_links	ReferenceLinks	Classe per rappresentare una raccolta di collegamenti di riferimento REST.
dashboardEntries	DashboardGroupEntry[]	Elenco di dashboard contenuti nel gruppo di dashboard
permission	GroupMemberPermission	Deprecato: modello di autorizzazione precedente che descrive il livello di autorizzazioni per il team corrente. Pre-M125.
teamDashboardPermission	TeamDashboardPermission	Maschera di bit delle autorizzazioni che descrive le autorizzazioni di sicurezza del team corrente per i dashboard. Quando questa autorizzazione è il valore Nessuno, usare GroupMemberPermission. Le autorizzazioni vengono valutate in base alla presenza di un valore diverso da Nessuno. In caso contrario, verrà salvato GroupMemberPermission.
url	string

DashboardGroupEntry

Object

Voce del gruppo di dashboard, ritorno a capo del dashboard (necessario?)

Nome	Tipo	Descrizione
_links	ReferenceLinks	Classe per rappresentare una raccolta di collegamenti di riferimento REST.
dashboardScope	DashboardScope	Entità a cui è limitato l'ambito del dashboard.
description	string	Descrizione del dashboard.
eTag	string	Valore di rilevamento della versione definito dal server, usato per il rilevamento delle collisioni di modifica.
groupId	string (uuid)	ID del gruppo per un dashboard. Per i dashboard con ambito team, si tratta dell'identificatore univoco per il team associato al dashboard. Per i dashboard con ambito progetto questa proprietà è vuota.
id	string (uuid)	ID del dashboard. Fornito dal servizio in fase di creazione.
lastAccessedDate	string (date-time)	Data dell'ultimo accesso al dashboard.
modifiedBy	string (uuid)	ID della persona che ha modificato il dashboard.
modifiedDate	string (date-time)	Data dell'ultima modifica del dashboard.
name	string	Nome del dashboard.
ownerId	string (uuid)	ID del proprietario di un dashboard. Per i dashboard con ambito team, si tratta dell'identificatore univoco per il team associato al dashboard. Per i dashboard con ambito progetto, si tratta dell'identificatore univoco per l'identità utente associata al dashboard.
position	integer (int32)	Posizione del dashboard, all'interno di un gruppo di dashboard. Se non viene impostato in fase di creazione, la posizione viene definita dal servizio.
refreshInterval	integer (int32)	Intervallo per consentire al client di aggiornare automaticamente il dashboard. Espresso in minuti.
url	string
widgets	Widget[]	Set di widget nel dashboard.

DashboardScope

Enumerazione

Ambito dashboard. Può essere Project o Project_Team

Valore	Descrizione
collection_User	[DEPRECATO] Il dashboard ha come ambito l'utente della raccolta.
project	Il dashboard ha come ambito il progetto.
project_Team	Il dashboard ha come ambito il team.

GroupMemberPermission

Enumerazione

Deprecato: modello di autorizzazione precedente che descrive il livello di autorizzazioni per il team corrente. Pre-M125.

Valore	Descrizione
edit
manage
managePermissions
none

LightboxOptions

Object

Configurazione di Lightbox

Nome	Tipo	Descrizione
height	integer (int32)	Altezza della casella di luce desiderata, in pixel
resizable	boolean	True per consentire il ridimensionamento di lightbox, false per impedire il ridimensionamento della casella di luce, il valore predefinito è false.
width	integer (int32)	Larghezza della casella di luce desiderata, in pixel

ReferenceLinks

Object

Classe per rappresentare una raccolta di collegamenti di riferimento REST.

Nome	Tipo	Descrizione
links	object	Visualizzazione di sola lettura dei collegamenti. Poiché i collegamenti di riferimento sono di sola lettura, è consigliabile esporli solo come di sola lettura.

SemanticVersion

Object

controllo delle versioni per un artefatto come descritto in: http://semver.org/, del formato major.minor.patch.

Nome	Tipo	Descrizione
major	integer (int32)	Versione principale quando si apportano modifiche all'API incompatibili
minor	integer (int32)	Versione secondaria quando si aggiungono funzionalità in modo compatibile con le versioni precedenti
patch	integer (int32)	Versione patch quando si apportano correzioni di bug compatibili con le versioni precedenti

TeamDashboardPermission

Enumerazione

Maschera di bit delle autorizzazioni che descrive le autorizzazioni di sicurezza del team corrente per i dashboard. Quando questa autorizzazione è il valore Nessuno, usare GroupMemberPermission. Le autorizzazioni vengono valutate in base alla presenza di un valore diverso da Nessuno. In caso contrario, verrà salvato GroupMemberPermission.

Valore	Descrizione
create
delete
edit
managePermissions
none
read

Object

Dati del widget

Nome	Tipo	Descrizione
_links	ReferenceLinks	Classe per rappresentare una raccolta di collegamenti di riferimento REST.
allowedSizes	WidgetSize[]	Fa riferimento alle dimensioni consentite per il widget. Questo viene popolato quando l'utente vuole configurare il widget
areSettingsBlockedForUser	boolean	Read-Only proprietà dal servizio dashboard. Indica se le impostazioni sono bloccate per l'utente corrente.
artifactId	string	Fa riferimento all'identificatore univoco di un artefatto di funzionalità. Usato per aggiungere e rimuovere un artefatto specifico.
configurationContributionId	string
configurationContributionRelativeId	string
contentUri	string
contributionId	string	ID del contributo sottostante che definisce la configurazione del widget fornita.
dashboard	Dashboard	Contenuto facoltativo del dashboard parziale, per supportare lo scambio di ETag della versione a livello di dashboard per le API a livello di widget
eTag	string
id	string (uuid)
isEnabled	boolean
isNameConfigurable	boolean
lightboxOptions	LightboxOptions	Configurazione di Lightbox
loadingImageUrl	string
name	string
position	WidgetPosition
settings	string
settingsVersion	SemanticVersion	controllo delle versioni per un artefatto come descritto in: http://semver.org/, del formato major.minor.patch.
size	WidgetSize
typeId	string
url	string

WidgetPosition

Object

Nome	Tipo	Descrizione
column	integer (int32)
row	integer (int32)

WidgetSize

Object

Nome	Tipo	Descrizione
columnSpan	integer (int32)	Larghezza del widget, espressa nelle colonne della griglia del dashboard.
rowSpan	integer (int32)	Altezza del widget, espressa nelle righe della griglia del dashboard.

Condividi tramite

Dashboards - Replace Dashboards

Parametri dell'URI

Corpo della richiesta

Risposte

Sicurezza

oauth2

Ambiti

Esempio

Esempio di richiesta

Risposta di esempio

Definizioni

Dashboard

DashboardGroup

DashboardGroupEntry

DashboardScope

GroupMemberPermission

LightboxOptions

ReferenceLinks

SemanticVersion

TeamDashboardPermission

Widget

WidgetPosition

WidgetSize