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	OK

例

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[]	データセット パラメーターの一覧