Datasets - Get Parameters In Group

Returns a list of parameters for the specified dataset from the specified workspace.

Required scope

Dataset.ReadWrite.All

Limitations

Datasets with SQL, Oracle, Teradata, and SAP HANA DirectQuery connections aren't supported.

GET https://api.powerbi.com/v1.0/myorg/groups/{groupId}/datasets/{datasetId}/parameters

URI Parameters

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

The workspace ID

Responses

Name Type Description
200 OK

OK

Examples

example

Sample Request

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

Sample Response

{
  "value": [
    {
      "name": "ServerName",
      "type": "Text",
      "isRequired": true,
      "currentValue": "MyTest.database.windows.net"
    },
    {
      "name": "DatabaseName",
      "type": "Text",
      "isRequired": true,
      "currentValue": "MyTestDB"
    },
    {
      "name": "FromDate",
      "type": "DateTime",
      "isRequired": true,
      "currentValue": "2/8/2002 12:00:00 AM"
    },
    {
      "name": "FilterBlanks",
      "type": "Logical",
      "isRequired": true,
      "currentValue": "TRUE"
    },
    {
      "name": "MaxId",
      "type": "Number",
      "isRequired": true,
      "currentValue": "77"
    },
    {
      "name": "AnyParam",
      "type": "Any",
      "isRequired": true,
      "currentValue": "uu63"
    }
  ]
}

Definitions

MashupParameter

A Power BI dataset parameter

MashupParameters

The OData response wrapper for a list of Power BI dataset parameters

MashupParameter

A Power BI dataset parameter

Name Type Description
currentValue
  • string

The current value of the parameter

isRequired
  • boolean

Whether the dataset parameter is required

name
  • string

The parameter name

suggestedValues
  • string[]

A list of suggested parameter values

type
  • string

The parameter type

MashupParameters

The OData response wrapper for a list of Power BI dataset parameters

Name Type Description
odata.context
  • string
value

A list of dataset parameters