共用方式為


Reports - Get Reports

[我的工作區] 傳回報表清單。

此 API 也會從共用應用程式傳回共用報表和報表。 您可以使用 取得群組 API 中的報表來存取位於共用工作區中的報表。

由於編頁報表 (RDL) 沒有數據集,因此不會顯示編頁報表 API 回應中的數據集標識符值。

必要範圍

Report.ReadWrite.All 或 Report.Read.All

GET https://api.powerbi.com/v1.0/myorg/reports

回應

名稱 類型 Description
200 OK

Reports

確定

範例

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/reports

Sample Response

{
  "value": [
    {
      "datasetId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "id": "5b218778-e7a5-4d73-8187-f10824047715",
      "name": "SalesMarketing",
      "webUrl": "https://app.powerbi.com//reports/5b218778-e7a5-4d73-8187-f10824047715",
      "embedUrl": "https://app.powerbi.com/reportEmbed?reportId=5b218778-e7a5-4d73-8187-f10824047715"
    }
  ]
}

定義

名稱 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
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 專案的訂用帳戶詳細數據, (例如報表或儀錶板) 。 這個屬性將會從即將推出的承載回應中移除。 您可以使用取得報表訂閱作為 API 呼叫 管理員,擷取 Power BI 報表的訂閱資訊。

users

ReportUser[]

(空白值) Power BI 報表的使用者存取詳細數據。 這個屬性將會從即將推出的承載回應中移除。 您可以使用取得報表使用者做為 管理員 API 呼叫,或使用 參數來擷取 Power BI 報表上的使用者資訊,或使用 參數擷getArtifactUsersPostWorkspaceInfo API 呼叫。

webUrl

string

報表的Web URL

Reports

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

名稱 類型 Description
odata.context

string

OData 內容

value

Report[]

報表集合

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 專案的類型 (例如 ReportDashboardDataset)

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

使用者的類型。