Datasets
Many semantic model operations are available through both group-less and workspace-qualified routes. For operations in this group that provide both route forms, the scope is as follows.
| Route pattern | Scope |
|---|---|
/v1.0/myorg/datasets/{datasetId}/... |
Operates on the specified semantic model in My workspace or another workspace, provided the caller has the required permissions. |
/v1.0/myorg/groups/{groupId}/datasets/{datasetId}/... |
Operates on the specified semantic model using a workspace-qualified route. Specify the ID of the workspace that owns the semantic model. |
/v1.0/myorg/datasets |
Returns semantic models from My workspace. |
/v1.0/myorg/groups/{groupId}/datasets |
Returns semantic models from the specified workspace. |
For compatibility with existing applications, group-less routes in this operation group that identify a specific semantic model by datasetId and have a corresponding workspace-qualified route can access semantic models outside My workspace. This compatibility behavior doesn't apply to collection operations, push semantic model table and row operations, or operations that are only available in workspace-qualified form. When both route forms are available, use the workspace-qualified route and specify the semantic model's owning workspace. Requests that specify a different workspace might fail as workspace containment validation is strengthened.
Operations
| Bind To Gateway |
Binds the specified semantic model to the specified gateway, optionally with a given set of data source IDs. The semantic model can reside in My workspace or an... |
| Bind To Gateway In Group |
Binds the specified dataset from the specified workspace to the specified gateway, optionally with a given set of data source IDs. If you don't supply a specifi... |
| Cancel Refresh |
Cancels the specified refresh operation for the specified semantic model. The semantic model can reside in My workspace or another workspace, provided the calle... |
| Cancel Refresh In Group |
Cancels the specified refresh operation for the specified dataset from the specified workspace. |
| Delete Dataset |
Deletes the specified semantic model. The semantic model can reside in My workspace or another workspace, provided the caller has the required permissions. |
| Delete Dataset In Group |
Deletes the specified dataset from the specified workspace. |
| Discover Gateways |
Returns a list of gateways that the specified semantic model can be bound to. The semantic model can reside in My workspace or another workspace, provided the c... |
| Discover Gateways In Group |
Returns a list of gateways that the specified dataset from the specified workspace can be bound to. |
| Execute Dax Queries |
Executes Data Analysis Expressions (DAX) queries against the provided semantic model. The semantic model can reside in My workspace or another workspace, provid... |
| Execute Dax Queries In Group |
Executes Data Analysis Expressions (DAX) queries against the provided dataset. The dataset must reside in the specified workspace. The response is returned in t... |
| Execute Queries |
Executes Data Analysis Expressions (DAX) queries against the provided semantic model. The semantic model can reside in My workspace or another workspace, provid... |
| Execute Queries In Group |
Executes Data Analysis Expressions (DAX) queries against the provided dataset. |
| Get Dataset |
Returns the specified semantic model. The semantic model can reside in My workspace or another workspace, provided the caller has the required permissions. |
| Get Dataset In Group |
Returns the specified dataset from the specified workspace. |
| Get Datasets |
Returns a list of datasets from My workspace. |
| Get Datasets In Group |
Returns a list of datasets from the specified workspace. |
| Get Dataset To Dataflows Links In Group |
Returns a list of upstream dataflows for datasets from the specified workspace. |
| Get Dataset Users |
Returns a list of principals that have access to the specified semantic model. The semantic model can reside in My workspace or another workspace, provided the ... |
| Get Dataset Users In Group |
Returns a list of principals that have access to the specified dataset. |
| Get Datasources |
Returns a list of data sources for the specified semantic model. The semantic model can reside in My workspace or another workspace, provided the caller has the... |
| Get Datasources In Group |
Returns a list of data sources for the specified dataset from the specified workspace. |
| Get Direct Query Refresh Schedule |
Returns the refresh schedule for a specified DirectQuery or LiveConnection semantic model. The semantic model can reside in My workspace or another workspace, p... |
| Get Direct Query Refresh Schedule In Group |
Returns the refresh schedule for a specified DirectQuery or LiveConnection dataset from the specified workspace. |
| Get Gateway Datasources |
Returns a list of gateway data sources for the specified semantic model. The semantic model can reside in My workspace or another workspace, provided the caller... |
| Get Gateway Datasources In Group |
Returns a list of gateway data sources for the specified dataset from the specified workspace. |
| Get Parameters |
Returns a list of parameters for the specified semantic model. The semantic model can reside in My workspace or another workspace, provided the caller has the r... |
| Get Parameters In Group |
Returns a list of parameters for the specified dataset from the specified workspace. |
| Get Query Scale Out Sync Status |
Returns the query scale-out sync status for the specified semantic model. The semantic model can reside in My workspace or another workspace, provided the calle... |
| Get Query Scale Out Sync Status In Group |
Returns the query scale-out sync status for the specified dataset from the specified workspace. |
| Get Refresh Execution Details |
Returns execution details of a refresh operation for the specified semantic model. The semantic model can reside in My workspace or another workspace, provided ... |
| Get Refresh Execution Details In Group |
Returns execution details of a refresh operation for the specified dataset from the specified workspace. |
| Get Refresh History |
Returns the refresh history for the specified semantic model. The semantic model can reside in My workspace or another workspace, provided the caller has the re... |
| Get Refresh History In Group |
Returns the refresh history for the specified dataset from the specified workspace. |
| Get Refresh Schedule |
Returns the refresh schedule for the specified semantic model. The semantic model can reside in My workspace or another workspace, provided the caller has the r... |
| Get Refresh Schedule In Group |
Returns the refresh schedule for the specified dataset from the specified workspace. |
| Post Dataset User |
Grants the specified user's permissions to the specified semantic model. The semantic model can reside in My workspace or another workspace, provided the caller... |
| Post Dataset User In Group |
Grants the specified user's permissions to the specified dataset. |
| Put Dataset User |
Updates the existing semantic model permissions of the specified user to the specified permissions. The semantic model can reside in My workspace or another wor... |
| Put Dataset User In Group |
Updates the existing dataset permissions of the specified user to the specified permissions. |
| Refresh Dataset |
Triggers a refresh for the specified semantic model. The semantic model can reside in My workspace or another workspace, provided the caller has the required pe... |
| Refresh Dataset In Group |
Triggers a refresh for the specified dataset from the specified workspace. An enhanced refresh is triggered only if a request payload other than |
| Set All Dataset Connections |
Updates all connections for the specified semantic model. The semantic model can reside in My workspace or another workspace, provided the caller has the requir... |
| Set All Dataset Connections In Group |
Updates all connections for the specified dataset from the specified workspace. This API call only supports SQL DirectQuery datasets. |
| Take Over In Group |
Transfers ownership over the specified dataset to the current authorized user. |
| Trigger Query Scale Out Sync |
Triggers a query scale-out sync of read-only replicas for the specified semantic model. The semantic model can reside in My workspace or another workspace, prov... |
| Trigger Query Scale Out Sync In Group |
Triggers a query scale-out sync of read-only replicas for the specified dataset from the specified workspace. |
| Update Dataset |
Updates the properties for the specified semantic model. The semantic model can reside in My workspace or another workspace, provided the caller has the require... |
| Update Dataset In Group |
Updates the properties for the specified dataset from the specified workspace. |
| Update Datasources |
Updates the data sources of the specified semantic model. The semantic model can reside in My workspace or another workspace, provided the caller has the requir... |
| Update Datasources In Group |
Updates the data sources of the specified dataset from the specified workspace. |
| Update Direct Query Refresh Schedule |
Updates the refresh schedule for a specified DirectQuery or LiveConnection semantic model. The semantic model can reside in My workspace or another workspace, p... |
| Update Direct Query Refresh Schedule In Group |
Updates the refresh schedule for a specified DirectQuery or LiveConnection dataset from the specified workspace. |
| Update Parameters |
Updates the parameter values for the specified semantic model. The semantic model can reside in My workspace or another workspace, provided the caller has the r... |
| Update Parameters In Group |
Updates the parameters values for the specified dataset from the specified workspace. |
| Update Refresh Schedule |
Updates the refresh schedule for the specified semantic model. The semantic model can reside in My workspace or another workspace, provided the caller has the r... |
| Update Refresh Schedule In Group |
Updates the refresh schedule for the specified dataset from the specified workspace. |