Datasets - Get Dataset In Group

Returns the specified dataset from the specified workspace.

Permissions

This API call can be called by a service principal profile. For more information see: Service principal profiles in Power BI Embedded.

Required Scope

Dataset.ReadWrite.All or Dataset.Read.All

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

URI Parameters

Name In Required Type Description
datasetId
path True

string

The dataset ID

groupId
path True

string

uuid

The workspace ID

Responses

Name Type Description
200 OK

Dataset

OK

Examples

Example

Sample request

GET https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229

Sample response

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

Definitions

Name Description
Dataset

A Power BI dataset. The API returns a subset of the following list of dataset properties. The subset depends on the API called, caller permissions, and the availability of the data in the Power BI database.

DatasetQueryScaleOutSettings

Query scale-out settings of a dataset

DatasetUser

A Power BI user access right entry for a dataset

DatasetUserAccessRight

The access right that the user has for the dataset (permission level)

DependentDataflow

A Power BI dependent dataflow

Encryption

Encryption information for a dataset

EncryptionStatus

Dataset encryption status

PrincipalType

The principal type

ServicePrincipalProfile

A Power BI service principal profile. Only relevant for Power BI Embedded multi-tenancy solution.

Dataset

A Power BI dataset. The API returns a subset of the following list of dataset properties. The subset depends on the API called, caller permissions, and the availability of the data in the Power BI database.

Name Type Description
ContentProviderType

string

The content provider type for the dataset

CreateReportEmbedURL

string

The dataset create report embed URL

CreatedDate

string

The dataset creation date and time

Encryption

Encryption

Dataset encryption information. Only applicable when $expand is specified.

IsEffectiveIdentityRequired

boolean

Whether the dataset requires an effective identity, which you must send in a GenerateToken API call.

IsEffectiveIdentityRolesRequired

boolean

Whether row-level security is defined inside the Power BI .pbix file. If so, you must specify a role.

IsInPlaceSharingEnabled

boolean

Whether the dataset can be shared with external users to be consumed in their own tenant

IsOnPremGatewayRequired

boolean

Whether the dataset requires an on-premises data gateway

IsRefreshable

boolean

This field returns true when the dataset is either recently refreshed or is configured for automatic refresh, with the connection mode specifically set to 'Import'. The value will return false for other connection modes, such as 'DirectQuery' and 'LiveConnection', regardless of whether the dataset is manually refreshed or is set up for automatic refresh.

QnaEmbedURL

string

The dataset Q&A embed URL

addRowsAPIEnabled

boolean

Whether the dataset allows adding new rows

configuredBy

string

The dataset owner

description

string

The dataset description

id

string

The dataset ID

name

string

The dataset name

queryScaleOutSettings

DatasetQueryScaleOutSettings

Query scale-out settings of a dataset

targetStorageMode

string

The dataset storage mode

upstreamDataflows

DependentDataflow[]

The list of all the dataflows this item depends on

users

DatasetUser[]

(Empty value) The dataset user access details. This property will be removed from the payload response in an upcoming release. You can retrieve user information on a Power BI item (such as a report or a dashboard) by using the Get Dataset Users as Admin API, or the PostWorkspaceInfo API with the getArtifactUsers parameter.

webUrl

string

The web URL of the dataset

DatasetQueryScaleOutSettings

Query scale-out settings of a dataset

Name Type Description
autoSyncReadOnlyReplicas

boolean

Whether the dataset automatically syncs read-only replicas

maxReadOnlyReplicas

integer

Maximum number of read-only replicas for the dataset (0-64, -1 for automatic number of replicas)

DatasetUser

A Power BI user access right entry for a dataset

Name Type Description
datasetUserAccessRight

DatasetUserAccessRight

The access right that the user has for the dataset (permission level)

displayName

string

Display name of the principal

emailAddress

string

Email address of the user

graphId

string

Identifier of the principal in Microsoft Graph. Only available for admin APIs.

identifier

string

Identifier of the principal

principalType

PrincipalType

The principal type

profile

ServicePrincipalProfile

A Power BI service principal profile. Only relevant for Power BI Embedded multi-tenancy solution.

userType

string

Type of the user.

DatasetUserAccessRight

The access right that the user has for the dataset (permission level)

Name Type Description
None

string

Removes permission to the content in the dataset

Read

string

Grants Read access to the content in the dataset

ReadExplore

string

Grants Read and Explore access to the content in the dataset

ReadReshare

string

Grants Read and Reshare access to the content in the dataset

ReadReshareExplore

string

Grants Read, Reshare, and Explore access to the content in the dataset

ReadWrite

string

Grants Read and Write access to the content in the dataset

ReadWriteExplore

string

Grants Read, Write, and Explore access to the content in the dataset

ReadWriteReshare

string

Grants Read, Write, and Reshare access to the content in the dataset

ReadWriteReshareExplore

string

Grants Read, Write, Reshare, and Explore access to the content in the dataset

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 but isn't in sync with the encryption settings

NotSupported

string

Encryption isn't supported for this dataset

Unknown

string

The encryption status is unknown due to dataset corruption

PrincipalType

The principal type

Name Type Description
App

string

Service principal type

Group

string

Group principal type

None

string

No principal type. Use for whole organization level access.

User

string

User principal type

ServicePrincipalProfile

A Power BI service principal profile. Only relevant for Power BI Embedded multi-tenancy solution.

Name Type Description
displayName

string

The service principal profile name

id

string

The service principal profile ID