Widgets - Get Widget

Ссылка

Service:: Dashboard

API Version:: 7.1-preview.2

Получение текущего состояния указанного мини-приложения.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
dashboardId	path	True	string uuid	Идентификатор панели мониторинга, содержащей мини-приложение.
organization	path	True	string	Название организации Azure DevOps.
project	path	True	string	Идентификатор проекта или имя проекта
widgetId	path	True	string uuid	Идентификатор считываемого мини-приложения.
team	path		string	Идентификатор или имя команды
api-version	query	True	string	Используемая версия API. Для использования этой версии API необходимо задать значение 7.1-preview.2.

Ответы

Имя	Тип	Описание
200 OK	Widget	успешная операция

Безопасность

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

Имя	Описание
vso.dashboards	Предоставляет возможность чтения сведений о панели мониторинга группы

Примеры

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

Определения

Имя	Описание
Dashboard	Модель панели мониторинга.
DashboardScope	Область панели мониторинга. Может быть либо Project, либо Project_Team
LightboxOptions	Конфигурация Lightbox
ReferenceLinks	Класс, представляющий коллекцию ссылок REST.
SemanticVersion	управление версиями для артефакта, как описано в: http://semver.org/, в формате major.minor.patch.
Widget	Данные мини-приложения
WidgetPosition
WidgetSize

Dashboard

Модель панели мониторинга.

Имя	Тип	Описание
_links	ReferenceLinks	Класс, представляющий коллекцию ссылок REST.
dashboardScope	DashboardScope	Сущность, область действия которой ограничена панелью мониторинга.
description	string	Описание панели мониторинга.
eTag	string	Определенное сервером значение отслеживания версий, используемое для обнаружения конфликтов редактирования.
groupId	string	Идентификатор группы для панели мониторинга. Для панелей мониторинга с областью действия группы это уникальный идентификатор команды, связанной с панелью мониторинга. Для панелей мониторинга в области проекта это свойство пусто.
id	string	Идентификатор панели мониторинга. Предоставляется службой во время создания.
lastAccessedDate	string	Дата последнего доступа к панели мониторинга.
modifiedBy	string	Идентификатор пользователя, изменившего панель мониторинга.
modifiedDate	string	Дата последнего изменения панели мониторинга.
name	string	Имя панели мониторинга.
ownerId	string	Идентификатор владельца панели мониторинга. Для панелей мониторинга с областью действия группы это уникальный идентификатор команды, связанной с панелью мониторинга. Для панелей мониторинга в области проекта это уникальный идентификатор удостоверения пользователя, связанного с панелью мониторинга.
position	integer	Положение панели мониторинга в группе панелей мониторинга. Если во время создания не задано, позиция определяется службой.
refreshInterval	integer	Интервал для автоматического обновления панели мониторинга клиентом. Выражается в минутах.
url	string
widgets	Widget[]	Набор мини-приложений на панели мониторинга.

DashboardScope

Область панели мониторинга. Может быть либо Project, либо Project_Team

Имя	Тип	Описание
collection_User	string	[НЕ РЕКОМЕНДУЕТСЯ] Область панели мониторинга ограничена пользователем коллекции.
project	string	Панель мониторинга ограничена проектом.
project_Team	string	Область панели мониторинга ограничена командой.

LightboxOptions

Конфигурация Lightbox

Имя	Тип	Описание
height	integer	Высота нужного лайтбокса в пикселях
resizable	boolean	Значение true, чтобы разрешить изменение размера лайтбокса, значение false, чтобы запретить изменение размера лайтбокса, по умолчанию — false.
width	integer	Ширина нужного лайтбокса в пикселях

ReferenceLinks

Класс, представляющий коллекцию ссылок REST.

Имя	Тип	Описание
links	object	Представление ссылок только для чтения. Так как ссылочные ссылки доступны только для чтения, мы хотим предоставить их только для чтения.

SemanticVersion

управление версиями для артефакта, как описано в: http://semver.org/, в формате major.minor.patch.

Имя	Тип	Описание
major	integer	Основная версия при внесении несовместимых изменений API
minor	integer	Дополнительный номер версии при добавлении функций с обратной совместимостью
patch	integer	Версия исправления при создании исправлений ошибок, совместимых с обратной совместимостью

Данные мини-приложения

Имя	Тип	Описание
_links	ReferenceLinks	Класс, представляющий коллекцию ссылок REST.
allowedSizes	WidgetSize[]	Указывает на допустимые размеры мини-приложения. Он заполняется, когда пользователь хочет настроить мини-приложение
areSettingsBlockedForUser	boolean	Read-Only свойство из службы панели мониторинга. Указывает, заблокированы ли параметры для текущего пользователя.
artifactId	string	Ссылается на уникальный идентификатор артефакта компонента. Используется для закрепления и открепления определенного артефакта.
configurationContributionId	string
configurationContributionRelativeId	string
contentUri	string
contributionId	string	Идентификатор базового вклада, определяющего предоставленную конфигурацию мини-приложения.
dashboard	Dashboard	Необязательное частичное содержимое панели мониторинга для поддержки обмена версией ETag на уровне панели мониторинга для API уровня мини-приложения
eTag	string
id	string
isEnabled	boolean
isNameConfigurable	boolean
lightboxOptions	LightboxOptions	Конфигурация Lightbox
loadingImageUrl	string
name	string
position	WidgetPosition
settings	string
settingsVersion	SemanticVersion	управление версиями для артефакта, как описано в: http://semver.org/, в формате major.minor.patch.
size	WidgetSize
typeId	string
url	string

WidgetPosition

Имя	Тип	Описание
column	integer
row	integer

WidgetSize

Имя	Тип	Описание
columnSpan	integer	Ширина мини-приложения, выраженная в столбцах сетки панели мониторинга.
rowSpan	integer	Высота мини-приложения, выраженная в строках сетки панели мониторинга.

Поделиться через