/api/dataSets/:id

指定されたIDを使用して設定データの詳細情報を表示します。

リソース情報

リソースURL 

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

HTTPメソッド

GET

リクエストパラメーター

パラメーター

詳細

例

id

データセットのIDをフェッチします。あなたは/api/dataSetsに応答して、IDを見つけることができます。

123

レスポンスの構造

JSONレスポンスは、次の要素ように1 つのJSONオブジェクトが含まれます。

名説明
idデータセット識別子
nameデータセット名
localizationローカライゼーションオブジェクトはキーがサポートされている言語と値ローカライズされたデータ・セット名のコードがある場合、キー-値のペアが含まれます。
descriptionデータセットの説明
owner所有者のフルネーム
lastChange最後の変更したデータの日付と時間
attributes

属性の配列

名説明
id属性識別子
name属性名
type属性タイプ - サポートされる値のリストをご参照してください。
code属性コード
indicators

属性の配列

名説明
idインジケータ識別子
nameインジケータ名
typeインジケータタイプ　 - 　サポートされる値のリストをご参照してください。
code"type"が「DATA_INDICATOR」値のみ。インジケータコード
formula"type"が「FORMULA_INDICATOR」値のみ。インジケータ式
reports

レポートの配列

名説明
idレポートの識別子
nameレポート名
descriptionレポート説明
owner所有者のフルネーム
lastChange最後変更の時間と日付

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

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

JSONフォーマットのレスポンス

{
  "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" : 24530,
      "name" : "City",
      "code" : "L_CITY",
      "type" : "String"
    }
  ],
  "indicators" : [
    {
      "id" : 24531,
      "name" : "Count",
      "type" : "DATA_INDICATOR",
      "code" : "M_COUNT"
    },
    {
      "id" : 24532,
      "name" : "Calculated indicator",
      "type" : "FORMULA_INDICATOR",
      "formula" : "M_COUNT * 1000"
    },
    {
      "id" : 24533,
      "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"
    }
  ]
}
  • No labels