Widgets - Get Widget

Service:

Dashboard

API Version:

7.1-preview.2

Pobierz bieżący stan określonego widżetu.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
dashboardId	path	True	string uuid	Identyfikator pulpitu nawigacyjnego zawierającego widżet.
organization	path	True	string	Nazwa organizacji usługi Azure DevOps.
project	path	True	string	Identyfikator projektu lub nazwa projektu
widgetId	path	True	string uuid	Identyfikator widżetu do odczytania.
team	path		string	Identyfikator zespołu lub nazwa zespołu
api-version	query	True	string	Wersja interfejsu API do użycia. Ta wartość powinna mieć wartość "7.1-preview.2", aby używać tej wersji interfejsu API.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	Widget	operacja zakończona powodzeniem

Zabezpieczenia

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

Nazwa	Opis
vso.dashboards	Umożliwia odczytywanie informacji o pulpicie nawigacyjnym zespołu

Przykłady

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

Definicje

Nazwa	Opis
Dashboard	Model pulpitu nawigacyjnego.
DashboardScope	Zakres pulpitu nawigacyjnego. Może to być projekt lub Project_Team
LightboxOptions	Konfiguracja usługi Lightbox
ReferenceLinks	Klasa reprezentująca kolekcję linków referencyjnych REST.
SemanticVersion	przechowywanie wersji artefaktu zgodnie z opisem w temacie : http://semver.org/, formularza major.minor.patch.
Widget	Dane widżetu
WidgetPosition
WidgetSize

Dashboard

Model pulpitu nawigacyjnego.

Nazwa	Typ	Opis
_links	ReferenceLinks	Klasa reprezentująca kolekcję linków referencyjnych REST.
dashboardScope	DashboardScope	Jednostka, do której jest zakres pulpitu nawigacyjnego.
description	string	Opis pulpitu nawigacyjnego.
eTag	string	Wartość śledzenia wersji zdefiniowanej przez serwer służącą do edytowania wykrywania kolizji.
groupId	string	Identyfikator grupy dla pulpitu nawigacyjnego. W przypadku pulpitów nawigacyjnych o zakresie zespołu jest to unikatowy identyfikator zespołu skojarzonego z pulpitem nawigacyjnym. W przypadku pulpitów nawigacyjnych o zakresie projektu ta właściwość jest pusta.
id	string	Identyfikator pulpitu nawigacyjnego. Udostępniane przez usługę w czasie tworzenia.
lastAccessedDate	string	Data ostatniego dostępu do pulpitu nawigacyjnego.
modifiedBy	string	Identyfikator osoby, która zmodyfikowała pulpit nawigacyjny.
modifiedDate	string	Data ostatniej modyfikacji pulpitu nawigacyjnego.
name	string	Nazwa pulpitu nawigacyjnego.
ownerId	string	Identyfikator właściciela pulpitu nawigacyjnego. W przypadku pulpitów nawigacyjnych o zakresie zespołu jest to unikatowy identyfikator zespołu skojarzonego z pulpitem nawigacyjnym. W przypadku pulpitów nawigacyjnych o zakresie projektu jest to unikatowy identyfikator tożsamości użytkownika skojarzonej z pulpitem nawigacyjnym.
position	integer	Pozycja pulpitu nawigacyjnego w grupie pulpitów nawigacyjnych. Jeśli pozycja nie jest ustawiana w czasie tworzenia, pozycja jest podejmowana przez usługę.
refreshInterval	integer	Interwał odświeżania pulpitu nawigacyjnego przez klienta. Wyrażone w minutach.
url	string
widgets	Widget[]	Zestaw widżetów na pulpicie nawigacyjnym.

DashboardScope

Zakres pulpitu nawigacyjnego. Może to być projekt lub Project_Team

Nazwa	Typ	Opis
collection_User	string	[PRZESTARZAŁE] Pulpit nawigacyjny jest w zakresie użytkownika kolekcji.
project	string	Zakres pulpitu nawigacyjnego dotyczy projektu.
project_Team	string	Zakres pulpitu nawigacyjnego jest ograniczona do zespołu.

LightboxOptions

Konfiguracja usługi Lightbox

Nazwa	Typ	Opis
height	integer	Wysokość żądanego światła w pikselach
resizable	boolean	Wartość True, aby umożliwić zmianę rozmiaru lightbox, wartość false nie zezwala na zmianę rozmiaru lightbox, domyślnie ma wartość false.
width	integer	Szerokość żądanego lightboxu w pikselach

ReferenceLinks

Klasa reprezentująca kolekcję linków referencyjnych REST.

Nazwa	Typ	Opis
links	object	Widok linków w trybie tylko do odczytu. Ponieważ linki odwołania są tylko do odczytu, chcemy uwidocznić je tylko jako tylko do odczytu.

SemanticVersion

przechowywanie wersji artefaktu zgodnie z opisem w temacie : http://semver.org/, formularza major.minor.patch.

Nazwa	Typ	Opis
major	integer	Wersja główna po wprowadzeniu niezgodnych zmian interfejsu API
minor	integer	Wersja pomocnicza w przypadku dodawania funkcji w sposób zgodny z poprzednimi wersjami
patch	integer	Wersja poprawek w przypadku wprowadzania poprawek usterek zgodnych z poprzednimi wersjami

Widget

Dane widżetu

Nazwa	Typ	Opis
_links	ReferenceLinks	Klasa reprezentująca kolekcję linków referencyjnych REST.
allowedSizes	WidgetSize[]	Odwołuje się do dozwolonych rozmiarów widżetu. Jest to wypełniane, gdy użytkownik chce skonfigurować widżet
areSettingsBlockedForUser	boolean	Read-Only właściwość z usługi pulpitu nawigacyjnego. Wskazuje, czy ustawienia są blokowane dla bieżącego użytkownika.
artifactId	string	Odwołuje się do unikatowego identyfikatora artefaktu funkcji. Służy do przypinania i odpinania określonego artefaktu.
configurationContributionId	string
configurationContributionRelativeId	string
contentUri	string
contributionId	string	Identyfikator bazowego udziału definiujący podaną konfigurację widżetu.
dashboard	Dashboard	Opcjonalna częściowa zawartość pulpitu nawigacyjnego w celu obsługi wymiany elementu ETag na poziomie pulpitu nawigacyjnego dla interfejsów API na poziomie widżetu
eTag	string
id	string
isEnabled	boolean
isNameConfigurable	boolean
lightboxOptions	LightboxOptions	Konfiguracja usługi Lightbox
loadingImageUrl	string
name	string
position	WidgetPosition
settings	string
settingsVersion	SemanticVersion	przechowywanie wersji artefaktu zgodnie z opisem w temacie : http://semver.org/, formularza major.minor.patch.
size	WidgetSize
typeId	string
url	string

WidgetPosition

Nazwa	Typ	Opis
column	integer
row	integer

WidgetSize

Nazwa	Typ	Opis
columnSpan	integer	Szerokość widżetu wyrażona w kolumnach siatki pulpitu nawigacyjnego.
rowSpan	integer	Wysokość widżetu wyrażona w wierszach siatki pulpitu nawigacyjnego.