Apps - Get Report

サービス:: Power BI REST APIs

API バージョン:: v1.0

指定したアプリから指定したレポートを返します。

必要なスコープ

Report.ReadWrite.All または Report.Read.All

制限事項

サービスプリンシパル認証はサポートされていません。

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

URI パラメーター

名前	/	必須	型	説明
appId	path	True	string (uuid)	アプリ ID
reportId	path	True	string (uuid)	レポート ID

応答

名前	型	説明
200 OK	Report	わかりました

例

Example

要求のサンプル

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

応答のサンプル

状態コード:: 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"
}

定義

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

列挙

プリンシパルの種類

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

Report

Object

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

名前	型	説明
appId	string	レポートがアプリに属している場合にのみ返されるアプリ ID
datasetId	string	レポートのデータセット ID
description	string	レポートの説明
embedUrl	string	レポートの埋め込み URL
format	string	レポート定義の形式の種類。 PowerBIReport の場合: PBIR PBIR-Legacy PaginatedReport の場合: `RDL`
id	string (uuid)	レポート ID
isOwnedByMe	boolean	現在のユーザーがレポートのコピーを変更または作成できるかどうかを示します。
name	string	レポートの名前。アプリレポートはプレフィックス [App] で始まります。
originalReportId	string (uuid)	ワークスペースがアプリとして発行されたときの実際のレポート ID。
reportType	enum: PaginatedReport PowerBIReport	レポートの種類
subscriptions	Subscription[]	(空の値)Power BI アイテム (レポートやダッシュボードなど) のサブスクリプションの詳細。このプロパティは、今後のリリースでペイロードの応答から削除されます。 Power BI レポートのサブスクリプション情報を取得するには、レポートサブスクリプションを管理者として取得 API 呼び出しを使用します。
users	ReportUser[]	(空の値)Power BI レポートのユーザーアクセスの詳細。このプロパティは、今後のリリースでペイロードの応答から削除されます。 Power BI レポートのユーザー情報を取得するには、Admin API 呼び出しとしてレポートユーザーを取得するか、パラメーターを使用した `getArtifactUsers` API 呼び出しを使用します。
webUrl	string	レポートの Web URL

ReportUser

Object

レポートの 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	レポート内のコンテンツに対するアクセス許可がない
Read	レポート内のコンテンツへの読み取りアクセス権を付与します
ReadWrite	レポート内のコンテンツに対する読み取りと書き込みのアクセス権を付与します
ReadReshare	レポート内のコンテンツへの読み取りと再共有のアクセス権を付与します
ReadCopy	レポート内のコンテンツへの読み取りとコピーのアクセス権を付与します
Owner	レポート内のコンテンツへの読み取り、書き込み、および再共有アクセスを許可します

ServicePrincipalProfile

Object

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

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

Subscription

Object

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

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

SubscriptionUser

Object

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

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

次の方法で共有

Apps - Get Report

必要なスコープ

制限事項

URI パラメーター

応答

例

Example

要求のサンプル

応答のサンプル

定義

PrincipalType

Report

ReportUser

ReportUserAccessRight

ServicePrincipalProfile

Subscription

SubscriptionUser