Dashboards - Get Dashboards In Group

リファレンス

Service:: Power BI REST APIs

API Version:: v1.0

指定したワークスペースからダッシュボードの一覧を返します。

アクセス許可

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

必要なスコープ

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

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

URI パラメーター

名前	/	必須	型	説明
groupId	path	True	string uuid	ワークスペース ID

応答

名前	型	説明
200 OK	Dashboards	OK

例

Example

Sample Request

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

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "69ffaa6c-b36d-4d01-96f5-1ed67c64d4af",
      "displayName": "SalesMarketing",
      "embedUrl": "https://app.powerbi.com/dashboardEmbed?dashboardId=69ffaa6c-b36d-4d01-96f5-1ed67c64d4af&groupId=f089354e-8366-4e18-aea3-4cb4a3a50b48",
      "isReadOnly": false
    }
  ]
}

定義

名前	説明
Dashboard	Power BI ダッシュボード。 API は、次のダッシュボードプロパティの一覧のサブセットを返します。サブセットは、呼び出された API、呼び出し元のアクセス許可、および Power BI データベース内のデータの可用性に依存します。
Dashboards	Power BI ダッシュボードコレクションの OData 応答ラッパー
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

Dashboards

Power BI ダッシュボードコレクションの OData 応答ラッパー

名前	型	説明
odata.context	string	OData コンテキスト
value	Dashboard[]	ダッシュボードコレクション

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 項目の種類 (、、`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	ユーザーの種類。