共用方式為

Apps - Get Reports

服務:
Power BI REST APIs
API 版本:
v1.0

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

必要範圍

Report.ReadWrite.All 或 Report.Read.All

局限性

不支援服務主體驗證。 

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

URI 參數

名稱 位於 必要 類型 Description
appId
 path True

string (uuid)

應用程式識別碼

回應

名稱 類型 Description
200 OK

Reports

還行

範例

Example

範例要求

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

範例回覆

狀態碼:
200 
{
  "value": [
    {
      "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 資料庫中數據的可用性。
Reports

Power BI 報表集合的 OData 回應包裝函式
ReportUser

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

使用者對於報表的存取權 （權限等級）
ServicePrincipalProfile

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

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

Power BI 電子郵件訂閱使用者

PrincipalType

列舉型別

主體類型

值 Description
None

沒有主體類型。 用於整個組織層級存取。
User

用戶主體類型
Group

群組主體類型
App

服務主體類型

Report

Object

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

名稱 類型 Description
appId

string

只有在報表屬於應用程式時，才會傳回應用程式標識碼
datasetId

string

報表的數據集標識碼
description

string

報表描述
embedUrl

string

報表的內嵌 URL
format

string

報告定義格式類型。 針對 PowerBIReport：

關於 PaginatedReport：
id

string (uuid)

報表標識碼
isOwnedByMe

boolean

指出目前使用者是否能夠修改或建立報表複本。
name

string

報表的名稱。 應用程式報表開頭為前置詞 [App]。
originalReportId

string (uuid)

當工作區發佈為應用程式時，實際的報表標識符。
reportType enum:
  • PaginatedReport
  • PowerBIReport

報表類型
subscriptions

Subscription[]

（空白值）Power BI 專案的訂用帳戶詳細數據（例如報表或儀錶板）。 這個屬性將會從即將發行的承載回應中移除。 您可以使用 取得報表訂閱做為系統管理員 API 呼叫，來擷取 Power BI 報表的訂閱資訊。
users

ReportUser[]

（空白值）使用者存取 Power BI 報表的詳細數據。 這個屬性將會從即將發行的承載回應中移除。 您可以使用 取得報表使用者做為系統管理員 API 呼叫，或使用 參數來擷取 Power BI 報表上的使用者資訊，或 getArtifactUsers API 呼叫。
webUrl

string

報表的Web URL

Reports

Object

Power BI 報表集合的 OData 回應包裝函式

名稱 類型 Description
@odata.context

string

OData 內容
value

Report[]

報表集合

ReportUser

Object

報表的 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

報表中的內容沒有許可權
Read

授與報表中內容的讀取許可權
ReadWrite

授與報表中內容的讀取和寫入存取權
ReadReshare

授與讀取和重新共享報表中內容的存取權
ReadCopy

授與報表中內容的讀取和複製存取權
Owner

授與報表中內容的讀取、寫入和重新共用存取權

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

使用者的類型。