You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 11 Next »

/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_JOINED", "joinedAttribute":"L_ID", "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.

{
   "drilldown": {
      "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"
      }
   }
}

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 dataM_INDICATOR asc

Response Structure

{
  "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:

NameDescription
UIDUnique ID of data row.
L_*Attribute values contained in the data row.
M_*Indicator values contained in the data row.

Sample Request / Response

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

The JSON format response:

{
  "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",
  "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"
      }
    ]
}
  • No labels