Page tree

Versions Compared

Key

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

/api/dataSets/:id

Shows detailed information about the data set with the specified ID.

Resource Information

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

Response Structure

JSON response contains one JSON object with following elements:

NameDescription
idData set identifier
nameData set name
codeData set code
localizationLocalization object that contains key-value pairs, where key is code of supported language and value is localized data set name.
descriptionData set description
ownerOwner's full name
lastChangeDate and time of last change
attributes

Array of attributes

NameDescription
idAttribute identifier
nameAttribute name
typeAttribute type - please see list of supported values
codeAttribute code


indicators

Array of indicators

NameDescription
idIndicator identifier
nameIndicator name
typeIndicator type - please see list of supported values
codeOnly if "type" has value "DATA_INDICATOR". Indicator code
formulaOnly if "type" has value "FORMULA_INDICATOR". Indicator formula


reports

Array of reports

NameDescription
idReport identifier
nameReport name
descriptionReport description
ownerOwner's full name
lastChangeDate and time of last change


parameters(Optional) Array of data set parameters

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

The JSON format response:

Code Block
javascript
javascript
{
  "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" : [
    {
      "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"
    }
  ],
  "parameters": [
        {
          "param1": "value1"
        },
        {
          "param2": "value2"
        }
      ]
}


...