Admin - Reports GetReportsInGroupAsAdmin
指定したワークスペースからのレポートの一覧を返します。
権限
- ユーザーは、ファブリック管理者であるか、サービス プリンシパルを使用して認証されている必要があります。
- 委任されたアクセス許可がサポートされています。
サービス 特権認証で実行する場合、アプリ は、Azure portal で Power BI に対して管理者の同意が必要な事前使用許可を設定 することはできません。
必要なスコープ
Tenant.Read.All または Tenant.ReadWrite.All
標準の委任された管理者アクセス トークンを使用して認証する場合にのみ関連します。 サービス プリンシパル経由の認証を使用する場合は、存在しない必要があります。
制限
1 時間あたり最大 200 要求。
GET https://api.powerbi.com/v1.0/myorg/admin/groups/{groupId}/reports
GET https://api.powerbi.com/v1.0/myorg/admin/groups/{groupId}/reports?$filter={$filter}&$top={$top}&$skip={$skip}
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
group
|
path | True |
string (uuid) |
ワークスペース ID |
$filter
|
query |
string |
Odata フィルター クエリ パラメーター条件 |
|
$skip
|
query |
integer (int32) |
最初の n 件の結果をスキップします |
|
$top
|
query |
integer (int32) |
最初の n 個の結果のみを返します |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
わかりました |
例
Example
要求のサンプル
GET https://api.powerbi.com/v1.0/myorg/admin/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/reports
応答のサンプル
{
"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"
}
]
}
定義
名前 | 説明 |
---|---|
Admin |
管理者 API によって返される Power BI レポート。 この API は、次のレポート プロパティの一覧のサブセットを返します。 サブセットは、呼び出された API、呼び出し元のアクセス許可、および Power BI データベース内のデータの可用性に依存します。 |
Admin |
Power BI 管理者レポート コレクションの OData 応答ラッパー |
Principal |
プリンシパルの種類 |
Report |
レポートの Power BI ユーザー アクセス権エントリ |
Report |
ユーザーがレポートに対して持っているアクセス権 (アクセス許可レベル) |
Service |
Power BI サービス プリンシパル プロファイル。 Power BI Embedded マルチテナント ソリューションにのみ関連します。 |
Subscription |
Power BI アイテムのメール サブスクリプション (レポートやダッシュボードなど) |
Subscription |
Power BI メール サブスクリプション ユーザー |
AdminReport
管理者 API によって返される Power BI レポート。 この API は、次のレポート プロパティの一覧のサブセットを返します。 サブセットは、呼び出された API、呼び出し元のアクセス許可、および Power BI データベース内のデータの可用性に依存します。
名前 | 型 | 説明 |
---|---|---|
appId |
string |
レポートがアプリに属している場合にのみ返されるアプリ ID |
createdBy |
string |
レポートの所有者。 2019 年 6 月以降に作成されたレポートでのみ使用できます。 |
createdDateTime |
string (date-time) |
レポートの作成日時 |
datasetId |
string |
レポートのデータセット ID |
description |
string |
レポートの説明 |
embedUrl |
string |
レポートの埋め込み URL |
id |
string (uuid) |
レポート ID |
isOwnedByMe |
boolean |
現在のユーザーがレポートのコピーを変更または作成できるかどうかを示します。 |
modifiedBy |
string |
レポートを最後に変更したユーザー |
modifiedDateTime |
string (date-time) |
レポートが最後に変更された日時 |
name |
string |
レポートの名前。 アプリ レポートはプレフィックス [App] で始まります。 |
originalReportId |
string (uuid) |
ワークスペースがアプリとして発行されたときの実際のレポート ID。 |
reportType |
enum:
|
レポートの種類 |
subscriptions |
(空の値)Power BI アイテム (レポートやダッシュボードなど) のサブスクリプションの詳細。 このプロパティは、今後のリリースでペイロードの応答から削除されます。 Power BI レポートのサブスクリプション情報を取得するには、レポート サブスクリプションを管理者として取得 API 呼び出しを使用します。 |
|
users |
(空の値)Power BI レポートのユーザー アクセスの詳細。 このプロパティは、今後のリリースでペイロードの応答から削除されます。 Power BI レポートのユーザー情報を取得するには、Admin API 呼び出しとしてレポート ユーザーを取得するか、 パラメーターを使用した |
|
webUrl |
string |
レポートの Web URL |
workspaceId |
string (uuid) |
レポートのワークスペース ID (GUID)。 このプロパティは、GetReportsAsAdmin でのみ返されます。 |
AdminReports
Power BI 管理者レポート コレクションの OData 応答ラッパー
名前 | 型 | 説明 |
---|---|---|
@odata.context |
string |
OData コンテキスト |
value |
レポート コレクション |
PrincipalType
プリンシパルの種類
値 | 説明 |
---|---|
App |
サービス プリンシパルの種類 |
Group |
グループ プリンシパルの種類 |
None |
プリンシパルの種類はありません。 組織全体レベルのアクセスに使用します。 |
User |
ユーザー プリンシパルの種類 |
ReportUser
レポートの Power BI ユーザー アクセス権エントリ
名前 | 型 | 説明 |
---|---|---|
displayName |
string |
プリンシパルの表示名 |
emailAddress |
string |
ユーザーのメール アドレス |
graphId |
string |
Microsoft Graph のプリンシパルの識別子。 管理者 API でのみ使用できます。 |
identifier |
string |
プリンシパルの識別子 |
principalType |
プリンシパルの種類 |
|
profile |
Power BI サービス プリンシパル プロファイル。 Power BI Embedded マルチテナント ソリューションにのみ関連します。 |
|
reportUserAccessRight |
ユーザーがレポートに対して持っているアクセス権 (アクセス許可レベル) |
|
userType |
string |
ユーザーの種類。 |
ReportUserAccessRight
ユーザーがレポートに対して持っているアクセス権 (アクセス許可レベル)
値 | 説明 |
---|---|
None |
レポート内のコンテンツに対するアクセス許可がない |
Owner |
レポート内のコンテンツへの読み取り、書き込み、および再共有アクセスを許可します |
Read |
レポート内のコンテンツへの読み取りアクセス権を付与します |
ReadCopy |
レポート内のコンテンツへの読み取りとコピーのアクセス権を付与します |
ReadReshare |
レポート内のコンテンツへの読み取りと再共有のアクセス権を付与します |
ReadWrite |
レポート内のコンテンツに対する読み取りと書き込みのアクセス権を付与します |
ServicePrincipalProfile
Power BI サービス プリンシパル プロファイル。 Power BI Embedded マルチテナント ソリューションにのみ関連します。
名前 | 型 | 説明 |
---|---|---|
displayName |
string |
サービス プリンシパル プロファイル名 |
id |
string (uuid) |
サービス プリンシパル プロファイル ID |
Subscription
Power BI アイテムのメール サブスクリプション (レポートやダッシュボードなど)
名前 | 型 | 説明 |
---|---|---|
artifactDisplayName |
string |
サブスクライブされている Power BI アイテムの名前 (レポートやダッシュボードなど) |
artifactId |
string (uuid) |
サブスクライブした Power BI アイテムの ID (レポートやダッシュボードなど) |
artifactType |
string |
Power BI 項目の種類 ( |
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 |
各メール サブスクライバーの詳細。
Get User Subscriptions As Admin API 呼び出しを使用する場合、返される値は空の配列 (null) です。 このプロパティは、今後のリリースでペイロードの応答から削除されます。 Power BI レポートまたはダッシュボードでサブスクリプション情報を取得するには、 |
SubscriptionUser
Power BI メール サブスクリプション ユーザー
名前 | 型 | 説明 |
---|---|---|
displayName |
string |
プリンシパルの表示名 |
emailAddress |
string |
ユーザーのメール アドレス |
graphId |
string |
Microsoft Graph のプリンシパルの識別子。 管理者 API でのみ使用できます。 |
identifier |
string |
プリンシパルの識別子 |
principalType |
プリンシパルの種類 |
|
profile |
Power BI サービス プリンシパル プロファイル。 Power BI Embedded マルチテナント ソリューションにのみ関連します。 |
|
userType |
string |
ユーザーの種類。 |