Dashboards - Get Dashboard In Group

服務:

Power BI REST APIs

API 版本:

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

範例要求

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

範例回覆

狀態碼:

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

Object

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

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

DashboardUser

Object

儀錶板的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	儀錶板中的內容沒有許可權
Owner	授與報表中內容的讀取、寫入和重新共用存取權
Read	授與儀錶板中內容的讀取許可權
ReadCopy	授與儀錶板中內容的讀取和複製存取權
ReadReshare	授與儀錶板中內容的讀取和重新共用存取權
ReadWrite	授與儀錶板中內容的讀取和寫入存取權

PrincipalType

列舉型別

主體類型

值	Description
App	服務主體類型
Group	群組主體類型
None	沒有主體類型。 用於整個組織層級存取。
User	用戶主體類型

ServicePrincipalProfile

Object

Power BI 服務主體配置檔。 僅與 Power BI Embedded 多租使用者解決方案相關。

名稱	類型	Description
displayName	string	服務主體配置檔名稱
id	string (uuid)	服務主體配置檔識別碼

Subscription

Object

Power BI 專案的電子郵件訂閱（例如報表或儀錶板）

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

SubscriptionUser

Object

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	使用者的類型。