詳細データサービスは、指定されたセルの詳細データを取得するAPIを提供します。キューブデータに接続している場合、このサービスはサポートされません。クライアントアプリケーションは、Detail Data APIを使用して、指定されたセルの詳細データを取得するためのHTTP要求をサービスアプリケーションに送信します。

詳細データサービスの要求スキーマ

データソースの詳細データを表示するには、POSTメソッドを使用する必要があります。データソース情報は、次のような要求URLで指定します。

POST: http://<host>[:port]/api/dataengine/{datasourcekey}

次の図は、データソース情報が指定された要求URLを示しています。

URLパラメータ

生データサービスには、次のパラメータがあります。

パラメータ	説明
Data Source	フィールド情報を取得するデータ ソースを指定します。
View Definition	ビュー定義の指定に使用します。タイプは、IViewDefinitionです。次に例を示します。 {   fields:[    {"binding":"Active","dataType":3},    {"binding":"Country","dataType":1},    {"binding":"Date","dataType":4},    {"binding":"Discount","dataType":2},    {"binding":"Downloads","dataType":2},    {"binding":"ID","dataType":2},    {"binding":"Product","dataType":1},    {"binding":"Sales","dataType":2}   ],   rowFields:{items:["Product"]},   columnFields:{items:["Country"]},   valueFields:{items:["Sales"]} }
Key	対応する値によってセルが指定されます。これは配列オブジェクトです。最初に、rowFields内のフィールドの値を順にキーに追加する必要があります。次に、columnFields内のフィールドの値を順に追加します。nullのフィールド値がある場合は、そのままnullを配列に追加します。nullを削除してはなりません。キー配列の数をrowFieldsおよびcolumnFields内のフィールドの数と同じにする必要があります。 次に例を示します。 ["Aoba", "China"]
Skip	全体生データの開始インデックスを指定される正の整数値です。これを設定しない場合は、一連のエントリが先頭から返されます。
Top	返される生データの数を指定される正の整数値です。これを設定しない場合は、スキップ値で始まるすべてのエントリが返されます。

レスポンスメッセージ

HTTPステータスコード	原因
200	集計結果を指定するためにIRawDataオブジェクトが返されます。これは、集計データの配列とページングなしですべての生データの総数を示す数値を含めます。
404	無効な{datasource}です。

詳細については、WebApiExplorerのデモを参照してください。