Datasets - Get Parameters

Service:

Power BI REST APIs

API Version:

v1.0

从 “我的工作区”返回指定数据集的参数列表。

所需范围

Dataset.Read.All 或 Dataset.ReadWrite.All

限制

• 不支持具有 SQL、Oracle、Teradata 和 SAP HANA DirectQuery 连接的数据集。
• 不支持使用公共 XMLA 终结点 创建或修改的数据集。
  
  

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

URI 参数

名称	在	必需	类型	说明
datasetId	path	True	string	数据集 ID

响应

名称	类型	说明
200 OK	MashupParameters	确定

示例

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/parameters

Sample Response

Status code:

200

{
  "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"
    }
  ]
}

定义

名称	说明
MashupParameter	Power BI 数据集参数
MashupParameters	Power BI 数据集参数列表的 OData 响应包装器

MashupParameter

Power BI 数据集参数

名称	类型	说明
currentValue	string	参数的当前值
isRequired	boolean	是否需要数据集参数
name	string	参数名称
suggestedValues	string[]	建议的参数值列表
type	string	参数类型

MashupParameters

Power BI 数据集参数列表的 OData 响应包装器

名称	类型	说明
odata.context	string
value	MashupParameter[]	数据集参数列表