Datasets

Operations

Bind To Gateway

Binds the specified dataset from "My Workspace" to the specified gateway. This only supports the On-Premises Data Gateway.

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

Bind To Gateway In Group

Binds the specified dataset from the specified workspace to the specified gateway. Only supported for the On-Premises Data Gateway.

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

Delete Dataset By Id

Deletes the specified dataset from "My Workspace".

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

Delete Dataset By Id In Group

Deletes the specified dataset from the specified workspace.

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

Discover Gateways

Returns a list of gateways which the specified dataset from "My Workspace" can be bound to.
This API is relevant only for datasets that have at least one on-premises connection.
For datasets with cloud-only connections, it will return an empty list.

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

Discover Gateways In Group

Returns a list of gateways that the specified dataset from the specified workspace can be bound to.
This API is relevant only for datasets that have at least one on-premises connection.
For datasets with cloud-only connections, it will return an empty list.

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

Get Dataset By Id

Returns the specified dataset from "My Workspace".

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

Get Dataset By Id In Group

Returns the specified dataset from the specified workspace.

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

Get Datasets

Returns a list of datasets from "My Workspace".

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

Get Datasets In Group

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 Datasources

Returns a list of datasources for the specified dataset from "My Workspace".

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

Get Datasources In Group

Returns a list of datasources for the specified dataset from the specified workspace.

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

Get Direct Query Refresh Schedule

Returns the refresh schedule of a specified DirectQuery or LiveConnection dataset from "My Workspace".

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

Get Direct Query Refresh Schedule In Group

Returns the refresh schedule of a specified DirectQuery or LiveConnection dataset from the specified workspace.

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

Get Gateway Datasources

Returns a list of gateway datasources for the specified dataset from "My Workspace".

Note: Use the new Dataset - Get Datasources API instead.

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

Get Gateway Datasources In Group

Returns a list of gateway datasources for the specified dataset from the specified workspace.

Note: Use the Dataset - Get Datasources In Group API instead.

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

Get Parameters

Returns a list of parameters for the specified dataset from "My Workspace".

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

Restrictions

Datasets with SQL, Oracle, Teradata & SapHana Direct Query connections are not supported.

Get Parameters In Group

Returns a list of parameters for the specified dataset from the specified workspace.

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

Restrictions

Datasets with SQL, Oracle, Teradata & SapHana Direct Query connections are not supported.

Get Refresh History

Returns the refresh history of the specified dataset from "My Workspace".

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

Get Refresh History In Group

Returns the refresh history of the specified dataset from the specified workspace.

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

Get Refresh Schedule

Returns the refresh schedule of the specified dataset from "My Workspace".

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

Get Refresh Schedule In Group

Returns the refresh schedule of the specified dataset from the specified workspace.

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

Refresh Dataset

Triggers a refresh for the specified dataset from "My Workspace".

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

Refresh Dataset In Group

Triggers a refresh for the specified dataset from the specified workspace.

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

Set All Dataset Connections

Updates all connections for the specified dataset from "My Workspace".

Note:

  • To update connection details for SQL, AS, OData Feed, and SharePoint, use Update Datasources. For other datasource types, use Update Parameters.
  • This API only supports SQL DirectQuery datasets.


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

Set All Dataset Connections In Group

Updates all connections for the specified dataset from the specified workspace.

Note:



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

Take Over In Group

Transfers ownership over the specified dataset to the current authorized user.

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

Update Datasources

Updates the datasources of the specified dataset from "My Workspace".

Important:

  • The original datasource and the new datasource must have the exact same schema.
  • For cached models, the dataset must be refreshed to get the data from the new data sources. Wait 30 minutes for the update datasources operation to complete before refreshing.


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

Restrictions

  • Update datasources supports SQL Server, Azure SQL Server, Analysis Services, Azure Analysis Services, OData Feed, and SharePoint datasources. For other datasource types, use Update Parameters
  • Changing datasource type is not supported.
  • Datasources that contain parameters on the connection string are not supported.
  • Datasources which are part of Merged or Joined tables are not supported.

Update Datasources In Group

Updates the datasources of the specified dataset from the specified workspace.

Important:

  • The original datasource and the new datasource must have the exact same schema.
  • For cached models, the dataset must be refreshed to get the data from the new datasources. Wait 30 minutes for the update datasources operation to complete before refreshing.


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

Restrictions

  • Update datasources supports SQL Server, Azure SQL Server, Analysis Services, Azure Analysis Services, OData Feed, and SharePoint datasources. For other datasource types, use Update Parameters In Group.
  • Changing datasource type is not supported.
  • Datasources that contain parameters on the connection string are not supported.
  • Datasources which are part of Merged or Joined tables are not supported.

Update Direct Query Refresh Schedule

Updates the refresh schedule for the specified DirectQuery or LiveConnection dataset from "My Workspace".

This operation is only supported for the dataset owner.
A request should contain either a combination of days and times (setting times is optional, otherwise a default single time per day is used) or a valid frequency, but not both.
Setting frequency will automatically truncate the days and times arrays.

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

Update Direct Query Refresh Schedule In Group

Updates the refresh schedule for the specified DirectQuery or LiveConnection dataset from the specified workspace.

This operation is only supported for the dataset owner.
A request should contain either a combination of days and times (setting times is optional, otherwise a default single time per day is used) or a valid frequency, but not both.
Setting frequency will automatically truncate the days and times arrays.

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

Update Parameters

Updates the parameters values for the specified dataset from "My Workspace".

Important: The dataset must be refreshed for new parameters values to be applied. Wait 30 minutes for the update parameters operation to complete before refreshing.

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

Restrictions

  • All parameters must exist in the dataset. Names are case-sensitive.
  • Datasets with SQL, Oracle, Teradata & SapHana Direct Query connections are not supported.
  • Datasets with Analysis Services Live connections are not supported.
  • Maximum of a 100 parameters in request is allowed.
  • Values should be of expected Type.
  • Cannot pass empty value to an IsRequired parameter.
  • List cannot be empty or include multiple occurrences of same parameter.
  • Parameters of types 'Any' or 'Binary' cannot be set.

Update Parameters In Group

Updates the parameters values for the specified dataset from the specified workspace.

Important: The dataset must be refreshed for the new parameter values to be applied. Wait 30 minutes for the update parameters operation to complete before refreshing.

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

Restrictions

  • All parameters must exist in the dataset. Names are case-sensitive.
  • Datasets with SQL, Oracle, Teradata & SapHana Direct Query connections are not supported.
  • Datasets with Analysis Services Live connections are not supported.
  • Maximum of 100 parameters in request is allowed.
  • Values should be of expected type.
  • An empty value is not permitted for the IsRequired parameter.
  • List cannot be empty or include multiple occurrences of same parameter.
  • Parameters of types 'Any' or 'Binary' cannot be set.

Update Refresh Schedule

Updates the refresh schedule for the specified dataset from "My Workspace".

This operation is only supported for the dataset owner.
A request that disables the refresh schedule should contain no other changes.
The days array should not be set to empty array.
The times may be set to empty array (in which case Power BI will use a default single time per day).
The limit on number of time slots per day depends on the type of capacity used (Premium or Shared), see What is Microsoft Power BI Premium.

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

Update Refresh Schedule In Group

Updates the refresh schedule for the specified dataset from the specified workspace.

This operation is only supported for the dataset owner.
A request that disables the refresh schedule should contain no other changes.
The days array should not be set to empty array.
The times may be set to empty array (in which case Power BI will use a default single time per day).
The limit on number of time slots per day depends on the type of capacity used (Premium or Shared), see What is Microsoft Power BI Premium.

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