Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

/api/dataSets/:id/attributes/:code/subsets/:sid

Lists subsets Gets detailed information about the subset for the given data set ID and attribute code.

Resource Information

Resource URL

https://service.belladati.com/api/dataSets/:id/attributes/:code/subsets/:sid

HTTP Method

GET

Request Parameters

idData Set identifier. You can find the ID in the response to  /api/dataSets .123
codeAttribute code. You can find the code in the response to  /api/dataSets/:id .L_STATE
sidID of the subsetxELCQrxs09

Response Structure

JSON response contains an object with the following definition:


namename of the subsets
idid of the subset
subsetValues

array of subset values. Each subset value has following definition:

idID of the subset value
valueThe value can be an attribute member or custom member
negativeValueBoolean parameter defining if a negative value should be used when calculating the value of parent in a nested subset.
drillDownDisabledBoolean parameter defining if the drill-down functionality is enabled or disabled in a nested subset.
children

Optional

An array of subset values which are children of this subset value



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/attributes/L_STATE/subsets/xELCQrxs09

The JSON format response:

...