Widgets - Get Widget

參考

服務:: Dashboard

API 版本:: 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 參數

名稱	位於	必要	類型	Description
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 版本。這應該設定為 '7.1-preview.2'，以使用此版本的 API。

回應

名稱	類型	Description
200 OK	Widget	成功作業

安全性

oauth2

類型: oauth2
Flow: accessCode
授權 URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
權杖 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

範圍

名稱	Description
vso.dashboards	授與讀取小組儀表板資訊的能力

範例

範例要求

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

範例回覆

狀態碼:: 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"
    }
  }
}

定義

名稱	Description
Dashboard	儀表板的模型。
DashboardScope	儀表板範圍。可以是 Project 或 Project_Team
LightboxOptions	Lightbox 組態
ReferenceLinks	表示 REST 參考連結集合的類別。
SemanticVersion	成品的版本設定，如下列所述： http://semver.org/ ，格式為 major.minor.patch。
Widget	小工具資料
WidgetPosition
WidgetSize

Dashboard

Object

儀表板的模型。

名稱	類型	Description
_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

Enumeration

儀表板範圍。可以是 Project 或 Project_Team

值	Description
collection_User	[已淘汰]儀表板的範圍是集合使用者。
project	儀表板的範圍是專案。
project_Team	儀表板的範圍限定于小組。

LightboxOptions

Object

Lightbox 組態

名稱	類型	Description
height	integer	所需光線箱的高度，以圖元為單位
resizable	boolean	True 是表示允許 Lightbox 調整大小，false 表示不允許 Lightbox 調整大小，預設值為 false。
width	integer	所需光線箱的寬度，以圖元為單位

ReferenceLinks

Object

表示 REST 參考連結集合的類別。

名稱	類型	Description
links	object	連結的唯讀檢視。因為參考連結是唯讀的，所以我們只想要將它們公開為唯讀。

SemanticVersion

Object

成品的版本設定，如下列所述： http://semver.org/ ，格式為 major.minor.patch。

名稱	類型	Description
major	integer	當您進行不相容的 API 變更時的主要版本
minor	integer	當您以回溯相容的方式新增功能時，次要版本
patch	integer	當您進行回溯相容的 Bug 修正時，修補程式版本

Object

小工具資料

名稱	類型	Description
_links	ReferenceLinks	表示 REST 參考連結集合的類別。
allowedSizes	WidgetSize[]	請參閱小工具的允許大小。當使用者想要設定小工具時，這會填入
areSettingsBlockedForUser	boolean	從儀表板服務Read-Only屬性。指出目前使用者的設定是否遭到封鎖。
artifactId	string	參考功能成品的唯一識別碼。用於釘選+取消釘選特定成品。
configurationContributionId	string
configurationContributionRelativeId	string
contentUri	string
contributionId	string	定義所提供 Widget 組態的基礎貢獻識別碼。
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

Object

名稱	類型	Description
column	integer
row	integer

WidgetSize

Object

名稱	類型	Description
columnSpan	integer	小工具的寬度，以儀表板格線資料行表示。
rowSpan	integer	小工具的高度，以儀表板方格資料清單示。

共用方式為

Widgets - Get Widget

URI 參數

回應

安全性

oauth2

範圍

範例

範例要求

範例回覆

定義

Dashboard

DashboardScope

LightboxOptions

ReferenceLinks

SemanticVersion

Widget

WidgetPosition

WidgetSize

其他資源