Dashboards - Get Dashboard

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

[マイ ワークスペース] から指定したダッシュボードを返します。

必要なスコープ

Dashboard.ReadWrite.All または Dashboard.Read.All

GET https://api.powerbi.com/v1.0/myorg/dashboards/{dashboardId}

URI パラメーター

名前 / 必須 型 説明
dashboardId
 path True

string

uuid

ダッシュボード ID

応答

名前 型 説明
200 OK

Dashboard

OK

例

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/dashboards/69ffaa6c-b36d-4d01-96f5-1ed67c64d4af

Sample Response

Status code:
200 
{
  "id": "69ffaa6c-b36d-4d01-96f5-1ed67c64d4af",
  "displayName": "SalesMarketing",
  "embedUrl": "https://app.powerbi.com/dashboardEmbed?dashboardId=69ffaa6c-b36d-4d01-96f5-1ed67c64d4af",
  "isReadOnly": false
}

定義

名前 説明
Dashboard

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

ダッシュボードの Power BI ユーザー アクセス権エントリ
DashboardUserAccessRight

ユーザーがダッシュボードに対して持っているアクセス権 (アクセス許可レベル)
PrincipalType

プリンシパルの種類
ServicePrincipalProfile

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

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

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

Dashboard

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

名前 型 説明
appId

string

ダッシュボードがアプリに属している場合にのみ返されるアプリ ID
displayName

string

ダッシュボードの表示名
embedUrl

string

ダッシュボードの埋め込み URL
id

string

ダッシュボード ID
isReadOnly

boolean

ダッシュボードが読み取り専用かどうか
subscriptions

Subscription[]

(空の値)Power BI アイテム (レポートやダッシュボードなど) のサブスクリプションの詳細。 このプロパティは、今後のリリースでペイロード応答から削除されます。 Power BI レポートのサブスクリプション情報を取得するには、API 呼び出しとしてレポート サブスクリプションの取得管理使用します。
users

DashboardUser[]

(空の値)ダッシュボードのユーザー アクセスの詳細。 このプロパティは、今後のリリースでペイロード応答から削除されます。 Power BI ダッシュボードでユーザー情報を取得するには、管理 API 呼び出しとしてダッシュボード ユーザーを取得するか、 パラメーターを指定して PostWorkspaceInfo API 呼び出しをgetArtifactUsers使用します。
webUrl

string

ダッシュボードの Web URL

DashboardUser

ダッシュボードの Power BI ユーザー アクセス権エントリ

名前 型 説明
dashboardUserAccessRight

DashboardUserAccessRight

ユーザーがダッシュボードに対して持っているアクセス権 (アクセス許可レベル)
displayName

string

プリンシパルの表示名
emailAddress

string

ユーザーの電子メール アドレス
graphId

string

Microsoft Graph のプリンシパルの識別子。 管理者 API でのみ使用できます。
identifier

string

プリンシパルの識別子
principalType

PrincipalType

プリンシパルの種類
profile

ServicePrincipalProfile

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

string

ユーザーの種類。

DashboardUserAccessRight

ユーザーがダッシュボードに対して持っているアクセス権 (アクセス許可レベル)

名前 型 説明
None

string

ダッシュボード内のコンテンツに対するアクセス許可がない
Owner

string

レポート内のコンテンツへの読み取り、書き込み、再共有アクセスを許可します
Read

string

ダッシュボード内のコンテンツへの読み取りアクセス権を付与します
ReadCopy

string

ダッシュボード内のコンテンツへの読み取りとコピーのアクセス権を付与します
ReadReshare

string

ダッシュボード内のコンテンツへの読み取りと再共有のアクセス権を付与します
ReadWrite

string

ダッシュボード内のコンテンツへの読み取りと書き込みのアクセス権を付与します

PrincipalType

プリンシパルの種類

名前 型 説明
App

string

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

string

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

string

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

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

ユーザーの種類。