Admin - Reports GetReportsAsAdmin

參考

服務:: Power BI REST APIs

API 版本:: v1.0

傳回組織的報表清單。

權限

用戶必須是網狀架構系統管理員，或使用服務主體進行驗證。
支援委派的許可權。

在服務原始驗證下執行時，應用程式不得在 Azure 入口網站中設定 Power BI 的任何系統管理員同意必要先決條件。

必要範圍

Tenant.Read.All 或 Tenant.ReadWrite.All

只有在透過標準委派的系統管理員存取令牌進行驗證時才相關。使用透過服務主體進行驗證時，不得存在。

局限性

每個租使用者每小時最多50個要求或每分鐘5個要求。

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

含選擇性參數:

GET https://api.powerbi.com/v1.0/myorg/admin/reports?$filter={$filter}&$top={$top}&$skip={$skip}

URI 參數

名稱	位於	類型	Description
$filter	query	string	根據 Odata 篩選查詢參數條件，傳回結果的子集。
$skip	query	integer (int32)	略過前 n 個結果
$top	query	integer (int32)	只傳回前 n 個結果

回應

名稱	類型	Description
200 OK	AdminReports	還行

範例

Example

範例要求

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

範例回覆

狀態碼:: 200

{
  "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",
      "workspaceId": "278e22a3-2aee-4057-886d-c3225423bc10"
    }
  ]
}

定義

名稱	Description
AdminReport	系統管理員 API 所傳回的 Power BI 報表。 API 會傳回下列報表屬性清單的子集。子集取決於呼叫的 API、呼叫端許可權，以及 Power BI 資料庫中數據的可用性。
AdminReports	Power BI Admin 報表集合的 OData 回應包裝函式
PrincipalType	主體類型
ReportUser	報表的 Power BI 使用者存取權專案
ReportUserAccessRight	使用者對於報表的存取權（權限等級）
ServicePrincipalProfile	Power BI 服務主體配置檔。僅與 Power BI Embedded 多租使用者解決方案相關。
Subscription	Power BI 專案的電子郵件訂閱（例如報表或儀錶板）
SubscriptionUser	Power BI 電子郵件訂閱使用者

AdminReport

Object

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

名稱	類型	Description
appId	string	只有在報表屬於應用程式時，才會傳回應用程式標識碼
createdBy	string	報表擁有者。僅適用於在 2019 年 6 月之後建立的報告。
createdDateTime	string (date-time)	報表建立日期和時間
datasetId	string	報表的數據集標識碼
description	string	報表描述
embedUrl	string	報表的內嵌 URL
id	string (uuid)	報表標識碼
isOwnedByMe	boolean	指出目前使用者是否能夠修改或建立報表複本。
modifiedBy	string	修改報表的最後一個使用者
modifiedDateTime	string (date-time)	上次修改報表的日期和時間
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
workspaceId	string (uuid)	報表的工作區標識碼（GUID）。此屬性只會在 GetReportsAsAdmin 中傳回。

AdminReports

Object

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

名稱	類型	Description
@odata.context	string	OData 內容
value	AdminReport[]	報表集合

PrincipalType

列舉型別

主體類型

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

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

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

共用方式為

Admin - Reports GetReportsAsAdmin

權限

必要範圍

局限性

URI 參數

回應

範例

Example

範例要求

範例回覆

定義

AdminReport

AdminReports

PrincipalType

ReportUser

ReportUserAccessRight

ServicePrincipalProfile

Subscription

SubscriptionUser

其他資源