Imports - Post Import In Group
在指定的工作區中建立新的內容。
注意
支援的內容:
- Power BI .pbix 檔案
- JSON 檔案 (.json)
- Excel 檔案 (.xlsx)
- SQL Server 報表定義語言檔案 (.rdl)
- 若要匯入檔案,請在要求標頭中指定內容類型 multipart/form-data ,並將檔案編碼為要求本文中的 窗體數據 。
- 若要匯入 .rdl 檔案,請在 所
datasetDisplayName
指定的名稱中包含擴展名,如 URI 參數中所述。 - 若要從 商務用 OneDrive 匯入 .xlsx 檔案,請在要求標頭中包含內容類型應用程式/json。 包含 ImportInfo ,並將
filePath
設定為要求本文中的 .xlsx 檔案路徑。 - 若要匯入大小介於 1 GB 到 10 GB 之間的大型 Power BI .pbix 檔案,請參閱 在群組中建立暫時上傳位置 ,以及 匯入大型檔案 PowerShell 腳本。 只有 Premium 容量工作區才支援此功能。
- 若要從model.json檔案建立數據流,請將 設定
datasetDisplayName
為 model.json,如 URI 參數中所述。
權限
此 API 呼叫可由服務主體配置檔呼叫。 如需詳細資訊,請參閱:Power BI Embedded 中的服務主體配置檔。
必要範圍
Dataset.ReadWrite.All
限制
- 不支援具有服務主體的數據流。
- 不支援從 OneDrive 匯入 Power BI .pbix 檔案。
- 服務主體不支持匯入具有 受保護 敏感度標籤的檔案。
POST https://api.powerbi.com/v1.0/myorg/groups/{groupId}/imports?datasetDisplayName={datasetDisplayName}
POST https://api.powerbi.com/v1.0/myorg/groups/{groupId}/imports?datasetDisplayName={datasetDisplayName}&nameConflict={nameConflict}&skipReport={skipReport}&overrideReportLabel={overrideReportLabel}&overrideModelLabel={overrideModelLabel}
URI 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
group
|
path | True |
string uuid |
工作區識別碼 |
dataset
|
query | True |
string |
數據集的顯示名稱應包含擴展名。 從 商務用 OneDrive 匯入時不支援。 若要匯入或建立數據流,此參數應該硬式編碼為model.json。 |
name
|
query |
指定如果具有相同名稱的數據集已經存在,該怎麼辦。 預設值是 |
||
override
|
query |
boolean |
決定是否要在重新發佈Power BI .pbix 檔案時覆寫模型上的現有標籤。 服務預設值為 |
|
override
|
query |
boolean |
重新發佈Power BI .pbix 檔案時,是否要覆寫報表上的現有標籤。 服務預設值為 |
|
skip
|
query |
boolean |
是否要略過報表匯入。 如果指定,此值必須是 |
要求本文
Media Types: "application/json", "multipart/form-data"
名稱 | 類型 | Description |
---|---|---|
connectionType |
商務用 OneDrive 檔案的匯入連線類型 |
|
filePath |
string |
要匯入 商務用 OneDrive Excel (.xlsx) 檔案的路徑,可以是絕對或相對的。 不支援 Power BI .pbix 檔案。 |
fileUrl |
string |
暫存 Blob 記憶體的共用存取簽章 URL,用來匯入大小介於 1 GB 到 10 GB 之間的大型 Power BI .pbix 檔案。 |
回應
名稱 | 類型 | Description |
---|---|---|
200 OK |
確定 |
|
202 Accepted |
已接受 |
範例
Import dataflow model. |
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
{
"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
{
"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
{
"value": "--f05e5244-f876-43b9-bc87-d71598f6b32a Content-Disposition: form-data AA...ZZ --f05e5244-f876-43b9-bc87-d71598f6b32a--"
}
Sample Response
{
"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
{
"value": "--f05e5244-f876-43b9-bc87-d71598f6b32a Content-Disposition: form-data AA...ZZ --f05e5244-f876-43b9-bc87-d71598f6b32a--"
}
Sample Response
{
"id": "d02b8896-e247-4d83-ae5a-014028cb0665"
}
定義
名稱 | Description |
---|---|
connection |
商務用 OneDrive 檔案的匯入連接類型 |
Dataset |
Power BI 數據集。 API 會傳回下列資料集屬性清單的子集。 子集取決於稱為的 API、呼叫端許可權,以及 Power BI 資料庫中數據的可用性。 |
Dataset |
查詢數據集的向外延展設定 |
Dataset |
數據集的 Power BI 使用者存取權專案 |
Dataset |
使用者對於數據集的存取權, (許可權等級) |
Dependent |
Power BI 相依數據流 |
Encryption |
數據集的加密資訊 |
Encryption |
數據集加密狀態 |
Import |
匯入物件 |
Import |
指定如果具有相同名稱的數據集已經存在,該怎麼做。 預設值是 |
Import |
匯入的相關信息 |
Principal |
主體類型 |
Report |
Power BI 報表。 API 會傳回下列報表屬性清單的子集。 子集取決於呼叫的 API、呼叫端許可權,以及 Power BI 資料庫中數據的可用性。 |
Report |
報表的 Power BI 使用者存取權專案 |
Report |
用戶對於報表的存取權 (許可權等級) |
Service |
Power BI 服務 主體配置檔。 僅適用於 Power BI Embedded 多租用戶解決方案。 |
Subscription |
Power BI 專案的電子郵件訂閱 (,例如報表或儀錶板) |
Subscription |
Power BI 電子郵件訂用帳戶使用者 |
connectionType
商務用 OneDrive 檔案的匯入連接類型
名稱 | 類型 | Description |
---|---|---|
connect |
string |
|
import |
string |
Dataset
Power BI 數據集。 API 會傳回下列資料集屬性清單的子集。 子集取決於稱為的 API、呼叫端許可權,以及 Power BI 資料庫中數據的可用性。
名稱 | 類型 | Description |
---|---|---|
ContentProviderType |
string |
數據集的內容提供者類型 |
CreateReportEmbedURL |
string |
數據集建立報表內嵌 URL |
CreatedDate |
string |
數據集建立日期和時間 |
Encryption |
數據集加密資訊。 只有在指定 時才 |
|
IsEffectiveIdentityRequired |
boolean |
數據集是否需要有效的身分識別,您必須在 GenerateToken API 呼叫中傳送。 |
IsEffectiveIdentityRolesRequired |
boolean |
數據列層級安全性是否定義於Power BI .pbix檔案內。 如果是,您必須指定角色。 |
IsInPlaceSharingEnabled |
boolean |
是否可以與外部使用者共享數據集,以在自己的租用戶中取用 |
IsOnPremGatewayRequired |
boolean |
數據集是否需要內部部署數據閘道 |
IsRefreshable |
boolean |
數據集是否可重新整理。 Power BI 可重新整理數據集是至少重新整理一次的數據集,或有效的重新整理排程存在。 |
QnaEmbedURL |
string |
數據集 Q&內嵌 URL |
addRowsAPIEnabled |
boolean |
數據集是否允許新增數據列 |
configuredBy |
string |
數據集擁有者 |
description |
string |
數據集描述 |
id |
string |
數據集標識碼 |
name |
string |
數據集名稱 |
queryScaleOutSettings |
查詢數據集的向外延展設定 |
|
targetStorageMode |
string |
數據集儲存模式 |
upstreamDataflows |
此專案所依存的所有資料流清單 |
|
users |
(空白值) 數據集使用者存取詳細數據。 這個屬性將會從即將推出的承載回應中移除。 您可以使用取得數據集使用者作為 管理員 API,或使用 參數的 PostWorkspaceInfo API |
|
webUrl |
string |
數據集的 Web URL |
DatasetQueryScaleOutSettings
查詢數據集的向外延展設定
名稱 | 類型 | Description |
---|---|---|
autoSyncReadOnlyReplicas |
boolean |
數據集是否自動同步只讀複本 |
maxReadOnlyReplicas |
integer |
數據集的只讀複本數目上限, (0-64,-1 表示自動複本數目) |
DatasetUser
數據集的 Power BI 使用者存取權專案
名稱 | 類型 | Description |
---|---|---|
datasetUserAccessRight |
使用者對於數據集的存取權, (許可權等級) |
|
displayName |
string |
主體的顯示名稱 |
emailAddress |
string |
使用者的電子郵件地址 |
graphId |
string |
Microsoft Graph 中主體的標識碼。 僅適用於系統管理員 API。 |
identifier |
string |
主體的標識碼 |
principalType |
主體類型 |
|
profile |
Power BI 服務 主體配置檔。 僅適用於 Power BI Embedded 多租用戶解決方案。 |
|
userType |
string |
使用者的型別。 |
DatasetUserAccessRight
使用者對於數據集的存取權, (許可權等級)
名稱 | 類型 | Description |
---|---|---|
None |
string |
拿掉資料集中內容的許可權 |
Read |
string |
授與數據集中內容的讀取許可權 |
ReadExplore |
string |
授與讀取和探索數據集中內容的存取權 |
ReadReshare |
string |
授與讀取和重新共享數據集中內容的存取權 |
ReadReshareExplore |
string |
授與數據集中內容的讀取、重新共用和探索存取權 |
ReadWrite |
string |
授與數據集中內容的讀取和寫入存取權 |
ReadWriteExplore |
string |
授與數據集中內容的讀取、寫入和探索存取權 |
ReadWriteReshare |
string |
授與數據集中內容的讀取、寫入和重新共用存取權 |
ReadWriteReshareExplore |
string |
授與數據集中內容的讀取、寫入、重新共用和探索存取權 |
DependentDataflow
Power BI 相依數據流
名稱 | 類型 | Description |
---|---|---|
groupId |
string |
目標組標識碼 |
targetDataflowId |
string |
目標數據流標識碼 |
Encryption
數據集的加密資訊
名稱 | 類型 | Description |
---|---|---|
EncryptionStatus |
數據集加密狀態 |
EncryptionStatus
數據集加密狀態
名稱 | 類型 | Description |
---|---|---|
InSyncWithWorkspace |
string |
支援加密,且與加密設定同步 |
NotInSyncWithWorkspace |
string |
支援加密,但未與加密設定同步 |
NotSupported |
string |
此數據集不支援加密 |
Unknown |
string |
加密狀態未知,因為數據集損毀 |
Import
匯入物件
名稱 | 類型 | Description |
---|---|---|
createdDateTime |
string |
匯入建立日期和時間 |
datasets |
Dataset[] |
與此匯入相關聯的數據集 |
id |
string |
匯入標識碼 |
importState |
enum:
|
匯入上傳狀態 |
name |
string |
匯入名稱 |
reports |
Report[] |
與此匯入相關聯的報告 |
updatedDateTime |
string |
匯入上次更新日期和時間 |
ImportConflictHandlerMode
指定如果具有相同名稱的數據集已經存在,該怎麼做。 預設值是 Ignore
。 對於 RDL 檔案, Abort
和 Overwrite
是唯一支援的選項。 針對數據流model.json檔案, Abort
而且 GenerateUniqueName
是唯一支持的選項。
名稱 | 類型 | Description |
---|---|---|
Abort |
string |
如果已存在具有相同名稱的數據集或數據流,將會取消匯入作業。 |
CreateOrOverwrite |
string |
如果已有同名的數據集存在,匯入作業會將現有的數據集取代為新的數據集。 如果有多個具有相同名稱的現有數據集,匯入作業將會失敗。 |
GenerateUniqueName |
string |
如果已有相同名稱的數據流存在,匯入作業就會為新的數據流產生新的唯一名稱。 |
Ignore |
string |
如果已經有相同名稱的數據集存在,匯入作業將會建立具有相同名稱的新數據集。 |
Overwrite |
string |
如果已有同名的數據集存在,匯入作業會將現有的數據集取代為新的數據集。 如果沒有衝突,或有多個具有相同名稱的現有數據集,匯入作業將會失敗。 |
ImportInfo
匯入的相關信息
名稱 | 類型 | Description |
---|---|---|
connectionType |
商務用 OneDrive 檔案的匯入連接類型 |
|
filePath |
string |
要匯入 商務用 OneDrive Excel (.xlsx) 檔案的路徑,可以是絕對或相對的。 不支援 Power BI .pbix 檔案。 |
fileUrl |
string |
暫存 Blob 記憶體的共用存取簽章 URL,用來匯入大小介於 1 GB 到 10 GB 之間的大型 Power BI .pbix 檔案。 |
PrincipalType
主體類型
名稱 | 類型 | Description |
---|---|---|
App |
string |
服務主體類型 |
Group |
string |
群組主體類型 |
None |
string |
沒有主體類型。 用於整個組織層級存取。 |
User |
string |
用戶主體類型 |
Report
Power BI 報表。 API 會傳回下列報表屬性清單的子集。 子集取決於呼叫的 API、呼叫端許可權,以及 Power BI 資料庫中數據的可用性。
名稱 | 類型 | Description |
---|---|---|
appId |
string |
只有在報表屬於應用程式時,才會傳回應用程式標識碼 |
datasetId |
string |
報表的數據集標識碼 |
description |
string |
報表描述 |
embedUrl |
string |
報表的內嵌 URL |
id |
string |
報表標識碼 |
name |
string |
報表的名稱 |
originalReportId |
string |
當工作區發佈為應用程式時的實際報表標識碼。 |
reportType |
enum:
|
報表類型 |
subscriptions |
(空白值) Power BI 專案的訂用帳戶詳細數據, (例如報表或儀錶板) 。 這個屬性將會從即將推出的承載回應中移除。 您可以使用取得報表訂閱作為 管理員 API 呼叫來擷取 Power BI 報表的訂閱資訊。 |
|
users |
(空白值) Power BI 報表的使用者存取詳細數據。 這個屬性將會從即將推出的承載回應中移除。 您可以使用取得報表用戶作為 api 呼叫 管理員,或使用 參數來擷取 Power BI 報表上的使用者資訊,或使用 參數擷 |
|
webUrl |
string |
報表的Web URL |
ReportUser
報表的 Power BI 使用者存取權專案
名稱 | 類型 | Description |
---|---|---|
displayName |
string |
主體的顯示名稱 |
emailAddress |
string |
使用者的電子郵件地址 |
graphId |
string |
Microsoft Graph 中主體的標識碼。 僅適用於系統管理員 API。 |
identifier |
string |
主體的標識碼 |
principalType |
主體類型 |
|
profile |
Power BI 服務 主體配置檔。 僅適用於 Power BI Embedded 多租用戶解決方案。 |
|
reportUserAccessRight |
用戶對於報表的存取權, (許可權等級) |
|
userType |
string |
使用者的類型。 |
ReportUserAccessRight
用戶對於報表的存取權 (許可權等級)
名稱 | 類型 | Description |
---|---|---|
None |
string |
報表中內容沒有許可權 |
Owner |
string |
授與報表中內容的讀取、寫入和重新共用存取權 |
Read |
string |
授與報表中內容的讀取許可權 |
ReadCopy |
string |
授與報表中內容的讀取和複製存取權 |
ReadReshare |
string |
授與讀取和重新共享報表中內容的存取權 |
ReadWrite |
string |
授與報表中內容的讀取和寫入存取權 |
ServicePrincipalProfile
Power BI 服務 主體配置檔。 僅適用於 Power BI Embedded 多租用戶解決方案。
名稱 | 類型 | Description |
---|---|---|
displayName |
string |
服務主體配置檔名稱 |
id |
string |
服務主體配置檔識別碼 |
Subscription
Power BI 專案的電子郵件訂閱 (,例如報表或儀錶板)
名稱 | 類型 | Description |
---|---|---|
artifactDisplayName |
string |
訂閱 Power BI 專案的名稱 (,例如報表或儀錶板) |
artifactId |
string |
訂閱 Power BI 專案的標識碼 (,例如報表或儀錶板) |
artifactType |
string |
Power BI 專案的類型 (例如 |
attachmentFormat |
string |
電子郵件訂閱中附加報表的格式 |
endDate |
string |
電子郵件訂閱的結束日期和時間 |
frequency |
string |
電子郵件訂閱的頻率 |
id |
string |
訂用帳戶標識碼 |
isEnabled |
boolean |
是否啟用電子郵件訂閱 |
linkToContent |
boolean |
電子郵件訂閱中是否有訂用帳戶連結 |
previewImage |
boolean |
報表的螢幕快照是否存在於電子郵件訂閱中 |
startDate |
string |
電子郵件訂閱的開始日期和時間 |
subArtifactDisplayName |
string |
如果訂閱的Power BI專案是報表,則為頁面名稱。 |
title |
string |
應用程式名稱 |
users |
每個電子郵件訂閱者的詳細數據。 使用取得使用者訂用帳戶作為 API 呼叫 管理員 時,傳回的值是空數位列, (null) 。 這個屬性將會從即將發行的承載回應中移除。 您可以使用取得報表訂閱作為 管理員 或取得儀錶板訂用帳戶作為 管理員 API 呼叫,來擷取 Power BI 報表或儀錶板上的訂用帳戶資訊。 |
SubscriptionUser
Power BI 電子郵件訂用帳戶使用者
名稱 | 類型 | Description |
---|---|---|
displayName |
string |
主體的顯示名稱 |
emailAddress |
string |
使用者的電子郵件地址 |
graphId |
string |
Microsoft Graph 中主體的標識碼。 僅適用於系統管理員 API。 |
identifier |
string |
主體的標識碼 |
principalType |
主體類型 |
|
profile |
Power BI 服務 主體配置檔。 僅適用於 Power BI Embedded 多租用戶解決方案。 |
|
userType |
string |
使用者的型別。 |