Versions Compared

Old Version 10

changes.mady.by.user Kanako Higashi

Saved on

compared with

New Version Current

changes.mady.by.user Martin Trgiňa

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Removed translated content for 'zh'
Sv translation
languageen

/api/dashboards

Lists all dashboards available to the user.

Resource Information

Resource URL

https://service.belladati.com/api/dashboards

HTTP Method

GET

Request Parameters

Parameters

Detail

Example

filter

(Optional) If set, the result only contains dashboards that contain the filter text in their name.

Sales

offset

(Optional) Specifies the page offset if pagination is necessary.

2

size

(Optional) Specifies the number of entries on each page if pagination is necessary.

  • size = 0 means, that the back-end is supposed to return total records count only. The returning object's size parameter then becomes the default value, which is 15
  • size =-1 is used to get to get all records
  • size >0 specifies the exact number of records to be retrieved
15

Response Structure

Code Block
languagejs
{
  "dashboards" : [ ],
  "offset" : 0,
  "size" : 100
}

JSON response contains 2 pagination elements (offset and size) but the main element is array "dashboards" that contains multiple dashboard objects with following definition:

NameDescription
idDashboard identifier
nameDashboard name
descriptionDashboard description
lastChangeDate and time of dashboard last change
localization

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

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/dashboards?filter=my

The JSON format response:

Code Block
javascript
javascript
{
  "dashboards": [
    {
      "id": 12149,
      "name": "My Dashboard",
      "localization" : {
        "de" : "Deutsch Name"
      },
      "description" : "This is my description.",
      "lastChange": "Fri, 16 Aug 2013 14:49:02 GMT"
    }
  ],
  "offset": 0,
  "size": 100
}
Sv translation
languageja

/api/dashboards

ユーザーが利用できるすべてのダッシュボードを一覧表示します。

リソース情報

リソースURL 

https://service.belladati.com/api/dashboards

HTTPメソッド

GET

リクエストパラメーター

パラメーター

詳細

例

filter

(オプション) 設定されている場合、結果には、名前にフィルターテキストを含むダッシュボードのみが含まれます。

Sales

offset

(オプション) ページ付けが必要な場合は、ページオフセットを指定します。

2

size

(オプション) ページ付けが必要な場合は、各ページのエントリ数を指定します。

  • size = 0は、バックエンドが合計レコード数のみを返すことになっていることを意味します。返されるオブジェクトのサイズパラメーターがデフォルト値の15になります。
  • size =-1は、すべてのレコードを取得するために使用されます。
  • size >0は、取得するレコードの正確な数を指定します。
15

レスポンス構造

Code Block
languagejs
{
  "dashboards" : [ ],
  "offset" : 0,
  "size" : 100
}

JSONレスポンスには、2つのページネーション要素 (オフセットとサイズ) が含まれていますが、主な要素は次の定義を持つ複数のダッシュボードオブジェクトを含む "dashboards" 配列です:

名説明
idダッシュボード識別子
nameダッシュボード名
descriptionダッシュボードの説明
lastChangeダッシュボードの最終変更の日時
localization

key-valueのペアを含むローカリゼーションオブジェクト。キーはサポート言語のコードであり、値はローカライズされたダッシュボード名です。

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

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/dashboards?filter=my

JSON形式のレスポンス:

Code Block
javascript
javascript
{
  "dashboards": [
    {
      "id": 12149,
      "name": "My Dashboard",
      "localization" : {
        "de" : "Deutsch Name"
      },
      "description" : "This is my description.",
      "lastChange": "Fri, 16 Aug 2013 14:49:02 GMT"
    }
  ],
  "offset": 0,
  "size": 100
}