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

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

URI Parameters

Name In Required Type Description
groupId
path True
  • string
uuid

The workspace id

datasetId
path True
  • string

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
{
  "updateDetails": [
    {
      "name": "DatabaseName",
      "newValue": "NewDB"
    },
    {
      "name": "MaxId",
      "newValue": "5678"
    }
  ]
}

Sample Response

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