Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Sv translation
languageen

/api/reports/views/:id/table/drilldownConfig

This method returns the drill-down configuration of the table.

Resource Information

Resource URL

https://service.belladati.com/api/reports/views/:id/table/drilldownConfig

HTTP Method

GET

Request Parameters

Parameters

Detail

Example

id

ID of the table. This ID is part of the /api/reports/:id response.

123

Response Structure

Code Block
{ 
  "horizontal" : [
	{
		 ...
	},
	{
		...
	}
  ],
 "vertical" : [
	{
		 ...
	},
	{
		...
	}
  ]
 
}

JSON response contains two arrays, one for horizontal header and one for vertical header. Each contains multiple objects with the following definition:

NameDescription
dataSetDrilldownAttributeCode of the attribute (e.g. L_CITY)
dataSetDrilldownAttributeSubset(Optional) ID of the used subset

Sample request/response

Using curl:

Code Block
curl -H "Authorization: OAuth realm=\"https://service.belladati.com/\", oauth_consumer_key=\"myConsumer\", oauth_token=\"mh7an9dkrg59\", oauth_timestamp=\"135131231\", oauth_nonce=\"randomString\"" https://service.belladati.com/api/reports/views/1234/table/drilldownConfig

The JSON format response:

Code Block
{
    "horizontal": [
        {
            "dataSetDrilldownAttribute": "L_MARKET"
        }
    ],
    "vertical": [
        {
            "dataSetDrilldownAttribute": "L_PRODUCT_TYPE",
            "dataSetDrilldownAttributeSubset": "a1TtUo017G"
        },
        {
            "dataSetDrilldownAttribute": "L_MARKET"
        }
    ]
}

Next steps

List siblings

Sv translation
languageja

/api/reports/views/:id/table/json

この方法は、JSONフォーマットでテーブルを返却します。

リソース情報

リクエストパラメータ

パラメーター

詳細

id

テーブルのID。このIDは/api/reports/:id responseの一部です。

123

filter

(任意)次の構造でテーブルに適用されたフィルタ:

説明
drilldown

ドリルダウンが属性コードと次のような構造で定義されました

説明
opフィルタ操作タイプ - サポートされている値のリストをご参照してください。
value/values(任意)選択した「op」に依存します。フィルタの値または値を格納します。


 

Code Block
{
  "drilldown": {
      "L_COUNTRY_OR_AREA": { "op": "EQ", "value": "Slovakia"},
      "L_TYPE": { "op": "IN", "values": [ "Type 1", "Type 2", "Type 3" ]},
      "L_DATE":{"op":"NOT_NULL"}
  }
}

レスポンスの構造

Code Block
{ 
  "rowsCount" : ..., 
  "name" : ..., 
  "header" : [ ], 
  "body" : [ ]
}

JSONレスポンスは、次の定義を持つ要素が含まれます。

説明
rowsCountヘッダーとデータを含む総数行
nameテーブルビュー名
headerヘッダ要素を含む配列
bodyデータ要素を含む配列

サンプルリクエスト/レスポンス

Curl使用:

Code Block
curl -H "Authorization: OAuth realm=\"https://service.belladati.com/\", oauth_consumer_key=\"myConsumer\", oauth_token=\"mh7an9dkrg59\", oauth_timestamp=\"135131231\", oauth_nonce=\"randomString\"" https://service.belladati.com/api/reports/views/1234/table/json

JSONフォーマットの応答:

Code Block
{ 
  "rowsCount" : 5, 
  "name" : "My Table Name", 
  "header" : [ 
    [ 
      { 
        "value" : "", 
        "type" : "header" 
      } 
    ], 
    [ 
      { 
        "value" : "", 
        "type" : "header" 
      } 
    ] 
  ], 
  "body" : [ 
    [ 
      { 
        "value" : "Value", 
        "type" : "header" 
      }, 
      { 
        "style" : " color:rgb(77, 77, 77) !important ; background-color:rgb(237, 237, 237); ", 
        "value" : "1,033,054,533,155" 
      } 
    ], 
    [ 
      { 
        "value" : "Value Footnotes", 
        "type" : "header" 
      }, 
      { 
        "style" : " color:rgb(77, 77, 77) !important ; background-color:rgb(237, 237, 237); ", 
        "value" : "1" 
      } 
    ], 
    [ 
      { 
        "value" : "B", 
        "type" : "header" 
      }, 
      { 
        "style" : " color:rgb(77, 77, 77) !important ; background-color:rgb(237, 237, 237); ", 
        "value" : "5" 
      } 
    ]
  ]
}

Next steps

List siblings

Sv translation
languagezh

Sv translation
languagecs

Sv translation
languagesk