Versions Compared

Old Version 8

changes.mady.by.user Radek Micka

Saved on

compared with

New Version 9

changes.mady.by.user Jan Bednarik

Saved on

Key

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

/api/dataSets/:id/data/:

deleteIds

rowIds

Deletes dataset data with given row IDs.

Resource Information

Resource URL

https://service.belladati.com/api/dataSets/:id/data/:uidsrowIds

HTTP Method

DELETE

Request Parameters

Parameters

Detail

Example
id (path parameter)
ID of the data set to fetchdelete data from. You can find the ID in the response to /api/dataSets.123
uidsrowIds (path parameter)
List of row IDs to be deleted123,411,731


/api/dataSets/:id/data

Deletes dataset data based on a filter.

Resource Information

Resource URL

https://service.belladati.com/api/dataSets/:id/data

HTTP Method

DELETE

Request Parameters

Parameters

Detail

Example
id (path parameter)
ID of the data set to delete data from. You can find the ID in the response to /api/dataSets.123
filter

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%"

{"drilldown":{"L_COUNTRY":{"op":"EQ","value":"USA"}}}


Sample Request / Response

Using curl:

Code Block
curl --location --request DELETE 'https://service.belladati.com/api/dataSets/51/data/411,731?oauth_consumer_key=apiKey&oauth_token=e112f77a6485a1c369641c63fa858dbe&oauth_signature_method=HMAC-SHA1&oauth_timestamp=1611844124&oauth_nonce=1611844124&oauth_version=1.0&oauth_signature=7DI6tg8TJCYH3U/TxGQ5Gk38iz8=' \
--header 'Content-Type: application/x-www-form-urlencoded'


Sv translation
languageja

/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
ID of the data set to fetch. You can find the ID in the response to /api/dataSets.123

filter

(Optional) Filter used to load data.

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

offset

(Optional) Specifies the page offset if pagination is necessary.

2

size

(Optional) Specifies the number of entries on each page if pagination is necessary.

15

Response Structure

Code Block
languagejs
{
  "dataSet" : { ... },
  "data" : [ { "UID" : 123456, "L_ATTRIBUTE" : "value", "M_INDICATOR" : 11.99 }, { "UID" : 123457, "L_ATTRIBUTE" : "value2", "M_INDICATOR" : 22.08 } ]
}

JSON response contains 2 elements dataSet that contains detailed information about data set (see GET Data Set Detail) and data which contains array of data rows in following strcuture:

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

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

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" : 123,
  	"name" : "My test data set",
  	"localization" : {
    "de" : "Deutsch Name"
  },
  "description" : "This is a sample data set.",
  "owner" : "John Smith",
  "lastChange" : "Tue, 22 May 2012 17:16:31 GMT",
  "attributes" : [
    {
      "id" : "123.FO8j1HfdDz",
      "name" : "City",
      "code" : "L_CITY",
      "type" : "String"
    }
  ],
  "indicators" : [
    {
      "id" : "123.8RnLDOwZnY",
      "name" : "Count",
      "type" : "DATA_INDICATOR",
      "code" : "M_COUNT"
    },
    {
      "id" : "123.Jiq7Cuyai1",
      "name" : "Calculated indicator",
      "type" : "FORMULA_INDICATOR",
      "formula" : "M_COUNT * 1000"
    },
    {
      "id" : "123.MrrmQgYyyo",
      "name" : "Indicator group",
      "type" : "INDICATOR_GROUP"
    }
  ],
  "reports" : [
    {
      "id" : 7497,
      "name" : "My Report",
      "description" : "This is a sample report.",
      "owner" : "John Smith",
      "lastChange" : "Mon, 16 Apr 2012 10:17:26 GMT"
    }
  ]
  },
  "data" : [ 
	{ "UID" : 123456, "L_ATTRIBUTE" : "value", "M_INDICATOR" : 11.99 }, 
	{ "UID" : 123457, "L_ATTRIBUTE" : "value2", "M_INDICATOR" : 22.08 } 
  ]
}

...