Reports - Get Report In Group

  • リファレンス
Service:
Power BI REST APIs
API Version:
v1.0

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

アクセス許可

この API 呼び出しは、サービス プリンシパル プロファイルによって呼び出すことができます。 詳細については、「Power BI Embeddedのサービス プリンシパル プロファイル」を参照してください。

必要なスコープ

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

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

URI パラメーター

名前 / 必須 型 説明
groupId
 path True

string

uuid

ワークスペース ID
reportId
 path True

string

uuid

レポート ID

応答

名前 型 説明
200 OK

Report

OK

例

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/reports/5b218778-e7a5-4d73-8187-f10824047715

Sample Response

Status code:
200 
{
  "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"
}

定義

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

プリンシパルの種類

名前 型 説明
App

string

サービス プリンシパルの種類
Group

string

グループ プリンシパルの種類
None

string

プリンシパルの種類はありません。 organization レベル全体のアクセスに使用します。
User

string

ユーザー プリンシパルの種類

Report

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

名前 型 説明
appId

string

レポートがアプリに属している場合にのみ返されるアプリ ID
datasetId

string

レポートのデータセット ID
description

string

レポートの説明
embedUrl

string

レポートの埋め込み URL
id

string

レポート ID
isOwnedByMe

boolean

レポートが現在のユーザーによって作成されるかどうかを確認します。
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

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 項目の種類 (、、Dashboardまたは DatasetなどReport)
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

ユーザーの種類。