Sv translation

language	en

/api/reports/:id

Shows detailed information about the report with the specified ID.

Resource Information

Resource URL	https://service.belladati.com/api/reports/:id
HTTP Method	`GET`

Request Parameters

Parameters	Detail	Example
`id`	ID of the report to fetch. You can find the ID in the response to `/api/reports`.	123

Response Structure

JSON response contains one JSON object with following elements:

Name

Description

id

Report identifier

name

Report name

localization

Localization object that contains key-value pairs, where key is code of supported language and value is localized report name.

description

Report description

owner

Owner's full name

lastChange

Date and time of last change

tabs

Array of tabs inside the report with following structure

Name	Description
name	Name of the tab
views	Array containing IDs of the views inside the tab

views

Array of views where each view has following structure:

Name

Description

id

View identifier

name

View name

type

View type - please see list of supported values.

localization

Localization object that contains key-value pairs, where key is code of supported language and value is localized view name.

isFavourite

Boolean flag indicating if view is marked as favourite

dateTimeDefinition

(Optional) Applied date and time definition with following structure:

Name

Description

timeSupported

Boolean flag indicating if time is supported.

timeInterval

(Optional) Time interval to filter values. Has following structure:

Name

Description

aggregated

Boolean flag indicating if values are aggregated.

aggregationType

Time interval period - please see list of supported values.

interval

Interval definition with following structure:

Name	Description
type	Interval type - please see list of supported values.
from	Interval start value
to	Interval end value

dateSupported

Boolean flag indicating if date is supported.

dateInterval

(Optional) Date interval to filter values. Has following structure:

Name

Description

aggregated

Boolean flag indicating if values are aggregated.

aggregationType

Date interval period - please see list of supported values.

interval

Interval definition with following structure:

Name	Description
type	Interval type - please see list of supported values.
from	Interval start value
to	Interval end value

filter

(Optional) Applied filter with following structure:

Name

Description

drilldown

Drilldown defined with attribute code and following structure:

Name	Description
op	Filter operation type - please see list of supported values.
value/values	(Optional) Depends on selected "op". Contains value or values for filter.

dataSet

Source data set

Name	Description
id	Data set identifier
name	Data set name
description	Data set description
owner	Owner's full name
lastChange	Date and time of last change
dateSupported	Boolean flag indicating if date is supported
timeSupported	Boolean flag indicating if time is supported
drilldownAttributes	Array of drilldown attributes

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

The JSON format response:

Code Block

	javascript
	javascript

{
  "id" : 123,
  "name" : "My Report",
  "localization" : {
    "de" : "Der Report"
  },
  "description" : "This is a report description",
  "owner" : "John Smith",
  "tabs": [
        {
            "name": "First tab",
            "views": [
                "l2nuOY1ocA"
            ]
        },
        {
            "name": "Second tab",
            "views": [
                "wK4g3gmezs"
            ]
        }
    ],
  "lastChange" : "Tue, 22 May 2012 17:16:31 GMT",
  "views" : [
    {
      "id" : 302-xB0Klm6c1L,
      "type" : "chart",
      "name" : "My View name",
      "localization" : {
        "de" : "Der lokalisierte Name"
      },
      "isFavourite" : false,
      "dateTimeDefinition" : {
        "timeSupported" : true,
        "dateSupported" : true,
        "timeInterval" : {
          "aggregationType" : "SECOND",
          "interval" : {
            "from" : {
              "hour" : "13",
              "minute" : "38",
              "second" : "0"
            },
            "to" : {
              "hour" : "21",
              "minute" : "48",
              "second" : "0"
            },
            "type" : "absolute"
          },
          "aggregated" : false
        },
        "dateInterval" : {
          "aggregationType" : "DAY",
          "interval" : {
            "from" : {
              "month" : "8",
              "year" : "2012",
              "day" : "7"
            },
            "to" : {
              "month" : "7",
              "year" : "2015",
              "day" : "14"
            },
            "type" : "absolute"
          }
        }
      },
      "filter": {
        "drilldown": {
          "L_USER": {
            "values": [
              "john"
            ],
            "op": "IN"
          }
        }
      }
    }
  ],
  "dataSet" : {
    "id" : 1234,
    "name" : "Data set name",
    "description" : "This is a data set description",
    "owner" : "John Smith",
    "lastChange" : "Thu, 08 Oct 2015 11:43:40 GMT",
    "timeSupported" : true,
    "dateSupported" : true,
    "drilldownAttributes" : [ ]
  }
}

Sv translation

language	ja

/api/reports/:id

指定されたIDを持つレポートの詳細情報を表示します。

リソース情報

リソースURL	https://service.belladati.com/api/reports/:id
HTTPメソッド	`GET`

リクエストパラメーター

パラメーター	詳細	例
`id`	レポートのIDをフェッチします。/api/reportsに応じて、IDを見つけることができます。	123

レスポンス構造

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

名

説明

id

レポートの識別子

name

レポート名

localization

ローカライゼーションオブジェクトはキーがサポートされている言語と値ローカライズされたレポート名のコードがある場合、キー-値のペアが含まれます。

description

レポートの説明

owner

所有者のフルネーム

lastChange

最後変更の時間と日付

views

各ビューの配列が以下のように構造があります：

名

説明

id

ビュー識別子

name

ビュー名

type

ビュータイプ　- 　サポートされている値のリストを参照してください。

localization

ローカライゼーションオブジェクトはキーがサポートされている言語と値ローカライズされたビュー名のコードがある場合、キー-値のペアが含まれます。

isFavourite

ビューがお気に入りとしてマークされているかどうかを示すブールフラグ

dateTimeDefinition

（任意）以下の構造の日時定義を適用：

名

説明

timeSupported

Booleanフラグは時間がサポートされている場合にを示します。

timeInterval

（任意）値をフィルタリングする時間間隔。構造は次の通りです：

名

説明

aggregated

Booleanフラグは値を集計している場合に示します。

aggregationType

タイムインターバル期間は - サポートされる値のリストをご参照してください。

interval

構造のインターバルの定義が次通りです:

名	説明
type	インターバルタイプ - サポートされている値のリストをご参照してください。
from	インターバル開始値
to	インターバル終了値

dateSupported

Booleanフラグは日付がサポートされている場合に示します。

dateInterval

（任意）値をフィルタリングする日付間隔。構造は次の通りです：

名

説明

aggregated

Booleanフラグは値を集計している場合に示します。

aggregationType

日付インターバル期間 - サポートされる値のリストをご参照してください。

interval

構造のインターバルの定義が次の通りです：

名	説明
type	インターバルタイプ - サポートされている値のリストをご参照してください。
from	インターバル開始値
to	インターバル終了値

filter

（任意）フィルタが次のような構造を持つ適用されます：

名

説明

drilldown

属性コードとそれに続く構造で定義されたドリルダウン：

名	説明
op	フィルタ操作タイプ - サポートされている値のリストをご参照してください。
value/values	（任意）選択した「op」に依存する。フィルタの値または値を格納します。

dataSet

ソースデータセット

名	説明
id	データセット識別子
name	データセット名
description	データセットの説明
owner	所有者のフルネーム
lastChange	最後変更の時間と日付
dateSupported	Booleanフラグは日付がサポートされている場合に示します
timeSupported	Booleanフラグは時間がサポートされている場合に示します
drilldownAttributes	ドロップダウン属性の配列

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

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

JSONフォーマットの応答:

Code Block

	javascript
	javascript

{
  "id" : 123,
  "name" : "My Report",
  "localization" : {
    "de" : "Der Report"
  },
  "description" : "This is a report description",
  "owner" : "John Smith",
  "lastChange" : "Tue, 22 May 2012 17:16:31 GMT",
  "views" : [
    {
      "id" : 24530,
      "type" : "chart",
      "name" : "My View name",
      "localization" : {
        "de" : "Der lokalisierte Name"
      },
      "isFavourite" : false,
      "dateTimeDefinition" : {
        "timeSupported" : true,
        "dateSupported" : true,
        "timeInterval" : {
          "aggregationType" : "SECOND",
          "interval" : {
            "from" : {
              "hour" : "13",
              "minute" : "38",
              "second" : "0"
            },
            "to" : {
              "hour" : "21",
              "minute" : "48",
              "second" : "0"
            },
            "type" : "absolute"
          },
          "aggregated" : false
        },
        "dateInterval" : {
          "aggregationType" : "DAY",
          "interval" : {
            "from" : {
              "month" : "8",
              "year" : "2012",
              "day" : "7"
            },
            "to" : {
              "month" : "7",
              "year" : "2015",
              "day" : "14"
            },
            "type" : "absolute"
          }
        }
      },
      "filter": {
        "drilldown": {
          "L_USER": {
            "values": [
              "john"
            ],
            "op": "IN"
          }
        }
      }
    }
  ],
  "dataSet" : {
    "id" : 1234,
    "name" : "Data set name",
    "description" : "This is a data set description",
    "owner" : "John Smith",
    "lastChange" : "Thu, 08 Oct 2015 11:43:40 GMT",
    "timeSupported" : true,
    "dateSupported" : true,
    "drilldownAttributes" : [ ]
  }
}

Page tree

Versions Compared

Old Version 29

New Version Current

Key

/api/reports/:id

Resource Information

Request Parameters

Response Structure

Sample Request / Response

/api/reports/:id

リソース情報

リクエストパラメーター

レスポンス構造

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

Page tree

Page History

Versions Compared

Old Version 29

New Version Current

Key

/api/reports/:id

Resource Information

Request Parameters

Response Structure

Sample Request / Response

/api/reports/:id

リソース情報

リクエストパラメーター

レスポンス構造

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