Admin - Reports GetReportsInGroupAsAdmin

リファレンス

Service:: Power BI REST APIs

API Version:: v1.0

指定したワークスペースからのレポートの一覧を返します。

アクセス許可

ユーザーは管理者権限 (Office 365グローバル管理者や Power BI サービス管理者など) を持っているか、サービスプリンシパルを使用して認証する必要があります。
委任されたアクセス許可がサポートされています。

サービスの prinicipal 認証で実行する場合、アプリには、Azure portalで Power BI に対して管理者の同意が必要な事前使用許可が設定されていない必要があります。

必要なスコープ

Tenant.Read.All または Tenant.ReadWrite.All

標準の委任された管理者アクセストークンを使用して認証する場合にのみ関連します。サービスプリンシパル経由の認証を使用する場合は、存在しない必要があります。

制限事項

1 時間あたり最大 200 要求。

GET https://api.powerbi.com/v1.0/myorg/admin/groups/{groupId}/reports

With optional parameters:

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

URI パラメーター

名前	/	必須	型	説明
groupId	path	True	string uuid	ワークスペース ID
$filter	query		string	ブール条件に基づいて結果をフィルター処理する
$skip	query		integer int32	最初の n 個の結果をスキップします
$top	query		integer int32	最初の n 個の結果のみを返します

応答

名前	型	説明
200 OK	AdminReports	OK

例

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/reports

Sample Response

Status code:: 200

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

定義

名前	説明
AdminReport	管理 API によって返される Power BI レポート。 API は、次のレポートプロパティの一覧のサブセットを返します。サブセットは、呼び出される API、呼び出し元のアクセス許可、および Power BI データベース内のデータの可用性に依存します。
AdminReports	Power BI 管理レポートコレクションの OData 応答ラッパー
PrincipalType	プリンシパルの種類
ReportUser	レポートの Power BI ユーザーアクセス権エントリ
ReportUserAccessRight	ユーザーがレポートに対して持っているアクセス権 (アクセス許可レベル)
ServicePrincipalProfile	Power BI サービスプリンシパルプロファイル。マルチテナントソリューションPower BI Embeddedにのみ関連します。
Subscription	Power BI アイテムのメールサブスクリプション (レポートやダッシュボードなど)
SubscriptionUser	Power BI メールサブスクリプションユーザー

AdminReport

管理 API によって返される Power BI レポート。 API は、次のレポートプロパティの一覧のサブセットを返します。サブセットは、呼び出される API、呼び出し元のアクセス許可、および Power BI データベース内のデータの可用性に依存します。

名前	型	説明
appId	string	レポートがアプリに属している場合にのみ返されるアプリ ID
createdBy	string	レポート所有者。 2019 年 6 月以降に作成されたレポートでのみ使用できます。
createdDateTime	string	レポートの作成日時
datasetId	string	レポートのデータセット ID
description	string	レポートの説明
embedUrl	string	レポートの埋め込み URL
id	string	レポート ID
isOwnedByMe	boolean	レポートが現在のユーザーによって作成されているかどうかを確認します。
modifiedBy	string	レポートを最後に変更したユーザー
modifiedDateTime	string	レポートが最後に変更された日時
name	string	レポートの名前
originalReportId	string	ワークスペースがアプリとして発行されたときの実際のレポート ID。
reportType	enum: PaginatedReport PowerBIReport	レポートの種類
subscriptions	Subscription[]	(空の値)Power BI アイテム (レポートやダッシュボードなど) のサブスクリプションの詳細。このプロパティは、今後のリリースでペイロード応答から削除されます。 Power BI レポートのサブスクリプション情報を取得するには、API 呼び出しとしてレポートサブスクリプションの取得管理使用します。
users	ReportUser[]	(空の値)Power BI レポートのユーザーアクセスの詳細。このプロパティは、今後のリリースでペイロード応答から削除されます。 Power BI レポートのユーザー情報を取得するには、レポートユーザーを管理 API 呼び出しとして取得するか、パラメーターを指定して PostWorkspaceInfo API 呼び出しを`getArtifactUsers`使用します。
webUrl	string	レポートの Web URL
workspaceId	string	レポートのワークスペース ID (GUID)。このプロパティは、GetReportsAsAdmin でのみ返されます。

AdminReports

Power BI 管理レポートコレクションの OData 応答ラッパー

名前	型	説明
odata.context	string	OData コンテキスト
value	AdminReport[]	レポートコレクション

PrincipalType

プリンシパルの種類

名前	型	説明
App	string	サービスプリンシパルの種類
Group	string	グループプリンシパルの種類
None	string	プリンシパルの種類はありません。 organization レベルのアクセス全体に使用します。
User	string	ユーザープリンシパルの種類

ReportUser

レポートの Power BI ユーザーアクセス権エントリ

名前	型	説明
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

ユーザーがレポートに対して持っているアクセス権 (アクセス許可レベル)

名前	型	説明
None	string	レポート内のコンテンツに対するアクセス許可がない
Owner	string	レポート内のコンテンツへの読み取り、書き込み、再共有のアクセス権を付与します
Read	string	レポート内のコンテンツへの読み取りアクセス権を付与します
ReadCopy	string	レポート内のコンテンツへの読み取りとコピーのアクセス権を付与します
ReadReshare	string	レポート内のコンテンツへの読み取りと再共有のアクセス権を付与します
ReadWrite	string	レポート内のコンテンツに対する読み取りと書き込みのアクセス権を付与します

ServicePrincipalProfile

Power BI サービスプリンシパルプロファイル。マルチテナントソリューションPower BI Embeddedにのみ関連します。

名前	型	説明
displayName	string	サービスプリンシパルプロファイル名
id	string	サービスプリンシパルプロファイル ID

Subscription

Power BI アイテムのメールサブスクリプション (レポートやダッシュボードなど)

名前	型	説明
artifactDisplayName	string	サブスクライブされている Power BI アイテムの名前 (レポートやダッシュボードなど)
artifactId	string	サブスクライブされている Power BI アイテムの ID (レポートやダッシュボードなど)
artifactType	string	Power BI 項目の種類 (、、または `Dataset`など`ReportDashboard`)
attachmentFormat	string	メールサブスクリプションに添付されているレポートの形式
endDate	string	メールサブスクリプションの終了日時
frequency	string	メールサブスクリプションの頻度
id	string	サブスクリプション ID
isEnabled	boolean	メールサブスクリプションが有効になっているかどうか
linkToContent	boolean	サブスクリプションリンクがメールサブスクリプションに存在するかどうか
previewImage	boolean	レポートのスクリーンショットがメールサブスクリプションに存在するかどうか
startDate	string	メールサブスクリプションの開始日時
subArtifactDisplayName	string	サブスクライブされている Power BI アイテムのページ名 (レポートの場合)。
title	string	アプリの名前
users	SubscriptionUser[]	各メールサブスクライバーの詳細。 Get User Subscriptions As 管理 API 呼び出しを使用する場合、返される値は空の配列 (null) です。このプロパティは、今後のリリースでペイロード応答から削除されます。 Power BI レポートまたはダッシュボードのサブスクリプション情報を取得するには、[レポートサブスクリプションを管理として取得] または [ダッシュボードサブスクリプションを管理 API 呼び出しとして取得する] を使用します。

SubscriptionUser

Power BI メールサブスクリプションユーザー

名前	型	説明
displayName	string	プリンシパルの表示名
emailAddress	string	ユーザーの電子メールアドレス
graphId	string	Microsoft Graph のプリンシパルの識別子。管理者 API でのみ使用できます。
identifier	string	プリンシパルの識別子
principalType	PrincipalType	プリンシパルの種類
profile	ServicePrincipalProfile	Power BI サービスプリンシパルプロファイル。マルチテナントソリューションPower BI Embeddedにのみ関連します。
userType	string	ユーザーの種類。

次の方法で共有