Imports - Post Import In Group

リファレンス

Service:: Power BI REST APIs

API Version:: v1.0

指定したワークスペースに新しいコンテンツを作成します。

注意

サポートされているコンテンツ:

Power BI .pbix ファイル
JSON ファイル (.json)
Excel ファイル (.xls)
SQL Server レポート定義言語ファイル (.rdl)

ファイルをインポートするには、要求ヘッダーでコンテンツタイプ multipart/form-data を指定し、要求本文でフォームデータとしてファイルをエンコードします。
.rdl ファイルをインポートするには、「URI パラメーター」で説明されているように、でdatasetDisplayName指定された名前にファイル拡張子を含めます。
OneDrive for Businessから .xlsx ファイルをインポートするには、要求ヘッダーにコンテンツタイプ application/json を含めます。 ImportInfo をfilePath、要求本文の .xlsx ファイルパスに設定して含めます。
サイズが 1 GB から 10 GB の大きな Power BI .pbix ファイルをインポートするには、「グループ内の一時アップロード場所のCreate」および「大きなファイルのインポート」PowerShell スクリプトを参照してください。これは、Premium 容量ワークスペースでのみサポートされます。
model.json ファイルからデータフローを作成するには、「URI パラメーター」で説明されているように、model.json に設定datasetDisplayNameします。

アクセス許可

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

必要なスコープ

Dataset.ReadWrite.All

制限事項

サービスプリンシパルを含むデータフローはサポートされていません。
OneDrive からの Power BI .pbix ファイルのインポートはサポートされていません。
保護された秘密度ラベルを持つファイルのインポートは、サービスプリンシパルではサポートされていません。

POST https://api.powerbi.com/v1.0/myorg/groups/{groupId}/imports?datasetDisplayName={datasetDisplayName}

With optional parameters:

POST https://api.powerbi.com/v1.0/myorg/groups/{groupId}/imports?datasetDisplayName={datasetDisplayName}&nameConflict={nameConflict}&skipReport={skipReport}&overrideReportLabel={overrideReportLabel}&overrideModelLabel={overrideModelLabel}&subfolderObjectId={subfolderObjectId}

URI パラメーター

名前	/	必須	型	説明
groupId	path	True	string uuid	ワークスペース ID
datasetDisplayName	query	True	string	データセットの表示名には、ファイル拡張子を含める必要があります。 OneDrive for Businessからインポートする場合はサポートされません。データフローをインポートまたは作成するには、このパラメーターをmodel.jsonにハードコーディングする必要があります。
nameConflict	query		ImportConflictHandlerMode	同じ名前のデータセットが既に存在する場合の対処方法を指定します。既定値は `Ignore` です。 RDL ファイルの場合は、 `Abort` と `Overwrite` のみがサポートされているオプションです。データフロー model.jsonファイルの場合は、 `AbortGenerateUniqueName` とのみがサポートされているオプションです。
overrideModelLabel	query		boolean	Power BI .pbix ファイルを再発行するときに、モデルの既存のラベルをオーバーライドするかどうかを指定します。サービスの既定値はです `true`。
overrideReportLabel	query		boolean	Power BI .pbix ファイルを再発行するときに、レポートの既存のラベルをオーバーライドするかどうか。サービスの既定値はです `true`。
skipReport	query		boolean	レポートのインポートをスキップするかどうか。指定する場合、値を `true` にする必要があります。 Power BI .pbix ファイルでのみサポートされます。
subfolderObjectId	query		string uuid	ファイルをサブフォルダーにインポートするサブフォルダー ID。

要求本文

Media Types: "application/json", "multipart/form-data"

名前	型	説明
connectionType	connectionType	OneDrive for Business ファイルのインポート接続の種類
filePath	string	インポートするOneDrive for Business Excel (.xlsx) ファイルのパス。絶対ファイルまたは相対ファイルを指定できます。 Power BI .pbix ファイルはサポートされていません。
fileUrl	string	サイズが 1 GB から 10 GB の大きな Power BI .pbix ファイルをインポートするために使用される一時 BLOB ストレージの共有アクセス署名 URL。

応答

名前	型	説明
200 OK	Import	OK
202 Accepted	Import	同意

例

Import dataflow model.json example

Post import example

Post import skip report example

Import dataflow model.json example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/groups/cfafbeb1-8037-4d0c-896e-a46fb27ff229/imports?datasetDisplayName=model.json&nameConflict=Abort&skipReport=True

Request Body

{
  "value": "--f05e5244-f876-43b9-bc87-d71598f6b32a Content-Disposition: form-data name=model.json; filename=model.json Content-Type: application/json [Contents of Model JSON Encoded] --f05e5244-f876-43b9-bc87-d71598f6b32a--"
}

Sample Response

Status code:: 202

{
  "id": "d02b8896-e247-4d83-ae5a-014028cb0665"
}

Post import example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/groups/cfafbeb1-8037-4d0c-896e-a46fb27ff229/imports?datasetDisplayName=MyReport&nameConflict=Ignore

Request Body

{
  "value": "--f05e5244-f876-43b9-bc87-d71598f6b32a Content-Disposition: form-data AA...ZZ --f05e5244-f876-43b9-bc87-d71598f6b32a--"
}

Sample Response

Status code:: 202

{
  "id": "d02b8896-e247-4d83-ae5a-014028cb0665"
}

Post import skip report example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/groups/cfafbeb1-8037-4d0c-896e-a46fb27ff229/imports?datasetDisplayName=MyReport&nameConflict=Ignore&skipReport=True&overrideReportLabel=True&overrideModelLabel=True

Request Body

{
  "value": "--f05e5244-f876-43b9-bc87-d71598f6b32a Content-Disposition: form-data AA...ZZ --f05e5244-f876-43b9-bc87-d71598f6b32a--"
}

Sample Response

Status code:: 202

{
  "id": "d02b8896-e247-4d83-ae5a-014028cb0665"
}

定義

名前	説明
connectionType	OneDrive for Business ファイルのインポート接続の種類
Dataset	Power BI データセット。この API は、次のデータセットプロパティの一覧のサブセットを返します。サブセットは、呼び出される API、呼び出し元のアクセス許可、および Power BI データベース内のデータの可用性によって異なります。
DatasetQueryScaleOutSettings	データセットのクエリスケールアウト設定
DatasetUser	データセットの Power BI ユーザーアクセス権エントリ
DatasetUserAccessRight	ユーザーがデータセットに対して持っているアクセス権 (アクセス許可レベル)
DependentDataflow	Power BI 依存データフロー
Encryption	データセットの暗号化情報
EncryptionStatus	データセットの暗号化の状態
Import	インポートオブジェクト
ImportConflictHandlerMode	同じ名前のデータセットが既に存在する場合の対処方法を指定します。既定値は `Ignore` です。 RDL ファイルの場合は、 `Abort` と `Overwrite` のみがサポートされるオプションです。データフロー model.jsonファイルの場合は、 `Abort` と `GenerateUniqueName` のみがサポートされるオプションです。
ImportInfo	インポートに関する情報
PrincipalType	プリンシパルの種類
Report	Power BI レポート。 API は、次のレポートプロパティの一覧のサブセットを返します。サブセットは、呼び出される API、呼び出し元のアクセス許可、および Power BI データベース内のデータの可用性に依存します。
ReportUser	レポートの Power BI ユーザーアクセス権エントリ
ReportUserAccessRight	ユーザーがレポートに対して持っているアクセス権 (アクセス許可レベル)
ServicePrincipalProfile	Power BI サービスプリンシパルプロファイル。マルチテナントソリューションPower BI Embeddedにのみ関連します。
Subscription	Power BI アイテムのメールサブスクリプション (レポートやダッシュボードなど)
SubscriptionUser	Power BI メールサブスクリプションユーザー

connectionType

OneDrive for Business ファイルのインポート接続の種類

名前	型	説明
connect	string
import	string

Dataset

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

名前	型	説明
ContentProviderType	string	データセットのコンテンツプロバイダーの種類
CreateReportEmbedURL	string	データセット作成レポートの埋め込み URL
CreatedDate	string	データセットの作成日時
Encryption	Encryption	データセットの暗号化情報。が指定されている場合 `$expand` にのみ適用されます。
IsEffectiveIdentityRequired	boolean	データセットに有効な ID が必要かどうか。これは GenerateToken API 呼び出しで送信する必要があります。
IsEffectiveIdentityRolesRequired	boolean	行レベルのセキュリティが Power BI .pbix ファイル内で定義されているかどうか。その場合は、ロールを指定する必要があります。
IsInPlaceSharingEnabled	boolean	データセットを外部ユーザーと共有して自分のテナントで使用できるかどうか
IsOnPremGatewayRequired	boolean	データセットにオンプレミスデータゲートウェイが必要かどうか
IsRefreshable	boolean	データセットが更新可能かどうか。 Power BI の更新可能なデータセットは、少なくとも 1 回更新されたデータセット、または有効な更新スケジュールが存在するデータセットです。
QnaEmbedURL	string	データセット Q&A 埋め込み URL
addRowsAPIEnabled	boolean	データセットで新しい行の追加を許可するかどうか
configuredBy	string	データセットの所有者
description	string	データセットの説明
id	string	データセット ID
name	string	データセット名
queryScaleOutSettings	DatasetQueryScaleOutSettings	データセットのスケールアウト設定のクエリ
targetStorageMode	string	データセットストレージモード
upstreamDataflows	DependentDataflow[]	この項目が依存するすべてのデータフローの一覧
users	DatasetUser[]	(空の値)データセットのユーザーアクセスの詳細。このプロパティは、今後のリリースでペイロード応答から削除されます。 Power BI アイテム (レポートやダッシュボードなど) のユーザー情報を取得するには、管理 API としてデータセットユーザーを取得するか、パラメーターを指定して PostWorkspaceInfo API を`getArtifactUsers`使用します。
webUrl	string	データセットの Web URL

DatasetQueryScaleOutSettings

データセットのクエリスケールアウト設定

名前	型	説明
autoSyncReadOnlyReplicas	boolean	データセットが読み取り専用レプリカを自動的に同期するかどうか
maxReadOnlyReplicas	integer	データセットの読み取り専用レプリカの最大数 (レプリカの自動数の場合は 0 から 64、-1)

DatasetUser

データセットの Power BI ユーザーアクセス権エントリ

名前	型	説明
datasetUserAccessRight	DatasetUserAccessRight	ユーザーがデータセットに対して持っているアクセス権 (アクセス許可レベル)
displayName	string	プリンシパルの表示名
emailAddress	string	ユーザーの電子メールアドレス
graphId	string	Microsoft Graph のプリンシパルの識別子。管理者 API でのみ使用できます。
identifier	string	プリンシパルの識別子
principalType	PrincipalType	プリンシパルの種類
profile	ServicePrincipalProfile	Power BI サービスプリンシパルプロファイル。マルチテナントソリューションPower BI Embeddedにのみ関連します。
userType	string	ユーザーの種類。

DatasetUserAccessRight

ユーザーがデータセットに対して持っているアクセス権 (アクセス許可レベル)

名前	型	説明
None	string	データセット内のコンテンツに対するアクセス許可を削除します
Read	string	データセット内のコンテンツへの読み取りアクセス権を付与します
ReadExplore	string	データセット内のコンテンツへの読み取りと探索のアクセス権を付与します
ReadReshare	string	データセット内のコンテンツへの読み取りと再共有のアクセス権を付与します
ReadReshareExplore	string	データセット内のコンテンツへの読み取り、再共有、探索アクセスを許可します
ReadWrite	string	データセット内のコンテンツに対する読み取りと書き込みのアクセス権を付与します
ReadWriteExplore	string	データセット内のコンテンツへの読み取り、書き込み、探索のアクセス権を付与します
ReadWriteReshare	string	データセット内のコンテンツへの読み取り、書き込み、再共有のアクセス権を付与します
ReadWriteReshareExplore	string	データセット内のコンテンツへの読み取り、書き込み、再共有、探索アクセスを許可します

DependentDataflow

Power BI 依存データフロー

名前	型	説明
groupId	string	ターゲットグループ ID
targetDataflowId	string	ターゲットデータフロー ID

Encryption

データセットの暗号化情報

名前	型	説明
EncryptionStatus	EncryptionStatus	データセットの暗号化の状態

EncryptionStatus

データセットの暗号化の状態

名前	型	説明
InSyncWithWorkspace	string	暗号化はサポートされており、暗号化設定と同期しています
NotInSyncWithWorkspace	string	暗号化はサポートされていますが、暗号化設定と同期されていません
NotSupported	string	このデータセットでは暗号化はサポートされていません
Unknown	string	データセットの破損により、暗号化の状態が不明です

Import

インポートオブジェクト

名前	型	説明
createdDateTime	string	作成日時のインポート
datasets	Dataset[]	このインポートに関連付けられているデータセット
id	string	インポート ID
importState	enum: Failed Publishing Succeeded	インポートアップロードの状態
name	string	インポート名
reports	Report[]	このインポートに関連付けられているレポート
updatedDateTime	string	最終更新日時のインポート

ImportConflictHandlerMode

同じ名前のデータセットが既に存在する場合の対処方法を指定します。既定値は Ignore です。 RDL ファイルの場合は、 Abort と Overwrite のみがサポートされるオプションです。データフロー model.jsonファイルの場合は、 Abort と GenerateUniqueName のみがサポートされるオプションです。

名前	型	説明
Abort	string	同じ名前のデータセットまたはデータフローが既に存在する場合、インポート操作は取り消されます。
CreateOrOverwrite	string	同じ名前のデータセットが既に存在する場合、インポート操作によって既存のデータセットが新しいデータセットに置き換えられます。同じ名前の既存のデータセットが複数ある場合、インポート操作は失敗します。
GenerateUniqueName	string	同じ名前のデータフローが既に存在する場合、インポート操作によって新しいデータフローの新しい一意の名前が生成されます。
Ignore	string	同じ名前のデータセットが既に存在する場合、インポート操作によって同じ名前の新しいデータセットが作成されます。
Overwrite	string	同じ名前のデータセットが既に存在する場合、インポート操作によって既存のデータセットが新しいデータセットに置き換えられます。競合がない場合、または同じ名前の既存のデータセットが複数ある場合、インポート操作は失敗します。

ImportInfo

インポートに関する情報

名前	型	説明
connectionType	connectionType	OneDrive for Business ファイルのインポート接続の種類
filePath	string	インポートするOneDrive for Business Excel (.xlsx) ファイルのパス。絶対ファイルまたは相対パスを指定できます。 Power BI .pbix ファイルはサポートされていません。
fileUrl	string	サイズが 1 GB から 10 GB の大きな Power BI .pbix ファイルをインポートするために使用される一時 BLOB ストレージの共有アクセス署名 URL。

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	ユーザーの種類。

次の方法で共有

Imports - Post Import In Group

アクセス許可

必要なスコープ

制限事項

URI パラメーター

要求本文

応答

例

Import dataflow model.json example

Sample Request

Sample Response

Post import example

Sample Request

Sample Response

Post import skip report example

Sample Request

Sample Response

定義

connectionType

Dataset

DatasetQueryScaleOutSettings

DatasetUser

DatasetUserAccessRight

DependentDataflow

Encryption

EncryptionStatus

Import

ImportConflictHandlerMode

ImportInfo

PrincipalType

Report

ReportUser

ReportUserAccessRight

ServicePrincipalProfile

Subscription

SubscriptionUser

その他のリソース