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

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:

{
    "subsetValues": [
        {
            "drillDownDisabled": "true",
            "children": [
                {
                    "drillDownDisabled": "true",
                    "negativeValue": "true",
                    "id": "DTfr7DGqqM",
                    "value": "Tea"
                }
            ],
            "negativeValue": "false",
            "id": "T9yI2XwdWV",
            "value": "Coffee"
        },
        {
            "drillDownDisabled": "false",
            "negativeValue": "false",
            "id": "PUcyY5Rzt3",
            "value": "Espresso"
        },
        {
            "drillDownDisabled": "false",
            "negativeValue": "false",
            "id": "wj0JZdihSR",
            "value": "@cm=bfqJgOVzcl"
        },
        {
            "drillDownDisabled": "false",
            "children": [
                {
                    "drillDownDisabled": "false",
                    "negativeValue": "false",
                    "id": "Tr9YXLMtiy",
                    "value": "@cm=bfqJgOVzcl"
                },
                {
                    "drillDownDisabled": "true",
                    "negativeValue": "true",
                    "id": "asuyvhu5AF",
                    "value": "@cm=bfqJgOVzcl"
                }
            ],
            "negativeValue": "false",
            "id": "POEvIZazDv",
            "value": "@cm=bfqJgOVzcl"
        }
    ],
    "name": "SUB1",
    "id": "kwuQpitto1"
}


  • No labels