Versions Compared

Old Version 9

changes.mady.by.user Lubomir Micko

Saved on

compared with

New Version 10

changes.mady.by.user Kanako Higashi

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Sv translation
languageja

/api/dashboards

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

リソース情報

リソースURL 

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

HTTP方法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ページネーション要素を（JSONレスポンスには、2つのページネーション要素 (オフセットとサイズ）が含まれますが、主な要素は次の定義のように複数のダッシュボードオブジェクトを含む「dashboards」配列です。) が含まれていますが、主な要素は次の定義を持つ複数のダッシュボードオブジェクトを含む "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フォーマットの応答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
}