通过

Imports - Post Import In Group

  • 参考
服务:
Power BI REST APIs
API 版本:
v1.0

在指定的工作区中创建新内容。

注释

支持的内容：

  • Power BI .pbix 文件
  • JSON 文件 （.json）
  • Excel 文件 （.xlsx）
  • SQL Server 报表定义语言文件 （.rdl）
  • 若要导入文件，请在请求标头中指定内容类型 多部分/表单数据，并将该文件编码为请求正文中的 表单数据。
  • 若要导入 .rdl 文件，请在 datasetDisplayName指定的名称中包含文件扩展名，如 URI 参数中所述。
  • 若要从 OneDrive for Business 导入 .xlsx 文件，请在请求标头中包含 应用程序/json 的内容类型。 在请求正文中包含 ImportInfo，其中 filePath 设置为 .xlsx 文件路径。
  • 若要导入大小在 1 GB 到 10 GB 之间的大型 Power BI .pbix 文件，请参阅 在组中创建临时上传位置 以及 导入大型文件 PowerShell 脚本。 这仅适用于高级容量工作区。
  • 若要从 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}&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 文件，Abort 和 GenerateUniqueName 是唯一受支持的选项。
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

临时 Blob 存储的共享访问签名 URL，用于导入大小在 1 GB 到 10 GB 之间的大型 Power BI .pbix 文件。

响应

名称 类型 说明
200 OK

Import

还行
202 Accepted

Import

已接受

示例

Import dataflow model.json example
Post import example
Post import skip report example

Import dataflow model.json example

示例请求

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--"
}

示例响应

状态代码:
202 
{
  "id": "d02b8896-e247-4d83-ae5a-014028cb0665"
}

Post import example

示例请求

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--"
}

示例响应

状态代码:
202 
{
  "id": "d02b8896-e247-4d83-ae5a-014028cb0665"
}

Post import skip report example

示例请求

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--"
}

示例响应

状态代码:
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
import

Dataset

Object

Power BI 数据集。 API 返回以下数据集属性列表的子集。 子集取决于调用的 API、调用方权限以及 Power BI 数据库中数据的可用性。

名称 类型 说明
ContentProviderType

string

应忽略的已弃用属性。
Encryption

Encryption

数据集加密信息。 仅当指定 $expand 时才适用。
IsEffectiveIdentityRequired

boolean

数据集是否需要有效的标识，必须在 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&嵌入 URL
queryScaleOutSettings

DatasetQueryScaleOutSettings

查询数据集的横向扩展设置
targetStorageMode

string

数据集存储模式
upstreamDataflows

DependentDataflow[]

此项所依赖的所有数据流的列表
users

DatasetUser[]

（空值）数据集用户访问详细信息。 将在即将发布的版本中从有效负载响应中删除此属性。 可以使用 获取数据集用户作为管理员 API，或使用 参数 getArtifactUsers API 检索 Power BI 项（例如报表或仪表板）上的用户信息。
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

授予对数据集中内容的读取访问权限
ReadExplore

授予对数据集中内容的读取和浏览访问权限
ReadReshare

授予对数据集中内容的读取和重新共享访问权限
ReadReshareExplore

授予对数据集中内容的读取、重新共享和浏览访问权限
ReadWrite

授予对数据集中内容的读取和写入访问权限
ReadWriteExplore

授予对数据集中内容的读取、写入和浏览访问权限
ReadWriteReshare

授予对数据集中内容的读取、写入和重新共享访问权限
ReadWriteReshareExplore

授予对数据集中内容的读取、写入、重新共享和浏览访问权限

DependentDataflow

Object

Power BI 依赖数据流

名称 类型 说明
groupId

string

目标组 ID
targetDataflowId

string

目标数据流 ID

Encryption

Object

数据集的加密信息

名称 类型 说明
EncryptionStatus

EncryptionStatus

数据集加密状态

EncryptionStatus

枚举

数据集加密状态

值 说明
InSyncWithWorkspace

支持加密，并且与加密设置同步
NotInSyncWithWorkspace

支持加密，但不与加密设置同步
NotSupported

此数据集不支持加密
Unknown

由于数据集损坏，加密状态未知

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 是唯一受支持的选项。 对于数据流 model.json 文件，Abort 和 GenerateUniqueName 是唯一受支持的选项。

值 说明
Abort

如果已存在具有相同名称的数据集或数据流，则导入作将被取消。
CreateOrOverwrite

如果已存在同名数据集，则导入作会将现有数据集替换为新的数据集。 如果有多个具有相同名称的现有数据集，则导入作将失败。
GenerateUniqueName

如果已存在同名的数据流，则导入作将为新数据流生成新的唯一名称。
Ignore

如果已存在同名数据集，则导入作将创建具有相同名称的新数据集。
Overwrite

如果已存在同名数据集，则导入作会将现有数据集替换为新的数据集。 如果没有冲突，或者有多个具有相同名称的现有数据集，则导入作将失败。

ImportInfo

Object

有关导入的信息

名称 类型 说明
connectionType

connectionType

OneDrive for Business 文件的导入连接类型
filePath

string

要导入的 OneDrive for Business Excel（.xlsx） 文件的路径，可以是绝对文件或相对文件。 不支持 Power BI .pbix 文件。
fileUrl

string

临时 Blob 存储的共享访问签名 URL，用于导入大小在 1 GB 到 10 GB 之间的大型 Power BI .pbix 文件。

PrincipalType

枚举

主体类型

值 说明
App

服务主体类型
Group

组主体类型
None

无主体类型。 用于整个组织级别的访问。
User

用户主体类型

Report

Object

Power BI 报表。 API 返回以下报表属性列表的子集。 子集取决于调用的 API、调用方权限以及 Power BI 数据库中数据的可用性。

名称 类型 说明
appId

string

仅当报表属于应用时才返回的应用 ID
datasetId

string

报表的数据集 ID
description

string

报表说明
embedUrl

string

报表的嵌入 URL
id

string (uuid)

报表 ID
isOwnedByMe

boolean

指示当前用户是否可以修改或创建报表的副本。
name

string

报表的名称。 应用报告以前缀 [App] 开头。
originalReportId

string (uuid)

工作区发布为应用时的实际报表 ID。
reportType enum:
  • PaginatedReport
  • PowerBIReport

报表类型
subscriptions

Subscription[]

（空值）Power BI 项（例如报表或仪表板）的订阅详细信息。 将在即将发布的版本中从有效负载响应中删除此属性。 可以使用 获取报表订阅作为管理员 API 调用来检索 Power BI 报表的订阅信息。
users

ReportUser[]

（空值）Power BI 报表的用户访问详细信息。 将在即将发布的版本中从有效负载响应中删除此属性。 可以使用 获取报表用户作为管理员 API 调用，或使用 参数 getArtifactUsers API 调用来检索有关 Power BI 报表的用户信息。
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

对报表中的内容没有权限
Owner

授予对报表中内容的读取、写入和重新共享访问权限
Read

授予对报表中内容的读取访问权限
ReadCopy

授予对报表中内容的读取和复制访问权限
ReadReshare

授予对报表中内容的读取和重新共享访问权限
ReadWrite

授予对报表中内容的读取和写入访问权限

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[]

每个电子邮件订阅者的详细信息。 使用 获取用户订阅作为管理员 API 调用时，返回的值是空数组（null）。 将在即将发布的版本中从有效负载响应中删除此属性。 可以使用 以 管理员身份获取报表订阅或 获取仪表板订阅作为管理员 API 调用来检索 Power BI 报表或仪表板上的订阅信息。

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

用户的类型。