次の方法で共有

Imports - Post Import

サービス:
Power BI REST APIs
API バージョン:
v1.0

[マイ ワークスペース] に新しいコンテンツ作成します。

この API の使用例については、「大きなファイル PowerShell スクリプトをインポートする」を参照してください。

注

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

  • Power BI .pbix ファイル
  • JSON ファイル (.json)
  • Excel ファイル (.xlsx)
  • レポート定義言語ファイル (.rdl)
  • ファイルをインポートするには、要求ヘッダーで multipart/form-data コンテンツ タイプを指定し、要求本文で フォーム データとしてファイルをエンコードします。
  • ページ分割されたレポート (.rdl) ファイルをインポートするには、datasetDisplayNameで説明されているように、paginatedReport.rdlなどので指定された名前に .rdl ファイル拡張子を含めます。 datasetDisplayNameのファイル拡張子は、ページ分割されたレポート (.rdl ファイル) のアップロードを他のアップロードと区別するのに役立ちます。
  • OneDrive for Business から .xlsx ファイルをインポートするには、アプリケーション/json コンテンツ タイプを要求ヘッダーに含めます。 が要求本文の .xlsx ファイル パスに設定されている ImportInfo filePath 含めます。
  • サイズが 1 GB から 10 GB の大きな Power BI .pbix ファイルをインポートするには、「一時アップロード場所の作成」を参照してください。 これは、Premium 容量ワークスペースでのみサポートされます。
  • model.json ファイルからデータフローを作成するには、「datasetDisplayName説明されているように、 を model.jsonに設定します。

必要なスコープ

Dataset.ReadWrite.All（データセットの読み取りおよび書き込みのすべての権限）

制限事項

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

POST https://api.powerbi.com/v1.0/myorg/imports?datasetDisplayName={datasetDisplayName}
省略可能なパラメーターを含む: 
POST https://api.powerbi.com/v1.0/myorg/imports?datasetDisplayName={datasetDisplayName}&nameConflict={nameConflict}&skipReport={skipReport}&overrideReportLabel={overrideReportLabel}&overrideModelLabel={overrideModelLabel}&subfolderObjectId={subfolderObjectId}

URI パラメーター

名前 / 必須 型 説明
datasetDisplayName
 query True

string

データセットの表示名には、ファイル拡張子を含める必要があります。 OneDrive for Business からインポートする場合はサポートされません。
nameConflict
 query

ImportConflictHandlerMode

同じ名前のデータセットが既に存在する場合の対処方法を指定します。 既定値は Ignore です。 RDL ファイルの場合、サポートされているオプションは Abort と Overwrite だけです。他のオプションはサポートされていません。
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。

要求本文

名前 型 説明
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 ストレージの Shared Access Signature URL。

応答

名前 型 説明
200 OK

Import

わかりました
202 Accepted

Import

受け入れられた

例

Import dataflow example
Post import example
Post import with 'skipReport' example

Import dataflow example

要求のサンプル

POST https://api.powerbi.com/v1.0/myorg/imports?datasetDisplayName=model.json&nameConflict=Abort
要求本文
{
  "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--"
}

応答のサンプル

状態コード:
202 
{
  "id": "d02b8896-e247-4d83-ae5a-014028cb0665"
}

Post import example

要求のサンプル

POST https://api.powerbi.com/v1.0/myorg/imports?datasetDisplayName=MyReport&nameConflict=Ignore
要求本文
{
  "value": "--f05e5244-f876-43b9-bc87-d71598f6b32a Content-Disposition: form-data AA...ZZ --f05e5244-f876-43b9-bc87-d71598f6b32a--"
}

応答のサンプル

状態コード:
202 
{
  "id": "d02b8896-e247-4d83-ae5a-014028cb0665"
}

Post import with 'skipReport' example

要求のサンプル

POST https://api.powerbi.com/v1.0/myorg/imports?datasetDisplayName=MyReport&nameConflict=Ignore&skipReport=True&overrideReportLabel=True&overrideModelLabel=True
要求本文
{
  "value": "--f05e5244-f876-43b9-bc87-d71598f6b32a Content-Disposition: form-data AA...ZZ --f05e5244-f876-43b9-bc87-d71598f6b32a--"
}

応答のサンプル

状態コード:
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 だけです。他のオプションはサポートされていません。
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 ファイルのインポート接続の種類

値 説明
import
connect

Dataset

Object

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

名前 型 説明
ContentProviderType

string

無視する必要がある非推奨のプロパティ。
Encryption

Encryption

データセットの暗号化情報。 $expand が指定されている場合にのみ適用されます。
IsEffectiveIdentityRequired

boolean

データセットに有効な ID が必要かどうか。これは、GenerateToken API 呼び出しで送信する必要があります。
IsEffectiveIdentityRolesRequired

boolean

行レベルのセキュリティが Power BI .pbix ファイル内で定義されているかどうか。 その場合は、ロールを指定する必要があります。
IsInPlaceSharingEnabled

boolean

データセットを外部ユーザーと共有して自分のテナントで使用できるかどうかを指定します。
IsOnPremGatewayRequired

boolean

データセットにオンプレミス データ ゲートウェイが必要かどうか
IsRefreshable

boolean

このフィールドは、データセットが最近更新されたとき、または自動更新用に構成され、接続モードが特に "インポート" に設定されている場合に、true を返します。 この値は、データセットが手動で更新されるか、自動更新用に設定されているかに関係なく、'DirectQuery' や 'LiveConnection' などの他の接続モードの false を返します。
addRowsAPIEnabled

boolean

データセットで新しい行の追加が許可されるかどうか
configuredBy

string

データセットの所有者
createReportEmbedURL

string

データセット作成レポートの埋め込み URL
createdDate

string (date-time)

データセットの作成日時
description

string

データセットの説明
id

string

データセット ID
name

string

データセット名
qnaEmbedURL

string

データセット Q&A 埋め込み URL
queryScaleOutSettings

DatasetQueryScaleOutSettings

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

string

データセットストレージモード
upstreamDataflows

DependentDataflow[]

この項目が依存するすべてのデータフローの一覧
users

DatasetUser[]

(空の値)データセット のユーザー アクセスの詳細。 このプロパティは、今後のリリースでペイロードの応答から削除されます。 Power BI アイテム (レポートやダッシュボードなど) のユーザー情報を取得するには、Admin API としてデータセット ユーザーを取得するか、 パラメーターを使用して getArtifactUsers API を使用します。
webUrl

string

データセットの Web URL

DatasetQueryScaleOutSettings

Object

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

名前 型 説明
autoSyncReadOnlyReplicas

boolean

データセットが読み取り専用レプリカを自動的に同期するかどうか
maxReadOnlyReplicas

integer

minimum: -1
maximum: 64

データセットの読み取り専用レプリカの最大数 (レプリカの自動数の場合は 0 から 64、-1)

DatasetUser

Object

データセットの 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

データセット内のコンテンツへのアクセス許可を削除します
Read

データセット内のコンテンツへの読み取りアクセス権を付与します
ReadWrite

データセット内のコンテンツに対する読み取りと書き込みのアクセス権を付与します
ReadReshare

データセット内のコンテンツへの読み取りと再共有のアクセス権を付与します
ReadWriteReshare

データセット内のコンテンツへの読み取り、書き込み、および再共有アクセスを許可します
ReadExplore

データセット内のコンテンツへの読み取りと探索のアクセス権を付与します
ReadReshareExplore

データセット内のコンテンツへの読み取り、再共有、探索アクセスを許可します
ReadWriteExplore

データセット内のコンテンツへの読み取り、書き込み、探索のアクセス権を付与します
ReadWriteReshareExplore

データセット内のコンテンツへの読み取り、書き込み、再共有、探索アクセスを許可します

DependentDataflow

Object

Power BI 依存データフロー

名前 型 説明
groupId

string

ターゲット グループ ID
targetDataflowId

string

ターゲット データフロー ID

Encryption

Object

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

名前 型 説明
EncryptionStatus

EncryptionStatus

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

EncryptionStatus

列挙

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

値 説明
Unknown

データセットの破損により、暗号化の状態が不明です
NotSupported

このデータセットでは暗号化はサポートされていません
InSyncWithWorkspace

暗号化はサポートされており、暗号化設定と同期されています
NotInSyncWithWorkspace

暗号化はサポートされていますが、暗号化設定と同期されていません

Import

Object

インポート オブジェクト

名前 型 説明
createdDateTime

string (date-time)

作成日時をインポートする
datasets

Dataset[]

このインポートに関連付けられているデータセット
id

string (uuid)

インポート ID
importState enum:
  • Failed
  • Publishing
  • Succeeded

アップロードのインポートの状態
name

string

インポート名
reports

Report[]

このインポートに関連付けられているレポート
updatedDateTime

string (date-time)

最新の更新日時をインポートする

ImportConflictHandlerMode

列挙

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

値 説明
Ignore

同じ名前のデータセットが既に存在する場合、インポート操作によって同じ名前の新しいデータセットが作成されます。
Abort

同じ名前のデータセットが既に存在する場合、インポート操作は取り消されます。
Overwrite

同じ名前のデータセットが既に存在する場合、インポート操作によって既存のデータセットが新しいデータセットに置き換えられます。 競合がない場合、または同じ名前の既存のデータセットが複数存在する場合、インポート操作は失敗します。
CreateOrOverwrite

同じ名前のデータセットが既に存在する場合、インポート操作によって既存のデータセットが新しいデータセットに置き換えられます。 同じ名前の既存のデータセットが複数存在する場合、インポート操作は失敗します。
GenerateUniqueName

同じ名前のデータフローが既に存在する場合、インポート操作によって新しいデータフローの新しい一意の名前が生成されます。

ImportInfo

Object

インポートに関する情報

名前 型 説明
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 ストレージの Shared Access Signature URL。

PrincipalType

列挙

プリンシパルの種類

値 説明
None

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

ユーザー プリンシパルの種類
Group

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

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

Report

Object

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

名前 型 説明
appId

string

レポートがアプリに属している場合にのみ返されるアプリ ID
datasetId

string

レポートのデータセット ID
description

string

レポートの説明
embedUrl

string

レポートの埋め込み URL
format

string

レポート定義の形式の種類。 PowerBIReport の場合:

PaginatedReport の場合:
id

string (uuid)

レポート ID
isOwnedByMe

boolean

現在のユーザーがレポートのコピーを変更または作成できるかどうかを示します。
name

string

レポートの名前。 アプリ レポートはプレフィックス [App] で始まります。
originalReportId

string (uuid)

ワークスペースがアプリとして発行されたときの実際のレポート ID。
reportType enum:
  • PaginatedReport
  • PowerBIReport

レポートの種類
subscriptions

Subscription[]

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

ReportUser[]

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

string

レポートの Web URL

ReportUser

Object

レポートの 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

レポート内のコンテンツに対するアクセス許可がない
Read

レポート内のコンテンツへの読み取りアクセス権を付与します
ReadWrite

レポート内のコンテンツに対する読み取りと書き込みのアクセス権を付与します
ReadReshare

レポート内のコンテンツへの読み取りと再共有のアクセス権を付与します
ReadCopy

レポート内のコンテンツへの読み取りとコピーのアクセス権を付与します
Owner

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

ServicePrincipalProfile

Object

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

名前 型 説明
displayName

string

サービス プリンシパル プロファイル名
id

string (uuid)

サービス プリンシパル プロファイル ID

Subscription

Object

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

名前 型 説明
artifactDisplayName

string

サブスクライブされている Power BI アイテムの名前 (レポートやダッシュボードなど)
artifactId

string (uuid)

サブスクライブした Power BI アイテムの ID (レポートやダッシュボードなど)
artifactType

string

Power BI 項目の種類 (Report、Dashboard、Datasetなど)
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

SubscriptionUser[]

各メール サブスクライバーの詳細。 Get User Subscriptions As Admin API 呼び出しを使用する場合、返される値は空の配列 (null) です。 このプロパティは、今後のリリースでペイロードの応答から削除されます。 Power BI レポートまたはダッシュボードでサブスクリプション情報を取得するには、[レポート サブスクリプションを管理者として取得] を使用するか、[ダッシュボード サブスクリプションを管理者として取得] API 呼び出しを します。

SubscriptionUser

Object

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

名前 型 説明
displayName

string

プリンシパルの表示名
emailAddress

string

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

string

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

string

プリンシパルの識別子
principalType

PrincipalType

プリンシパルの種類
profile

ServicePrincipalProfile

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

string

ユーザーの種類。