Datasets - Update Parameters In Group

Service:
Power BI REST APIs
API Version:
v1.0

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).

Important: The dataset must be refreshed for the new parameter values to be applied. If you're not using enhanced dataset metadata, 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

  • 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.

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

URI Parameters

Name In Required Type Description
datasetId
 path True
  • string
groupId
 path True
  • string
uuid

The workspace id

Request Body

Name Required Type Description
updateDetails True

The dataset parameter list to update

Responses

Name Type Description
200 OK

OK

Examples

example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/Default.UpdateParameters
Request Body
{
  "updateDetails": [
    {
      "name": "DatabaseName",
      "newValue": "NewDB"
    },
    {
      "name": "MaxId",
      "newValue": "5678"
    }
  ]
}

Sample Response

Status code:
200

Definitions

UpdateMashupParameterDetails

Power BI dataset parameter update details
UpdateMashupParametersRequest

Power BI dataset parameter update request

UpdateMashupParameterDetails

Power BI dataset parameter update details

Name Type Description
name
  • string

The parameter name
newValue
  • string

The parameter new value

UpdateMashupParametersRequest

Power BI dataset parameter update request

Name Type Description
updateDetails

The dataset parameter list to update