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

このメソッドは、JSON形式で表を返します。

リソース情報

リソースURL

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

HTTPメソッド

POST

リクエストパラメーター

パラメーター

詳細

例

id

表ID。このIDは、/api/reports/:id レスポンスの一部です。

123
drilldownConfig

(オプション - RAW) 表のドリルダウンをカスタム構成に置き換えます。水平ドリルダウン構成と垂直ドリルダウン構成の両方を置き換えることができます。各構成は、次の要素を持つ配列です:

名

説明

vertical設定するヘッダーの定義 (垂直ヘッダー)
horizontal設定するヘッダーの定義 (水平ヘッダー)
dataSetDrilldownAttribute属性コード (例: L_CITY)
dataSetDrilldownAttributeSubset(オプション) 使用されたサブセットのID
hideDataSetCustomMembersカスタムメンバーを表示するかどうかを定義します。
limit

選択したドリルダウンに表示されるメンバーの制限を設定します。使用可能なすべてのメンバーをロードする必要がある場合は、この値を "ALL" に設定します。

{
	"horizontal":[
		{
			"dataSetDrilldownAttribute":"L_PRODUCT_TYPE",
			"hideDataSetCustomMembers": false,
			"limit": "ALL"
		},
		{
			"dataSetDrilldownAttribute":"L_PRODUCT",
			"dataSetDrilldownAttributeSubset": "TdPgywXkmB",
			"hideDataSetCustomMembers": true,
			"limit": 1000
		}
	],
	"vertical":[
		{
			"dataSetDrilldownAttribute":"L_DATE",
	 		"dataSetDrilldownAttributeSubset":"0EE39yrVHY",
			"hideDataSetCustomMembers": false
		}
	]
}
subsetValueId

定義されている場合、レスポンスはサブセットの選択されたメンバーの値を返します。このパラメーターを expand = true と組み合わせると、選択したメンバーのすべての子がロードされます。

subsetValueId=F2Qx2LrYRX
expand

利用可能なすべてのドリルダウンを拡張します。使用可能な値: true / false

expand=true
filter

(オプション - RAW) Filter applied to the table, with following structure:

名

説明

drilldown

属性コードと次の構造で定義されたドリルダウン:

名

説明

opフィルター操作タイプ - サポートされている値のリストを参照してください。
value/values

(オプション) 選択した "op" に依存します。フィルターの1つまたは複数の値が含まれます。

countOp

(オプション) COUNT演算で使用されます。countと一緒に使用される2番目の操作を指定します。

サポートされている値: EQ, NEQ, GT, GTE, LT, LTE

複数のフィルターを結合したり、同じパラメーターに2つのフィルターを適用したりするために、属性のドリルダウンを配列にすることができます。"drilldown" の外側の "conditionType" 属性は、ドリルダウン配列メンバー間の条件を定義し、ドリルダウンメンバーの内側の "conditionType" 属性は、ドリルダウンの属性間の条件を定義します。



{
   "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"
      },
      "L_PRODUCT":{
         "op":"COUNT",
         "countOp":"LTE",
         "value":"816"
      }
   }
}

RAW構造の例

{
    "drilldownConfig": {
        "vertical": [
            {
                "dataSetDrilldownAttribute": "L_THELONGESTTITLETHERECAN01",
                "limit": "ALL",
                "hideDataSetCustomMembers": false
            },
            {
                "dataSetDrilldownAttribute": "L_THELONGESTTITLETHERECAN30",
                "limit": "ALL",
                "hideDataSetCustomMembers": false
            }
        ]
    },
    "filter": {
        "drilldown": {
            "L_THELONGESTTITLETHERECAN30": {
                "op": "EQ",
                "value": "10"
            }
        }
    }
}


レスポンス構造

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

JSONレスポンスには、次の要素を持つ要素が含まれています:

名説明
rowsCountTotal number of rows including headers and data
nameTable view name
headerArray containing header elements
bodyArray containing data elements

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

curl使用:

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形式のレスポンス:

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

次に

  • No labels