/Data/KPIExecute
KPI で定義されたクエリを実行します。
要求のメソッド
POST
URL パラメータ
なし。要求の本文は必須です。次のセクションを参照してください。
要求の本文の詳細
このエンドポイントでは、要求の本文の以下のプロパティが使用されます。
KPI
必須項目。KPI の論理名。
FILTERS
オプション。KPI のフィルタ処理方法を指定するフィルタ・オブジェクトの配列。各フィルタ・オブジェクトは、以下のプロパティを提供する必要があります。
-
name — フィルタの仕様 ([aged].[h1].[age group] など)
-
value — フィルタのメンバの論理名 ([0 to 29] など)
要求の例
-
要求のメソッド ：
POST
-
要求の URL ：
https://localhost/api/deepsee/v3/Data/KPIExecute
URL の有効な形式に関する説明は、"Business Intelligence REST API の概要" を参照してください。
-
要求の本文 ：
{ "KPI": "DemoMDX", "FILTERS": [ {"name" : "[aged].[h1].[age group]","value" : "&[0 to 29]" } ] }
応答の例
{
"Info": {
"Error": "",
"KpiName": "DemoMDX"
},
"Result": {
"Properties": [
{"name": "PatCount","caption": "PatCount","columnNo": 1},
{"name": "AvgTestScore","caption": "AvgTestScore","columnNo": 2}
],
"Series": [
{"PatCount": 482,"AvgTestScore": 73.62564102564102564,"seriesName": "Cedar Falls"},
{"PatCount": 473,"AvgTestScore": 74.54089709762532982,"seriesName": "Centerville"},
{"PatCount": 454,"AvgTestScore": 73.86532951289398281,"seriesName": "Cypress"},
{"PatCount": 471,"AvgTestScore": 75.69459459459459459,"seriesName": "Elm Heights"},
{"PatCount": 468,"AvgTestScore": 74.00806451612903226,"seriesName": "Juniper"},
{"PatCount": 464,"AvgTestScore": 73.71925133689839572,"seriesName": "Magnolia"},
{"PatCount": 438,"AvgTestScore": 73.76123595505617978,"seriesName": "Pine"},
{"PatCount": 464,"AvgTestScore": 75.46537396121883657,"seriesName": "Redwood"},
{"PatCount": 445,"AvgTestScore": 75.19886363636363636,"seriesName": "Spruce"}
]
}
}
この応答オブジェクト内では、Result プロパティに Series プロパティと Properties プロパティが含まれています。Series プロパティにはオブジェクトの配列が含まれており、KPI 内の系列 (または行) ごとに 1 つのオブジェクトがあります。Properties プロパティにはオブジェクトの配列が含まれており、KPI 内の行ごとに 1 つのオブジェクトがあります。
すべての応答オブジェクトに適用される情報は、"応答オブジェクトに関する注意事項" を参照してください。
