Imports - Get Import

参考

Service:: Power BI REST APIs

API Version:: v1.0

从 “我的工作区”返回指定的导入。

必需范围

Dataset.ReadWrite.All 或 Dataset.Read.All

GET https://api.powerbi.com/v1.0/myorg/imports/{importId}

URI 参数

名称	在	必需	类型	说明
importId	path	True	string uuid	导入 ID

响应

名称	类型	说明
200 OK	Import	确定

示例

Completed import example

In-progress import example

Completed import example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/imports/82d9a37a-2b45-4221-b012-cb109b8e30c7

Sample Response

Status code:: 200

{
  "id": "82d9a37a-2b45-4221-b012-cb109b8e30c7",
  "importState": "Succeeded",
  "createdDateTime": "2018-05-08T14:56:18.477Z",
  "updatedDateTime": "2018-05-08T14:56:18.477Z",
  "name": "SalesMarketing",
  "connectionType": "import",
  "source": "Upload",
  "datasets": [
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "name": "SalesMarketing",
      "webUrl": "https://app.powerbi.com/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229"
    }
  ],
  "reports": [
    {
      "id": "5b218778-e7a5-4d73-8187-f10824047715",
      "name": "SalesMarketing",
      "webUrl": "https://app.powerbi.com/reports/5b218778-e7a5-4d73-8187-f10824047715",
      "embedUrl": "https://app.powerbi.com/reportEmbed?reportId=5b218778-e7a5-4d73-8187-f10824047715"
    }
  ]
}

In-progress import example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/imports/82d9a37a-2b45-4221-b012-cb109b8e30c7

Sample Response

Status code:: 200

{
  "id": "82d9a37a-2b45-4221-b012-cb109b8e30c7",
  "importState": "Publishing",
  "createdDateTime": "2018-05-08T14:56:18.477Z",
  "updatedDateTime": "2018-05-08T14:56:18.477Z",
  "name": "SalesMarketing",
  "connectionType": "import",
  "source": "Upload",
  "datasets": [],
  "reports": []
}

定义

名称	说明
Dataset	Power BI 数据集。 API 返回以下数据集属性列表的子集。子集取决于调用的 API、调用方权限以及 Power BI 数据库中数据的可用性。
DatasetQueryScaleOutSettings	查询数据集的横向扩展设置
DatasetUser	数据集的 Power BI 用户访问权限条目
DatasetUserAccessRight	用户对数据集的访问权限 (权限级别)
DependentDataflow	依赖于 Power BI 的数据流
Encryption	数据集的加密信息
EncryptionStatus	数据集加密状态
Import	import 对象
PrincipalType	主体类型
Report	Power BI 报表。 API 返回以下报表属性列表的子集。子集取决于调用的 API、调用方权限以及 Power BI 数据库中数据的可用性。
ReportUser	报表的 Power BI 用户访问权限条目
ReportUserAccessRight	用户对报表的访问权限 (权限级别)
ServicePrincipalProfile	Power BI 服务主体配置文件。仅适用于Power BI Embedded多租户解决方案。
Subscription	Power BI 项的电子邮件订阅 (如报表或仪表板)
SubscriptionUser	Power BI 电子邮件订阅用户

Dataset

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

名称	类型	说明
ContentProviderType	string	数据集的内容提供程序类型
CreateReportEmbedURL	string	数据集创建报表嵌入 URL
CreatedDate	string	数据集创建日期和时间
Encryption	Encryption	数据集加密信息。仅在指定时 `$expand` 适用。
IsEffectiveIdentityRequired	boolean	数据集是否需要有效的标识，必须在 GenerateToken API 调用中发送该标识。
IsEffectiveIdentityRolesRequired	boolean	是否在 Power BI .pbix 文件中定义行级别安全性。如果是这样，则必须指定角色。
IsInPlaceSharingEnabled	boolean	是否可以与外部用户共享数据集，以在其自己的租户中使用
IsOnPremGatewayRequired	boolean	数据集是否需要本地数据网关
IsRefreshable	boolean	数据集是否可刷新。 Power BI 可刷新数据集是至少刷新一次或存在有效刷新计划的数据集。
QnaEmbedURL	string	数据集 Q&A 嵌入 URL
addRowsAPIEnabled	boolean	数据集是否允许添加新行
configuredBy	string	数据集所有者
description	string	数据集说明
id	string	数据集 ID
name	string	数据集名称
queryScaleOutSettings	DatasetQueryScaleOutSettings	查询数据集的横向扩展设置
targetStorageMode	string	数据集存储模式
upstreamDataflows	DependentDataflow[]	此项目所依赖的所有数据流的列表
users	DatasetUser[]	(数据集用户访问详细信息) 空值。在即将发布的版本中，将从有效负载响应中删除此属性。可以使用获取数据集用户作为管理员 API 或带 `getArtifactUsers` 参数的 PostWorkspaceInfo API，检索有关 Power BI 项 (的用户信息，例如报表或仪表板) 。
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

import 对象

名称	类型	说明
createdDateTime	string	导入创建日期和时间
datasets	Dataset[]	与此导入关联的数据集
id	string	导入 ID
importState	enum: Failed Publishing Succeeded	导入上传状态
name	string	导入名称
reports	Report[]	与此导入关联的报表
updatedDateTime	string	导入上次更新日期及时间

PrincipalType

主体类型

名称	类型	说明
App	string	服务主体类型
Group	string	组主体类型
None	string	无主体类型。用于整个组织级别的访问。
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 项 (（如报表或仪表板) ）的订阅详细信息。在即将发布的版本中，将从有效负载响应中删除此属性。可以使用获取报表订阅作为管理员 API 调用来检索 Power BI 报表的订阅信息。
users	ReportUser[]	() Power BI 报表的用户访问详细信息的空值。在即将发布的版本中，将从有效负载响应中删除此属性。可以使用获取报表用户作为管理员 API 调用或使用参数的 PostWorkspaceInfo API 调用来检索 Power BI 报表上的用户`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 项的类型 (例如 `Report`、 `Dashboard`或 `Dataset`)
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[]	每个电子邮件订阅者的详细信息。使用获取用户订阅作为管理员 API 调用时，返回的值是空数组， (null) 。在即将发布的版本中，将从有效负载响应中删除此属性。可以使用获取报表订阅作为管理员或获取仪表板订阅作为管理员 API 调用来检索 Power BI 报表或仪表板上的订阅信息。

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 - Get Import

必需范围

URI 参数

响应

示例

Completed import example

Sample Request

Sample Response

In-progress import example

Sample Request

Sample Response

定义

Dataset

DatasetQueryScaleOutSettings

DatasetUser

DatasetUserAccessRight

DependentDataflow

Encryption

EncryptionStatus

Import

PrincipalType

Report

ReportUser

ReportUserAccessRight

ServicePrincipalProfile

Subscription

SubscriptionUser

其他资源