Dashboards - Create

リファレンス

Service:: Dashboard

API Version:: 6.0-preview.3

提供されたダッシュボードを作成します。

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

URI パラメーター

名前	/	必須	型	説明
organization	path	True	string	Azure DevOps 組織の名前です。
project	path	True	string	プロジェクト ID またはプロジェクト名
team	path		string	チーム ID またはチーム名
api-version	query	True	string	使う API のバージョン。このバージョンの API を使用するには、これを '6.0-preview.3' に設定する必要があります。

要求本文

名前	型	説明
_links	ReferenceLinks	REST 参照リンクのコレクションを表すクラス。
dashboardScope	DashboardScope	ダッシュボードのスコープを設定するエンティティ。
description	string	ダッシュボードの説明。
eTag	string	編集の競合検出に使用される、サーバー定義のバージョン追跡値。
groupId	string	ダッシュボードのグループの ID。チームスコープのダッシュボードの場合、これはダッシュボードに関連付けられているチームの一意の識別子です。プロジェクトスコープのダッシュボードの場合、このプロパティは空です。
id	string	ダッシュボードの ID。作成時にサービスによって提供されます。
name	string	ダッシュボードの名前。
ownerId	string	ダッシュボードの所有者の ID。チームスコープのダッシュボードの場合、これはダッシュボードに関連付けられているチームの一意の識別子です。プロジェクトスコープのダッシュボードの場合、これはダッシュボードに関連付けられているユーザー ID の一意の識別子です。
position	integer	ダッシュボードグループ内のダッシュボードの位置。作成時に設定を解除した場合、位置はサービスによって決定されます。
refreshInterval	integer	クライアントがダッシュボードを自動的に更新する間隔。分単位で表されます。
url	string
widgets	Widget[]	ダッシュボード上のウィジェットのセット。

応答

名前	型	説明
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

名前	説明
vso.dashboards_manage	チームダッシュボード情報を管理する機能を付与します

例

Sample Request

HTTP

POST https://dev.azure.com/fabrikam/{project}/_apis/dashboard/dashboards?api-version=6.0-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"
      }
    ]
  }
}

定義

名前	説明
Dashboard	ダッシュボードのモデル。
DashboardScope	ダッシュボードのスコープを設定するエンティティ。
LightboxOptions	ライトボックスの構成
ReferenceLinks	REST 参照リンクのコレクションを表すクラス。
SemanticVersion	「major.minor.patch」という形式の成果物 http://semver.org/のバージョン管理。
Widget	ウィジェットデータ
WidgetPosition
WidgetSize

Dashboard

ダッシュボードのモデル。

名前	型	説明
_links	ReferenceLinks	REST 参照リンクのコレクションを表すクラス。
dashboardScope	DashboardScope	ダッシュボードのスコープを設定するエンティティ。
description	string	ダッシュボードの説明。
eTag	string	編集の競合検出に使用される、サーバー定義のバージョン追跡値。
groupId	string	ダッシュボードのグループの ID。チームスコープのダッシュボードの場合、これはダッシュボードに関連付けられているチームの一意の識別子です。プロジェクトスコープのダッシュボードの場合、このプロパティは空です。
id	string	ダッシュボードの ID。作成時にサービスによって提供されます。
name	string	ダッシュボードの名前。
ownerId	string	ダッシュボードの所有者の ID。チームスコープのダッシュボードの場合、これはダッシュボードに関連付けられているチームの一意の識別子です。プロジェクトスコープのダッシュボードの場合、これはダッシュボードに関連付けられているユーザー ID の一意の識別子です。
position	integer	ダッシュボードグループ内のダッシュボードの位置。作成時に設定を解除した場合、位置はサービスによって決定されます。
refreshInterval	integer	クライアントがダッシュボードを自動的に更新する間隔。分単位で表されます。
url	string
widgets	Widget[]	ダッシュボード上のウィジェットのセット。

DashboardScope

ダッシュボードのスコープを設定するエンティティ。

名前	型	説明
collection_User	string	[非推奨]ダッシュボードのスコープはコレクションユーザーです。
project	string	ダッシュボードのスコープはプロジェクトです。
project_Team	string	ダッシュボードのスコープはチームです。

LightboxOptions

ライトボックスの構成

名前	型	説明
height	integer	必要なライトボックスの高さ (ピクセル単位)
resizable	boolean	ライトボックスのサイズ変更を許可する場合は True、ライトボックスのサイズ変更を許可しない場合は false、既定値は false です。
width	integer	目的のライトボックスの幅 (ピクセル単位)

ReferenceLinks

REST 参照リンクのコレクションを表すクラス。

名前	型	説明
links	object	リンクの読み取り時ビュー。参照リンクは読み取り専用であるため、参照リンクは読み取り専用として公開する必要があります。

SemanticVersion

「major.minor.patch」という形式の成果物 http://semver.org/のバージョン管理。

名前	型	説明
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	指定されたウィジェット構成を定義する基になるコントリビューションの ID。
dashboard	Dashboard	ウィジェットレベル API のダッシュボードレベルバージョン ETag の交換をサポートするオプションの部分的なダッシュボードコンテンツ
eTag	string
id	string
isEnabled	boolean
isNameConfigurable	boolean
lightboxOptions	LightboxOptions	ライトボックスの構成
loadingImageUrl	string
name	string
position	WidgetPosition
settings	string
settingsVersion	SemanticVersion	「major.minor.patch」という形式の成果物 http://semver.org/のバージョン管理。
size	WidgetSize
typeId	string
url	string

WidgetPosition

名前	型	説明
column	integer
row	integer

WidgetSize

名前	型	説明
columnSpan	integer	ダッシュボードのグリッド列で表されるウィジェットの幅。
rowSpan	integer	ダッシュボードグリッド行で表されるウィジェットの高さ。