Datasets

Binds the specified dataset from "My Workspace" to the specified gateway with (optional) given set of datasource Ids. This only supports the On-Premises Data Gateway.

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

Binds the specified dataset from the specified workspace to the specified gateway with (optional) given set of datasource Ids. This only supports the On-Premises Data Gateway.

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

Deletes the specified dataset from "My Workspace".

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

Deletes the specified dataset from the specified workspace.

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

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.

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.

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.

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.

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.

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.

Returns a list of upstream dataflows for datasets from the specified workspace.

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

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.

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.

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.

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.

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.

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.

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

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

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.

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.

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.

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.

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

In Shared capacities this call is limited to eight times per day (including refreshes executed via Scheduled Refresh)
In Premium capacities this call is not limited in number of times per day, but only by the available resources in the capacity, hence if overloaded, the refresh execution may be throttled until the load is reduced. If this throttling exceeds 1 hour, the refresh will fail.

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

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

In Shared capacities this call is limited to eight times per day (including refreshes executed via Scheduled Refresh)
In Premium capacities this call is not limited in number of times per day, but only by the available resources in the capacity, hence if overloaded, the refresh execution may be throttled until the load is reduced. If this throttling exceeds 1 hour, the refresh will fail.

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

Updates all connections for the specified dataset from "My Workspace". This API only supports SQL DirectQuery datasets.

Note: This API is deprecated and no longer supported

• Update Datasources In Group - To update connection details for SQL, AS, OData Feed, and SharePoint.
• Update Parameters In Group - To update connection details for other datasource types.

Updates all connections for the specified dataset from the specified workspace. This API only supports SQL DirectQuery datasets.

Note: This API is deprecated and no longer supported

• Update Datasources In Group - To update connection details for SQL, AS, OData Feed, and SharePoint.
• Update Parameters In Group - To update connection details for other datasource types.

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.

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

Note:

• When using this API, it's recommended to use enhanced dataset metadata.
• This API doesn't support datasets created using the public XML/A endpoint. To make changes to these datasources, the admin must use the Analysis Services Client Library for Tabular Object Model (TOM).

• 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. If you're not using enhanced dataset metadata, wait 30 minutes for the update datasources operation to complete before refreshing.

Restrictions

• This operation is only supported for the dataset owner
• Update datasources supports the following datasource types:
  • SQL Server
  • Azure SQL Server
  • Analysis Services
  • Azure Analysis Services
  • Azure Synapse
  • OData Feed
  • SharePoint
  • Teradata
  • SapHana
  For other datasource types, use Update Parameters
• Changing datasource type is not supported.
• Datasources that contain parameters on the connection string are not supported.
• If you are not using enhanced dataset metadata, updating datasources which are part of merged or joined tables are not supported. If you are using enhanced dataset metadata, updating datasources which are part of merged or joined tables is supported. However, in an Advanced Query referencing multiple datasources, only the first datasource can be updated. To overcome this limitation, define the datasource as a parameter and then use Update Parameters.

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

Note:

• When using this API, it's recommended to use enhanced dataset metadata.
• This API doesn't support datasets created using the public XML/A endpoint. To make changes to these datasources, the admin must use the Analysis Services Client Library for Tabular Object Model (TOM).

• 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. If you're not using enhanced dataset metadata, wait 30 minutes for the update datasources operation to complete before refreshing.

Restrictions

• This operation is only supported for the dataset owner
• Update datasources supports the following datasource types:
  • SQL Server
  • Azure SQL Server
  • Analysis Services
  • Azure Analysis Services
  • Azure Synapse
  • OData Feed
  • SharePoint
  • Oracle
  • Teradata
  • SapHana
  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.
• If you are not using enhanced dataset metadata, updating datasources which are part of merged or joined tables are not supported. If you are using enhanced dataset metadata, updating datasources which are part of merged or joined tables is supported. However, in an Advanced Query referencing multiple datasources, only the first datasource can be updated. To overcome this limitation, define the datasource as a parameter and then use Update Parameters In Group.

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.

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.

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

Note:

• When using this API, it's recommended to use enhanced dataset metadata.
• This API doesn't support datasets created using the public XML/A endpoint. To make changes to these datasources, the admin must use the Analysis Services Client Library for Tabular Object Model (TOM).

Restrictions

• This operation is only supported for the dataset owner
• All parameters must exist in the dataset. Names are case-sensitive.
• Direct Query connections are supported only with enhanced dataset metadata.
• Datasets with Analysis Services Live connections are not supported.
• Maximum of 100 parameters in a 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.

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

Note:

• When using this API, it's recommended to use enhanced dataset metadata.
• This API doesn't support datasets created using the public XML/A endpoint. To make changes to these datasources, the admin must use the Analysis Services Client Library for Tabular Object Model (TOM).

Restrictions

• This operation is only supported for the dataset owner
• All parameters must exist in the dataset. Names are case-sensitive.
• Direct Query connections are supported only with enhanced dataset metadata.
• Datasets with Analysis Services Live connections are not supported.
• Maximum of 100 parameters in a 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.

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.

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.