Dashboards - Create

參考

Service:: Dashboard

API Version:: 7.1-preview.3

建立提供的儀表板。

POST https://dev.azure.com/{organization}/{project}/{team}/_apis/dashboard/dashboards?api-version=7.1-preview.3

URI 參數

名稱	位於	必要	類型	Description
organization	path	True	string	Azure DevOps 組織的名稱。
project	path	True	string	專案識別碼或專案名稱
team	path		string	小組識別碼或小組名稱
api-version	query	True	string	要使用的 API 版本。這應該設定為 '7.1-preview.3'，以使用此版本的 API。

要求本文

名稱	類型	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[]	儀表板上的 Widget 集合。

回應

名稱	類型	Description
200 OK	Dashboard	成功的作業

安全性

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

名稱	Description
vso.dashboards_manage	授與管理小組儀表板資訊的能力

範例

Sample Request

HTTP

POST https://dev.azure.com/fabrikam/{project}/_apis/dashboard/dashboards?api-version=7.1-preview.3

{
  "name": "test",
  "position": 5,
  "widgets": [
    {
      "name": "Team Members renamed",
      "position": {
        "row": 2,
        "column": 2
      },
      "size": {
        "rowSpan": 1,
        "columnSpan": 2
      },
      "settings": null,
      "settingsVersion": {
        "major": 1,
        "minor": 0,
        "patch": 0
      },
      "contributionId": "ms.vss-dashboards-web.Microsoft.VisualStudioOnline.Dashboards.TeamMembersWidget"
    }
  ]
}

Sample Response

Status code:: 200

{
  "id": "29653dd2-c18a-4d19-8333-e556c5b8d025",
  "name": "test",
  "position": 5,
  "eTag": "1",
  "widgets": [
    {
      "name": "Team Members renamed",
      "position": {
        "row": 2,
        "column": 2
      },
      "size": {
        "rowSpan": 1,
        "columnSpan": 2
      },
      "settings": null,
      "settingsVersion": {
        "major": 1,
        "minor": 0,
        "patch": 0
      },
      "contributionId": "ms.vss-dashboards-web.Microsoft.VisualStudioOnline.Dashboards.TeamMembersWidget"
    }
  ],
  "url": "https://dev.azure.com/fabrikam/99755c45-cb33-4ab4-9f36-e5920cec7ba9/dc0d32d0-be95-4385-9df6-1176d698be22/_apis/Dashboard/Dashboards/29653dd2-c18a-4d19-8333-e556c5b8d025",
  "_links": {
    "self": {
      "href": "https://dev.azure.com/fabrikam/99755c45-cb33-4ab4-9f36-e5920cec7ba9/dc0d32d0-be95-4385-9df6-1176d698be22/_apis/Dashboard/Dashboards/29653dd2-c18a-4d19-8333-e556c5b8d025"
    },
    "group": {
      "href": "https://dev.azure.com/fabrikam/99755c45-cb33-4ab4-9f36-e5920cec7ba9/dc0d32d0-be95-4385-9df6-1176d698be22/_apis/Dashboard/Dashboards"
    },
    "widget": [
      {
        "href": "https://dev.azure.com/fabrikam/99755c45-cb33-4ab4-9f36-e5920cec7ba9/dc0d32d0-be95-4385-9df6-1176d698be22/_apis/Dashboard/dashboards/29653dd2-c18a-4d19-8333-e556c5b8d025/Widgets/456afb86-ecf6-49cf-bbcc-1ab7d0fc14b2"
      }
    ]
  }
}

定義

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

Dashboard

儀表板的模型。

名稱	類型	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[]	儀表板上的 Widget 集合。

DashboardScope

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

名稱	類型	Description
collection_User	string	[已淘汰]儀表板的範圍設定為集合使用者。
project	string	儀表板的範圍設定為專案。
project_Team	string	儀表板的範圍限定于小組。

LightboxOptions

Lightbox 設定

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

ReferenceLinks

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

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

SemanticVersion

成品的版本控制，如： http://semver.org/ ，格式為 major.minor.patch。

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

小工具資料

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

名稱	類型	Description
column	integer
row	integer

WidgetSize

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

共用方式為