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	OK

例

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	データフロー定義ファイル (model.json) への URL
modifiedBy	string	データフローを変更したユーザー
modifiedDateTime	string	データフローが最後に変更された日時
name	string	データフロー名
objectId	string	データフロー ID
users	DataflowUser[]	(空の値)データフロー ユーザー アクセスの詳細。 このプロパティは、今後のリリースでペイロード応答から削除されます。 Power BI データフローのユーザー情報を取得するには、get Dataflow Users as 管理 API 呼び出し、または PostWorkspaceInfo API 呼び出しと パラメーターを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