Dashboards - Create

Service:

Dashboard

API Version:

7.1-preview.3

Creare il dashboard fornito.

POST 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 del progetto
team	path		string	ID team o nome del 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.
dashboardScope	DashboardScope	Entità a cui è limitato l'ambito del dashboard.
description	string	Descrizione del dashboard.
eTag	string	Valore di rilevamento delle versioni definito dal server, usato per il rilevamento delle collisioni di modifica.
groupId	string	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	ID del dashboard. Fornito dal servizio in fase di creazione.
lastAccessedDate	string	Data dell'ultimo accesso al dashboard.
modifiedBy	string	ID della persona che ha modificato il dashboard.
modifiedDate	string	Data dell'ultima modifica del dashboard.
name	string	Nome del dashboard.
ownerId	string	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	Posizione del dashboard, all'interno di un gruppo di dashboard. Se non impostato in fase di creazione, la posizione viene definita dal servizio.
refreshInterval	integer	Intervallo per l'aggiornamento automatico del dashboard da parte del client. Espresso in minuti.
url	string
widgets	Widget[]	Set di widget nel dashboard.

Risposte

Nome	Tipo	Descrizione
200 OK	Dashboard	operazione riuscita

Sicurezza

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

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

Esempio

Sample Request

HTTP

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

{
  "name": "test",
  "position": 5,
  "widgets": [
    {
      "name": "Team Members renamed",
      "position": {
        "row": 2,
        "column": 2
      },
      "size": {
        "rowSpan": 1,
        "columnSpan": 2
      },
      "settings": null,
      "settingsVersion": {
        "major": 1,
        "minor": 0,
        "patch": 0
      },
      "contributionId": "ms.vss-dashboards-web.Microsoft.VisualStudioOnline.Dashboards.TeamMembersWidget"
    }
  ]
}

Sample Response

Status code:

200

{
  "id": "29653dd2-c18a-4d19-8333-e556c5b8d025",
  "name": "test",
  "position": 5,
  "eTag": "1",
  "widgets": [
    {
      "name": "Team Members renamed",
      "position": {
        "row": 2,
        "column": 2
      },
      "size": {
        "rowSpan": 1,
        "columnSpan": 2
      },
      "settings": null,
      "settingsVersion": {
        "major": 1,
        "minor": 0,
        "patch": 0
      },
      "contributionId": "ms.vss-dashboards-web.Microsoft.VisualStudioOnline.Dashboards.TeamMembersWidget"
    }
  ],
  "url": "https://dev.azure.com/fabrikam/99755c45-cb33-4ab4-9f36-e5920cec7ba9/dc0d32d0-be95-4385-9df6-1176d698be22/_apis/Dashboard/Dashboards/29653dd2-c18a-4d19-8333-e556c5b8d025",
  "_links": {
    "self": {
      "href": "https://dev.azure.com/fabrikam/99755c45-cb33-4ab4-9f36-e5920cec7ba9/dc0d32d0-be95-4385-9df6-1176d698be22/_apis/Dashboard/Dashboards/29653dd2-c18a-4d19-8333-e556c5b8d025"
    },
    "group": {
      "href": "https://dev.azure.com/fabrikam/99755c45-cb33-4ab4-9f36-e5920cec7ba9/dc0d32d0-be95-4385-9df6-1176d698be22/_apis/Dashboard/Dashboards"
    },
    "widget": [
      {
        "href": "https://dev.azure.com/fabrikam/99755c45-cb33-4ab4-9f36-e5920cec7ba9/dc0d32d0-be95-4385-9df6-1176d698be22/_apis/Dashboard/dashboards/29653dd2-c18a-4d19-8333-e556c5b8d025/Widgets/456afb86-ecf6-49cf-bbcc-1ab7d0fc14b2"
      }
    ]
  }
}

Definizioni

Nome	Descrizione
Dashboard	Modello di un dashboard.
DashboardScope	Ambito dashboard. Può essere Project o Project_Team
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.
Widget	Dati del widget
WidgetPosition
WidgetSize

Dashboard

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 delle versioni definito dal server, usato per il rilevamento delle collisioni di modifica.
groupId	string	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	ID del dashboard. Fornito dal servizio in fase di creazione.
lastAccessedDate	string	Data dell'ultimo accesso al dashboard.
modifiedBy	string	ID della persona che ha modificato il dashboard.
modifiedDate	string	Data dell'ultima modifica del dashboard.
name	string	Nome del dashboard.
ownerId	string	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	Posizione del dashboard, all'interno di un gruppo di dashboard. Se non impostato in fase di creazione, la posizione viene definita dal servizio.
refreshInterval	integer	Intervallo per l'aggiornamento automatico del dashboard da parte del client. Espresso in minuti.
url	string
widgets	Widget[]	Set di widget nel dashboard.

DashboardScope

Ambito dashboard. Può essere Project o Project_Team

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

LightboxOptions

Configurazione di Lightbox

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

ReferenceLinks

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

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

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

Widget

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 l'aggiunta e l'annullamento dell'associazione di un elemento 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 versioni a livello di dashboard ETag per le API a livello di widget
eTag	string
id	string
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

Nome	Tipo	Descrizione
column	integer
row	integer

WidgetSize

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