Sv translation

language	en

/api/dataSets/:id/data

Loads dataset data.

Resource Information

Resource URL	https://service.belladati.com/api/dataSets/:id/data
HTTP Method	`GET`

Request Parameters

Parameters

Detail

Example

id

(path parameter)

ID of the data set to fetch. You can find the ID in the response to /api/dataSets.

123

joinPoints

Definition of join points to be used for loading the data.

Available join types:

LEFT_OUTER_JOIN
INNER_JOIN
CROSS_JOIN

joinPoints={"joins"=[

{"joinedDataSetId":"198", "primaryAttribute": "L_ID", "joinedAttribute":"L_ID_JOINED", "alias":"th", "joinType": "INNER_JOIN"}

]}

filter

(query parameter)

(Optional)

...

Filter used to load data.

Prefix (PT) can be used when join contains columns with the same names.

See the complete list of Filter operation types.

conditionType (optional) is used to define condition operator between conditions. Available values:

AND (default)
OR

Searching part of String: use '%' wildcard to search selected String in data set values. E.g. "value": "%al%"

In order to join multiple filters or apply two filters on the same parameter, attribute drilldown can be an array. "conditionType" attribute outside "drilldown" defines condition between drilldown array members and "conditionType" attribute inside drilldown member defines condition between attributes in the drilldown.

{
   "drilldown": {
      
      "UID": {
          "op":"IN",
          "values":["1","2","4","10"]
      },
      "L_COUNTRY_OR_AREA": {
          "op": "EQ",
          "value": "Slovakia"
      },
      "L_TYPE": {
          "op": "IN",
          "values": [ "Type 1", "Type 2", "Type 3" ]
      },
      "PT.L_DATE": {
          "op": "NOT_NULL"
      },
      "conditionType":"OR"     
   }
}

Example of a between filter:
{"drilldown":[{"L_ID":{"op":"GT","value":"10"}},{"L_ID":{"op":"LT","value":"20"}}]}

offset (query parameter)

...

	(Optional) Specifies the page offset if pagination is necessary.	2
`size (query parameter)`	(Optional) Specifies the number of entries on each page if pagination is necessary.	15
order (query parameter)	(Optional) Specifies the sorting order of the listed data	M_INDICATOR asc

Response Structure

Code Block

language	js

{
  "dataSet" : { ... },
  "data" : [ { "UID" : 123456, "L_ATTRIBUTE" : "value", "M_INDICATOR" : 11.99 }, { "UID" : 123457, "L_ATTRIBUTE" : "value2", "M_INDICATOR" : 22.08 } ],
  "offset" : 0,
  "size" : 2
}

JSON response contains 2 pagination elements (offset and size) but the main 2 elements are dataSet that contains detailed information about data set (see GET Data Set Detail) and data which contains array of data rows in following

...

structure:

Name	Description
UID	Unique ID of data row.
L_*	Attribute values contained in the data row.
M_*	Indicator values contained in the data row.

Join Data Sets

Note
Available since BellaDati 2.9.19

In Join Data Sets, prefix indicates the source Data Set of duplicated attributes or indicators, e.g. DATASETCODE_L_ATTRIBUTE

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/

dataSet

dataSets/123/data

The JSON format response:

Code Block

	javascript
	javascript

{
  "dataSet" : {
	"id" : 123,
  	"name" : "My test data set",
    "code" : "DATASET_CODE",
  	"localization" : {
    "de" : "Deutsch Name"
  },
  "description" : "This is a sample data set.",
  "owner" : "John Smith",
  "lastChange" : "Tue, 22 May 2012 17:16:31 GMT",
  "

attributes

data" : [ 
	{ "UID" : 123456,

{ "id

"L_ATTRIBUTE" : "value", "M_INDICATOR" : 11.99 }, 
	{ "UID" : 123457, "L_ATTRIBUTE" : "value2", "M_INDICATOR" :

"123.FO8j1HfdDz"

22.08 } 
  ],
  "offset" : 0,
  "

name

size" : 2,
  "

City",

parameters": [
      {
        "

code

param1"

: "

L_CITY",

value1"
      },
      {
        "

type

param2"

: "

String

value2"
      }
    ]

, "indicators" : [ {

Sv translation

language	ja

/api/dataSets/:id/data

データセットデータをロードします。

リソース情報

リソースURL	https://service.belladati.com/api/dataSets/:id/data
HTTPメソッド	`GET`

リクエストパラメーター

パラメーター

詳細

例

id

(path parameter)

フェッチするデータセットのID。 IDは、/api/dataSetsへのレスポンスで見つけることができます。

123

joinPoints

データのロードに使用される結合ポイントの定義。

使用可能な結合タイプ:

LEFT_OUTER_JOIN
INNER_JOIN
CROSS_JOIN

joinPoints={"joins"=[

{"joinedDataSetId":"198", "primaryAttribute": "L_ID", "joinedAttribute":"L_ID_JOINED", "alias":"th", "joinType": "INNER_JOIN"}

]}

filter

(query parameter)

(オプション) データを読み込む際に使用するフィルター。

プレフィックス（PT）は、joinに同じ名前のカラムが含まれる場合に使用できます。

フィルター操作の種類一覧はこちら.

conditionType (オプション) は、条件間の条件演算子を定義するために使用される。利用可能な値：

AND (default)
OR

文字列の一部を検索する：データセット値で選択された文字列を検索するには、'%'ワイルドカードを使用します。例："value": "%al%"

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

{
   "drilldown": {
      
      "

id

UID":

: "123.8RnLDOwZnY",

{
          "op":"IN",
          "

name

values"

: "Count"

:["1","2","4","10"]
      },
      "

type"

L_COUNTRY_OR_AREA": {
          "op": "

DATA_INDICATOR

EQ",
          "

code

value"

: "

M_COUNT

Slovakia"
      },
      "L_TYPE": {
          "

id

op"

: "

123.Jiq7Cuyai1

IN",

"name" : "Calculated indicator",

    "values": [ "Type 1", "Type 2", "Type 3" ]

"type" : "FORMULA_INDICATOR",

},
      "PT.L_DATE": {
          "

formula

op"

: "

M

NOT_

COUNT

NULL"

*

1000"

},


      "conditionType":"OR"

{

} } `Example of a between filter:` `{"drilldown":[{"L_ID":{"op":"GT","value":"10"}},{"L_ID":{"op":"LT","value":"20"}}]}`
offset (query parameter)	(オプション)ページ分割が必要な場合のページオフセットを指定します。	2
size (query parameter)	(オプション) ページネーションが必要な場合に、各ページの項目数を指定します。	15
order (query parameter)	(オプション) リストアップされたデータのソート順を指定します	M_INDICATOR asc

レスポンス構造

Code Block

language	js

{
  "

id

dataSet" : {

"123.MrrmQgYyyo"

... },
  "data" : [ { "

name

UID" : 123456,

"Indicator group

"L_ATTRIBUTE" : "value",

 "M_INDICATOR" : 11.99 }, { "

type

UID" : 123457, "

INDICATOR

L_

GROUP

ATTRIBUTE"

} ]

 : "value2", "M_INDICATOR" : 22.08 } ],
  "offset" : 0,
  "

reports

size" :

[ {

2
}

JSONレスポンスには2つのページネーション要素 (offsetとsize) が含まれますが、主な2つの要素はデータセットに関する詳細情報を含むdataSet (GET Data Set Detailを参照）と、次の構造のデータ行の配列を含むdataです:

名	説明
UID	Unique ID of data row.
L_*	Attribute values contained in the data row.
M_*	Indicator values contained in the data row.

結合データセット

Note
BellaDati 2.9.19から利用可能です。

結合データセットでは、プレフィックスは重複した属性またはインジケータのソースデータセットを示します。例: DATASETCODE_L_ATTRIBUTE

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

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/dataSets/123/data

JSON形式のレスポンス:

Code Block

	javascript
	javascript

{
  "dataSet" : {
	"id" :

7497

123,
  	"name" : "My test data

"name

set",
    "code" :

"My Report",

"DATASET_CODE",
  	"localization" : {
    "de" : "Deutsch Name"
  },
  "description" : "This is a sample data

report

set.",

  "owner" : "John Smith",

  "lastChange" : "

Mon

Tue,

16

Apr

May 2012

10

17:

17

16:

26

31 GMT"

} ] }

,
  "data" : [ 
	{ "UID" : 123456, "L_ATTRIBUTE" : "value", "M_INDICATOR" : 11.99 }, 
	{ "UID" : 123457, "L_ATTRIBUTE" : "value2", "M_INDICATOR" : 22.08 } 
  ],
  "offset" : 0,
  "size" : 2,
  "parameters": [
      {
        "param1": "value1"
      },
      {
        "param2": "value2"
      }
    ]
}

Page tree

Versions Compared

Old Version 1

New Version Current

Key

/api/dataSets/:id/data

Resource Information

Request Parameters

Response Structure

Join Data Sets

Sample Request / Response

/api/dataSets/:id/data

リソース情報

リクエストパラメーター

レスポンス構造

結合データセット

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

Page tree

Page History

Versions Compared

Old Version 1

New Version Current

Key

/api/dataSets/:id/data

Resource Information

Request Parameters

Response Structure

Join Data Sets

Sample Request / Response

/api/dataSets/:id/data

リソース情報

リクエストパラメーター

レスポンス構造

結合データセット

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