Dashboard Component Snapshot リソース

このリソースは、ダッシュボードコンポーネントのスナップショットをユーザ、グループ、またはダッシュボードフィードに投稿して、他のユーザがデータの変更をフォローできるようにするために使用します。

リソース

1/connect/dashboards/components/componentId/snapshots

適用開始バージョン

25.0

Chatter が必要かどうか

はい

HTTP メソッド

POST

リクエストボディ

ルート XML タグ

<dashboardComponentSnapshot>

JSON

1{ 
2   "parentId" : "0F9D00000000I4O",
3   "feedItemBody" : {
4      "messageSegments" : [
5      {
6         "text" : "Sales Heat",
7         "type" : "Text"
8      }
9      ]
10   }
11}

プロパティ

名前	型	説明	使用可能なバージョン
parentId	String	スナップショットの post 送信先となるユーザ、グループ、または ダッシュボードの ID。	25.0
filterId1	String	省略可能。ダッシュボード絞り込み項目の ID。	25.0
filterId2	String	省略可能。2 つ目のダッシュボード絞り込み項目の ID。	25.0
filterId3	String	省略可能。3 つ目のダッシュボード絞り込み項目の ID。	25.0
feedItemBody	Message Body Input	ダッシュボードコンポーネントスナップショットに関連付けられたフィード項目に付随するテキストが含まれます。	25.0
runningUserId	String	省略可能。ダッシュボードのビューの作成元となるユーザ ID (作成者以外の場合)。	25.0

要求のパラメータ

名前	型	説明
parentId	String	スナップショットの post 送信先となるユーザ、グループ、または ダッシュボードの ID。
filterId1	String。	省略可能。ダッシュボード絞り込み項目の ID。
filterId2	String	省略可能。2 つ目のダッシュボード絞り込み項目の ID。
filterId3	String	省略可能。3 つ目のダッシュボード絞り込み項目の ID。
feedItemText	String	ダッシュボードコンポーネントスナップショットに付随するテキスト。
runningUserId	String	省略可能。ダッシュボードのビューの作成元となるユーザ ID (作成者以外の場合)。

レスポンスボディ

API バージョン 23.0 ～ 31.0 では、Feed Item Attachment: Dashboard を返します。

API バージョン 32.0 以降では、Dashboard Component Snapshot を返します。