Dashboards - Get Dashboard In Group

參考

Service:: Power BI REST APIs

API Version:: v1.0

從指定的工作區傳回指定的儀表板。

權限

此 API 呼叫可由服務主體設定檔呼叫。如需詳細資訊，請參閱：Power BI Embedded中的服務主體設定檔。

必要範圍

Dashboard.ReadWrite.All 或 Dashboard.Read.All

GET https://api.powerbi.com/v1.0/myorg/groups/{groupId}/dashboards/{dashboardId}

URI 參數

名稱	位於	必要	類型	Description
dashboardId	path	True	string uuid	儀表板識別碼
groupId	path	True	string uuid	工作區識別碼

回應

名稱	類型	Description
200 OK	Dashboard	確定

範例

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/dashboards/69ffaa6c-b36d-4d01-96f5-1ed67c64d4af

Sample Response

Status code:: 200

{
  "id": "69ffaa6c-b36d-4d01-96f5-1ed67c64d4af",
  "displayName": "SalesMarketing",
  "embedUrl": "https://app.powerbi.com/dashboardEmbed?dashboardId=69ffaa6c-b36d-4d01-96f5-1ed67c64d4af&groupId=f089354e-8366-4e18-aea3-4cb4a3a50b48",
  "isReadOnly": false
}

定義

名稱	Description
Dashboard	Power BI 儀表板。 API 會傳回下列儀表板屬性清單的子集。子集取決於呼叫的 API、呼叫端許可權，以及 Power BI 資料庫中資料的可用性。
DashboardUser	儀表板的 Power BI 使用者存取權專案
DashboardUserAccessRight	使用者對於儀表板的存取權 (許可權等級)
PrincipalType	主體類型
ServicePrincipalProfile	Power BI 服務主體設定檔。僅適用于Power BI Embedded多租使用者解決方案。
Subscription	Power BI 專案的電子郵件訂閱 (，例如報表或儀表板)
SubscriptionUser	Power BI 電子郵件訂用帳戶使用者

Dashboard

Power BI 儀表板。 API 會傳回下列儀表板屬性清單的子集。子集取決於呼叫的 API、呼叫端許可權，以及 Power BI 資料庫中資料的可用性。

名稱	類型	Description
appId	string	只有在儀表板屬於應用程式時，才會傳回應用程式識別碼
displayName	string	儀表板的顯示名稱
embedUrl	string	儀表板的內嵌 URL
id	string	儀表板識別碼
isReadOnly	boolean	儀表板是否為唯讀
subscriptions	Subscription[]	(空白值) Power BI 專案的訂用帳戶詳細資料 (，例如報表或儀表板) 。這個屬性將會從即將發行的承載回應中移除。您可以使用取得報表訂閱作為管理員 API 呼叫，來擷取 Power BI 報表的訂用帳戶資訊。
users	DashboardUser[]	(空白值) 儀表板使用者存取詳細資料。這個屬性將會從即將發行的承載回應中移除。您可以使用取得儀表板使用者作為管理員API 呼叫，或使用`getArtifactUsers` 參數來擷取 Power BI 儀表板上的使用者資訊。
webUrl	string	儀表板的 Web URL

DashboardUser

儀表板的 Power BI 使用者存取權專案

名稱	類型	Description
dashboardUserAccessRight	DashboardUserAccessRight	使用者對於儀表板的存取權 (許可權等級)
displayName	string	主體的顯示名稱
emailAddress	string	使用者的電子郵件地址
graphId	string	Microsoft Graph 中主體的識別碼。僅適用于系統管理員 API。
identifier	string	主體的識別碼
principalType	PrincipalType	主體類型
profile	ServicePrincipalProfile	Power BI 服務主體設定檔。僅適用于Power BI Embedded多租使用者解決方案。
userType	string	使用者的型別。

DashboardUserAccessRight

使用者對於儀表板的存取權 (許可權等級)

名稱	類型	Description
None	string	儀表板中的內容沒有許可權
Owner	string	授與報表中內容的讀取、寫入和重新共用存取權
Read	string	授與儀表板中內容的讀取權限
ReadCopy	string	授與儀表板中內容的讀取和複製存取權
ReadReshare	string	授與儀表板中內容的讀取和重新共用存取權
ReadWrite	string	授與儀表板中內容的讀取和寫入存取權

PrincipalType

主體類型

名稱	類型	Description
App	string	服務主體類型
Group	string	群組主體類型
None	string	沒有主體類型。用於整個組織層級存取。
User	string	使用者主體類型

ServicePrincipalProfile

Power BI 服務主體設定檔。僅適用于Power BI Embedded多租使用者解決方案。

名稱	類型	Description
displayName	string	服務主體設定檔名稱
id	string	服務主體設定檔識別碼

Subscription

Power BI 專案的電子郵件訂閱 (，例如報表或儀表板)

名稱	類型	Description
artifactDisplayName	string	訂閱的 Power BI 專案名稱 (，例如報表或儀表板)
artifactId	string	訂閱 Power BI 專案 (識別碼，例如報表或儀表板)
artifactType	string	Power BI 專案的類型 (例如 `Report` 、 `Dashboard` 或 `Dataset`)
attachmentFormat	string	電子郵件訂閱中附加的報表格式
endDate	string	電子郵件訂閱的結束日期和時間
frequency	string	電子郵件訂閱的頻率
id	string	訂用帳戶識別碼
isEnabled	boolean	是否啟用電子郵件訂閱
linkToContent	boolean	電子郵件訂閱中是否有訂用帳戶連結
previewImage	boolean	報表的螢幕擷取畫面是否存在於電子郵件訂閱中
startDate	string	電子郵件訂閱的開始日期和時間
subArtifactDisplayName	string	如果訂閱的 Power BI 專案是報表，則為頁面名稱。
title	string	應用程式名稱
users	SubscriptionUser[]	每個電子郵件訂閱者的詳細資料。使用取得使用者訂用帳戶作為管理員API 呼叫時，傳回的值是空陣列， (null) 。這個屬性將會從即將發行的承載回應中移除。您可以使用取得報表訂閱作為管理員或取得儀表板訂用帳戶作為管理員API 呼叫，來擷取 Power BI 報表或儀表板上的訂用帳戶資訊。

SubscriptionUser

Power BI 電子郵件訂用帳戶使用者

名稱	類型	Description
displayName	string	主體的顯示名稱
emailAddress	string	使用者的電子郵件地址
graphId	string	Microsoft Graph 中主體的識別碼。僅適用于系統管理員 API。
identifier	string	主體的識別碼
principalType	PrincipalType	主體類型
profile	ServicePrincipalProfile	Power BI 服務主體設定檔。僅適用于Power BI Embedded多租使用者解決方案。
userType	string	使用者的型別。

共用方式為