Reports - Clone Report

リファレンス

Service:: Power BI REST APIs

API Version:: v1.0

指定したレポートを [マイワークスペース] から複製します。

複製されたレポートのデータセットが 2 つの異なるワークスペースまたは マイワークスペースに存在する場合は、レポートのワークスペースに共有データセットが作成されます。
複製すると、ライブ接続を持つレポートはその接続を失い、代わりにターゲットデータセットへの直接バインドを持ちます。

アクセス許可

要件が適用されない場合を除き、ユーザーは次のすべてを持っている必要があります。

指定したレポートに対する書き込みアクセス許可。
パラメーターを使用する場合に必要な、ターゲットデータセットに対するtargetModelIdビルドアクセス許可。

必要なスコープ

Content.Create

POST https://api.powerbi.com/v1.0/myorg/reports/{reportId}/Clone

URI パラメーター

名前	/	必須	型	説明
reportId	path	True	string uuid	レポート ID

要求本文

名前	必須	型	説明
name	True	string	新しいレポート名
targetModelId		string	省略可能。ターゲットに関連付けられたデータセット ID を指定するためのパラメーター。指定しない場合、新しいレポートはソースレポートと同じデータセットに関連付けられます。
targetWorkspaceId		string	省略可能。ターゲットワークスペース ID を指定するためのパラメーター。空の GUID (`00000000-0000-0000-0000-000000000000`) は、マイワークスペースを示します。このパラメーターを指定しない場合、新しいレポートはソースレポートと同じワークスペース内に複製されます。

応答

名前	型	説明
200 OK	Report	OK

例

Example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/reports/cfafbeb1-8037-4d0c-896e-a46fb27ff229/Clone

Request Body

{
  "name": "New Report Name",
  "targetModelId": "8e4d5880-81d6-4804-ab97-054665050799",
  "targetWorkspaceId": "2f42a406-a075-4a15-bbf2-97ef958c94cb"
}

Sample Response

Status code:: 200

定義

名前	説明
CloneReportRequest	Power BI クローンレポート要求
PrincipalType	プリンシパルの種類
Report	Power BI レポート。 API は、次のレポートプロパティの一覧のサブセットを返します。サブセットは、呼び出される API、呼び出し元のアクセス許可、および Power BI データベース内のデータの可用性に依存します。
ReportUser	レポートの Power BI ユーザーアクセス権エントリ
ReportUserAccessRight	ユーザーがレポートに対して持っているアクセス権 (アクセス許可レベル)
ServicePrincipalProfile	Power BI サービスプリンシパルプロファイル。マルチテナントソリューションPower BI Embeddedにのみ関連します。
Subscription	Power BI アイテムのメールサブスクリプション (レポートやダッシュボードなど)
SubscriptionUser	Power BI メールサブスクリプションユーザー

CloneReportRequest

Power BI クローンレポート要求

名前	型	説明
name	string	新しいレポート名
targetModelId	string	省略可能。ターゲットに関連付けられたデータセット ID を指定するためのパラメーター。指定しない場合、新しいレポートはソースレポートと同じデータセットに関連付けられます。
targetWorkspaceId	string	省略可能。ターゲットワークスペース ID を指定するためのパラメーター。空の GUID (`00000000-0000-0000-0000-000000000000`) は、マイワークスペースを示します。このパラメーターを指定しない場合、新しいレポートはソースレポートと同じワークスペース内に複製されます。

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