Widgets - Get Widget

Reference

Service:: Dashboard

API Version:: 7.1-preview.2

Získejte aktuální stav zadaného widgetu.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
dashboardId	path	True	string uuid	ID řídicího panelu obsahujícího widget
organization	path	True	string	Název organizace Azure DevOps.
project	path	True	string	ID projektu nebo název projektu
widgetId	path	True	string uuid	ID widgetu, který chcete přečíst.
team	path		string	ID týmu nebo název týmu
api-version	query	True	string	Verze rozhraní API, která se má použít. Aby se tato verze rozhraní API používala, měla by být nastavená na 7.1-preview.2.

Odpovědi

Name	Typ	Description
200 OK	Widget	úspěšná operace

Zabezpečení

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

Name	Description
vso.dashboards	Uděluje možnost číst informace o týmovém řídicím panelu.

Příklady

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

Definice

Name	Description
Dashboard	Model řídicího panelu.
DashboardScope	Rozsah řídicího panelu. Může to být project nebo Project_Team
LightboxOptions	Konfigurace Lightboxu
ReferenceLinks	Třída představující kolekci odkazů REST.
SemanticVersion	správa verzí artefaktu, jak je popsáno na: http://semver.org/, ve formátu major.minor.patch.
Widget	Data widgetu
WidgetPosition
WidgetSize

Dashboard

Model řídicího panelu.

Name	Typ	Description
_links	ReferenceLinks	Třída představující kolekci odkazů REST.
dashboardScope	DashboardScope	Entita, na kterou je řídicí panel vymezen.
description	string	Popis řídicího panelu
eTag	string	Serverem definovaná hodnota sledování verzí, která se používá k úpravě detekce kolizí.
groupId	string	ID skupiny pro řídicí panel. U řídicích panelů s oborem týmu se jedná o jedinečný identifikátor týmu přidruženého k řídicímu panelu. U řídicích panelů s oborem projektu je tato vlastnost prázdná.
id	string	ID řídicího panelu. Služba je poskytována při vytváření.
lastAccessedDate	string	Datum posledního přístupu na řídicím panelu.
modifiedBy	string	ID osoby, která řídicí panel upravila.
modifiedDate	string	Datum poslední změny řídicího panelu
name	string	Název řídicího panelu.
ownerId	string	ID vlastníka řídicího panelu U řídicích panelů s oborem týmu se jedná o jedinečný identifikátor týmu přidruženého k řídicímu panelu. U řídicích panelů s oborem projektu se jedná o jedinečný identifikátor identity uživatele přidružené k řídicímu panelu.
position	integer	Umístění řídicího panelu v rámci skupiny řídicích panelů Pokud se při vytváření nenasadí, o pozici rozhoduje služba.
refreshInterval	integer	Interval automatické aktualizace řídicího panelu klientem Vyjádřeno v minutách.
url	string
widgets	Widget[]	Sada widgetů na řídicím panelu.

DashboardScope

Rozsah řídicího panelu. Může to být project nebo Project_Team

Name	Typ	Description
collection_User	string	[ZASTARALÉ] Řídicí panel je vymezený na uživatele kolekce.
project	string	Řídicí panel je vymezený na projekt.
project_Team	string	Řídicí panel je vymezený na tým.

LightboxOptions

Konfigurace Lightboxu

Name	Typ	Description
height	integer	Výška požadovaného lightboxu v pixelech
resizable	boolean	True, pokud chcete povolit změnu velikosti lightboxu, false zakáže změnu velikosti lightboxu, výchozí hodnota je false.
width	integer	Šířka požadovaného lightboxu v pixelech

ReferenceLinks

Třída představující kolekci odkazů REST.

Name	Typ	Description
links	object	Zobrazení odkazů jen pro čtení. Vzhledem k tomu, že odkazy jsou jen pro čtení, chceme je zveřejnit jenom jako jen pro čtení.

SemanticVersion

správa verzí artefaktu, jak je popsáno na: http://semver.org/, ve formátu major.minor.patch.

Name	Typ	Description
major	integer	Hlavní verze při provádění nekompatibilních změn rozhraní API
minor	integer	Podverze při přidávání funkcí zpětně kompatibilním způsobem
patch	integer	Verze opravy při zpětně kompatibilních opravách chyb

Data widgetu

Name	Typ	Description
_links	ReferenceLinks	Třída představující kolekci odkazů REST.
allowedSizes	WidgetSize[]	Odkazuje na povolené velikosti widgetu. Tato funkce se vyplní, když uživatel chce nakonfigurovat widget.
areSettingsBlockedForUser	boolean	Read-Only vlastnost ze služby řídicího panelu. Označuje, jestli jsou nastavení pro aktuálního uživatele zablokovaná.
artifactId	string	Odkazuje na jedinečný identifikátor artefaktu funkce. Používá se k připnutí a odepnutí konkrétního artefaktu.
configurationContributionId	string
configurationContributionRelativeId	string
contentUri	string
contributionId	string	ID základního příspěvku definující zadanou konfiguraci widgetu.
dashboard	Dashboard	Volitelný částečný obsah řídicího panelu pro podporu výměny značky ETag verze na úrovni řídicího panelu pro rozhraní API na úrovni widgetů
eTag	string
id	string
isEnabled	boolean
isNameConfigurable	boolean
lightboxOptions	LightboxOptions	Konfigurace Lightboxu
loadingImageUrl	string
name	string
position	WidgetPosition
settings	string
settingsVersion	SemanticVersion	správa verzí artefaktu, jak je popsáno na: http://semver.org/, ve formátu major.minor.patch.
size	WidgetSize
typeId	string
url	string

WidgetPosition

Name	Typ	Description
column	integer
row	integer

WidgetSize

Name	Typ	Description
columnSpan	integer	Šířka widgetu vyjádřená ve sloupcích mřížky řídicího panelu
rowSpan	integer	Výška widgetu vyjádřená v řádcích mřížky řídicího panelu

Sdílet prostřednictvím