この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。

ステップ 4: ダッシュボードを検索、表示、更新する

ユーザの多くは、通常ダッシュボードを使用してレポートを操作します。レポートおよびダッシュボード REST API を使用すると、レポートと同じくらい簡単に、ダッシュボードにアクセスしたりダッシュボードを更新したりできます。

たとえば、ユーザが必要なダッシュボードを見つけるためにいくつもの画面に目を通さなければならず、うんざりしているとします。レポートおよびダッシュボード REST API を使用すれば、最近表示したダッシュボードの中から選ぶことができます。

Dashboard List リソースに対して GET 要求を実行すれば、最近使用したダッシュボードのリストを取得できるため、ユーザがダッシュボードを簡単に見つけられるようになります。
1/services/data/v31.0/analytics/dashboards
各ダッシュボードについて、Dashboard List リソースから次のような情報が返されます。URL ハンドルには、ダッシュボードの状況または結果が保存されます。リストは、ダッシュボードの最終更新日順に並び替えられます。
1[ { 2 "id" : "01ZD00000007QeuMAE", 3 "name" : "Adoption Dashboard", 4 "statusUrl" : "/services/data/v31.0/analytics/dashboards/01ZD00000007QeuMAE/status", 5 "url" : "/services/data/v31.0/analytics/dashboards/01ZD00000007QeuMAE" 6}]

ユーザがアプリケーションを使用しているプラットフォームやデバイスに応じて、ダッシュボードのデータを異なる方法で表示することも可能です。Dashboard Results リソースに GET 要求を実行すれば、ダッシュボードからデータをプルできます。

1/services/data/v31.0/analytics/dashboards/01ZD00000007S89MAE

返される情報は、ダッシュボードの実際のデータとそのメタデータ (ダッシュボード ID、名前、コンポーネントメタデータ、検索条件) およびその更新状況です。結果は次のように表示されます。

1{
2{
3  "componentData" : [ {
4    "componentId" : "01aD0000000a36LIAQ",
5    "reportResult" : {
6      // Report result data omitted for brevity.
7    },
8    "status" : {
9      "dataStatus" : "DATA",
10      "errorCode" : null,
11      "errorMessage" : null,
12      "errorSeverity" : null,
13      "refreshDate" : "2014-04-10T20:37:43.000+0000",
14      "refreshStatus" : "IDLE"
15    }
16  } ],
17  "dashboardMetadata" : {
18    "attributes" : {
19      "dashboardId" : "01ZD00000007S89MAE",
20      "dashboardName" : "Simple Dashboard",
21      "statusUrl" : "/services/data/v31.0/analytics/dashboards/01ZD00000007S89MAE/status",
22      "type" : "Dashboard"
23    },
24    "canChangeRunningUser" : false,
25    "components" : [ {
26      "componentData" : 0,
27      "footer" : null,
28      "header" : null,
29      "id" : "01aD0000000a36LIAQ",
30      "properties" : {
31        "aggregateName" : "s!AMOUNT",
32        "maxRows" : null,
33        "sort" : {
34          "column" : "TYPE",
35          "sortOrder" : "asc"
36        },
37        "visualizationProperties" : { },
38        "visualizationType" : "Bar"
39      },
40      "reportId" : "00OD0000001g2nWMAQ",
41      "title" : null,
42      "type" : "Report"
43    } ],
44    "description" : null,
45    "developerName" : "Simple_Dashboard",
46    "filters" : [ {
47      "name" : "Amount",
48      "options" : [ {
49        "alias" : null,
50        "endValue" : null,
51        "id" : "0ICD00000004CBiOAM",
52        "operation" : "greaterThan",
53        "startValue" : null,
54        "value" : "USD 2000000"
55      } ],
56      "selectedOption" : null
57    } ],
58    "id" : "01ZD00000007S89MAE",
59    "layout" : {
60      "columns" : [ {
61        "components" : [ 0 ]
62      } ]
63    },
64    "name" : "Simple Dashboard",
65    "runningUser" : {
66      "displayName" : "Allison Wheeler",
67      "id" : "005D00000016V2qIAE"
68    }
69  }
70}

ユーザに最新データが表示されないのではないかと懸念する場合は、更新するダッシュボードの ID を指定して、PUT Dashboard Results 要求を送信すれば、ダッシュボードをリモートで更新できます。
1/services/data/v31.0/analytics/dashboards/01ZD00000007S89MAE
応答には、更新済みのダッシュボードの状況 URL が含まれます。
1{ 2 "statusUrl" : "/services/data/v31.0/analytics/dashboards/01ZD00000007S89MAE/status" 3}

Force.com ワークブック

ステップ 4: ダッシュボードを検索、表示、更新する