Widgets - Get Widget

Riferimento

Service:: Dashboard

API Version:: 7.1-preview.2

Ottenere lo stato corrente del widget specificato.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
dashboardId	path	True	string uuid	ID del dashboard contenente il widget.
organization	path	True	string	Nome dell'organizzazione di Azure DevOps.
project	path	True	string	ID progetto o nome progetto
widgetId	path	True	string uuid	ID del widget da leggere.
team	path		string	ID team o nome team
api-version	query	True	string	Versione dell'API da usare. Questa opzione deve essere impostata su '7.1-preview.2' per usare questa versione dell'API.

Risposte

Nome	Tipo	Descrizione
200 OK	Widget	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	Concede la possibilità di leggere le informazioni del dashboard del team

Esempio

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

Definizioni

Nome	Descrizione
Dashboard	Modello di un dashboard.
DashboardScope	Ambito dashboard. Può essere Project o Project_Team
LightboxOptions	Configurazione di Lightbox
ReferenceLinks	Classe da rappresentare una raccolta di collegamenti di riferimento REST.
SemanticVersion	controllo delle versioni per un artefatto come descritto in: http://semver.org/, della maschera major.minor.patch.
Widget	Dati del widget
WidgetPosition
WidgetSize

Dashboard

Modello di un dashboard.

Nome	Tipo	Descrizione
_links	ReferenceLinks	Classe da rappresentare una raccolta di collegamenti di riferimento REST.
dashboardScope	DashboardScope	Entità a cui è compreso 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 dashboard.
modifiedDate	string	Data dell'ultima modifica del dashboard.
name	string	Nome del dashboard.
ownerId	string	ID del proprietario 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, 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 viene impostato in fase di creazione, la posizione viene decisa dal servizio.
refreshInterval	integer	Intervallo per il client per aggiornare automaticamente il dashboard. 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 è compreso nell'ambito dell'utente della raccolta.
project	string	Il dashboard è compreso nell'ambito del progetto.
project_Team	string	Il dashboard è compreso nell'ambito del team.

LightboxOptions

Configurazione di Lightbox

Nome	Tipo	Descrizione
height	integer	Altezza della casella di luce desiderata, in pixel
resizable	boolean	True per consentire il ridimensionamento della casella di luce, false per impedire il ridimensionamento della casella di luce, le impostazioni predefinite sono false.
width	integer	Larghezza della casella di luce desiderata, in pixel

ReferenceLinks

Classe da rappresentare una raccolta di collegamenti di riferimento REST.

Nome	Tipo	Descrizione
links	object	Visualizzazione di lettura dei collegamenti. Poiché i collegamenti di riferimento sono in sola lettura, si vuole esporre solo i collegamenti di riferimento come sola lettura.

SemanticVersion

controllo delle versioni per un artefatto come descritto in: http://semver.org/, della maschera 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 delle patch quando si apportano correzioni di bug compatibili con le versioni precedenti

Dati del widget

Nome	Tipo	Descrizione
_links	ReferenceLinks	Classe da 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 vengono bloccate per l'utente corrente.
artifactId	string	Fa riferimento all'identificatore univoco di un artefatto di funzionalità. Usato per l'aggiunta+rimozione di un artefatto specifico.
configurationContributionId	string
configurationContributionRelativeId	string
contentUri	string
contributionId	string	ID del contributo sottostante che definisce la configurazione del widget fornito.
dashboard	Dashboard	Contenuto del dashboard parziale facoltativo 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/, della maschera 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.

Condividi tramite