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	包含小组件的仪表板的 ID。
organization	path	True	string	Azure DevOps 组织的名称。
project	path	True	string	项目 ID 或项目名称
widgetId	path	True	string uuid	要读取的小组件的 ID。
team	path		string	团队 ID 或团队名称
api-version	query	True	string	要使用的 API 版本。应将其设置为“7.1-preview.2”才能使用此版本的 API。

响应

名称	类型	说明
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。对于团队范围的仪表板，这是与仪表板关联的团队的唯一标识符。对于项目范围的仪表板，此属性为空。
id	string	仪表板的 ID。创建时由服务提供。
lastAccessedDate	string	仪表板上次访问日期。
modifiedBy	string	修改仪表板的人员的 ID。
modifiedDate	string	仪表板的上次修改日期。
name	string	仪表板的名称。
ownerId	string	仪表板所有者的 ID。对于团队范围的仪表板，这是与仪表板关联的团队的唯一标识符。对于项目范围的仪表板，这是与仪表板关联的用户标识的唯一标识符。
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	在进行向后兼容的 bug 修复时修补版本

小组件数据

名称	类型	说明
_links	ReferenceLinks	表示 REST 引用链接集合的类。
allowedSizes	WidgetSize[]	指小组件允许的大小。当用户想要配置小组件时，会填充此小组件
areSettingsBlockedForUser	boolean	Read-Only仪表板服务中的属性。指示是否阻止当前用户的设置。
artifactId	string	引用特征项目的唯一标识符。用于固定+取消固定特定项目。
configurationContributionId	string
configurationContributionRelativeId	string
contentUri	string
contributionId	string	定义提供的小组件配置的基础贡献的 ID。
dashboard	Dashboard	可选部分仪表板内容，支持交换小组件级 API 的仪表板级版本 ETag
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	小组件的高度，以网格行仪表板表示。

通过