Apps - Get Report

參考

Service:: Power BI REST APIs

API Version:: v1.0

從指定的應用程式傳回指定的報表。

必要範圍

Report.ReadWrite.All 或 Report.Read.All

限制

不支援服務主體驗證。

GET https://api.powerbi.com/v1.0/myorg/apps/{appId}/reports/{reportId}

URI 參數

名稱	位於	必要	類型	Description
appId	path	True	string uuid	應用程式識別碼
reportId	path	True	string uuid	報表標識碼

回應

名稱	類型	Description
200 OK	Report	確定

範例

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/apps/3d9b93c6-7b6d-4801-a491-1738910904fd/reports/{reportId}

Sample Response

Status code:: 200

{
  "appId": "3d9b93c6-7b6d-4801-a491-1738910904fd",
  "datasetId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "66b2570c-d9d3-40b2-83d9-1095c6700041",
  "name": "SalesMarketing",
  "webUrl": "https://app.powerbi.com/reports/66b2570c-d9d3-40b2-83d9-1095c6700041",
  "embedUrl": "https://app.powerbi.com/reportEmbed?reportId=66b2570c-d9d3-40b2-83d9-1095c6700041&appId=3d9b93c6-7b6d-4801-a491-1738910904fd&config=eyJjbHVzdGVyVXJsIjoiaHR0cHM6Ly9XQUJJLVNPVVRILUNFTlRSQUwtVVMtcmVkaXJlY3QuYW5hbHlzaXMud2luZG93cy5uZXQifQ"
}

定義

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

PrincipalType

主體類型

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

Report

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

名稱	類型	Description
appId	string	只有在報表屬於應用程式時，才會傳回應用程式標識碼
datasetId	string	報表的數據集標識碼
description	string	報表描述
embedUrl	string	報表的內嵌 URL
id	string	報表標識碼
isOwnedByMe	boolean	判斷報表是否由目前使用者建立。
name	string	報表的名稱
originalReportId	string	當工作區發佈為應用程式時的實際報表標識碼。
reportType	enum: PaginatedReport PowerBIReport	報表類型
subscriptions	Subscription[]	(空白值) Power BI 專案的訂用帳戶詳細數據， (例如報表或儀錶板) 。這個屬性將會從即將推出的承載回應中移除。您可以使用取得報表訂閱作為 #DCF1953430281401D99C4CB6E4CCC98AE API 呼叫來擷取 Power BI 報表的訂閱資訊。
users	ReportUser[]	(空白值) Power BI 報表的使用者存取詳細數據。這個屬性將會從即將推出的承載回應中移除。您可以使用取得報表使用者做為管理員 API 呼叫，或使用參數來擷取 Power BI 報表的使用者`getArtifactUsers`資訊。
webUrl	string	報表的Web URL

ReportUser

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

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

ReportUserAccessRight

用戶對於報表的存取權， (許可權等級)

名稱	類型	Description
None	string	報表中的內容沒有許可權
Owner	string	授與報表中內容的讀取、寫入和重新共用存取權
Read	string	授與報表中內容的讀取許可權
ReadCopy	string	授與報表中內容的讀取和複製存取權
ReadReshare	string	授與報表中內容的讀取和重新共用存取權
ReadWrite	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	使用者的類型。

共用方式為