Datasets - Refresh Dataset In Group

Service:: Power BI REST APIs

API Version:: v1.0

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.

POST https://api.powerbi.com/v1.0/myorg/groups/{groupId}/datasets/{datasetKey}/refreshes

URI Parameters

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

Request Body

Name	Required	Type	Description
notifyOption	True	NotifyOption	Mail notification options (success and/or failure, or none)

Responses

Name	Type	Description
202 Accepted	Object	Accepted

Examples

example

Sample Request

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

Request Body

{
  "notifyOption": "MailOnFailure"
}

Sample Response

Status code:: 202

Definitions

NotifyOption	Mail notification options (success and/or failure, or none)
Object
RefreshRequest	Power BI refresh request

NotifyOption

Mail notification options (success and/or failure, or none)

Name	Type	Description
MailOnCompletion	string	Mail notification will be sent on refresh completion, including either failure and success
MailOnFailure	string	Mail notification will be sent on refresh failure
NoNotification	string	No notification will be sent

Object

RefreshRequest

Power BI refresh request

Name	Type	Description
notifyOption	NotifyOption	Mail notification options (success and/or failure, or none)