Dataflows - Get Dataflows

参考

Service:: Power BI REST APIs

API Version:: v1.0

返回指定工作区中所有数据流的列表。

权限

此 API 调用可由服务主体配置文件调用。有关详细信息，请参阅：Power BI Embedded 中的服务主体配置文件。

所需范围

Dataflow.ReadWrite.All 或 Dataflow.Read.All

GET https://api.powerbi.com/v1.0/myorg/groups/{groupId}/dataflows

URI 参数

名称	在	必需	类型	说明
groupId	path	True	string uuid	工作区 ID

响应

名称	类型	说明
200 OK	Dataflows	确定

示例

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/groups/a2f89923-421a-464e-bf4c-25eab39bb09f/dataflows

Sample Response

Status code:: 200

{
  "value": [
    {
      "objectId": "bd32e5c0-363f-430b-a03b-5535a4804b9b",
      "name": "AdventureWorks",
      "description": "Our Adventure Works",
      "modelUrl": "https://MyDataflowStorageAccount.dfs.core.windows.net/powerbi/contoso/AdventureWorks/model.json"
    }
  ]
}

定义

名称	说明
Dataflow	数据流的元数据。下面是可能为数据流返回的属性列表。将仅返回属性的子集，具体取决于调用的 API、调用方权限以及 Power BI 数据库中数据的可用性。
Dataflows	数据流元数据列表的 OData 响应包装器
DataflowUser	数据流的 Power BI 用户访问权限条目
DataflowUserAccessRight	用户对数据流的访问权限 (权限级别)
PrincipalType	主体类型
ServicePrincipalProfile	Power BI 服务主体配置文件。仅适用于Power BI Embedded多租户解决方案。

Dataflow

数据流的元数据。下面是可能为数据流返回的属性列表。将仅返回属性的子集，具体取决于调用的 API、调用方权限以及 Power BI 数据库中数据的可用性。

名称	类型	说明
configuredBy	string	数据流所有者
description	string	数据流说明
modelUrl	string	数据流定义文件的 URL (model.json)
modifiedBy	string	修改数据流的用户
modifiedDateTime	string	上次修改数据流的日期和时间
name	string	数据流名称
objectId	string	数据流 ID
users	DataflowUser[]	(数据流用户访问详细信息) 空值。在即将发布的版本中，将从有效负载响应中删除此属性。可以使用获取数据流用户作为管理员 API 调用或带参数的 PostWorkspaceInfo API 调用来检索有关 Power BI 数据流的用户`getArtifactUser`信息。

Dataflows

数据流元数据列表的 OData 响应包装器

名称	类型	说明
odata.context	string
value	Dataflow[]	数据流元数据列表

DataflowUser

数据流的 Power BI 用户访问权限条目

名称	类型	说明
DataflowUserAccessRight	DataflowUserAccessRight	用户对数据流的访问权限 (权限级别)
displayName	string	主体的显示名称
emailAddress	string	用户的电子邮件地址
graphId	string	Microsoft Graph 中主体的标识符。仅适用于管理员 API。
identifier	string	主体的标识符
principalType	PrincipalType	主体类型
profile	ServicePrincipalProfile	Power BI 服务主体配置文件。仅适用于Power BI Embedded多租户解决方案。
userType	string	用户的类型。

DataflowUserAccessRight

用户对数据流的访问权限 (权限级别)

名称	类型	说明
None	string	删除对数据流中内容的权限
Owner	string	授予对数据流中内容的读取、写入和重新共享访问权限
Read	string	授予对数据流中内容的读取访问权限
ReadReshare	string	授予对数据流中内容的读取和重新共享访问权限
ReadWrite	string	授予对数据流中内容的读取和写入访问权限

PrincipalType

主体类型

名称	类型	说明
App	string	服务主体类型
Group	string	组主体类型
None	string	无主体类型。用于整个组织级别的访问。
User	string	用户主体类型

ServicePrincipalProfile

Power BI 服务主体配置文件。仅适用于Power BI Embedded多租户解决方案。

名称	类型	说明
displayName	string	服务主体配置文件名称
id	string	服务主体配置文件 ID

通过