Datasets - Get Datasets In Group

Service:: Power BI REST APIs

API Version:: v1.0

Returns a list of datasets from the specified workspace.

Required scope: Dataset.ReadWrite.All or Dataset.Read.All
To set the permissions scope, see Register an app.

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

URI Parameters

Name	In	Required	Type	Description
groupId	path	True	string uuid	The workspace id

Responses

Name	Type	Description
200 OK	Datasets	OK

Examples

example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/datasets

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "name": "SalesMarketing",
      "addRowsAPIEnabled": false,
      "configuredBy": "john@contoso.com",
      "isRefreshable": true,
      "isEffectiveIdentityRequired": false,
      "isEffectiveIdentityRolesRequired": false,
      "isOnPremGatewayRequired": false
    }
  ]
}

Definitions

Dataset	A Power BI dataset
Datasets	A dataset odata list wrapper
DatasourceUsage	Datasource usage
DependentDataflow	A Power BI Dependent dataflow
Encryption	Encryption information for a dataset
EncryptionStatus	Dataset encryption status
EndorsementDetails	Power BI endorsement details
SensitivityLabel	Artifact sensitivity label info

Dataset

A Power BI dataset

Name	Type	Description
ContentProviderType	string	The content provider type for the dataset
CreateReportEmbedURL	string	The dataset create report embed url
CreatedDate	string	DateTime of creation of this dataset
Encryption	Encryption	The dataset encryption information (Only applicable when $expand is specified)
IsEffectiveIdentityRequired	boolean	Whether the dataset requires an effective identity. This indicates that you must send an effective identity using the GenerateToken API.
IsEffectiveIdentityRolesRequired	boolean	Whether RLS is defined inside the PBIX file. This indicates that you must specify a role.
IsOnPremGatewayRequired	boolean	Dataset requires an On-premises Data Gateway
IsRefreshable	boolean	Can this dataset be refreshed
QnaEmbedURL	string	The dataset qna embed url
addRowsAPIEnabled	boolean	Whether the dataset allows adding new rows
configuredBy	string	The dataset owner
datasourceUsages	DatasourceUsage[]	Datasource usages
description	string	The dataset description
endorsementDetails	EndorsementDetails	The dataset endorsement details
id	string	The dataset id
name	string	The dataset name
sensitivityLabel	SensitivityLabel	The dataset sensitivity label
upstreamDataflows	DependentDataflow[]	Upstream Dataflows
webUrl	string	The dataset web url

Datasets

A dataset odata list wrapper

Name	Type	Description
odata.context	string	OData context
value	Dataset[]	The datasets

DatasourceUsage

Datasource usage

Name	Type	Description
datasourceInstanceId	string	The datasource instance ID

DependentDataflow

A Power BI Dependent dataflow

Name	Type	Description
groupId	string	The target group id
targetDataflowId	string	The target dataflow id

Encryption

Encryption information for a dataset

Name	Type	Description
EncryptionStatus	EncryptionStatus	Dataset encryption status

EncryptionStatus

Dataset encryption status

Name	Type	Description
InSyncWithWorkspace	string	Encryption is supported and is in sync with the encryption settings
NotInSyncWithWorkspace	string	Encryption is supported and not in sync with the encryption settings
NotSupported	string	Encryption is not supported for this dataset
Unknown	string	Unable to determine state due to dataset corruption

EndorsementDetails

Power BI endorsement details

Name	Type	Description
certifiedBy	string	The user that certified the artifact
endorsement	string	The endorsement status

SensitivityLabel

Artifact sensitivity label info

Name	Type	Description
labelId	string	The sensitivity label ID