Chatter REST API 開発者ガイド
バージョン 35.0, Winter ’16
@salesforcedocs
最終更新日: 2015/9/1
© Copyright 2000–2015 salesforce.com, inc. All rights reserved. Salesforce およびその他の名称や商標は、salesforce.com,
inc. の登録商標です。本ドキュメントに記載されたその他の商標は、各社に所有権があります。
目次
第 1 章: Chatter REST API の概要 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Chatter REST API を使用するケースの決定 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Chatter REST API アーキテクチャ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Chatter REST API リソース URL の作成 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
HTTP 要求の送信 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Chatter REST API 要求および応答について . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Chatter REST API 入力の使用 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
ワイルドカード . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
応答サイズの指定 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
filterGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
exclude . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
include . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
レスポンスボディの符号化 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
状況コードとエラー応答 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
OAuth と Chatter REST API について . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Web サーバ OAuth 認証フローについて . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
ユーザエージェント OAuth 認証フローについて . . . . . . . . . . . . . . . . . . . . . . . . . . 48
トークンの使用 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
HTML からの静的アセットの直接要求およびフォーム要求の直接投稿 . . . . . . . . . . 53
CORS を使用した Chatter REST API および REST API へのアクセス . . . . . . . . . . . . . . . . . . . 54
第 2 章: Chatter REST API クイックスタート . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
前提条件 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
ステップ 1: Salesforce Developer Edition 組織を取得する . . . . . . . . . . . . . . . . . . . . . . . . . 57
ステップ 2: 認証を設定する . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
ステップ 3: OAuth を使用して Chatter REST API に接続する . . . . . . . . . . . . . . . . . . . . . . . 58
Salesforce Communities への接続 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
第 3 章: Chatter REST API の機能 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
アクションリンクの使用 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
アクションリンクの使用事例 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
アクションリンクの概要、認証、およびセキュリティ . . . . . . . . . . . . . . . . . . . . . 66
アクションリンクテンプレート . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
コミュニティの使用 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
フィードおよびフィード要素の使用 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Salesforce Files の使用 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
第 4 章: Chatter REST API の例 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
レスポンスボディを絞り込む . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
目次
コミュニティで要求を実行する . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
フィード項目を投稿する . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
フィード要素を投稿し、Salesforce のファイルを含める . . . . . . . . . . . . . . . . . . . . . . . 107
コメントを投稿する . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
コメントを投稿し、Salesforce のファイルを含める . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
バイナリファイルを投稿する . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
@メンションを投稿する . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
複数の @メンションを投稿する . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
@メンション提案のリストを取得する . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
アクションリンクを定義し、フィード要素を使用して投稿する . . . . . . . . . . . . . . . . . . 114
テンプレートのアクションリンクを定義し、フィード要素を使用して投稿する . . . . . . 118
アクションリンクの状況を更新するかアクションリンクを呼び出す . . . . . . . . . . . . . . 123
フィード項目にいいね! と言う . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
フィード項目にいいね! と言い、いいね! の総数を返す . . . . . . . . . . . . . . . . . . . . . . . . 125
フィード項目を共有する . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
最後の要求以降に更新されたフィード要素を取得する . . . . . . . . . . . . . . . . . . . . . . . . 126
自分のニュースフィードの更新をポーリングする . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
自分のニュースフィードを取得する . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
グループフィードを取得する . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
内部のフィード項目のみを含むフィードを取得する . . . . . . . . . . . . . . . . . . . . . . . . . . 129
フィードを検索する . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
ユーザがフォローしているレコードのリストを取得する . . . . . . . . . . . . . . . . . . . . . . 129
ユーザの Chatter 活動の統計情報を取得する . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
フォローするユーザのおすすめを取得する . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
グループを作成する . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
グループの写真を更新およびトリミングする . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
グループに参加する . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
非公開グループへの参加を要求する . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
非公開グループへの参加要求を承認または却下する . . . . . . . . . . . . . . . . . . . . . . . . . . 132
グループに投稿する . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
レコードをフォローする . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
レコードのフォローを停止する . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
レコードフィードを取得する . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
ユーザプロファイルを更新する . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
ユーザの写真を更新およびトリミングする . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
非公開メッセージを送信する . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
複数のユーザのユーザ情報を取得する . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
第 5 章: Chatter REST API リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
Action Links リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
Action Link Group Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
Action Link Group Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
Action Link Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
Action Link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
目次
Action Link Diagnostic Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
Announcements リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
Batch リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
Chatter リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
Comments リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
Communities リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
Communities Moderation リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
Connect リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
Dashboard Component Snapshot リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
Datacloud リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
Datacloud Company Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
Datacloud Contact Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
Datacloud OrderId Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
Datacloud Company Order Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
Datacloud Contact Order Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
Datacloud Orders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
Datacloud Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
Feed Elements リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
Feed Elements, Post and Search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
Feed Elements, Batch Post . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
Feed Elements, Batch Get . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
Feed Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
Feed Element Capabilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
Feed Elements Capability, Approval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
Feed Elements Capability, Associated Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
Feed Elements Capability, Banner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
Feed Elements Capability, Bookmarks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
Feed Elements Capability, Bundle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
Feed Elements Capability, Bundle Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
Feed Elements Capability, Canvas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
Feed Elements Capability, Case Comment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
Feed Elements Capability, Chatter Likes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
Feed Elements Capability, Chatter Likes Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
Feed Elements Capability, Comments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
Feed Elements Capability, Comments Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
Feed Elements Capability, Content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
Feed Elements Capability, Dashboard Component Snapshot . . . . . . . . . . . . . . . . . . . 206
Feed Elements Capability, Editability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
Feed Elements Capability, Email Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
Feed Elements Capability, Enhanced Link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
Feed Elements Capability, Link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
Feed Elements Capability, Moderation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
Feed Elements Capability, Origin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
Feed Elements Capability, Poll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
目次
Feed Elements Capability, Question and Answers . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
Feed Elements Capability, Recommendations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
Feed Elements Capability, Record Snapshot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
Feed Elements Capability, Topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
Feed Elements Capability, Tracked Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
Feed Items リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
Feed-Items Batch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
Feed-Items Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
Feed-Items, Specific Feed Item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
Feed Items Comments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
Feed-Items Likes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
Feed-Items Polls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
Feed-Items Topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
Feed リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
Bookmarks Feed リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
Communities Home Feed リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
Communities Moderation Feed リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
Company Feed リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239
Favorites Feed リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
Feeds リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252
Files Feed リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252
Filter Feed リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259
Groups Feed リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
News Feed リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274
People Feed リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300
Record Feed リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
To Feed リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329
Topics Feed リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336
User Profile Feed リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339
Files Connect Repository リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359
Files Connect Repository List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360
Files Connect リポジトリ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361
Files Connect Repository File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361
Files Connect Repository File Content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 362
Files Connect Repository Folder Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 362
Files リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363
File Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364
File Content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367
File Shares . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367
Files Shares Link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370
File Rendition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370
File Information, Batch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371
Folders リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372
Groups リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 376
目次
List of Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 377
Group Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 381
Batch Group Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 386
Group Announcements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387
Group Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 389
Group Members . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390
Group Members—Private . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393
Group Membership Requests—Private . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398
Group Memberships リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 400
Group Photo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 404
Group Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 407
Group Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 408
Group Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 409
Group Topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410
Influence リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 411
Likes リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412
Managed Topics リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412
Managed Topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 413
Managed Topic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 418
Mentions リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419
Mentions Completions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419
Mentions Validations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 422
Motifs リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423
Push Notifications リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 425
Question and Answers Suggestions リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427
おすすめ定義リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428
Recommendation Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428
Recommendation Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 430
Recommendation Definition Photo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 432
Records リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 435
Followers on Records リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 435
Topics on Records リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 436
スケジュール済みおすすめリソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 438
スケジュール済みおすすめ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 438
スケジュール済みおすすめ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 441
Subscriptions リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 445
Topics リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 445
List of Topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 446
Topics Suggestions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448
Trending Topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 449
Topic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 451
Topics, Endorse People . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454
Topic Endorsements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455
Topic Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456
目次
Topic Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 459
Topics, Knowledgeable People List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460
Related Topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460
Topics, Opt Outs from Knowledgeable People List . . . . . . . . . . . . . . . . . . . . . . . . . . . 461
Topics, Opt Out from Knowledgeable People List . . . . . . . . . . . . . . . . . . . . . . . . . . . 461
User Profiles リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462
Users リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463
User Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 465
User Profile Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466
Batch User Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 468
User Conversations, General . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 469
User Conversations, Specific . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 470
Change Status of Conversations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 472
Get Unread Count for Conversations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 473
Users Files, General . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 473
User Files, Filtered by Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 477
User Files, Filtered by Sharing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 478
User Followers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 479
Following . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480
User Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 482
Topics a User is Knowledgeable About . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 483
User Messages, General . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 484
User Messages, Specific . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495
User Photo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495
User Recommendations, General . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 499
User Recommendations for a Specific Action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 501
User Recommendations for a Specific Action and Object Category . . . . . . . . . . . . . . . 503
User Recommendations for a Specific Action and Key Prefix . . . . . . . . . . . . . . . . . . . 506
User Recommendations for a Specific Action and Object ID . . . . . . . . . . . . . . . . . . . . 509
User Recommendations for a Specific Action and Object Type . . . . . . . . . . . . . . . . . . 510
User Reputation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 510
User Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 511
User Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 512
Topics Recently Used . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 513
Zones リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 513
List of Zones . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 514
Zone Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 514
Zone Search Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 515
第 6 章: Chatter REST API リクエストボディ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 516
Action Link Definition Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 516
Action Link Group Definition Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 522
Action Link Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 526
Action Link Template Binding Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 527
目次
Announcement Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 528
Associated Actions Capability Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 529
Attachment Input: Canvas App . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 530
Attachment Input: Existing Content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 531
Attachment Input: Feed Poll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 532
Attachment Input: Link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 533
Attachment Input: New File Upload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 534
Batch Collection Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 535
Batch Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 536
Bookmarks Capability Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 539
Canvas Capability Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 539
Comment Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 540
Comment Capabilities Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 541
Content Capability Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 542
Datacloud Order Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 542
Dashboard Component Snapshot Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 544
Feed Element Capabilities Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 545
Feed Favorite Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 547
Feed Item Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 548
Feed Item Topic Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 554
Feed Poll Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 554
File Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 555
File Shares Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 556
Folder Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 557
Folder Item Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 557
Following Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 558
Generic Batch Collection Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 559
Generic Batch Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 560
Group Chatter Settings Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 563
Group Information Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 563
Group Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 564
Group Member Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 566
Group Membership Request Update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 567
Group Record Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 567
Link Capability Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 568
Managed Topic Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 568
Managed Topic Position Collection Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 570
Managed Topic Position Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 572
Message Body Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 572
Message Segment Input: Hash Tag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 573
Message Segment Input: Link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 573
Message Segment Input: Mention . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 574
Message Segment Input: Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 574
Moderation Flag Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 574
目次
Photo Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 575
Poll Capability Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 576
Push Notification Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 577
Question and Answers Capability Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 578
Recommendation Definition Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 579
Request Header Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 580
Scheduled Recommendation Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 581
Share Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 583
Topic Assignment Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 583
Topic Endorsement Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 584
Topic Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 584
User Chatter Settings Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 585
User Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 586
User Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 587
User Message Recipient Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 588
User Message Recipient List Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 588
User Status Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 589
User Stream (Conversation) Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 589
第 7 章: Chatter REST API レスポンスボディ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 590
Action Link Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 590
Action Link Diagnostic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 594
Action Link Group Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 594
Address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 596
Announcement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 596
Announcement Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 597
Approval Capability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 598
Approval Post Template Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 598
Article Item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 599
Associated Actions Capability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 599
Banner Capability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 599
Batch Result Item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 600
Batch Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 601
Bookmarks Capability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 601
Case Comment Capability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 602
Canvas Capability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 603
Chatter Activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 604
Chatter Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 604
Chatter Influence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 605
Chatter Likes Capability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 605
ClientInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 605
Comment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 606
Comment Capabilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 607
Comment Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 608
目次
Comments Capability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 608
Community . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 609
Community Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 610
Connect Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 610
Content Capability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 611
Conversation Detail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 613
Conversation Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 613
Conversation Summary Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 613
Conversation Unread Count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 614
Dashboard Component Snapshot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 614
Dashboard Component Snapshot Capability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 615
Datacloud Company . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 615
Datacloud Company Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 617
Datacloud Contact . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 618
Datacloud Contact Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 619
Datacloud Order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 620
Datacloud Purchase Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 620
Edit Capability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 620
Email Address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 621
Email Message Capability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 622
Enhanced Link Capability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 622
Error Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 623
Error with Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 623
Explanation Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 623
Explanation Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 625
Favorite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 627
Favorites Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 628
Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 628
Feed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 630
Feed Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 631
Feed Directory Item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 631
Feed Element Capabilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 633
Feed Element Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 636
Feed Entity Is Editable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 638
Feed Item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 638
Feed Item Attachment: Approval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 647
Feed Item Attachment: Basic Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 648
Feed Item Attachment: Canvas Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 648
Feed Item Attachment: Case Comment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 649
Feed Item Attachment: Content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 651
Feed Item Attachment: Dashboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 653
Feed Item Attachment: Email Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 654
Feed Item Attachment: Link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 654
Feed Item Attachment: Poll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 655
目次
Feed Item Attachment: Record Snapshot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 655
Feed Item Attachment: Tracked Change . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 655
Feed Item Body . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 656
Feed Item Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 656
Feed Item Preamble Message Body . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 657
Feed Items Topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 658
Feed Modified Info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 658
Feed Poll Choice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 659
Feed Tracked Change . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 659
File Detail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 659
File Share Link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 660
File Shares Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 661
File Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 661
File Summary Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 665
Files Connect Provider Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 666
Files Connect リポジトリ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 666
Files Connect Repository Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 667
Files Connect Repository Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 668
Flat Feed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 668
Flat Feed Item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 669
Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 669
Folder Item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 670
Folder Item Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 670
Follower Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 671
Following Counts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 671
Following Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 672
Generic Bundle Capability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 672
汎用フィード要素 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 673
Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 675
Group Chatter Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 677
Group Detail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 677
Group Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 680
Group Member . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 680
Group Member Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 680
Group Membership Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 681
Group Membership Request Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 682
Group Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 682
Group Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 682
Group Record Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 683
Icon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 683
Influence Thresholds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 684
Knowledgeable People . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 684
Knowledgeable People Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 685
Like . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 685
目次
Like Message Body . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 686
Like Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 686
Link Capability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 687
List View Column . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 687
List View Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 687
List View Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 688
List View Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 688
List View Sort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 689
Maintenance Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 690
Managed Topic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 691
Managed Topic Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 692
Mention Completion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 692
Mention Completion Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 693
Mention Validation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 693
Mention Validations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 694
Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 695
Message Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 696
Message Segment: Entity Link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 696
Message Segment: Field Change . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 696
Message Segment: Field Change Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 697
Message Segment: Field Change Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 698
Message Segment: Hashtag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 698
Message Segment: Link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 699
Message Segment: Mention . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 699
Message Segment: More Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 700
Message Segment: Resource Link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 701
Message Segment: Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 701
Moderation Capability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 701
Moderation Flags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 702
Motif . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 702
Non-Entity Recommendation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 704
Organization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 705
Origin Capability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 705
Phone Number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 706
Photo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 707
Platform Action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 707
Platform Action Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 711
Poll Capability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 713
Question and Answers Capability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 713
Question and Answers Suggestion Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 713
Recommendation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 714
Recommendation Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 715
Recommendation Definition Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 716
Recommendations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 716
目次
Recommendations Capability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 716
Recommended Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 717
Record Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 717
Record Field: Blank . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 718
Record Field: Compound . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 718
Record Field: Currency . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 719
Record Field: Date . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 720
Record Field: Percent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 720
Record Field: Picklist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 721
Record Field: Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 721
Record Field: Reference with Date . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 722
Record Snapshot Capability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 723
Record Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 723
Record Summary List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 723
Record View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 724
Record View Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 725
Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 726
Repository File Detail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 726
Repository File Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 726
Repository Folder Item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 727
Repository Folder Items Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728
Repository Folder Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728
評価 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 729
Reputation Level . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 729
Request Header . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 730
スケジュール済みおすすめ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 730
Scheduled Recommendation Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 731
Shares . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 731
Subscription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 732
Subscription Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 733
Time Zone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 733
Topic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 733
Topic Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 734
Topic Endorsement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 734
Topic Endorsement Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 735
Topic Images . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 735
Topic Opt Out . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 736
Topic Opt Out Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 736
Topic Suggestion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 737
Topic Suggestion Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 737
Topics Capability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 737
Topics People Are Knowledgeable About . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 737
Topics People Are Knowledgeable About Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . 738
Tracked Change Bundle Capability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 739
目次
Tracked Changes Capability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 739
Unauthenticated User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 740
User Capabilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 740
User Chatter Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 741
User Detail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 741
User Group Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 744
User Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 745
User Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 745
User Profile Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 745
User Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 746
User Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 748
User Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 748
Zone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 750
Zone Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 751
Zone Search Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 751
Zone Search Result . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 752
第 8 章: Chatter REST API の付録 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 753
アクションリンクの表示ラベル . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 753
第1章
トピック:
•
Chatter REST API を
使用するケースの
決定
•
Chatter REST API
アーキテクチャ
•
Chatter REST API リ
ソース URL の作成
•
HTTP 要求の送信
•
Chatter REST API 要
求および応答につ
いて
•
Chatter REST API 入
力の使用
•
ワイルドカード
•
応答サイズの指定
•
レスポンスボディ
の符号化
•
状況コードとエ
ラー応答
•
OAuth と Chatter
REST API について
•
CORS を使用した
Chatter REST API お
よび REST API へのア
クセス
Chatter REST API の概要
特にモバイルアプリケーションで、Salesforce データを
表示するには、Chatter REST API を使用します。Chatter
REST API 応答は、表示用にローカライズおよび構造化
されます。アプリケーションに必要な応答のみが含ま
れるように、応答を絞り込むことができます。また、
Chatterフィード、ユーザ、グループ、フォロワーに加
え、Chatter REST API では、ファイル、おすすめ情報、ト
ピック、通知、Data.com の購入などにプログラムを介
してアクセスすることもできます。Chatter REST API は、
Facebook や Twitter などのフィードを提供する他の企業
から公開されている API に似ていますが、Chatter 以外
の Salesforce 機能も公開されます。
1
エディション
使用可能なエディション:
Personal Edition を除くす
べてのエディション。さ
らに、一部の機能では、
組織で Chatter が有効に
なっている必要がありま
す。
Chatter REST API の概要
Chatter REST API を使用するケースの決定
Chatter REST API を使用するケースの決定
次の場合は、Chatter REST API を使用してください。
• Chatter フィードを表示するモバイルクライアントを作成する。
• サードパーティ製 Web アプリケーションを Chatter と統合して、ユーザのグループに行動について通知す
る。
• ユーザが認証された後、Chatter フィードをイントラネットサイトなどの外部システムに表示する。
• フィードをサードパーティサイトに統合して利用可能にする。たとえば、投稿に #tweet ハッシュタグが含
まれる場合は常に Chatter 項目を Twitter に投稿するアプリケーションなどがあります。
• Chatter と連動し、フィード上で通知を行える簡単なゲームを作成する。たとえば、インセンティブが支給
されるセールスコンテストなどが考えられます。
• 組織のブランド情報を含むカスタムの Chatter 用スキンを作成する。
Chatter REST API と他の API との違い
Chatter REST API は、フィード、グループ情報、Chatter ユーザプロファイルの詳細など、Chatter データを操作しや
すくすることで SOAP API および REST API 機能を補足します。
SOAP API および REST API との違いとして、Chatter REST API は次のような特長を備えています。
• 返された情報が自動的にユーザのタイムゾーンと言語にローカライズされる。
• フィード項目は、Web サイトとモバイルデバイスに表示しやすい方法で構造化される。
• フィードで追跡されている変更値は、値ペア表現で返される。
• オブジェクト間のリレーションは、外部キーを解決しなくても容易にトラバースできる。たとえば、Chatter
REST API を使用すると、ユーザをフォローしている人やユーザのグループのすべてをページごとに 1 つの要
求で取得できます。
• Chatter REST API のレート制限は、ユーザ、アプリケーション、および時間ごとです。SOAP API および REST API
のレート制限は、組織ごとです。詳細は、「Chatter REST API 要求および応答について」を参照してくださ
い。
アプリケーションに適した API の選択
Salesforce は、さまざまな使用事例向けに、SOAP API、REST API を含む多くのタイプの API を用意しています。こ
れらの API を使用すると、ほとんどの Chatter データを含む、Salesforce データの大半にアクセスできます。
それでは、どのような場合に、どの API を使用すればよいのでしょうか。
SOAP API または REST API は、次のような状況で使用します。
• あるシステムから別のシステムにユーザプロファイルとそれに関連付けられたユーザの写真を移行または
同期する。
• Chatter の分析アプリケーションを作成する。
• 返すレコードまたは項目を具体的に選択してクエリする。
2
Chatter REST API の概要
Chatter REST API アーキテクチャ
SOAP API および REST API のレート制限と強力なクエリ言語は、これらの使用事例により適しており、Chatter デー
タのほとんどに適用できます。
これに対し、Chatter REST APIは、たとえば、写真の投稿や、フィード項目での @メンションリッチテキストの使
用など、Chatter の最も複雑なデータ構造のいくつかをサポートする唯一の API です。必要に応じて、SOAP API ま
たは REST API でクエリを行い、抽出したフィード項目またはコメント ID を使用して、Chatter REST API で複雑な操
作を行うといった使い方が可能です。
Chatter in Apex
ConnectApi 名前空間の Apex クラスでは多くの Chatter REST API リソースアクションが静的メソッドとして公開
されています。この名前空間は、Chatter in Apex とも呼ばれます。Chatter in Apex は、Apex からの HTTP コールアウ
トを使用せずに Force.com プラットフォームで Chatter アプリケーションを開発するために使用します。
Chatter in Apex についてのドキュメントは、『Apex コード開発者ガイド』を参照してください。
Chatter REST API アーキテクチャ
Chatter REST APIを使用するには、認証方法、要求の制限、サポートされるデータ形式など、そのアーキテクチャ
の基本的な特性をいくつか理解する必要があります。
Chatter REST API のリソースとアーキテクチャには次の重要な特性があります。
認証
Chatter REST API は OAuth 2.0 を使用します。
メモ: Salesforce には、一般に HTTPS を使用してセキュアにアクセスします。
CORS (クロスオリジンリソーススクリプティング)
Chatter REST API および REST API では、CORS (クロスオリジンリソース共有) がサポートされます。Web ブラウザ
で JavaScript からこれらの API にアクセスするには、スクリプトを提供するオリジンを CORS ホワイトリスト
に追加します。「CORS を使用した Chatter REST API および REST API へのアクセス」を参照してください。
デフォルトの HTML エンティティ符号化
Chatter REST API 文字列は、デフォルトでは最小限に符号化された HTML エンティティであり、多くの場合は
HTML タグ間の表示に適していますが、他の HTML コンテキストには適しているとは限りません。
ネイティブのモバイルアプリケーションなど、非 HTML コンテキストの場合、Chatter REST API クライアント
が、要求内の X-Chatter-Entity-Encoding HTTP ヘッダーを false に設定して、未加工 (符号化されて
いない) の出力を要求する場合があります。
詳細は、「レスポンスボディの符号化」 (ページ 38) を参照してください。
JSON と XML のサポート
JavaScript Object Notation (JSON) 形式は UTF-8 でサポートされます。日時情報は ISO8601 形式です。
XML 逐次化は SOAP API と類似しています。XML 要求は UTF-8 および UTF-16 でサポートされ、XML 応答は UTF-8
で提供されます。
デフォルトでは、応答は JSON 形式です。XML を指定するには、HTTP ヘッダー Accept: application/xml
を使用します (JSON を指定するには、Accept: application/json を使用します)。
3
Chatter REST API の概要
Chatter REST API アーキテクチャ
戻り値の形式を指定するには、.json または .xml のいずれかをリソースの URI に付加します。たとえ
ば、/chatter/feeds/filter/me/001/feed-elements.xml です。
メモ: すべての機能が XML をサポートしているわけではありません。
制限
Chatter REST API 要求はレート制限の対象になります。Chatter REST API には、ユーザ、アプリケーション、およ
び時間ごとのレート制限があります。レート制限を超過すると、すべての Chatter REST API リソースが 503
Service Unavailable エラーコードを返します。
アプリケーションでの認証に OAuth トークンではなくセッション ID が使用されると、そのアプリケーショ
ンの要求は、要求の一般割り当て数としてカウントされます。セッション ID を使用してアクセスするすべ
てのアプリケーションでは、この一般割り当て数が使用されます。このため、クライアントで OAuth トー
クンを使用することをお勧めします。
メモ: すべての状況で指定されたリソースが規定の制限まで使用できるとは限りません。たとえば、
負荷、パフォーマンスやその他のシステムの問題によってはその制限に達する前に使用できなくなる
場合があります。規定の制限は、通知なく変更される場合があります。アプリケーションは、使用可
能な要求を効率よく利用し、503 エラーコードを適切に処理する必要があります。
ローカライズされた名前と時刻
Chatter REST API は、名前と日時の両方をユーザのロケール設定にローカライズします。ユーザは、個人情報
にロケールを設定します。ユーザがロケールを設定していない場合、Chatter REST API は組織のデフォルトの
ロケールを使用します。
クライアントは、組織で使用できる任意のロケールを使用して、デフォルトのロケールを上書きできます。
Accept-Language HTTP ヘッダーを使用して、API 要求のロケールを上書きします。
メモ: ISO-8601 の日付形式は常に GMT です。
Salesforce ID の長さ
レスポンスボディでの Salesforce ID は常に 18 文字です。リクエストボディでは、15 文字または 18 文字の ID
を使用できます。
UI のテーマ
クライアントは、X-Connect-Theme HTTP ヘッダーを使用して任意の API 要求の UI テーマを指定できます。
2 つのテーマがあり、各テーマには独自の motif アイコンのセット、Classic と Salesforce1 がありま
す。テーマ名は大文字と小文字を区別します。
メソッドの上書き
使用する HTTP ライブラリで任意の HTTP メソッド名の上書きまたは設定が許可されていない場合、POST 要
求を送信し、要求パラメータ _HttpMethod で HTTP メソッドを上書きすることができます。次に例を示し
ます。
https://instance_name/services/data/v34.0/chatter/
/chatter/users/me/conversations/03MD0000000008KMAQ
?_HttpMethod=PATCH&read=true
メモ: _HttpMethod パラメータでは、大文字と小文字が区別されます。すべての値の大文字と小文字
を正しく使用してください。
4
Chatter REST API の概要
Chatter REST API リソース URL の作成
ステートレス
クライアントからサーバへの各要求には、要求を理解するのに必要なすべての情報が含まれている必要が
あり、サーバに保存されたコンテキストは使用されません。ただし、リソースの表現は URL を使用して相
互に連結されるため、クライアントはステート間を移動して処理を行うことができます。
統一されたインターフェース
すべてのリソースには、HTTP を介した汎用インターフェースを使用してアクセスします。
Chatter REST API リソース URL の作成
すべての Chatter REST API リソースへのアクセスには、会社のインスタンスの URI に、バージョンとコミュニティ
情報、およびリソースの URI を組み合わせて使用します。
たとえば、次のようなインスタンスがある場合に、コミュニティを含まない URL を作成するとします。
https://na1.salesforce.com
バージョン情報:
/services/data/v34.0
リソース:
/chatter/feeds/news/me/feed-elements
これらを組み合わせると完全な URL は次のようになります。
https://na1.salesforce.com/services/data/v34.0/chatter/
feeds/news/me/feed-elements
コミュニティの一部であるリソースにアクセスするには、バージョン情報の後、リソースの前に次のように指
定します。
/connect/communities/communityId
たとえば、コミュニティの News Feed リソースにアクセスする完全な URL は次のようになります。
https://na1.salesforce.com/services/data/v34.0/connect
/communities/communityId/chatter/feeds/news/me/feed-elements
デフォルトのコミュニティのリソースにアクセスするには、internal ショートカットをコミュニティ ID とし
て使用します。
/connect/communities/internal
internal ショートカットは、コミュニティが有効になっていない場合でも使用できます。複数の組織向けに
アプリケーションを開発しており、コミュニティを使用しない組織がある場合に、このショートカットを使用
できます。
レスポンスボディの URL には、/connect/communities/internal が含まれます。この形式を使用すると、
コミュニティの参照時に文字列の補間を実行できます。
5
Chatter REST API の概要
HTTP 要求の送信
デフォルトのコミュニティのリソースにアクセスする場合は、/chatter リソース
(/connect/communities/internal なし) を直接使用することもできます。レスポンスボディの URL に
は、/connect/communities/internal は含まれません。
さらに、組織のコミュニティのカスタム URL を使用して、コミュニティ内のリソースにアクセスすることも可
能です。次に例を示します。
https://communitydomain.force.com/communitypath/services/data/v34.0/connect
/communities/communityId/chatter/feeds/news/me/feed-elements
HTTP 要求の送信
Chatter REST API は HTTP メソッドを使用して JSON および XML コンテンツを送受信します。そのため、自分で選ん
だツールや言語を使用してクライアントアプリケーションを非常に簡単に構築することができます。
Chatter REST API リソースへの HTTP 要求には、次の情報が含まれます。
• HTTP メソッド (GET、POST、PATCH、または DELETE)。
• 要求の認証に使用される OAuth 2.0 アクセストークン。トークンの取得方法については、「Chatter REST API ク
イックスタート」を参照してください。
• Chatter REST API リソース URL。
• レコードを更新するための情報など、要求に必要な情報が含まれる要求パラメータまたはリクエストボ
ディ。
リクエストボディには、JSON または XML を含めることができます。リソース固有の要求パラメータとリク
エストボディを渡すと、要求パラメータが無視されます。リソースに固有でない要求パラメータ (ベアラー
トークン URL 内のパラメータや _HttpMethod パラメータなど) はリクエストボディと共に処理されます。
ベアラートークンパラメータはそのまま使用します。パラメータの追加や削除はしないでください。
HTTP メソッドは、情報の取得や、レコードの作成、更新、削除など、目的のアクションを示すために使用され
ます。
• GET は、基本リソースサマリー情報など、情報の取得に使用されます。
• POST は、新しい項目 (フィード項目、コメント、いいね! など) の作成やグループへの登録に使用されます。
• PATCH は、ファイルの名前変更など、項目の部分的な更新に使用されます。
• PUT は、会話を既読とマークする場合など、項目の全体的な更新に使用されます。
• DELETE は、フィード要素などの項目の削除、またはグループからの登録解除に使用されます。
• HEAD は、リソースメタデータの取得に使用されます。使用方法は GET と似ていますが、レスポンスボディ
を返しません。HEAD は、リソースが使用可能かどうかのテストに使用できます。
Chatter REST API 要求および応答について
Chatter REST API を使用するための一般的なプロセスフローは次のようになります。
1. HTTP 要求を Salesforce に送信します。
6
Chatter REST API の概要
Chatter REST API 要求および応答について
2. システムがユーザとクライアントアプリケーションを認証します。
3. HTTP 要求を使用して Chatter REST API リソースを要求します。
4. システムが HTTP 戻りコードを返します。追加の情報 (Chatter REST API レスポンスボディなど) は、必要に応じ
て応答に含まれます。
Chatter REST API の各リソースは、HTTP メソッド (GET、POST、DELETE、HEAD など) で使用される URI です。各リソー
スは、ユーザのニュースフィードや投稿へのコメントなど、Chatter 内のものを表します。
リソースの多くは、指定されたユーザ ID またはキーワード me を使用して現在のコンテキストユーザを示しま
す。たとえば、現在のコンテキストユーザのユーザプロファイル情報を返すには、次のリソースを使用しま
す。
/chatter/users/me
ユーザ ID で特定のユーザを指定することもできます。
/chatter/users/005D0000001GLoh
正常にリソースにアクセスすると、JSON または XML でレスポンスボディが返されます。デフォルトでは、JSON
が返されます。各レスポンスボディに 1 つ以上のレスポンスボディ項目が含まれます。たとえば、上記のリ
ソース (Users) にアクセスすると、次のようなレスポンスボディが返されます。これには、住所 (address)、現在
の状況 (currentStatus)、電話番号 (phoneNumbers) など、他のレスポンスボディも含まれています。
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
aboutMe
String
ユーザのプロファイルから取得したテキスト Big、29.0
23.0
additional
Label
String
ユーザの追加表示ラベル。たとえば、「顧 Small、30.0
客」、「パートナー」、「Acme Corporation」
などがあります。ユーザに追加表示ラベルが
ない場合、値は null です。
30.0
address
Address
住所
Big、29.0
23.0
chatterActivity Chatter Activity
Chatter 活動統計
Big、29.0
23.0
chatterInfluence Chatter Influence
ユーザの影響度ランク
Big、29.0
23.0
community
Nickname
String
コミュニティでのユーザのニックネーム
Medium、32.0 32.0
companyName
String
会社名
Small、29.0
currentStatus User Status
メモ: このプロパティは、バージョン
25.0 以降、使用できなくなります。
23.0
23.0 ～ 25.0
ユーザの現在の状況
displayName
String
コミュニティで表示されるユーザの名前。 Small、32.0
ニックネームが有効な場合は、ニックネーム
7
32.0
Chatter REST API の概要
プロパティ
Chatter REST API 要求および応答について
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
が表示されます。ニックネームが有効ではな
い場合は、氏名が表示されます。
email
String
ユーザのメールアドレス
Medium、29.0 23.0
firstName
String
ユーザの名
Small、29.0
23.0
followersCount Integer
このユーザをフォローしているユーザの数
Big、29.0
23.0
followingCounts Following Counts
ユーザがフォローしている項目に関する情報 Big、29.0
23.0
groupCount
Integer
ユーザがフォローしているグループの数
Big、29.0
23.0
hasChatter
Boolean
ユーザに Chatter へのアクセス権がある場合
は true、それ以外の場合は false
Small、31.0
31.0
id
String
ユーザの 18 文字の ID
Small、29.0
23.0
isActive
Boolean
ユーザが有効な場合は true、それ以外の場 Small、29.0
合は false
23.0
isChatterGuest Boolean
23.0 ～ 25.0
メモ: このプロパティは、バージョン
26.0 以降、使用できなくなります。代
わりに、userType プロパティを使用
してください。
ユーザが Chatter 顧客の場合は true、それ以
外の場合は false
isInThis
Community
Boolean
ユーザがコンテキストユーザと同じコミュニ Small、29.0
ティに含まれる場合は true、それ以外の場
合は false。範囲が「すべてのユーザ」の
投稿に対するレコードフィードの @メンショ
ンの場合、false になることがあります。
28.0
lastName
String
ユーザの姓
Small、29.0
23.0
managerId
String
ユーザのマネージャの 18 文字の ID
Big、29.0
23.0
managerName
String
ロケールに基づいて連結されたマネージャの Big、29.0
姓と名
23.0
motif
Motif
オブジェクトがユーザであることを示す小、 Small、29.0
中、大のアイコン。motif にはオブジェクト
のベース色を含めることもできます。
27.0
motif アイコンは、ユーザのプロファイル写
真ではありません。
8
Chatter REST API の概要
プロパティ
Chatter REST API 要求および応答について
型
mySubscription Reference
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
コンテキストユーザがこのユーザをフォロー Medium、29.0 23.0
している場合は、登録に関する情報が含まれ
ます。それ以外の場合は、null を返しま
す。
name
String
ロケールに基づいて連結されたユーザの姓と Small、29.0
名
23.0
phoneNumbers
Phone Number[]
ユーザの電話番号のコレクション
Big、29.0
23.0
photo
Photo
ユーザの写真に関する情報
Small、29.0
23.0
reputation
評価
コミュニティでのユーザの評価。コミュニ Big、32.0
ティで実行したイベントやアクションを基に
獲得したポイント数によって判断されます。
32.0
ユーザが受け取った感謝の数。
Big、29.0
29.0
thanksReceived Integer
title
String
ユーザの役職
Small、29.0
23.0
type
String
User
Small、29.0
23.0
url
String
ユーザの Chatter プロファイルへの URL
Small、29.0
23.0
username
String
ユーザのユーザ名 ([email protected] Small、29.0
など)
24.0
userType
String
ユーザの種別を指定します。有効な値は、次 Medium、29.0 26.0
のとおりです。
• ChatterGuest — 非公開グループの外部
ユーザ。
• ChatterOnly — Chatter Free ユーザ。
• Guest — 認証されていないユーザ。
• Internal — 標準組織メンバー。
• Portal — カスタマーポータル、パート
ナーポータル、またはコミュニティの外
部ユーザ。
• System — Chatter Expert またはシステム
ユーザ。
• Undefined — カスタムオブジェクトの
ユーザ種別
9
Chatter REST API の概要
Chatter REST API 要求および応答について
JSON 形式では、出力は次のようになります。
{
"aboutMe": "I'm excited to be part of the team focused on building out our apps
business
and showing our customers their future.",
"additionalLabel" : null,
"address": {
"city": "Seattle",
"country": "US",
"state": "WA",
"street": "2001 8th Ave",
"zip": "98121"
"formattedAdress": "2001 8th Ave\nSeattle, WA 98121\nUS"
},
"chatterActivity": {
"commentCount": 0,
"commentReceivedCount": 1,
"likeReceivedCount": 0,
"postCount": 2
},
"chatterInfluence" : {
"percentile" : "0.6666666666666667",
"rank" : 1
},
"communityNickname": "marRave",
"companyName": "Seattle Apps",
"displayName": "Marion Raven",
"email": "[email protected]",
10
Chatter REST API の概要
Chatter REST API 要求および応答について
"firstName": "Marion",
"followersCount": 1,
"followingCounts": {
"people": 5,
"records": 0,
"total": 5
},
"groupCount": 3,
"hasChatter": true,
"id": "005D0000001Kl6xIAC",
"isActive": true,
"isInThisCommunity" : true,
"lastName": "Raven",
"managerId": null,
"managerName": null,
"motif": {
"color" : "20aeb8",
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png"
},
"mySubscription": null,
"name": "Marion Raven",
"phoneNumbers": [{
"label": "Work",
"phoneNumber": "(206) 999-2846",
"phoneType": "Work"
11
Chatter REST API の概要
Chatter REST API 要求および応答について
}],
"photo": {
"fullEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cGW2pGjfqoWUUgTENHjVyS1i9x6Z16L8wXEGigpcWjAd",
"largePhotoUrl": "https://instance_name/profilephoto/729D00000000BDV/F",
"photoVersionId": "729D00000000BDV",
"smallPhotoUrl": "https://instance_name/profilephoto/729D00000000BDV/T",
"standardEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cGW2pGjfqoWUUgTENHjVyS1q43x_rW2ciXBHst0Eh3Y6",
"url":
"/services/data/v34.0/chatter/users/005D0000001LL8OIAW/photo"
},
"reputation" : null,
"thanksReceived" : null,
"title": null,
"type": "User",
"url": "/services/data/v34.0/chatter/users/005D0000001Kl6xIAC",
"userType": "Internal";
"username": "[email protected]"
}
メモ: Salesforce は複数のサーバインスタンス上で実行されます。このガイドの例は、instance_name を
使用してインスタンスを示します。組織のインスタンスは、na1.salesforce.com または
na6.mycompany.com と類似している場合があります。
レスポンスボディ内の項目には完全修飾 URL を持つものもありますが、ほとんどは相対 URL が返されま
す。相対 URL の場合は、項目が認証されたときにクライアントアプリケーションに与えられるインスタン
スを先頭に付加します。
12
Chatter REST API の概要
Chatter REST API 入力の使用
Chatter REST API 入力の使用
入力での POST、PATCH、または PUT の使用
HTTP POST、PATCH、および PUT メソッドを使用して要求を行うとき、要求パラメータまたはリクエストボディ
を使用できます。リクエストボディには、JSON または XML を含めることができます。リソース固有の要求パ
ラメータとリクエストボディを渡すと、要求パラメータが無視されます。リソースに固有でない要求パラメー
タ (ベアラートークン URL 内のパラメータや _HttpMethod パラメータなど) はリクエストボディと共に処理さ
れます。ベアラートークンパラメータはそのまま使用します。パラメータの追加や削除はしないでください。
要求パラメータを使用して要求を送信するには、値 application/x-www-form-urlencoded を指定した
Content-Type ヘッダー項目を使用します。
リクエストボディを使用して要求を送信するには、Content-Type ヘッダー項目と Accept ヘッダー項目に
次のいずれかの値を使用します。
• application/json
• application/xml
バイナリファイルのアップロード
バイナリファイルをアップロードするには、マルチパート/フォームデータ要求のボディパートとして送信す
る必要があります。投稿またはコメントのテキストのような情報を、同じマルチパート/フォームデータ要求
の JSON または XML リッチ入力ボディパートとして送信できます。または、その情報を要求パラメータで送信
するように選択することもできます。リッチ入力リクエストボディと要求パラメータの両方を渡すと、要求パ
ラメータは無視されます。
マルチパート/フォームデータ要求を作成するには、要求のヘッダーで Content-Type HTTP ヘッダーを
multipart/form-data に設定します。
その他の HTTP ヘッダーについての詳細は、W3C フォームコンテンツタイプと、マルチパート/フォームデータ
インターネットメディアタイプが定義されている 「RFC 2388」 を参照してください。
次の表では、マルチパート/フォームデータ要求のリッチ入力ボディパートに必要な HTTP ヘッダーとパラメー
タを説明します。
リッチ入力ボディパート ヘッダー値とパラメータ
の HTTP ヘッダー
説明
Content-Disposition form-data; name="json"
投稿またはコメントのリクエストボディ。
form-data; name="xml"
JSON の場合は、name の値に "json" を使
用します。
XML の場合は、name の値に "xml" を使用
します。
13
Chatter REST API の概要
Chatter REST API 入力の使用
リッチ入力ボディパート ヘッダー値とパラメータ
の HTTP ヘッダー
Content-Type
説明
application/json; charset=UTF-8 リクエストボディのデータ形式と文字セッ
application/xml; charset=UTF-8 ト。
JSON の場合、値は application/json に
する必要があります。
XML の場合、値は application/xml に
する必要があります。
ヒント: Web ブラウザは通常、非バイナリパート (リッチ入力ボディなど) に独自の Content-Type があ
ると、マルチパートの要求を実行することができません。この問題を回避するには、特定の
Content-Disposition name を指定して、Salesforce がリッチ入力パートの Content-Type を読み取れ
るようにします (リッチ入力ボディに Content-Type を指定する必要はありません)。
次の表では、Web ブラウザからのマルチパート/フォームデータ要求のリッチ入力ボディパートに必要な HTTP
ヘッダーとパラメータについて説明します。
Web ブラウザからのリッ ヘッダー値とパラメータ
チ入力ボディパートの
HTTP ヘッダー
説明
Content-Disposition form-data; name="feedElement"
バイナリファイルを含むフィード要素を
投稿するには、name の値を
"feedElement" にする必要があります。
form-data; name="comment"
form-data; name="photo"
form-data; name="file"
バイナリファイルを含むコメントを投稿
するには、name の値を "comment" にす
る必要があります。
ユーザまたはグループの写真を投稿する
には、name の値を "photo" にする必要
があります。
[ファイル] リストにファイルを投稿するに
は、name の値を "file" にする必要があ
ります。
次の表では、マルチパート/フォームデータ要求のバイナリアップロードボディパートに必要な HTTP ヘッダー
とパラメータを説明します。
14
Chatter REST API の概要
Chatter REST API 入力の使用
バイナリアップロードボ ヘッダー値とパラメータ
ディパートの HTTP ヘッ
ダー
説明
Content-Disposition form-data;
name="feedElementFileUpload";
filename=string
バイナリ添付ファイルを含むフィード要
素を投稿するには、name の値を
"feedElementFileUpload" にする必要
があります。
form-data;
name=name="feedElementFileUpload";
バイナリファイルを含むコメントを投稿
filename=string
するには、name の値を
form-data; name="fileUpload"
"feedElementFileUpload" にする必要
filename=string
があります。
form-data; name="fileData"
filename=string
ユーザまたはグループの写真を投稿する
には、name の値を "fileUpload" にす
る必要があります。
[ファイル] リストにファイルを投稿するに
は、name の値を "fileData" にする必要
があります。
メモ: filename パラメータと値を
指定する必要があります。ただし、
Chatter は、Content Capability Input の
title プロパティの値を filename
パラメータの値ではなく、ファイル
名として使用します。
Content-Type
application/octet-stream;
charset=ISO-8859-1
バイナリファイルのメディアタイプと文
字セット。
メモ: 空白と改行 (CRLF) は重要です。たとえば、次の行では空白が必要です: Content-Disposition:
form-data; name="feedItemFileUpload"; title="2012_q1_review.ppt"。空白ではなく CRLF を
使用すると、エラーが返されます。
バイナリファイルを含むフィード要素の投稿
次の例では、/chatter/feed-elements リソースを使用して新しいフィード項目 (フィード要素の種類の
1 つ) を投稿し、バイナリファイルをアップロードして新しいフィード項目に添付します。次の例では cURL
を使用します。
curl -H "X-PrettyPrint: 1" -F 'json={ "body":{ "messageSegments":[ { "type":"Text",
"text":"Please accept this receipt." } ] },
"capabilities":{ "content":{ "description":"Receipt for expenses", "title":"receipt.pdf"
} }, "feedElementType":"FeedItem", "subjectId":"005RR000000DmOb" };
type=application/json' -F
"[email protected];type=application/octet-stream"
15
Chatter REST API の概要
Chatter REST API 入力の使用
-X POST https://instance_name/services/data/v34.0/chatter/feed-elements
-H 'Authorization: OAuth 00DRR0000000N0g!...' --insecure
以下に、上記の例を、リクエストボディパートが確認できる形式に変えた例を示します。
POST /services/data/v34.0/chatter/feed-elements HTTP/1.1
Authorization: OAuth 00DRR0000000N0g!...
User-Agent: Jakarta Commons-HttpClient/3.0.1
Host: instance_name
Content-Length: 845
Content-Type: multipart/form-data; boundary=a7V4kRcFA8E79pivMuV2tukQ85cmNKeoEgJgq
Accept: application/json
--a7V4kRcFA8E79pivMuV2tukQ85cmNKeoEgJgq
Content-Disposition: form-data; name="json"
Content-Type: application/json; charset=UTF-8
{
"body":{
"messageSegments":[
{
"type":"Text",
"text":"Please accept this receipt."
}
]
},
"capabilities":{
"content":{
"description":"Receipt for expenses",
16
Chatter REST API の概要
Chatter REST API 入力の使用
"title":"receipt.pdf"
}
},
"feedElementType":"FeedItem",
"subjectId":"005RR000000DmOb"
}
--a7V4kRcFA8E79pivMuV2tukQ85cmNKeoEgJgq
Content-Disposition: form-data; name="feedElementFileUpload"; filename="receipt.pdf"
Content-Type: application/octet-stream; charset=ISO-8859-1
...contents of receipt.pdf...
--a7V4kRcFA8E79pivMuV2tukQ85cmNKeoEgJgq--
バイナリファイルを含むフィード要素の一括投稿
次の例では、/chatter/feed-elements/batch リソースを使用してフィード要素を一括投稿し、2 つの
バイナリファイルをアップロードして、バッチ内のフィード要素に添付します。リクエストボディにはバ
イナリパートに関する情報を含める必要があります。次の例では cURL を使用します。
curl -H "X-PrettyPrint: 1" -F 'json={"inputs":[{"binaryPartNames":["bin1"],
"richInput":{"subjectId":"me","body":{
"messageSegments":[{"type":"Text","text":"Please accept this receipt"}]},"capabilities":
{"content" : {"description": "Receipt for expenses",
"title":"receipt.pdf"}},"feedElementType":"FeedItem"}},
{"binaryPartNames":["bin2"],"richInput":{"subjectId":"me","body":{"messageSegments":[{"type":"Text","text":"Post
Number 2"}]},
"capabilities": {"content" : {"description": "Receipt for expenses",
"title":"receipt2.pdf"}},"feedElementType":"FeedItem"}}]};type=application/json'
-F "bin1=@/Users/jsmith/Desktop/receipt.pdf;type=application/octet-stream" -F
"bin2=@/Users/jsmith/Desktop/receipt2.pdf;type=application/octet-stream"
-X POST https://instance_name/services/data/v34.0/chatter/feed-elements/batch
-H 'Authorization: OAuth 00DD00000007HoR44QATPNzhzYEJBfU' --insecure
17
Chatter REST API の概要
Chatter REST API 入力の使用
以下に、上記の例を、リクエストボディパートが確認できる形式に変えた例を示します。
POST /services/data/v34.0/chatter/feed-elements/batch HTTP/1.1
Authorization: OAuth 00DRR0000000N0g!...
User-Agent: Jakarta Commons-HttpClient/3.0.1
Host: instance_name
Content-Length: 845
Content-Type: multipart/form-data; boundary=a7V4kRcFA8E79pivMuV2tukQ85cmNKeoEgJgq
Accept: application/json
--a7V4kRcFA8E79pivMuV2tukQ85cmNKeoEgJgq
Content-Disposition: form-data; name="json"
Content-Type: application/json; charset=UTF-8
{
"inputs": [
{
"binaryPartNames": [
"bin1"
],
"richInput": {
"subjectId": "me",
"body": {
"messageSegments": [
{
"type": "Text",
"text": "Please accept this receipt"
}
]
18
Chatter REST API の概要
Chatter REST API 入力の使用
},
"capabilities": {
"content": {
"description": "Receipt for expenses",
"title": "receipt.pdf"
}
},
"feedElementType": "FeedItem"
}
},
{
"binaryPartNames": [
"bin2"
],
"richInput": {
"subjectId": "me",
"body": {
"messageSegments": [
{
"type": "Text",
"text": "Post Number 2"
}
]
},
"capabilities": {
"content": {
"description": "Receipt for expenses",
19
Chatter REST API の概要
Chatter REST API 入力の使用
"title": "receipt2.pdf"
}
},
"feedElementType": "FeedItem"
}
}
]
}
--a7V4kRcFA8E79pivMuV2tukQ85cmNKeoEgJgq
Content-Disposition: form-data; name="bin1"; filename="receipt.pdf"
Content-Type: application/octet-stream; charset=ISO-8859-1
...contents of receipt.pdf...
--a7V4kRcFA8E79pivMuV2tukQ85cmNKeoEgJgq
Content-Disposition: form-data; name="bin2"; filename="receipt2.pdf"
Content-Type: application/octet-stream; charset=ISO-8859-1
...contents of receipt2.pdf...
--a7V4kRcFA8E79pivMuV2tukQ85cmNKeoEgJgq--
メモ: binaryPartNames プロパティ内のバイナリパート名は、バイナリリクエストパートの name プ
ロパティ内のバイナリパート名と一致する必要があります。
20
Chatter REST API の概要
Chatter REST API 入力の使用
バイナリファイルを含むコメントの投稿
次の例では、cURL を使用してフィード項目にコメントを投稿し、バイナリ添付ファイルをアップロードし
ます。
curl -H "X-PrettyPrint: 1" -F 'json={ "body":{ "messageSegments":[ { "type":"Text",
"text":"Here's another receipt." } ] }, "capabilities":{ "content":{ "title":"receipt2"
} } };
type=application/json' -F
"[email protected];type=application/octet-stream"
-X POST
https://instance_name/services/data/v34.0/chatter/feed-elements/0D5RR0000004Grx/capabilities/comments/items
-H 'Authorization: OAuth 00DRR0000000N0g!ARoAQB...' --insecure
以下に、上記の例を、リクエストボディパートが確認できる形式に変えた例を示します。
POST
/services/data/v34.0/chatter/feed-elements/0D5RR0000004Grx/capabilities/comments/items
HTTP/1.1
Authorization: OAuth
00DD0000000Jhd2!AQIAQC.lh4qTQcBhOPm4TZom5IaOOZLVPVK4wI_rPYJvmE8r2VW8XA.
OZ7S29JEM_7Ctq1lst2dzoV.owisJc0KacUbDxyae
Accept: application/json
User-Agent: Jakarta Commons-HttpClient/3.0.1
Host: instance_name
Content-Length: 978
Content-Type: multipart/form-data; boundary=F9jBDELnfBLAVmLNbnLIYibT5Icp0h3VJ7mkI
--F9jBDELnfBLAVmLNbnLIYibT5Icp0h3VJ7mkI
Content-Disposition: form-data; name="json"
Content-Type: application/json; charset=UTF-8
{
"body":{
"messageSegments":[
21
Chatter REST API の概要
Chatter REST API 入力の使用
{
"type":"Text",
"text":"Here's another receipt."
}
]
},
"capabilities":{
"content":{
"title":"receipt2"
}
}
}
--F9jBDELnfBLAVmLNbnLIYibT5Icp0h3VJ7mkI
Content-Disposition: form-data; name="feedElementFileUpload"; filename="receipt2.txt"
Content-Type: application/octet-stream; charset=ISO-8859-1
...contents of receipt2.txt...
--F9jBDELnfBLAVmLNbnLIYibT5Icp0h3VJ7mkI--
バイナリファイルを含む複数のコメントの投稿
この例は、2 つのサブ要求が含まれる https://instance_name/services/data/v34.0/connect/batch
への汎用バッチ要求です。各サブ要求はフィード項目にコメントし、バイナリファイルをコメントにアッ
プロードします。
richInput プロパティには、各サブ要求のリクエストボディを含める必要があります。
また、binaryPartName および binaryPartNameAlias プロパティには、バイナリパートに関する情報
を含める必要もあります。
次に cURL の例を示します。
curl -H "X-PrettyPrint: 1" -F 'json={ "haltOnError":true, "batchRequests":[ {
"url":"/v33.0/chatter/feed-elements/0D5D0000000YG0N/capabilities/comments/items",
22
Chatter REST API の概要
Chatter REST API 入力の使用
"method":"Post", "binaryPartName":"binaryPart1",
"binaryPartNameAlias":"feedElementFileUpload", "richInput":{ "body":{ "messageSegments":[
{ "type":"Text", "text":"Check out this file, it may help." } ] },
"capabilities":{ "content":{ "title":"Presentation1.txt" } } } }, {
"url":"/v33.0/chatter/feed-elements/0D5D0000000YG0M/capabilities/comments/items",
"method":"Post", "binaryPartName":"binaryPart2",
"binaryPartNameAlias":"feedElementFileUpload", "richInput":{ "body":{ "messageSegments":[
{ "type":"Text", "text":"Check out this file, it may help." } ] },
"capabilities":{ "content":{ "title":"Presentation2.txt" } } } } ]
};type=application/json' -F
"binaryPart1=@/Users/jbleyle/Desktop/Presentation1.txt;type=application/octet-stream"
-F "binaryPart2=@/Users/jbleyle/Desktop/Presentation2.txt;type=application/octet-stream"
-X POST https://instance_name/services/data/v34.0/connect/batch
-H 'Authorization: OAuth 00DD00000007HoR!...' --insecure
これは、マルチパート/フォームデータリクエストボディです。
https://instance_name/services/data/v34.0/connect/batch
Authorization: OAuth 00DD0000000Jhd2!...
Accept: application/json
Host: instance_name
Content-Type: multipart/form-data; boundary=123123
--123123
Content-Disposition: form-data; name="json"
Content-Type: application/json
{
"haltOnError":true,
"batchRequests":[
23
Chatter REST API の概要
Chatter REST API 入力の使用
{
"url":"/v34.0/chatter/feed-elements/0D5D0000000YG0D/capabilities/comments/items",
"method":"Post",
"binaryPartName":"binaryPart1",
"binaryPartNameAlias":"feedElementFileUpload",
"richInput":{
"body":{
"messageSegments":[
{
"type":"Text",
"text":"Check out this file, it may help."
}
]
},
"capabilities":{
"content":{
"title":"Presentation1.txt"
}
}
}
},
{
"url":"/v34.0/chatter/feed-elements/0D5D0000000YG0H/capabilities/comments/items",
"method":"Post",
"binaryPartName":"binaryPart2",
"binaryPartNameAlias":"feedElementFileUpload",
24
Chatter REST API の概要
Chatter REST API 入力の使用
"richInput":{
"body":{
"messageSegments":[
{
"type":"Text",
"text":"Check out this file, it may help."
}
]
},
"capabilities":{
"content":{
"title":"Presentation2.txt"
}
}
}
}
]
}
--123123
Content-Disposition: form-data; name="binaryPart1"; filename="Presentation1.txt"
Content-Type: application/octet-stream; charset=ISO-8859-1
Content-Transfer-Encoding: binary
This is the content of file 1
--123123
25
Chatter REST API の概要
Chatter REST API 入力の使用
Content-Disposition: form-data; name="binaryPart2"; filename="Presentation2.txt"
Content-Type: application/octet-stream; charset=ISO-8859-1
Content-Transfer-Encoding: binary
This is the content of file 2
--123123--
ユーザの写真の投稿およびトリミング
次の例では、cURL を使用してユーザプロファイルの写真をアップロードし、トリミングします。
curl -H "X-PrettyPrint: 1" -F 'json={"cropX": "0", "cropY": "0", "cropSize":
"200"};type=application/json'
-F "[email protected];type=application/octet-stream"
-X POST https://instance_name/services/data/v34.0/chatter/users/me/photo
-H 'Authorization: OAuth 00DRR0000000N0g!ARoAQFRi_gBqZhajAX22MNuLrrE2Xk...'
--insecure
以下に、上記の例を、リクエストボディパートが確認できる形式に変えた例を示します。
POST /services/data/v34.0/chatter/users/me/photo HTTP/1.1
Authorization: OAuth
00DD0000000Jhd2!AQIAQC.lh4qTQcBhOPm4TZom5IaOOZLVPVK4wI_rPYJvmE8r2VW8XA.
OZ7S29JEM_7Ctq1lst2dzoV.owisJc0KacUbDxyae
User-Agent: Jakarta Commons-HttpClient/3.0.1
Host: instance_name
Content-Length: 543
Content-Type: multipart/form-data; boundary=a7V4kRcFA8E79pivMuV2tukQ85cmNKeoEgJgq
Accept: application/json
--a7V4kRcFA8E79pivMuV2tukQ85cmNKeoEgJgq
Content-Type: application/json; charset=UTF-8
Content-Disposition: form-data; name="json"
26
Chatter REST API の概要
Chatter REST API 入力の使用
{
"cropX" : "0",
"cropY" : "0",
"cropSize" : "200"
}
--a7V4kRcFA8E79pivMuV2tukQ85cmNKeoEgJgq
Content-Disposition: form-data; name="fileUpload"; filename="myPhoto.jpg"
Content-Type: application/octet-stream; charset=ISO-8859-1
...contents of myPhoto.jpg...
--a7V4kRcFA8E79pivMuV2tukQ85cmNKeoEgJgq--
[ファイル] リストへのファイルの投稿
次の例では、cURL を使用してファイルを [ファイル] リストにアップロードします。
curl -H "X-PrettyPrint: 1" -F 'json={"title":"BoatPrices"};type=application/json'
-F "[email protected];type=application/octet-stream"
-X POST https://instance_name/services/data/v34.0/chatter/users/me/files
-H 'Authorization: OAuth 00DRR0000000N0g!...' --insecure
以下に、上記の例を、リクエストボディパートが確認できる形式に変えた例を示します。
POST /services/data/v34.0/chatter/users/me/files
Authorization: OAuth
00DD0000000Jhd2!AQIAQC.lh4qTQcBhOPm4TZom5IaOOZLVPVK4wI_rPYJvmE8r2VW8XA.
OZ7S29JEM_7Ctq1lst2dzoV.owisJc0KacUbDxyae
User-Agent: Jakarta Commons-HttpClient/3.0.1
Host: instance_name
Content-Length: 489
27
Chatter REST API の概要
ワイルドカード
Content-Type: multipart/form-data; boundary=a7V4kRcFA8E79pivMuV2tukQ85cmNKeoEgJgq
Accept: application/json
--a7V4kRcFA8E79pivMuV2tukQ85cmNKeoEgJgq
Content-Type: application/json; charset=UTF-8
Content-Disposition: form-data; name="json"
{
"title":"BoatPrices"
}
--a7V4kRcFA8E79pivMuV2tukQ85cmNKeoEgJgq
Content-Disposition: form-data; name="fileData"; filename="BoatPrices.txt"
Content-Type: application/octet-stream; charset=ISO-8859-1
...contents of BoatPrices.txt...
--a7V4kRcFA8E79pivMuV2tukQ85cmNKeoEgJgq--
ワイルドカード
Chatter REST API と Chatter in Apex の検索でテキストパターンを一致させるには、ワイルドカード文字を使用しま
す。
ワイルドカードが一般的に使用されるのはフィードを検索するときです。q パラメータで検索文字列とワイル
ドカードを渡します。次の例は、Chatter REST API 要求です。
/chatter/feed-elements?q=chat*
次の例は、Chatter in Apex メソッドコールです。
ConnectApi.ChatterFeeds.searchFeedElements(null, 'chat*');
検索内のテキストパターンと一致させるために、次のワイルドカード文字を指定できます。
28
Chatter REST API の概要
応答サイズの指定
ワイルドカー 説明
ド
*
検索語の途中または末尾で、0 個以上の文字の代わりにアスタリスクを使用できます。標準
ルックアップ検索を実行する場合以外は、検索語の先頭にアスタリスクを使用しないでくだ
さい。たとえば、「太*」を検索すると、「太一」、「太郎」、「太次郎」などの「太」で
始まるデータが表示されます。ただし、中国語、日本語、韓国語、またはタイ語で検索する
場合は、検索語の中間にアスタリスクまたは疑問符のワイルドカードは使用できません。単
語または語句内のリテラルアスタリスクを検索する場合、アスタリスクをエスケープします
( \ 文字をそれの前に付けます)。
?
疑問符は、検索語の途中または末尾 (先頭ではない) にある 1 つのみの文字の代わりに使用で
きます。たとえば、「jo?n」を検索すると、「john」や「joan」を含むデータが表示されま
す。ただし、中国語、日本語、韓国語、またはタイ語で検索する場合は、検索語の中間にア
スタリスクまたは疑問符のワイルドカードは使用できません。また、検索キーワードの先頭
にワイルドカードの疑問符を使用しても機能しません。
ワイルドカードを使用する場合には、以下の点に注意してください。
• ワイルドカードは先行する文字の種類を表します。たとえば、「aa*a」は「aaaa」と「aabcda」に一致し
ますが、「aa2a」や「aa.!//a」には一致せず、「p?n」は「pin」と「pan」には一致しますが、「p1n」や
「p!n」には一致しません。同様に、「1?3」は「123」と「143」には一致しますが、「1a3」や「1b3」には
一致しません。
• ワイルドカード (*) は、中国語、日本語、韓国語、タイ語 (CJKT) での検索で、完全に一致する語句の検索以
外では、検索文字の最後に追加します。
• ワイルドカード検索の条件を絞り込むほど、検索結果はより速く返され、期待する結果が返される可能性
が高まります。たとえば、単語 prospect (または複数形 prospects) のすべての発生を検索するには、無
関係の一致 ( prosperity など) を返す可能性のある制限のより少ないワイルドカード検索 (prosp* など)
を指定するよりも、検索文字列内で prospect* を指定する方がより効率的です。
• 単語のすべてのバリエーションを見つけるために、検索を調整します。たとえば、property と properties
を見つけるには、propert* を指定します。
• 句読点にはインデックスを付けます。語句内で * または ? を見つけるためには、検索文字列を引用符で囲
む必要があり、特殊文字をエスケープする必要があります。たとえば、"where are you\?" は、語句
where are you? を見つけます。エスケープ文字 (\) は、この検索が正しく機能するために必要です。
応答サイズの指定
応答サイズを指定するには、filterGroup を要求パラメータとして、またはリクエストボディで使用し、プ
ロパティのグループをサイズで指定します。さらに、exclude や include を要求パラメータとして、または
リクエストボディで使用し、特定のプロパティを除外したり、含めたりします。アプリケーションに必要な
データのみが返されるようにするには、絞り込み条件を使用します。
29
Chatter REST API の概要
filterGroup
このセクションの内容:
filterGroup
要求 URL またはリクエストボディで filterGroup パラメータを使用して、返されるプロパティのグルー
プサイズ (Small、Medium、Big) を指定します。filterGroup プロパティは、API バージョン 29.0 以降で使用
できます。
exclude
特定のプロパティをレスポンスボディから除外するには、exclude 要求パラメータを使用します。exclude
パラメータは、API バージョン 27.0 以降で使用できます。
include
レスポンスボディを特定のプロパティに限定するには、include クエリ文字列パラメータを使用します。
filterGroup
要求 URL またはリクエストボディで filterGroup パラメータを使用して、返されるプロパティのグループサ
イズ (Small、Medium、Big) を指定します。filterGroup プロパティは、API バージョン 29.0 以降で使用できま
す。
メモ: filterGroup パラメータは、JSON と REST のみでサポートされています。
各レスポンスボディのすべてのプロパティにグループサイズが割り当てられます。
• Big — デフォルトのサイズです。レスポンスボディにすべてのプロパティ (Big、Medium、および Small
のマークが付けられたプロパティ) が含まれます。
• Medium — Medium および Small のマークが付けられたプロパティが含まれます。
• Small — 最小の応答サイズです。Small のマークが付けられたプロパティのみが含まれます。
メモ: サイズの割り当ては、ドキュメントにのみ表示されます。レスポンスボディには表示されません。
要求に filterGroup がある場合、レスポンスボディには、指定されたグループの一部であるプロパティのみ
が含まれます。
検索条件グループの使用について、次の事項を把握している必要があります。
• デフォルトの filterGroup サイズは Big です。
• プロパティに割り当てられる各検索条件グループサイズには、API バージョンがあります。今後、API バー
ジョンのプロパティは、別の検索条件グループに移動する可能性があります。
• 検索条件グループは、DELETE と HEAD を除くすべての HTTP 動詞に影響します。
• 特に指定のない限り、バッチ要求のボディ内のサブ要求を含むすべての要求 URL で filterGroup パラメー
タを使用できます。
• filterGroup パラメータを include または exclude 条件パラメータと組み合わせて使用し、返される
プロパティのセットを変更できます。結果セットは、2 つのセットの結合です。
filterGroup パラメータと、include または exclude パラメータの併用
要求には、filterGroup パラメータ、グループサイズ値、include または exclude 条件パラメータ、URL
の値を含めることができます。これは、汎用バッチ要求のサブ要求にも該当します。
30
Chatter REST API の概要
filterGroup
要求 (またはサブ要求) に filterGroup と include の両方のパラメータがあると、include パラメータで指
定されたプロパティが常に応答に含まれます。
要求 (またはサブ要求) に filterGroup と exclude の両方のパラメータがあると、exclude パラメータで指
定されたプロパティが常に応答から除外されます。
次の表の行を左から右に読んでいき、応答にプロパティが含まれているかどうかを確認します。
要求に
要求の
要求に
要求の
要求に
要求の
応答にプロパ
include 条件 include 条件 exclude 条件 exclude 条件 filterGroup filterGroup ティがある
がある
にプロパティ がある
がある
にプロパティ がある
がある
にプロパティ
がある
はい
いいえ
いいえ
いいえ
いいえ
いいえ
いいえ
はい
はい
いいえ
いいえ
はい/いいえ
はい/いいえ
はい
いいえ
いいえ
はい
いいえ
いいえ
いいえ
はい
いいえ
いいえ
はい
いいえ
はい
いいえ
いいえ
いいえ
いいえ
はい
はい
はい/いいえ
はい/いいえ
いいえ
いいえ
いいえ
いいえ
いいえ
はい
いいえ
いいえ
いいえ
いいえ
いいえ
いいえ
はい
はい
はい
はい
はい/いいえ
はい
はい/いいえ
はい/いいえ
はい/いいえ
エラー (400)
例
この例では、User Profile リソースの Small レスポンスボディを取得します。
GET /chatter/users/me?filterGroup=Small
次にレスポンスボディを示します。
{
"companyName": "Universal Containers",
"firstName": "Deanna",
"hasChatter": true,
"id": "005D0000001LL8OIAW",
"isActive": true,
"isInThisCommunity": true,
"lastName": "Li",
"motif": {
31
Chatter REST API の概要
exclude
"color": "1797C0",
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png"
},
"name": "Deanna Li",
"photo": {
"photoVersionId": "729D00000000LJFIA2",
"smallPhotoUrl": "https://instance_name/profilephoto/729D00000000LJF/T",
"standardEmailPhotoUrl": "https://instance_name/ncsphoto
/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sYVo6fntPnCQ_-xIH-GU3vI",
"url": "/services/data/v34.0/chatter/users/005D0000001LL8OIAW/photo"
},
"title": null,
"type": "User",
"url": "/services/data/v34.0/chatter/users/005D0000001LL8OIAW",
"username": "[email protected]"
}
exclude
特定のプロパティをレスポンスボディから除外するには、exclude 要求パラメータを使用します。exclude
パラメータは、API バージョン 27.0 以降で使用できます。
exclude クエリの値は、バー (|) で区切られたプロパティのリストです。URL は、バーを %7C として符号化し
ます。各プロパティ名の前にスラッシュを含める必要があります。
次の要求は、aboutMe プロパティと address プロパティをレスポンスボディから除外します。
/chatter/users/me?exclude=/aboutMe%7C/address
次の表に、exclude クエリパラメータの使用ルールおよびその他の例を示します。
32
Chatter REST API の概要
説明
プロパティ名の前
にスラッシュ (/) を
含めないと、要求
からエラーが返さ
れます。
exclude
元の出力
{
Exclude の値
絞り込み後の出力
exclude=bar
エラーコード
INVALID_FILTER_VALUE の 400
エラー
"bar" : "bar value",
"baz" : "baz value"
}
プロパティを名前
で絞り込みます。
exclude=/bar
{
"bar" : "bar value",
"baz" : "baz
"baz" : "baz value"
value"
}
最上位レベルのプ
ロパティは絞り込
みできません。こ
のクエリ文字列は
エラーを返しませ
ん。
{
}
exclude=/foo
<foo>
<foo>
<bar>bar value</bar>
<bar>bar value
<baz>baz value</baz>
</bar>
</foo>
<baz>baz value
</baz>
</foo>
複数のプロパティ
を絞り込むには、
バー (|) 区切り文字
を使用します。URL
は、区切り文字を
%7C として符号化
します。
exclude=/foo%7C/bar
{
"foo" : "foo value",
{
"baz" : "baz
"bar" : "bar value",
value"
"baz" : "baz value"
}
}
レスポンスボディ
の絞り込みでは、
レスポンスボディ
内のすべてが絞り
込まれます。
exclude=/someObject
<foo>
<bar>bar value</bar>
<foo>
<bar>bar value
<baz>baz value</baz>
</bar>
<someObject>
<baz>baz value
<sub>sub 1</sub>
</baz>
33
Chatter REST API の概要
説明
exclude
元の出力
Exclude の値
</someObject>
絞り込み後の出力
</foo>
</foo>
レスポンスボディ
内でネストされた
プロパティを絞り
込むには、親レス
ポンスボディの名
前を条件セグメン
トとして含めま
す。
exclude=/someObject/sub
<foo>
<foo>
<bar>bar value</bar>
<bar>bar value
<baz>baz value</baz>
</bar>
<someObject>
<baz>baz value
<sub>sub value</sub>
</baz>
</someObject>
<someObject>
</foo>
</someObject>
</foo>
リスト内の項目
は、プロパティ名
で識別します。こ
の例では XML を使
用します。
exclude=/someList/item/id
<foo>
<foo>
<bar>bar valu</bar>
<bar>bar value
<baz>baz value</baz>
</bar>
<someList>
<baz>baz value
<item>
</baz>
<id>1</id>
<someList>
</item>
<item/>
<item>
<item/>
<id>2</id>
<item/>
</item>
</someList>
<item>
</foo>
<id>3</id>
</item>
</someList>
</foo>
34
Chatter REST API の概要
説明
リスト内の項目
は、プロパティ名
で識別します。こ
の例では JSON を使
用します。
include
元の出力
Exclude の値
exclude=/someList/item/id
{
絞り込み後の出力
{
"bar" : "bar value",
"bar" : "bar value",
"baz" : "baz value",
"baz" : "baz value",
"someList" : [
"someList" : [
{
{},
"id" : "1"
{},
},
{}
{
]
"id" : "2"
}
} ,
{
"id" : "3"
}
]
}
include
レスポンスボディを特定のプロパティに限定するには、include クエリ文字列パラメータを使用します。
include クエリ文字列パラメータの値は、バー (|) で区切られたプロパティのリストです。URL は、バーを
%7C として符号化します。各プロパティ名の前にスラッシュを含めます。
次の要求では、aboutMe プロパティと address プロパティのみがレスポンスボディに含まれます。
/chatter/users/me?include=/aboutMe%7C/address
次の表に、include クエリパラメータの使用ルールを示します。
説明
プロパティ名の前
にスラッシュ (/) を
含めないと、要求
元の出力
{
Include の値
絞り込み後の出力
include=bar
エラーコード
INVALID_FILTER_VALUE
の 400 エラー
"bar" : "bar value",
35
Chatter REST API の概要
説明
からエラーが返さ
れます。
include
元の出力
Include の値
絞り込み後の出力
"baz" : "baz value"
}
プロパティを名前
で絞り込みます。
include=/bar
{
"bar" : "bar value",
"bar" : "bar
"baz" : "baz value"
value",
}
最上位レベルのプ
ロパティは無視さ
れます。この操作
を行っても、エ
ラーにはなりませ
ん。
{
}
include=/foo
<foo>
<foo>
<bar>bar value</bar>
<bar>bar value
<baz>baz value</baz>
</bar>
</foo>
<baz>baz value
</baz>
</foo>
複数のプロパティ
を絞り込むには、
バー (|) 区切り文字
を使用します。URL
は、区切り文字を
%7C として符号化
します。
include=/foo%7C/bar
{
{
"foo" : "foo value",
"foo" : "foo
"bar" : "bar value",
value",
"baz" : "baz value"
"bar" : "bar
}
value",
}
レスポンスボディ
の絞り込みでは、
その下にあるすべ
てのものが絞り込
まれます。
include=/someObject
<foo>
<foo>
<bar>bar value</bar>
<someObject>
<baz>baz value</baz>
<sub>sub 1
<someObject>
</sub>
<sub>sub 1</sub>
</someObject>
</someObject>
</foo>
36
Chatter REST API の概要
説明
include
元の出力
Include の値
絞り込み後の出力
</foo>
レスポンスボディ
内でネストされた
プロパティを絞り
込むには、親レス
ポンスボディの名
前を条件セグメン
トとして含めま
す。
include=/someObject/sub
<foo>
<foo>
<bar>bar value</bar>
<someObject>
<baz>baz value</baz>
<sub>sub 1
<someObject>
</sub>
<sub>sub value</sub>
</someObject>
</someObject>
</foo>
</foo>
リスト内の項目
は、プロパティ名
で識別します。こ
の例では XML を使
用します。
include=/someList/item/id
<foo>
<bar>bar valu</bar>
<foo>
<someList>
<baz>baz value</baz>
<item>
<someList>
<id>1</id>
<item>
</item>
<id>1</id>
<item>
</item>
<id>2</id>
<item>
</item>
<id>2</id>
<item>
</item>
<id>3</id>
<item>
</item>
<id>3</id>
</someList>
</item>
</foo>
</someList>
</foo>
リスト内の項目
は、プロパティ名
include=/someList/item/id
{
37
{
Chatter REST API の概要
説明
で識別します。こ
の例では JSON を使
用します。
レスポンスボディの符号化
元の出力
Include の値
"bar" : "bar value",
絞り込み後の出力
"someList" : [
"baz" : "baz value",
{
"someList" : [
"id" : "1"
{
},
"id" : "1"
{
},
"id" : "2"
{
} ,
"id" : "2"
{
} ,
"id" : "3"
{
}
"id" : "3"
]
}
}
]
}
レスポンスボディの符号化
Chatter REST API は、ユーザが送信したコンテンツを配信します。このコンテンツの多くは、入力時に絞り込み
されず、サードパーティのモバイルアプリケーションや Web アプリケーションなど、雑多なソースから送ら
れてくる場合があります。そのため、Chatter REST API 出力を使用するアプリケーションを作成する開発者は、
データを使用するコンテキスト用に出力を適切に処理するように考慮する必要があります。これに失敗する
と、アプリケーションとそのユーザがクロスサイトスクリプト (XSS) 攻撃やその他の問題にさらされ、結果的
にデータ損失、アプリケーション障害、会社の機密情報の漏洩などにつながる可能性があります。
Chatter REST API 文字列は、デフォルトでは最小限に符号化された HTML エンティティであり、多くの場合は HTML
タグ間の表示に適していますが、他の HTML コンテキストには適しているとは限りません。Chatter REST API 出力
は、多くのコンテキストで使用される可能性があります。開発者は、デフォルトのエンティティ符号化がすべ
てのコンテキストに適していると想定しないでください。特に、Chatter REST API 出力を HTML 属性値内、URL 内、
JavasScript 内、スクリプトタグ内、CSS 内で使用する場合は、それぞれ異なる符号化とホワイトリスト登録が必
要になります。 さまざまなコンテキストでの API 出力の処理用法についての詳細は、「オープン Web アプリ
ケーションセキュリティプロジェクト」を参照してください。
Chatter REST API応答の戻り値は、出力上で符号化されます。すべての文字列で次の文字はエスケープされます。
38
Chatter REST API の概要
状況コードとエラー応答
文字
エスケープ文字
<
&lt;
>
&gt;
"
&quot;
'
&#39;
\
&#92;
&
&amp;
ネイティブのモバイルアプリケーションなど、非 HTML コンテキストの場合、Chatter REST API クライアントが、
要求内の X-Chatter-Entity-Encoding HTTP ヘッダーを false に設定して、未加工 (符号化されていない)
の出力を要求する場合があります。
Chatter REST API は、応答ペイロードに含まれる URL 値に特殊な符号化を行います。URL の主部分は、RFC2396 に
従って URL 符号化され、クエリ文字列は HTML 形式で符号化されます。この符号化は無効にできません。
状況コードとエラー応答
エラーが発生した場合、または応答が正常な場合、応答ヘッダーには HTTP コードが含まれ、レスポンスボディ
には通常 HTTP 応答コード、そのエラーに付随するメッセージ、必要に応じてエラーが発生した項目またはオ
ブジェクトが含まれます。
HTTP 応答コード
説明
200
GET、PATCH、または HEAD 要求が成功しました
201
POST 要求が成功しました
204
DELETE が成功しました
400
要求を理解できませんでした。通常は、特定のリソースに対して無効な ID が使用さ
れていることが原因です。たとえば、groupId が要求される場合に userId を使用
すると、要求は 400 を返します。
401
セッション ID または OAuth トークンが期限切れか無効です。または、要求がゲスト
ユーザによって行われた場合、ゲストユーザはこのリソースにアクセスできません。
レスポンスボディに message および errorCode が含まれます。
403
要求が却下されました。コンテキストユーザに要求されたデータへの適切なアクセ
ス権限があること、またはコンテキストユーザが外部ユーザではないことを確認し
てください。
404
指定されたリソースが見つからなかったか、リソースがすでに削除されています。
409
競合が発生しました。たとえば、グループへの参加要求を更新しようとしたら、そ
の要求がすでに承認または却下されていた場合などに発生するエラーです。
39
Chatter REST API の概要
OAuth と Chatter REST API について
HTTP 応答コード
説明
412
前提処理が失敗しました。たとえば、バッチ要求で haltOnError が true に設定
され、サブ要求が失敗した場合、後続のサブ要求は 412 を返します。
500
Force.com 内でエラーが発生したため、要求を完了できませんでした。Salesforce カス
タマーサポートにお問い合わせください。
503
1 時間あたりの要求数を超えています。
例
この要求ではコメント ID が必要ですが、代わりにフィード項目 ID が使用されています。
GET /chatter/comments/0D5D0000000XZoHKAW
これは、レスポンスボディです。
[ {
"errorCode" : "NOT_FOUND",
"message" : "The requested resource does not exist"
} ]
OAuth と Chatter REST API について
OAuth は、ユーザデータへのアクセスにセキュア認証を許可するオープンプロトコルです。ユーザのユーザ名
およびパスワードを渡す必要はありません。OAuth は、ソフトウェアアクセスのバレットキーと呼ばれること
がよくあります。バレットキーとは、自動車の特定の部分のみ開けられる鍵のことです。たとえば、トランク
やダッシュボードの小物入れなどは開けられません。
Chatter REST API は、OAuth を使用してアプリケーションを Salesforce に接続する前にセキュアに識別します。
OAuth を使用すると、アプリケーションにログイン情報を保存せずにすみます。アプリケーションへのユーザ
のログインは、標準の Salesforce ページを使用して行うことができます。この際、Salesforce ページからアプリ
ケーションへのアクセストークンが返されます。アプリケーションは、このアクセストークンを使用してChatter
REST API Web サービスにアクセスできます。この認証方法は、モバイルアプリケーションと Web ページの両方
で使用できます。
Chatter REST API は OAuth 2.0 を使用します。
接続アプリケーションについて
Chatter REST API を使用するには、組織に REST エントリポイントを作成する必要があります。Salesforce は、この
エントリポイントを接続アプリケーション定義として定義します。
40
Chatter REST API の概要
OAuth と Chatter REST API について
接続アプリケーション定義の作成例については、「ステップ 2: 認証を設定する」 (ページ 57)を参照してくだ
さい。
接続アプリケーションの作成および使用時の考慮事項
• 接続アプリケーション定義で使用されるラベルと OAuth 用語は次のように対応付けられます。
接続アプリケーションのラベル
OAuth 用語
説明
コンシューマ鍵
client_id
Salesforce に対してアプリケーショ
ンを識別する一意の識別子。
コンシューマの秘密
client_secret
アプリケーションに関連付けられ
た秘密鍵。
コールバック URL
redirect_uri
クライアントアプリケーションに
関連付けられた URL。場合によっ
ては、これはクライアントの Web
ブラウザがリダイレクトされる先
の実際の URL にする必要がありま
す。それ以外では、この URL は使
用されませんが、クライアントア
プリケーションとサーバ (接続アプ
リケーション定義) 間で値が一致す
る必要があります。たとえば、
http://mycomponent.myapp のよう
に、アプリケーションを識別する
値を使用できます。
• モバイルアプリケーションを開発している場合、次の値を [コールバック URL] (redirect_uri) に使用し
て、独自のアプリケーションサーバの設定を省略できます。
https://login.instance_name/services/oauth2/success
Web アプリケーションを開発する場合は、この値を使用しないでください。
• 接続アプリケーションがユーザの組織と同じ組織に存在していなくてもかまいません。作成する接続アプ
リケーションは、どの組織へのサインインにも使用できます。
• テスト用に 1 つ、本番用に 1 つとして、複数の接続アプリケーション定義を作成することをお勧めします。
1 つのみを作成する場合、アプリケーションコードの場所を反映させて [コールバック URL] の値を変更す
る必要があります。さらに、iOS と Android など、異なるプラットフォームを開発する場合は、複数の接続
アプリケーションを作成する必要があります。
OAuth の基礎
• OAuth は、クライアントアプリケーションにリソース所有者が所有するリソースへのアクセス権を付与しま
す。OAuth では、リソースとはセキュアな状態に保つ必要があるものを指します。Chatter REST API の場合、
API を介してアクセス可能なすべてのデータを保護対象として考慮します。
41
Chatter REST API の概要
OAuth と Chatter REST API について
• リソースへのアクセス権を付与するかどうかはリソース所有者次第です。このコンテキストでは、システ
ム管理者 (ユーザと接続アプリケーションを管理する) とユーザ (サードパーティアプリケーションにログイ
ンしてアクセス権を付与する) を合わせたものがリソース所有者です。
• アプリケーションがリソースにアクセスする場合、リソース所有者からの認証が要求されます。OAuth で
は、アプリケーションにリソースへのアクセス権を付与するさまざまな方法が提供されます。これらは許
可種別またはフローと呼ばれます。コンテキストに応じて適したフローは異なります。
• クライアントアプリケーションがリソースへのアクセスを認証されると、クライアントアプリケーション
にはアクセストークンと更新トークンが与えられます。認証されたクライアントアプリケーションには、
ID を証明するために、後続のすべての Web サービス要求にアクセストークンを含める必要があります。ア
クセストークンの有効期間は限られています。アクセストークンの期限が切れると、認証されたクライア
ントアプリケーションは、更新トークンを使用して新しいアクセストークンを取得するための特殊な要求
を行うことができます。
OAuth フロー
ユーザは、Salesforce にアクセスする前に認証を受ける必要があります。OAuth には複数の認証フローがありま
す。各認証フローには複数のステップがあります。これらは、OAuth 標準および Salesforce へのアクセスを試行
するアプリケーションの種別によって決まります。認証が成功すると、クライアントアプリケーションにはア
クセストークンと更新トークンが与えられます。
Salesforce は、Chatter REST API で使用するために次のフローをサポートしています。
• Web サーバフロー
• ユーザエージェントフロー
さらに、アプリケーションのアクセスが認証された後に更新トークンを使用して新しいアクセストークンを取
得することもできます。
Salesforce Communites での OAuth の使用についての詳細は、『Salesforce Communites 実装ガイド』を参照してくださ
い。
アクセス権の取り消し
ユーザにクライアントアプリケーションへのアクセス権が付与された後、そのアクセス権を取り消すには、
[個人情報] ページの [接続アプリケーション] セクションで [取り消し] をクリックします。
関連リソース
Chatter REST API の最新情報とその他のコード例は、https://developer.salesforce.com/page/Chatter_APIを参照してくださ
い。
Chatter REST API は、一部のインフラストラクチャを Force.com REST API と共有します。次の Force.com チュートリア
ルに含まれる認証に関する情報は、Chatter REST API にも該当します。
• Getting Started with the Force.com REST API (Force.com REST API の使用開始)
• Digging Deeper into OAuth on Force.com (Force.com の OAuth の詳細)
• Using OAuth to Authorize External Applications (OAuth を使用した外部アプリケーションの認証)
42
Chatter REST API の概要
Web サーバ OAuth 認証フローについて
Force.com REST API の認証部分は、Chatter REST API と共有されています。Force.com REST API をサポートする次のライ
ブラリが役立ちます。
• Force.com JavaScript REST Toolkit
OAuth は広く使われている認証標準です。OAuth のクライアントライブラリを使用すると、クライアントアプ
リケーションの開発プロセスを円滑に進めることができます。次のクライアントプログラミングライブラリが
役に立ちます。
• Ruby on Rails: OmniAuth
• Java Apache Amber
Web サーバ OAuth 認証フローについて
通常、このフローを使用するのは、クライアントの秘密を機密扱いで保存できる Web アプリケーションです。
Web サーバフローで非常に重要な点として、アプリケーションがコンシューマの秘密を保護できる必要があり
ます。
一般的なフローは次のようになります。個々のステップについては、その後に説明します。
OAuth Web サーバフローの概要を次に説明します。
43
Chatter REST API の概要
Web サーバ OAuth 認証フローについて
1. リソースの認証を要求するために、クライアントアプリケーションは、エンドユーザのブラウザをリソー
ス所有者の認証サーバでホストされている Web ページにリダイレクトします。この場合は、Salesforce ログ
インページです。
2. エンドユーザが Salesforce にログインして自分自身を認証します。この Web ページは、リソース所有者
(Salesforce) がホストし、エンドユーザが直接操作しているため、クライアント Web アプリケーションがユー
ザのログイン情報を見つけることはありません。エンドユーザは、クライアントアプリケーションの認証
も行います。
3. Salesforce は、指定されたコールバック URL を使用して認証コードをクライアントアプリケーションに返送
します。
4. 認証コードを取得したら、クライアントアプリケーションはアクセストークンを取得するための認証コー
ドを返します。
5. 認証コードの確認後、Salesforce はレスポンストークンを返します。エラーがなければ、レスポンストーク
ンには、アクセスコード、更新トークン、追加情報が含まれます。
6. 保護されるリソースは Chatter REST API エンドポイントです。
Chatter REST API および Salesforce による Web サーバフローの使用
ここでは、OAuth Web サーバフローを Salesforce および Chatter REST API で使用する場合の詳細を具体的に説明しま
す。
1. 次の要求パラメータを指定して、クライアントの Web ブラウザをページ
https://login.instance_name/services/oauth2/authorize に転送します。
パラメータ
説明
response_type
この認証フローの場合、必ず code にする
client_id
このアプリケーション用に定義された接続アプリ
ケーションからの [コンシューマ鍵] 値
redirect_uri
このアプリケーション用に定義された接続アプリ
ケーションからの [コールバック URL] 値
必要に応じて、次の要求パラメータを含めることもできます。
パラメータ
説明
state
承認後にコールバック URL で返される、URL 符号化
された状態データを指定します。
immediate
ログインと承認についてユーザにプロンプトメッ
セージを表示するかどうかを決定します。値は、
true か false のいずれかです。デフォルトは
false です。
44
Chatter REST API の概要
Web サーバ OAuth 認証フローについて
パラメータ
説明
• true に設定され、ユーザが現在ログインしてお
り、以前にこのアプリケーションを承認してい
る場合、承認ステップはスキップされます。
• true に設定され、ユーザがログインしていない
か、これまでこのアプリケーションを承認した
ことがない場合、セッションはただちにエラー
コード immediate_unsuccessful で終了しま
す。
提供される Web ページの種別を示します。有効な値
は、次のとおりです。
display
• page — 全画面のページ認証。これは、値が指定
されていない場合のデフォルト値です。
• popup — 最新の Web ブラウザのポップアップ
ウィンドウ用に最適化されたコンパクトなダイ
アログ。
• touch — Android や iPhone など、最新のスマート
フォン用に設計されたモバイル用に最適化され
たダイアログ。
• mobile — BlackBerry OS 5 など、機能の少ないス
マートフォン用に設計されたモバイル用に最適
化されたダイアログ。
2. ログインに成功したら、ユーザはアプリケーションを認証するように要求されます。
45
Chatter REST API の概要
Web サーバ OAuth 認証フローについて
ユーザがすでにアプリケーションを認証している場合、このステップはスキップされます。
3. クライアントアプリケーションが認証されたことが Salesforce で確認されると、エンドユーザの Web ブラウ
ザは、redirect_uri パラメータで指定されたコールバック URL にリダイレクトされます。このパラメー
タのクエリ文字列には次の値が付加されます。
パラメータ
説明
code
アクセストークンと更新トークンを取得するために
渡される認証コード
46
Chatter REST API の概要
Web サーバ OAuth 認証フローについて
パラメータ
説明
state
最初の要求の一部として渡される状態値 (該当する
場合のみ)。
redirect_uri Web ページは、クライアントアプリケーションサーバでホストされていると想定されます。
4. クライアントアプリケーションサーバは、認証コードを抽出して、これを含めたアクセストークン要求を
Salesforce に渡す必要があります。この要求は、URL
https://login.instance_name/services/oauth2/token に対する POST 送信として次のクエリパラ
メータを指定して行う必要があります。
パラメータ
説明
grant_type
このフローの値は authorization_code である必
要があります。
client_id
接続アプリケーション定義のコンシューマ鍵。
client_secret
接続アプリケーション定義のコンシューマの秘密。
redirect_uri
承認後にユーザをリダイレクトする URI。これは、
接続アプリケーション定義の [コールバック URL]
項目の値に完全に一致している必要があります。ま
た、最初のリダイレクトによって送信された値と同
じ値です。
code
承認後にコールバックから取得される認証コード。
format
期待される戻り形式。このパラメータは省略可能で
す。デフォルトは json です。値は次のとおりで
す。
• urlencoded
• json
• xml
5. この要求が成功した場合、サーバは次の内容を保持するレスポンスボディを返します。
パラメータ
説明
access_token
Chatter REST API 要求を行うために使用可能なセッショ
ン ID。このセッション ID はユーザインターフェース
では使用できません。これは、ユーザのセッション
と同様に扱い、厳密に保護する必要があります。
47
Chatter REST API の概要
ユーザエージェント OAuth 認証フローについて
パラメータ
説明
refresh_token
新しいアクセストークン (セッション) を取得するた
めに将来使用できるトークン。
警告: この値は秘密です。ユーザのパスワード
などと同様に処理し、適切な手段で保護する
必要があります。
instance_url
ユーザの組織のインスタンスを示す URL。この例で
は、インスタンスは na1:
https://na1.salesforce.com です。
id
ユーザ、およびユーザの詳細に関するクエリの両方
を識別するために使用できる ID URL。エンドユーザ
に関する詳細な情報を取得するための HTTP 要求で使
用できます。
signature
連結 ID と issued_at を含むコンシューマの非公開
キーで署名されている Base64 符号化された
HMAC-SHA256 署名。これは、サーバによる送信以降
変更されなかった ID URL の確認に使用できます。
issued_at
いつ署名が作成されたか。
ユーザエージェント OAuth 認証フローについて
通常、このフローは、JavaScript から直接 Chatter REST API にアクセスするモバイルアプリケーションまたはアプ
リケーションで使用されます。このフローでは、クライアントアプリケーションは信頼できないため、クライ
アントのログイン情報やユーザのログイン情報を保存できないということを前提にしています。
警告: アクセストークンは符号化され、リダイレクト URI になっているため、エンドユーザや、コンピュー
タまたはデバイス上にある他のアプリケーションに公開できます。
JavaScript を使用して認証する場合、window.location.replace(); をコールし、ブラウザの履歴から
コールバックを削除することをお勧めします。
一般的なフローは次のようになります。個々のステップについては、その後に説明します。
48
Chatter REST API の概要
ユーザエージェント OAuth 認証フローについて
次に、OAuth ユーザエージェントフローの概要を説明します。
1. リソースの認証を要求するために、クライアントアプリケーションは、エンドユーザのブラウザをリソー
ス所有者の認証サーバでホストされている Web ページにリダイレクトします。この場合は、Salesforce ログ
インページです。
2. エンドユーザが Salesforce にログインして自分自身を認証します。この Web ページは、リソース所有者
(Salesforce) がホストし、エンドユーザが直接操作しているため、クライアント Web アプリケーションがユー
ザのログイン情報を見つけることはありません。
クライアントアプリケーションがすでにブラウザで実行されている場合、そのままブラウザをリダイレク
トできます。クライアントアプリケーションがモバイルアプリケーションの場合、ブラウザを開く必要が
あります (iOS の UIWebView など)。エンドユーザはこの Web ページを使用して自分自身を認証し、その後、
クライアントアプリケーションを認証します。
3. 認証されると、認証サーバはエンドユーザの Web ブラウザをリダイレクト URL にリダイレクトします。こ
の URL は、クライアントアプリケーションがアクセストークンと更新トークンを取得するために使用でき
ます。
4. 保護されるリソースは Chatter REST API リソースです。
49
Chatter REST API の概要
ユーザエージェント OAuth 認証フローについて
Chatter REST API および Salesforce によるユーザエージェントフローの使用
ここでは、OAuth ユーザエージェントフローを Salesforce および Chatter REST API で使用する場合の詳細を具体的に
説明します。
1. 次の要求パラメータを指定して、クライアントの Web ブラウザをページ
https://login.instance_name/services/oauth2/authorize に転送します。
パラメータ
説明
response_type
この認証フローの場合、必ず token にする
client_id
このアプリケーション用に定義された接続アプリ
ケーションからの [コンシューマ鍵] 値
redirect_uri
このアプリケーション用に定義された接続アプリ
ケーションからの [コールバック URL] 値
必要に応じて、次の要求パラメータを含めることもできます。
パラメータ
説明
display
提供される Web ページの種別を示します。有効な値
は、次のとおりです。
• page — 全画面のページ認証。これは、値が指定
されていない場合のデフォルト値です。
• popup — 最新の Web ブラウザのポップアップ
ウィンドウ用に最適化されたコンパクトなダイ
アログ。
• touch — Android や iPhone など、最新のスマート
フォン用に設計されたモバイル用に最適化され
たダイアログ。
• mobile — BlackBerry OS 5 など、以前のスマート
フォン用に設計された、モバイル用に最適化さ
れたダイアログ。
scope
アプリケーションがアクセスできるデータを指定し
ます。Chatter REST API にアクセスするために値を指定
する必要はありません。値を指定する場合は、
chatter_api 値を含める必要があります。
state
承認後にコールバック URL で返される、URL 符号化
された状態データを指定します。
50
Chatter REST API の概要
ユーザエージェント OAuth 認証フローについて
2. ログインに成功したら、ユーザはアプリケーションを認証するように要求されます。ユーザがすでにアプ
リケーションを認証している場合、このステップはスキップされます。
3. クライアントアプリケーションが認証されたことが Salesforce で確認されると、エンドユーザの Web ブラウ
ザは、redirect_uri パラメータで指定されたコールバック URL にリダイレクトされます。このパラメー
タにはハッシュ記号 (#) の後に次の値が付加されます。これは、クエリ文字列ではありません。
パラメータ
説明
access_token
Chatter REST API 要求を行うために使用可能なセッショ
ン ID。このセッション ID はユーザインターフェース
では使用できません。これは、ユーザのセッション
と同様に扱い、厳密に保護する必要があります。
expires_in
アクセストークンが有効な時間 (秒)。
refresh_token
新しいアクセストークン (セッション) を取得するた
めに将来使用できるトークン。
警告: この値は秘密です。ユーザのパスワード
などと同様に処理し、適切な手段で保護する
必要があります。
更新トークンが返されるのは、リダイレクト URI が
https://login.instance_name/services/oauth2/success
であるか、HTTPS 以外のカスタムプロトコルで使用
されている場合のみです。
次の追加パラメータが返されますが、このフローと Chatter REST API では使用されません。
• instance_url
• id
• signature
• issued_at
4. クライアントアプリケーションが Web アプリケーションの場合、そこで使用されるリダイレクト Web ペー
ジには、クライアントアプリケーションがアクセストークンと更新トークンを取得するために操作可能な
JavaScript が含まれている場合があります。
または、クライアントアプリケーション (ネイティブまたは Web) がページ
https://login.instance_name/services/oauth2/success をコールバック URL として使用している
場合があります。リダイレクト時に実際にページを読み込む代わりに、リダイレクト URI をインターセプト
してパラメータ値を抽出する必要があります。refresh_token パラメータ値は、リダイレクト URI がこの
URI である場合か、カスタムプロトコルを使用する場合にのみ提供されます。
クライアントアプリケーションは、アクセストークンと更新トークンを取得すると、それらのトークンを
使用して Chatter REST API に要求を行います。
51
Chatter REST API の概要
トークンの使用
トークンの使用
両方の認証フローの一部として、アクセストークンと更新トークンを使用します。
アクセストークンの使用
Chatter REST API 要求を正常に行うには、要求に有効なアクセストークンを含める必要があります。これを行う
には、HTTP 認証ヘッダーを使用します。
Authorization: OAuth <access token>
要求のトークンの期限が切れていたためにエラー応答が返された場合、更新トークンを使用して新しいアクセ
ストークンを取得できます。
アクセストークンが取り消されたために要求がエラーになった場合、クライアントアプリケーションがアクセ
ス権を得るには、ユーザによる再認証が必要です。
更新トークンの使用
クライアントアプリケーションに更新トークンがある場合、更新トークンを使用して新しいアクセストークン
の要求を送信できます。
新しいアクセストークンを要求するには、クライアントアプリケーションが次のクエリパラメータを指定した
POST 要求を https://login.instance_name/services/oauth2/token に送信する必要があります。
パラメータ
説明
grant_type
このフローの値は refresh_token である必要があり
ます。
refresh_token
クライアントアプリケーションがすでに受け取ってい
る更新トークン。
client_id
接続アプリケーション定義のコンシューマ鍵。
必要に応じて、次のパラメータを含めることもできます。
パラメータ
説明
client_secret
接続アプリケーション定義のコンシューマの秘密。
format
期待される戻り形式。デフォルトは json です。値は
次のとおりです。
• urlencoded
• json
• xml
このリクエストが成功した場合、サーバは access_token を保持するペイロードを返します。
52
Chatter REST API の概要
HTML からの静的アセットの直接要求およびフォーム要
求の直接投稿
次の追加パラメータも返されますが、このフローと Chatter REST API では使用されません。
• instance_url
• id
• signature
• issued_at
HTML からの静的アセットの直接要求およびフォーム要求の直接投稿
Salesforce でホストされない HTML ページでは、ユーザやグループ画像を表示したり、フォームに添付ファイル
を投稿したりするのが困難でした。理由は、これらのアセットの URL で認証が必要であるからです。この認証
は、ページが Salesforce でホストされるときに、セッション Cookie によって提供されます。Salesforce でホストさ
れないページは、セッション Cookie にアクセスできません。また、HTML のコンテキスト <img>、<a>、および
<form> から OAuth トークンを渡すこともできません。
この問題を解決するには、自己認証を行うべアラートークン URL を要求します。べアラートークン URL は、リ
ソースへのアクセスを提供するべアラートークンが付加された Chatter REST API リソースです。ベアラートーク
ン URL はそのまま使用します。パラメータを追加または削除しないでください。パラメータを追加または削除
すると、エラーが発生します。次の操作を行うには、<img>、<a>、および <form> タグでべアラートークン
URL を使用します。
• Chatter ユーザプロファイルの画像およびファイル、ファイルやダッシュボードのプレビューなどの静的な
Chatter REST API アセットの要求
• 添付ファイルがあるフィード項目やコメント、またはユーザプロファイル写真の更新など、ファイルが添
付されている場合の Chatter REST API へのフォーム要求の投稿
静的アセットの要求またはフォーム要求の投稿を行うには、べアラートークン URL を返すリソースを要求しま
す。次に、べアラートークン URL を使用して、リソースを要求します。
1. べアラートークン URL を含むレスポンスボディのプロパティを使用して、リソースを要求します。
• Comment Page — currentPageUrl*
• Content Capability — downloadUrl、externalDocumentUrl、renditionUrl、repositoryFileUrl
• Feed — feedElementPostUrl*、feedElementsUrl*、feedItemsUrl*
• Feed Item — photoUrl
• Feed Item Attachment: Content — downloadUrl、externalDocumentUrl、renditionUrl、
repositoryFileUrl
• Feed Item Attachment: Dashboard — fullSizeImageUrl、thumbnailUrl
• File Detail — downloadUrl、externalDocumentUrl、renditionUrl、renditionUrl240By180、
renditionUrl720By480、repositoryFileUrl
• File Summary — downloadUrl、externalDocumentUrl、renditionUrl、renditionUrl240By180、
renditionUrl720By480、repositoryFileUrl
• File Summary Page — currentPageUrl*
• Icon — url
• Mention Completion — photoUrl
• Photo — largePhotoUrl、smallPhotoUrl、url*
53
Chatter REST API の概要
CORS を使用した Chatter REST API および REST API へのア
クセス
• Repository File Detail — downloadUrl
• Repository File Summary — downloadUrl
* 添付ファイルがあるフィード項目やコメントなど、バイナリファイルを含む新しい項目を POST または PUT
するときに使用します。
2. true の値を使用して、X-Connect-Bearer-Urls 要求ヘッダーを渡します。
X-Connect-Bearer-Urls: true
3. レスポンスボディからべアラートークン URL を解析し、それを HTML タグで使用して、静的アセットの要求
またはフォーム要求の投稿を行います。
べアラートークン URL には、次の特性があります。
• べアラートークンは、特定の URL にのみ適しています。クエリパラメータを追加したり、並び替えたり
すると、URL が無効になります。
• べアラートークンの Time to Live (TTL) は 20 分です。トークンの有効期限が切れた場合、再度要求する必要
があります。
• べアラートークン URL への要求は、べアラートークン URL を返したリソースを要求したユーザとして認
証されます。
CORS を使用した Chatter REST API および REST API へのアクセス
Chatter REST API および REST API では、CORS (クロスオリジンリソース共有) がサポー
トされます。Web ブラウザで JavaScript からこれらの API にアクセスするには、ス
クリプトを提供するオリジンを CORS ホワイトリストに追加します。
CORS は、Web ブラウザが他のオリジンからのリソースを要求 (クロスオリジン要
求) できるようにする W3C 勧告です。たとえば、CORS を使用すると、
https://www.example.com にある JavaScript スクリプトで
https://www.salesforce.com からのリソースを要求できます。
CORS をサポートするブラウザが、Salesforce CORS ホワイトリスト内のオリジンに
要求を行うと、Salesforce はオリジンを含む Access-Control-Allow-Origin
HTTP ヘッダーと、追加の CORS HTTP ヘッダーを返します。オリジンがホワイトリ
ストにない場合は、Salesforce が HTTP 状況コード 403 を返します。
1. [設定] から、[セキュリティのコントロール] > [CORS] を選択します。
エディション
使用可能なエディション:
Developer Edition、
Enterprise Edition、
Performance Edition、
Unlimited Edition
ユーザ権限
作成、参照、更新、およ
び削除する
• 「すべてのデータの編
集」
2. [新規] を選択します。
3. オリジンの URL パターンを入力します。
オリジンの URL パターンには、HTTPS プロトコルとドメイン名を含める必要があり、ポートを含めることも
できます。ワイルドカード文字 (*) はサポートされますが、第 2 レベルドメイン名の前にある必要がありま
す。たとえば、https://*.example.com により、example.com のすべてのサブドメインがホワイトリ
ストに追加されます。
オリジンの URL パターンに IP アドレスを使用できます。ただし、IP アドレスと、同じアドレスに解決する
ドメインは同じオリジンではないため、CORS ホワイトリストには別々のエントリとして追加する必要があ
ります。
54
Chatter REST API の概要
CORS を使用した Chatter REST API および REST API へのア
クセス
重要: OAuth トークンが必要な要求では、OAuth トークンを渡す必要があります。
55
第2章
トピック:
•
前提条件
•
ステップ 1:
Salesforce Developer
Edition 組織を取得す
る
•
ステップ 2: 認証を
設定する
•
ステップ 3: OAuth
を使用して Chatter
REST API に接続する
•
Salesforce
Communities への接
続
Chatter REST API クイックスタート
Salesforce に接続して認証し、Chatter REST API に対して要求を実行して応答を確認しま
す。
56
Chatter REST API クイックスタート
前提条件
前提条件
クイックスタートを開始する前に、次の前提条件を満たしていることを確認してください。
次のことに習熟しておいてください。
• cURL。コマンドラインツールであり、クイックスタートでは Salesforce への HTTP 要求を行うクライアントア
プリケーションとして使用します。cURL は、多くの Linux システムや Mac システムにあらかじめインストー
ルされています。Windows バージョンは、curl.haxx.se/ からダウンロードできます。Windows で HTTPS を
使用する場合、システムが SSL 対応の cURL の要件を満たしていることを確認してください。
メモ: cURL はオープンソースのツールで、Salesforce ではサポートされていません。
• JavaScript Object Notation (JSON)。このクイックスタートで返されるデータ形式です。
• OAuth 2.0。Salesforce が認証に使用するフレームワークです。このクイックスタートでは手順を説明します
が、OAuth の用語と概念に習熟しておくと役立ちます。
ステップ 1: Salesforce Developer Edition 組織を取得する
まだ Force.com 開発者コミュニティのメンバーでない場合、developer.salesforce.com/signup にアクセス
し、Developer Edition 組織のサインアップの説明に従ってください。すでに Enterprise Edition、Unlimited Edition、ま
たは Performance Edition を所有している場合でも、組織の使用中のデータを保護するために、サンプルデータに
対するソリューションの開発、ステージングおよびテストには Developer Edition を使用します。これは、特に、
(データをただ参照するだけのアプリケーションに対し) データを挿入、更新または削除するアプリケーション
の場合に該当します。
Developer Edition 組織をすでに所有している場合は、「API の有効化」権限があることを確認します。この権限は
デフォルトで有効になっていますが、管理者によって変更されている場合があります。詳細は、Salesforceユー
ザインターフェースのヘルプを参照してください。
ステップ 2: 認証を設定する
Salesforce 組織で接続アプリケーションを作成し、OAuth を有効にします。クライアントアプリケーションは、
接続アプリケーションを使用して Salesforce に接続します。
1. Developer Edition 組織で、[設定] から [作成] > [アプリケーション] をクリックし、[接続アプリケーション] セ
クションで [新規] をクリックして新しい接続アプリケーションを作成します。
クライアントは、接続アプリケーションが組織で定義されていなくても、接続アプリケーションを使用し
て組織にサインインできます。
2. 接続アプリケーション名を入力します。
3. 取引先責任者のメールと、必要に応じてその他の情報を入力します。
4. [OAuth 設定の有効化] を選択します。
5. [コールバック URL] を入力します。これはセキュアである必要があります。http:// は機能せず、https://
のみが機能します。
57
Chatter REST API クイックスタート
ステップ 3: OAuth を使用して Chatter REST API に接続す
る
このクイックスタートでは、「https://」と入力してください。
6. OAuth の範囲を入力します。接続アプリケーションでアクセスを許可する他の範囲に加え、[Chatter フィー
ドへのアクセスと管理] を選択します。
7. [保存] をクリックします。
[コンシューマ鍵] が作成され、表示されます。また、[コンシューマの秘密] が作成されます (表示するには
リンクをクリックします)。
ステップ 3: OAuth を使用して Chatter REST API に接続する
OAuth を使用して Salesforce に接続し、アクセストークンを取得します。アクセストークンを要求で Chatter REST
API に渡します。
「ステップ 2: 認証を設定する」を完了し、接続アプリケーションを作成してからこのタスクを開始します。
作成した接続アプリケーションで使用される用語と、例で使用される OAuth のプロパティの対応付けを次の表
に示します。OAuth 2.0 仕様では、「コンシューマ」ではなく「クライアント」という用語を使用します。
接続アプリケーションのアプリケーションラベル
例の値
コンシューマ鍵
client_id
コンシューマの秘密
client_secret
メモ: このクイックスタートでは、ユーザ名パスワード OAuth 認証フローを使用します。ユーザ名パス
ワード認証フローでは、ユーザのログイン情報をやりとりする必要があります。この認証フローは、こ
のクイックスタートのように必要な場合にのみ使用してください。更新トークンは発行されません。さ
らに、Salesforce Communities ではユーザ名パスワード認証フローはサポートされていません。このクイッ
クスタートでは、コミュニティ URL への要求は行わないでください。
Salesforce への要求を行うには、次の例に組織の値を代入します。
1. アクセストークンを生成します。
次の cURL コマンドはアクセストークンを生成します。
curl --form client_id=3MVG9PhR6g6B7ps4xDycwGrI4PvjVZvK9
--form client_secret=8870355475032095511
--form grant_type=password
--form [email protected]
--form password=1Lsfdc!
https://login.salesforce.com/services/oauth2/token
58
Chatter REST API クイックスタート
ステップ 3: OAuth を使用して Chatter REST API に接続す
る
ヒント: 複数行コマンドを Mac または Linux コマンドラインインターフェースに貼り付ける場合、各行
をバックスラッシュ (「\」) でエスケープしてコマンドが次の行に続くことを示します。エスケープさ
れた行は次のようになります。
curl --form client_id=3MVG9PhR6g6B7ps4xDycwGrI4PvjVZvK9 \
複数行コマンドを Windows コマンドプロンプトに貼り付ける場合、各行をキャレット (「^」) でエス
ケープします。エスケープされた行は次のようになります。
curl --form client_id=3MVG9PhR6g6B7ps4xDycwGrI4PvjVZvK9 ^
応答には、次のようにサーバインスタンスとアクセストークンが含まれます。
{
"id":"https://login.salesforce.com/id/00Di0000000hT9uEAE/005i00000022uIbAAI",
"issued_at":"1302907727777",
"instance_url":"https://na1.salesforce.com",
"signature":"5jcevY5fUai0lWntuSxkwBzWcvRjd01RCOkIBZpyGv0=",
"access_token":"00DD0000000FJ6T!AQkAQPde_DMF2vGzddfZmBRS95GojDbtA
rKkgukAgZP0OVFYY5KkAqhLw9ejeKIlpJ3FgwGAWeRlBiWRt8mfXEuAZGbZNosk"
}
2. Chatter REST API リソースを要求するには、返された instance_url をサーバインスタンスとして使用しま
す。返された access_token を Authorization 要求ヘッダーで Bearer トークンとして渡します。
curl -X GET https://na1.salesforce.com/services/data/v34.0/chatter/users/me
-H 'Authorization: Bearer 00DD0000000FJ6T!AQkAQPde_DMF2vGzddfZmBRS95Goj
DbtArKkgukAgZP0OVFYY5KkAqhLw9ejeKIlpJ3FgwGAWeRlBiWRt8mfXEuAZGbZNosk'
この例では次の値を使用しています。
プロパティ
値
サーバインスタンス
na1.salesforce.com
client_id
3MVG9PhR6g6B7ps4xDycwGrI4PvjVZvK9
client_secret
8870355475032095511
grant_type
password
grant_type の値は使用する OAuth 認証フローに応じ
て異なります。
59
Chatter REST API クイックスタート
Salesforce Communities への接続
プロパティ
値
username
[email protected]
password
1Lsfdc!
Salesforce Communities への接続
OAuth を使用して Salesforce のコミュニティに接続するには、サーバインスタンス名をコミュニティ URL へのフ
ルパスで置き換えます。
Salesforceコミュニティに接続するには、OAuth Web サーバおよびユーザエージェントワークフローを使用しま
す。
承認 URL を使用してユーザを認証するには、login.salesforce.com ホスト名をコミュニティ URL へのフル
パスで置き換えます。次の例は コミュニティ URL ではありません。
https://login.salesforce.com/services/oauth2/authorize?
response_type=token&client_id=your_app_id&redirect_uri=your_redirect_uris
コミュニティ URL は、次のようになります。
https://acme.force.com/customers/services/oauth2/authorize?
response_type=token&client_id=your_app_id&redirect_uri=your_redirect_uri
正常に実装されると、この URL によりユーザはアプリケーションのブランド名が入ったログインページに移動
します。アプリケーションを認証したら、ユーザアクセストークンを設定し、将来の認証に備えてトークンを
更新します。トークンエンドポイントの要求で、次のようにホストをコミュニティで置き換えます。
https://acme.force.com/customers/services/oauth2/token
Chatter REST API リソースを要求するには、Salesforce ホスト名を使用してコミュニティ ID を次のように指定しま
す。
https://na1.salesforce.com/services/data/v29.0/connect
/communities/communityId/chatter/feeds/news/me/feed-elements
または、ホスト名をコミュニティ URL へのフルパスで置き換えます。
https://communitydomain.force.com/communitypath/services/data/v29.0/connect
/communities/communityId/chatter/feeds/news/me/feed-elements
60
第3章
トピック:
•
アクションリンク
の使用
•
コミュニティの使
用
•
フィードおよび
フィード要素の使
用
•
Salesforce Files の使
用
Chatter REST API の機能
『Chatter REST API 開発者ガイド』のこの章では、Chatter REST API 機能の操作に使用する
リソースについて説明します。
61
Chatter REST API の機能
アクションリンクの使用
アクションリンクの使用
アクションリンクは、フィード要素上のボタンです。アクションリンクをクリックすると、ユーザを特定の
Web ページに移動したり、ファイルダウンロードを開始したり、Salesforce または外部サーバへの API コールを
呼び出したりできます。アクションリンクには、URL と HTTP メソッドが含まれ、リクエストボディとヘッダー
情報 (認証用の OAuth トークンなど) を含めることができます。アクションリンクを使用して Salesforce および
サードパーティサービスをフィードに統合することで、ユーザはアクションを実行して生産性を高め、イノ
ベーションを促進できます。
Workflow
次のフィード項目には、[承認] および [却下] という 2 つのアクションリンクを含む 1 つのアクションリンクグ
ループがあります。
フィード要素を使用してアクションリンクを作成および投稿するワークフローは、次のとおりです。
1. (省略可能) アクションリンクテンプレートを作成します。
2. /connect/action-link-group-definitions に対して要求を実行して、アクションリンクグループを定義するか、テン
プレートからアクションリンクグループをインスタンス化します。アクションリンクグループには、少な
くとも 1 つのアクションリンクが含まれます。
3. /chatter/feed-elementsに対して要求を実行して、フィード要素を投稿し、アクションリンクを関連付けます。
Action Links リソース
アクションリンクを操作するには、次のリソースを使用します。
62
Chatter REST API の機能
リソース
アクションリンクの使用
HTTP メソッド タスク
/connect/action-link-group-definitions POST
アクションリンクグループ定義を作成します。
アクションリンクをフィード要素に関連付け
るには、まずアクションリンクグループ定義
を作成します。次に、関連付けられたアクショ
ン機能を含むフィード要素を投稿します。
/chatter/feed-elements
POST
関連付けられたアクション機能を含むフィー
ド要素を投稿します。1 つのフィード要素に、
最大 10 個のアクションリンクグループを関連
付けます。
/connect/action-links/actionLinkId
GET、PATCH
アクションリンクの status の情報取得や更
新を行います。アクションリンクの status
と Action Link Definition Input の labelKey プロパ
ティの組み合わせにより、UI に表示されるテ
キストが決まります。Api および ApiAsync
アクションリンクの API 要求をトリガするに
は、status を PendingStatus に設定しま
す。
/connect/action-link-group-definitions GET、DELETE
/actionLinkGroupId
アクションリンクグループ定義の情報取得や
削除を行います。アクションリンクグループ
定義を削除すると、その定義へのすべての参
照がフィード要素から削除されます。アクショ
ンリンクグループ定義の取得や削除を行うに
は、クライアントは定義を作成した接続アプ
リケーションと同じである必要があり、ユー
ザは定義を作成したか「すべてのデータの参
照」権限を持っている必要があります。
/connect/action-link-groups
/actionLinkGroupId
GET
コンテキストユーザの状態を含む、アクショ
ンリンクグループに関する情報を取得します。
/connect/action-links/actionLinkId
/diagnostic-info
GET
アクションリンクが実行されたときに返され
た診断情報を取得します。診断情報は、アク
ションリンクにアクセスできるユーザに対し
てのみ提供されます。
/chatter/feed-elements/feedElementId GET
/capabilities/associated-actions
Feed リソース
フィード要素に関連付けられたすべてのプラッ
トフォームアクションを取得します。アクショ
ンリンクは、プラットフォームアクションの
種別の 1 つです。
GET
指定されたフィード種別のフィード要素を取
得します。フィード要素にアクションリンク
が関連付けられている場合、関連付けられた
/chatter/feeds/feedType/userId/feed-elements
/chatter/feeds/feedType/feed-elements
63
Chatter REST API の機能
リソース
アクションリンクの使用事例
HTTP メソッド タスク
アクション機能でアクションリンクデータが
返されます。
このセクションの内容:
アクションリンクの使用事例
アクションリンクを使用してSalesforceおよびサードパーティサービスをフィードと統合できます。アクショ
ンリンクでは、Salesforce またはサードパーティ API への HTTP 要求を実行できます。また、ファイルをダウ
ンロードしたり、Web ページを開いたりすることもできます。このトピックには、2 つの使用事例がありま
す。
アクションリンクの概要、認証、およびセキュリティ
Chatter REST API アクションリンクのセキュリティ、認証、表示ラベル、およびエラーについて学習します。
アクションリンクテンプレート
[設定] でアクションリンクテンプレートを作成し、Chatter REST API または Apex から共通のプロパティを持つ
アクションリンクグループをインスタンス化できます。テンプレートをパッケージ化して他の Salesforce 組
織に配布できます。
関連トピック:
アクションリンクを定義し、フィード要素を使用して投稿する
テンプレートのアクションリンクを定義し、フィード要素を使用して投稿する
テンプレートのアクションリンクを定義し、フィード要素を使用して投稿する
アクションリンクの使用事例
アクションリンクを使用してSalesforceおよびサードパーティサービスをフィードと統合できます。アクション
リンクでは、Salesforce またはサードパーティ API への HTTP 要求を実行できます。また、ファイルをダウンロー
ドしたり、Web ページを開いたりすることもできます。このトピックには、2 つの使用事例があります。
フィードから手順をダウンロードして部品を注文する
架空の 3D プリントショップ「BuildIt」が、アクションリンクを使用して Salesforce に統合される AppExchange ア
プリケーションを作成したとします。BuildIt の顧客は、このアプリケーションをインストールすると、BuildIt の
Web サイトへのアクセス、アカウントの作成、BuildIt に部品を注文できるように特定のユーザを招待するSalesforce
へのアクションリンクを含む投稿の送信を行えます。このサンプルフィード要素は、BuildIt の顧客である Pam
Jones からその部下の Jin Chang に投稿されたものです。[ダウンロード] アクションリンクをクリックすると、
BuildIt Web サイトから部品情報を含むファイルがダウンロードされます。[注文] アクションリンクをクリック
すると、Jin Chang に BuildIt Web サイトのページが表示されて部品を注文できます。
64
Chatter REST API の機能
アクションリンクの使用事例
フィードから旅程を承認または却下する
架空の「Travel Example」という会社の開発者として、「Travel Example for Salesforce」というアプリケーションを
Salesforce AppExchange 用に作成するとします。会社 A には「Travel Example for Salesforce」がインストールされてい
ます。会社 A の誰かが Travel Example Web サイトにアクセスし、旅程を予約します。Travel Example のサーバ側コー
ドは、会社 A の Salesforce 組織に本文テキスト [この出張を承認してください。]、および表示ラベル [承認] と [却
下] のアクションリンクを含むフィード項目を投稿する Chatter REST API 要求を実行します。これらのアクション
リンクは、旅程を承認または却下するために Travel Example サーバの REST リソースに対して HTTP 要求を実行し
ます。
「Travel Example for Salesforce」アプリケーションを作成するため、[設定] でこれらのアクションリンクおよび関
連付けられたアクションリンクグループを定義するアクションリンクテンプレートを作成しました。サーバ側
65
Chatter REST API の機能
アクションリンクの概要、認証、およびセキュリティ
コードでは、テンプレートからアクションリンクグループをインスタンス化する Chatter REST API 要求を実行し
ます。また、アクションリンクグループをフィード項目に関連付けて投稿する、別の Chatter REST API 要求を実
行します。
[アクション URL]、[HTTP ヘッダー]、および [HTTP リクエストボディ] テンプレート項目には、コンテキ
スト変数とバインド変数を含めることができます。
[アクション URL] に {!userId} コンテキスト変数を含めます。これにより、ユーザがフィードのアクショ
ンリンクをクリックしたときに、Salesforceがそのユーザの ID をサーバ側コードに送信して誰がアクションリン
クをクリックしたかを伝えます。アクションリンクでは、定義済みのコンテキスト変数のセットがサポートさ
れています。
アクションリンクテンプレートで必要なバインド変数を作成し、今後の変更に対応できる動的なコードにする
ことができます。サーバ側コードでは、アクションリンクグループをインスタンス化するときにバインド変数
の値を設定します。パッケージを更新することなく新しい API バージョンをリリースできるように、
{!Bindings.apiVersion} を使用します。また、アクションリンクをクリックすることでユーザが作成した
旅程を承認または却下できるように、{!Bindings.tripId} も使用します。
アクションリンクが 1 人のユーザのみに表示されるように、[ユーザ表示設定] 項目を設定します。[カスタム
ユーザ(別名)] 項目に値を入力します。これは、サーバ側コードがアクションリンクグループをインスタンス
化するときに、ユーザのマネージャの ID に対して値が設定されるバインド変数でもあります。
[承認] アクションリンク用のアクションリンクテンプレートを次に示します。
アクションリンクの概要、認証、およびセキュリティ
Chatter REST API アクションリンクのセキュリティ、認証、表示ラベル、およびエラーについて学習します。
66
Chatter REST API の機能
アクションリンクの概要、認証、およびセキュリティ
Workflow
次のフィード項目には、[承認] および [却下] という 2 つのアクションリンクを含む 1 つのアクションリンクグ
ループがあります。
フィード要素を使用してアクションリンクを作成および投稿するワークフローは、次のとおりです。
1. (省略可能) アクションリンクテンプレートを作成します。
2. /connect/action-link-group-definitions に対して要求を実行して、アクションリンクグループを定義するか、テン
プレートからアクションリンクグループをインスタンス化します。アクションリンクグループには、少な
くとも 1 つのアクションリンクが含まれます。
3. /chatter/feed-elementsに対して要求を実行して、フィード要素を投稿し、アクションリンクを関連付けます。
アクションリンクテンプレート
[設定] でアクションリンクテンプレートを作成して、共通のプロパティを持つアクションリンクグループをイ
ンスタンス化します。テンプレートをパッケージ化して他の Salesforce 組織に配布できます。
テンプレートにバインド変数を指定し、そのアクションリンクグループをインスタンス化するときに変数の値
を設定します。たとえば、API バージョン番号、ユーザ ID、または OAuth トークンにバインド変数を使用しま
す。
テンプレートでコンテキスト変数を指定することもできます。ユーザがアクションリンクを実行すると、
Salesforce によってこれらの値 (どの組織でどのユーザがリンクを実行したかなど) が提供されます。
アクションリンクグループをインスタンス化するには、/connect/action-link-group-definitions リ
ソースへの要求を実行します。テンプレートで定義されたバインド変数のテンプレート ID と値を指定します。
「アクションリンクテンプレートの設計」を参照してください。
67
Chatter REST API の機能
アクションリンクの概要、認証、およびセキュリティ
アクションリンクの種別
アクションリンクを定義するときに、actionType プロパティでアクションリンクの種別を指定します。
アクションリンクには次の 4 つの種別があります。
• Api — アクションリンクは、アクション URL で同期 API をコールします。Salesforce は、サーバから返された
HTTP 状況コードに基づいて状況を SuccessfulStatus または FailedStatus に設定します。
• ApiAsync — アクションリンクは、アクション URL で非同期 API をコールします。アクションは、非同期操
作の完了時にサードパーティが /connect/action-links/actionLinkId への要求を行って状況を
SuccessfulStatus または FailedStatus に設定するまで、PendingStatus 状態のままになります。
• Download — アクションリンクは、アクション URL からファイルをダウンロードします。
• Ui — アクションリンクは、アクション URL で Web ページをユーザに表示します。
さまざまな種別のアクションリンクのさまざまなワークフローで、アクションリンクの状況 (Pending、
Successful、または Failed) が設定されます。詳細は、/connect/action-links/actionLinkIdを参照
してください。
認証
アクションリンクを定義するときは、URL (actionUrl) と、その URL に対して要求を行うために必要な HTTP
ヘッダー (headers) を指定します。
外部リソースに認証が必要な場合は、リソースで必要とするすべての場所に情報を含めます。
Salesforce リソースに認証が必要な場合は、HTTP ヘッダーに OAuth 情報を含めるか、URL にベアラートークンを
含めることができます。
Salesforce は自動的に次のリソースを認証します。
• テンプレート内の相対 URL
• アクションリンクグループが Apex からインスタンス化されるときの /services/apexrest で始まる相対
URL
機密情報を扱う操作にこれらのリソースを使用しないでください。
セキュリティ
HTTPS
アクションリンクのアクション URL は、https:// で始まるか、「認証」セクションのルールのいずれか
に一致する相対 URL である必要があります。
暗号化
API の詳細は、暗号化して保存され、クライアントには隠匿されます。
テンプレートからインスタンス化されていないアクションリンクの actionURL、headers、および
requestBody データは、組織の暗号化鍵で暗号化されます。アクションリンクテンプレートの [アクショ
ン URL]、[HTTP ヘッダー]、および [HTTP リクエストボディ] は暗号化されません。テンプレートから
アクションリンクグループをインスタンス化するときに使用されるバインド値は、組織の暗号化鍵で暗号
化されます。
68
Chatter REST API の機能
アクションリンクの概要、認証、およびセキュリティ
アクションリンクテンプレート
「アプリケーションのカスタマイズ」ユーザ権限を持つユーザのみが、[設定] でアクションリンクテンプ
レートの作成、編集、削除、およびパッケージ化を行うことができます。
テンプレートに機密情報を保存しないでください。バインド変数を使用して、アクションリンクグループ
をインスタンス化するときに機密情報を追加します。アクションリンクグループがインスタンス化される
と、値は暗号化された形式で保存されます。「バインド変数の定義」を参照してください。
接続アプリケーション
接続アプリケーションを使用してアクションリンクを作成する場合、常に制御可能なコンシューマキーの
ある接続アプリケーションを使用することをお勧めします。接続アプリケーションはサーバ間の通信に使
用され、逆コンパイル可能なモバイルアプリケーションに対してはコンパイルされません。
有効期限
アクションリンクグループを定義するときは、有効期限 (expirationDate) を指定します。この期限後は、
グループのアクションリンクを実行できなくなり、フィードから削除されます。アクションリンクグルー
プ定義に OAuth トークンが含まれる場合、そのグループの有効期限を OAuth トークンの有効期限と同じ値に
設定します。
アクションリンクテンプレートは、若干異なるユーザの除外メカニズムを使用します。「アクションリン
クグループの有効期限の設定」を参照してください。
ユーザの除外またはユーザの指定
Action Link Definition Input の excludeUserId プロパティは、アクションの実行から単一ユーザを除外する場
合に使用します。
Action Link Definition Input の userId プロパティは、アクションを実行できる唯一のユーザの ID を指定する場
合に使用します。userId プロパティを指定しない場合、または null を渡す場合は、すべてのユーザが
アクションを実行できます。アクションリンクに excludeUserId と userId 両方を指定することはでき
ません。
アクションリンクテンプレートは、若干異なるユーザの除外メカニズムを使用します。「アクションリン
クを表示できるユーザの設定」を参照してください。
アクションリンクグループ定義の参照、変更、または削除
アクションリンクとアクションリンクグループには、定義ビューとコンテキストユーザビューという 2 つ
のビューがあります。定義には、認証情報などの機密情報が含まれる可能性があります。コンテキストユー
ザビューは、表示オプションによって絞り込まれ、コンテキストユーザの状態が値に反映されます。
アクションリンクグループ定義には機密情報 (OAuth トークンなど) を含めることができます。そのため、定
義を参照、変更、または削除するには、ユーザがその定義を作成したか、「すべてのデータの参照」権限
を持っている必要があります。さらに、Chatter REST API では、定義を作成した接続アプリケーションから要
求を実行する必要があります。Apex では、定義を作成した名前空間からコールを行う必要があります。
コンテキスト変数
コンテキスト変数を使用して、アクションリンクを実行したユーザとアクションリンクが呼び出されたコンテ
キストに関する情報を、アクションリンクの呼び出しによって実行された HTTP 要求に渡すことができます。
コンテキスト変数は、Action Link Definition Input リクエストボディまたは
ConnectApi.ActionLinkDefinitionInput オブジェクトの actionUrl、headers、および requestBody
プロパティで使用できます。コンテキスト変数はまた、アクションリンクテンプレートの [アクション URL]、
69
Chatter REST API の機能
アクションリンクの概要、認証、およびセキュリティ
[HTTP リクエストボディ]、および [HTTP ヘッダー] 項目でも使用できます。テンプレートの公開後も、これ
らの項目は編集 (コンテキスト変数の追加と削除を含む) できます。
次のコンテキスト変数があります。
コンテキスト変数
説明
{!actionLinkId}
ユーザが実行したアクションリンクの ID。
{!actionLinkGroupId}
ユーザが実行したアクションリンクが含まれるアク
ションリンクグループの ID。
{!communityId}
ユーザがアクションリンクを実行したコミュニティの
ID。内部組織の場合、値は空のキー
"000000000000000000" になります。
{!communityUrl}
ユーザがアクションリンクを実行したコミュニティの
URL。内部組織の場合、値は空の文字列 "" になりま
す。
{!orgId}
ユーザがアクションリンクを実行した組織の ID。
{!userId}
アクションリンクを実行したユーザの ID。
バージョン設定
API のアップグレードや機能の変更による問題を避けるため、アクションリンクを定義するときにはバージョ
ン設定を使用することをお勧めします。たとえば、Action Link Definition Input の actionUrl プロパティは
https://www.example.com/api/v1/exampleResource のようになります。
テンプレートがパッケージで配布された後でも、テンプレートを使用して actionUrl、headers、または
requestBody プロパティの値を変更できます。たとえば、新しい入力が必要な新しい API バージョンをリリー
スする場合、システム管理者はアクションリンクテンプレートの入力を変更できます。すでにフィード要素に
関連付けられているアクションリンクでも新しい入力が使用されます。ただし、新しいバインド変数を公開済
みアクションリンクテンプレートに追加することはできません。
API がバージョン管理されていない場合、Action Link Group Definition Input の expirationDate プロパティを使用
して API のアップグレードや機能変更による問題を避けることができます。「アクションリンクグループの有
効期限の設定」を参照してください。
エラー
アクションリンクの診断情報リソース (/connect/action-links/actionLinkId/diagnostic-info) を使
用して、Api アクションリンクおよび AsyncApi アクションリンクを実行後の状況コードおよびエラーを返
します。診断情報は、アクションリンクにアクセスできるユーザに対してのみ提供されます。
70
Chatter REST API の機能
アクションリンクテンプレート
ローカライズされた表示ラベル
アクションリンクは、Action Link Definition Input リクエストボディの labelKey プロパティおよびアクションリ
ンクテンプレートの [表示ラベルキー] 項目に指定された、定義済みのローカライズされた表示ラベルセット
を使用します。
表示ラベルのリストについては、「アクションリンクの表示ラベル」を参照してください。
メモ: アクションリンクに適した表示ラベルキー値がない場合、アクションリンクテンプレートの [表示
ラベル] 項目にカスタムラベルを指定し、[表示ラベルキー] を [なし] に設定します。ただし、カスタム表
示ラベルはローカライズされません。
アクションリンクテンプレート
[設定] でアクションリンクテンプレートを作成し、Chatter REST API または Apex から共通のプロパティを持つア
クションリンクグループをインスタンス化できます。テンプレートをパッケージ化して他のSalesforce組織に配
布できます。
アクションリンクは、フィード要素上のボタンです。アクションリンクをクリックすると、ユーザを特定の
Web ページに移動したり、ファイルダウンロードを開始したり、Salesforce または外部サーバへの API コールを
呼び出したりできます。アクションリンクには、URL と HTTP メソッドが含まれ、リクエストボディとヘッダー
情報 (認証用の OAuth トークンなど) を含めることができます。アクションリンクを使用して Salesforce および
サードパーティサービスをフィードに統合することで、ユーザはアクションを実行して生産性を高め、イノ
ベーションを促進できます。
次の例では、[承認] と [却下] が架空の旅行 Web サイトの REST API への API コールを実行して旅程を承認または却
下するアクションリンクです。Pam が旅行 Web サイトに旅程を作成すると、旅行 Web サイトが Chatter REST API
要求を実行してアクションリンクを含むフィード項目を Pam のマネージャである Kevin に対して投稿し、Kevin
が旅程を承認または却下できるようにします。
71
Chatter REST API の機能
アクションリンクテンプレート
重要: アクションリンクは開発者機能です。アクションリンクテンプレートは [設定] で作成しますが、
Apex または Chatter REST API を使用してテンプレートからアクションリンクを生成し、そのリンクをフィー
ド要素に追加する必要があります。
このセクションの内容:
アクションリンクテンプレートの設計
テンプレートを作成する前に、テンプレートにどの値を設定し、テンプレートからアクションリンクグルー
プをインスタンス化するときにバインド変数にどの値を設定するかを検討します。
アクションリンクテンプレートの作成
[設定] でアクションリンクテンプレートを作成し、Chatter REST API または Apex から共通のプロパティを持つ
アクションリンクグループをインスタンス化できます。テンプレートをパッケージ化して他の Salesforce 組
織に配布できます。
アクションリンクテンプレートの編集
未公開のアクションリンクグループテンプレートおよび関連付けられているアクションリンクテンプレー
トのすべての項目を編集できます。
アクションリンクグループテンプレートの削除
アクションリンクグループテンプレートを削除すると、関連付けられているアクションリンクテンプレー
トと、そのテンプレートからインスタンス化されているすべてのアクションリンクグループが削除されま
す。削除されたアクションリンクグループは、関連付けられているすべてのフィード要素に表示されなく
なります。
アクションリンクテンプレートのパッケージ化
アクションリンクテンプレートをパッケージ化して他の Salesforce 組織に配布できます。
関連トピック:
テンプレートのアクションリンクを定義し、フィード要素を使用して投稿する
テンプレートのアクションリンクを定義し、フィード要素を使用して投稿する
アクションリンクテンプレートの設計
テンプレートを作成する前に、テンプレートにどの値を設定し、テンプレートからアクションリンクグループ
をインスタンス化するときにバインド変数にどの値を設定するかを検討します。
• アクションリンクテンプレートの概要
• テンプレート設計の考慮事項
• アクションリンクグループの有効期限の設定
• バインド変数の定義
• アクションリンクを表示できるユーザの設定
• コンテキスト変数の使用
72
Chatter REST API の機能
アクションリンクテンプレート
アクションリンクテンプレートの概要
[設定] に次のようなアクションリンクグループテンプレートが表示されます。
各アクションリンクグループに、少なくとも 1 つのアクションリンクが必要です。この例のアクションリンク
テンプレートには、[アクション URL] 項目に API バージョン番号、[HTTP リクエストボディ] 項目にアイテム
番号、[HTTP ヘッダー] 項目に OAuth トークン値の 3 つのバインド変数があります。
73
Chatter REST API の機能
アクションリンクテンプレート
アクションリンクグループをインスタンス化して、バインド変数の値を設定する Chatter REST API 要求は、次の
とおりです。
POST /connect/action-link-group-definitions
{
"templateId":"07gD00000004C9r",
"templateBindings":[
{
"key":"ApiVersion",
"value":"v1.0"
},
{
"key":"ItemNumber",
"value":"8675309"
},
{
"key":"BearerToken",
"value":"00DRR0000000N0g!ARoAQMZyQtsP1Gs27EZ8hl7vdpYXH5O5rv1VNprqTeD12xYnvygD3JgPnNR"
}
]
}
次は、テンプレートからアクションリンクグループをインスタンス化して、バインド変数の値を設定するApex
コードです。
// Get the action link group template Id.
ActionLinkGroupTemplate template = [SELECT Id FROM ActionLinkGroupTemplate WHERE
DeveloperName='Doc_Example'];
// Add binding name-value pairs to a map.
Map<String, String> bindingMap = new Map<String, String>();
74
Chatter REST API の機能
アクションリンクテンプレート
bindingMap.put('ApiVersion', '1.0');
bindingMap.put('ItemNumber', '8675309');
bindingMap.put('BearerToken',
'00DRR0000000N0g!ARoAQMZyQtsP1Gs27EZ8hl7vdpYXH5O5rv1VNprqTeD12xYnvygD3JgPnNR');
// Create ActionLinkTemplateBindingInput objects from the map elements.
List<ConnectApi.ActionLinkTemplateBindingInput> bindingInputs = new
List<ConnectApi.ActionLinkTemplateBindingInput>();
for (String key : bindingMap.keySet()) {
ConnectApi.ActionLinkTemplateBindingInput bindingInput = new
ConnectApi.ActionLinkTemplateBindingInput();
bindingInput.key = key;
bindingInput.value = bindingMap.get(key);
bindingInputs.add(bindingInput);
}
// Set the template Id and template binding values in the action link group definition.
ConnectApi.ActionLinkGroupDefinitionInput actionLinkGroupDefinitionInput = new
ConnectApi.ActionLinkGroupDefinitionInput();
actionLinkGroupDefinitionInput.templateId = template.id;
actionLinkGroupDefinitionInput.templateBindings = bindingInputs;
// Instantiate the action link group definition.
ConnectApi.ActionLinkGroupDefinition actionLinkGroupDefinition =
ConnectApi.ActionLinks.createActionLinkGroupDefinition(Network.getNetworkId(),
actionLinkGroupDefinitionInput);
テンプレート設計の考慮事項
テンプレートを設計するときは次の点を検討します。
• アクションリンクグループの有効期限を決定します。
75
Chatter REST API の機能
アクションリンクテンプレート
「アクションリンクグループの有効期限の設定」を参照してください。
• テンプレートにバインド変数を定義して、グループをインスタンス化するときの値を設定します。テンプ
レートに機密情報を保存しないでください。機密情報はバインド変数を使用して実行時に追加します。
「バインド変数の定義」を参照してください。
• アクションリンクがフィード要素に関連付けられているときに、アクションリンクを表示できるユーザを
決定します。
「アクションリンクを表示できるユーザの設定」を参照してください。
• アクションリンクの実行コンテキストに関する情報を取得するためには、テンプレートのコンテキスト変
数を使用します。
アクションリンクの実行時に、Salesforce が値を入力し、HTTP 要求で送信します。「コンテキスト変数の使
用 」を参照してください。
アクションリンクグループの有効期限の設定
テンプレートからアクションリンクグループを作成するときに、テンプレートに指定された期間に基づいて有
効期限を計算することも、アクションリンクグループに有効期限を設定しないことも可能です。
テンプレートに有効期限までの時間を設定するには、アクションリンクグループテンプレートの [有効期限ま
での時間] 項目に値を入力します。この値は、アクションリンクグループがインスタンス化されてから、関連
付けられたフィード要素から削除され実行できなくなるまでの時間数です。最大値は 8760 で、365 日に相当し
ます。
アクションリンクグループをインスタンス化するときに有効期限を設定するには、Action Link Group Definition リ
クエストボディ (Chatter REST API) または ConnectApi.ActionLinkGroupDefinition 入力クラス (Apex) のいず
れかの expirationDate プロパティを設定します。
有効期限のないアクションリンクグループを作成するには、テンプレートの [有効期限までの時間] 項目に値
を入力せず、アクションリンクグループをインスタンス化するときに expirationDate プロパティにも値を
入力しません。
テンプレートからアクションリンクグループを作成するときに、expirationDate と [有効期限までの時間]
は次のように連動します。
• expirationDate を指定すると、新しいアクションリンクグループでその値が使用されます。
• expirationDate を指定せず、テンプレートで [有効期限までの時間] を指定した場合は、新しいアクショ
ンリンクグループで [有効期限までの時間] の値が使用されます。
• expirationDate も [有効期限までの時間] も指定しない場合は、テンプレートからインスタンス化された
アクションリンクグループに有効期限が設定されません。
バインド変数の定義
テンプレートでバインド変数を定義し、アクションリンクグループをインスタンス化するときにその値を設定
します。
重要: テンプレートに機密情報を保存しないでください。機密情報はバインド変数を使用して実行時に追
加します。バインドの値が設定されている場合は、Salesforce に暗号化形式で保存されます。
76
Chatter REST API の機能
アクションリンクテンプレート
バインド変数は、アクションリンクテンプレートの [アクション URL]、[HTTP リクエストボディ]、および
[HTTP ヘッダー] 項目で定義できます。テンプレートを公開後、これらの項目を編集することや項目間でバ
インド変数を移動させること、バインド変数を削除することができます。ただし、新しいバインド変数を追加
することはできません。
テンプレートでバインド変数のキーを定義します。アクションリンクグループをインスタンス化するときに、
キーとその値を指定します。
バインド変数キーは {!Bindings.key} の形式です。
key は、事前に定義された \w 文字クラスの
[\p{Alpha}\p{gc=Mn}\p{gc=Me}\p{gc=Mc}\p{Digit}\p{gc=Pc}] で Unicode 文字をサポートします。
次の [アクション URL] 項目には 2 つのバインド変数があります。
https://www.example.com/{!Bindings.ApiVersion}/items/{!Bindings.ItemId}
次の [HTTP ヘッダー] 項目には 2 つのバインド変数があります。
Authorization: OAuth {!Bindings.OAuthToken}
Content-Type: {!Bindings.ContentType}
アクションリンクグループを Chatter REST API でインスタンス化するときにキーとその値を指定します。
POST /connect/action-link-group-definitions
{
"templateId":"07gD00000004C9r",
"templateBindings" : [
{
"key":"ApiVersion",
"value":"1.0"
},
{
"key":"ItemId",
"value":"8675309"
},
{
77
Chatter REST API の機能
アクションリンクテンプレート
"key":"OAuthToken",
"value":"00DRR0000000N0g_!..."
},
{
"key":"ContentType",
"value":"application/json"
}
]
}
Apex にバインド変数キーを指定して、その値を設定します。
Map<String, String> bindingMap = new Map<String, String>();
bindingMap.put('ApiVersion', '1.0');
bindingMap.put('ItemId', '8675309');
bindingMap.put('OAuthToken', '00DRR0000000N0g_!...');
bindingMap.put('ContentType', 'application/json');
List<ConnectApi.ActionLinkTemplateBindingInput> bindingInputs =
new List<ConnectApi.ActionLinkTemplateBindingInput>();
for (String key : bindingMap.keySet()) {
ConnectApi.ActionLinkTemplateBindingInput bindingInput = new
ConnectApi.ActionLinkTemplateBindingInput();
bindingInput.key = key;
bindingInput.value = bindingMap.get(key);
bindingInputs.add(bindingInput);
}
// Define the action link group definition.
78
Chatter REST API の機能
アクションリンクテンプレート
ConnectApi.ActionLinkGroupDefinitionInput actionLinkGroupDefinitionInput =
new ConnectApi.ActionLinkGroupDefinitionInput();
actionLinkGroupDefinitionInput.templateId = '07gD00000004C9r';
actionLinkGroupDefinitionInput.templateBindings = bindingInputs;
// Instantiate the action link group definition.
ConnectApi.ActionLinkGroupDefinition actionLinkGroupDefinition =
ConnectApi.ActionLinks.createActionLinkGroupDefinition(Network.getNetworkId(),
actionLinkGroupDefinitionInput);
ヒント: アクションリンクテンプレートでは同じバインド変数を複数回使用でき、インスタンス化のとき
に値を 1 回だけ指定します。たとえば、あるアクションリンクテンプレートの [HTTP リクエストボディ]
項目で {!Bindings.MyBinding} を 2 回使用し、同じアクションリンクグループテンプレート内の別の
アクションリンクテンプレートの [HTTP ヘッダー] 項目でもう一回使用することができますが、この場
合、テンプレートからアクションリンクグループをインスタンス化するときにこの共有変数の値を 1 回の
み指定します。
アクションリンクを表示できるユーザの設定
[ユーザ表示設定] ドロップダウンリストから値を選択して、アクションリンクがフィード要素に関連付けられ
た後にそのアクションリンクを表示できるユーザを決定します。
使用可能なオプションに [カスタムユーザのみに表示] と [カスタムユーザ以外の全員に表示] があります。この
いずれかの値を選択して、アクションリンクを特定のユーザのみが表示できるようにするか、特定のユーザが
表示できないようにします。次に、[カスタムユーザ(別名)] 項目に値を入力します。この値はバインド変数
キーです。アクションリンクグループをインスタンス化するコードで、キーを使用して、バインド変数の場合
と同じように値を指定します。
次のテンプレートは、[カスタムユーザ(別名)] の値に Invitee を使用します。
79
Chatter REST API の機能
アクションリンクテンプレート
アクションリンクグループをインスタンス化するときに、バインド変数を設定する場合と同じように値を設定
します。
POST /connect/action-link-group-definitions
{
"templateId":"07gD00000004C9r",
"templateBindings" : [
{
"key":"Invitee",
"value":"005D00000017u6x"
80
Chatter REST API の機能
アクションリンクテンプレート
}
]
}
テンプレートで[作成者のマネージャのみに表示]を使用する場合にユーザにマネージャがいなければ、テンプ
レートからアクションリンクグループをインスタンス化するときにエラーが表示されます。この場合のマネー
ジャは、インスタンス化の時点のマネージャです。インスタンス化した後にユーザのマネージャを変更した場
合、この変更は反映されません。
コンテキスト変数の使用
コンテキスト変数を使用して、アクションリンクを実行したユーザとアクションリンクが呼び出されたコンテ
キストに関する情報を、アクションリンクの呼び出しによって実行された HTTP 要求に渡すことができます。
コンテキスト変数は、Action Link Definition Input リクエストボディまたは
ConnectApi.ActionLinkDefinitionInput オブジェクトの actionUrl、headers、および requestBody
プロパティで使用できます。コンテキスト変数はまた、アクションリンクテンプレートの [アクション URL]、
[HTTP リクエストボディ]、および [HTTP ヘッダー] 項目でも使用できます。テンプレートの公開後も、これ
らの項目は編集 (コンテキスト変数の追加と削除を含む) できます。
使用可能なコンテキスト変数は次のとおりです。
コンテキスト変数
説明
{!actionLinkId}
ユーザが実行したアクションリンクの ID。
{!actionLinkGroupId}
ユーザが実行したアクションリンクが含まれるアク
ションリンクグループの ID。
{!communityId}
ユーザがアクションリンクを実行したコミュニティの
ID。内部組織の場合、値は空のキー
"000000000000000000" になります。
{!communityUrl}
ユーザがアクションリンクを実行したコミュニティの
URL。内部組織の場合、値は空の文字列 "" になりま
す。
{!orgId}
ユーザがアクションリンクを実行した組織の ID。
{!userId}
アクションリンクを実行したユーザの ID。
たとえば、Survey Example という会社に勤務していて、「Survey Example for Salesforce」というアプリケーション
を Salesforce AppExchange 用に作成したとします。会社 A には「Survey Example for Salesforce」がインストールさ
れています。会社 A の誰かが surveyexample.com にアクセスしてアンケートを作成します。Survey Example
のコードは、Chatter REST API を使用して、会社 A の Salesforce 組織に本文テキスト [調査を実行] と、表示ラベル
[OK] のアクションリンクを含むフィード項目を作成します。
81
Chatter REST API の機能
アクションリンクテンプレート
この UI アクションリンクをクリックすると、ユーザがSalesforceからアンケートに回答する surveyexample.com
の Web ページに移動します。
そのアクションリンクの [HTTP リクエストボディ] または [アクション URL] に {!userId} コンテキスト変
数が含まれる場合、ユーザがフィードのアクションリンクをクリックすると、Salesforceはクリックしたユーザ
の ID を、作成した HTTP 要求に含めてサーバに送信します。
アクションリンクを作成する Survey Example のサーバ側コードに {!actionLinkId} コンテキスト変数が含ま
れる場合は、Salesforce がアクションリンクの ID を含む HTTP 要求を送信するため、この ID をデータベースに保
存できます。
次の例では、アクションリンクテンプレートの [アクション URL] に {!userId} コンテキスト変数が含まれ
ます。
ヒント: バインド変数とコンテキスト変数は同じ項目で使用できます。たとえば、アクション URL
https://www.example.com/{!Bindings.apiVersion}/doSurvey?salesforceUserId={!userId}
にはバインド変数とコンテキスト変数が含まれています。
82
Chatter REST API の機能
アクションリンクテンプレート
アクションリンクテンプレートの作成
[設定] でアクションリンクテンプレートを作成し、Chatter REST API または Apex か
ら共通のプロパティを持つアクションリンクグループをインスタンス化できま
す。テンプレートをパッケージ化して他の Salesforce 組織に配布できます。
メモ: アクションリンクテンプレートは、[設定] から作成するだけでなく、
メタデータ API、SOAP API、および REST API を使用して作成することもできま
す。
[アクション URL]、[HTTP リクエストボディ]、および [HTTP ヘッダー] 項目
はバインド変数とコンテキスト変数をサポートします。テンプレートにバイン
ド変数を定義し、アクションリンクグループをインスタンス化するときにその
値を設定します。テンプレートでコンテキスト変数が使用されている場合、ア
クションリンクが実行されると Salesforce が値を入力して要求で返します。テン
プレートでこれらの変数を使用する方法についての詳細は、「アクションリン
クテンプレートの設計」を参照してください。
1. [設定] で、[作成] > [アクションリンクテンプレート] をクリックします。
2. [新規] をクリックします。
エディション
使用可能なエディション:
Personal Edition を除くす
べてのエディション。
ユーザ権限
アクションリンクグルー
プテンプレートを作成す
る
• 「アプリケーションの
カスタマイズ」
アクションリンクテンプ
レートを作成する
• 「アプリケーションの
カスタマイズ」
3. テンプレートの [名前] を入力します。この名前が、アクションリンクグルー
プテンプレートのリストに表示されます。
これがアクションリンクグループテンプレートの公開後に編集可能な唯一のアクションリンクグループテ
ンプレート値です。
4. [API 参照名] を入力します。コードからこのテンプレートを参照するには、開発者名を使用します。[API
参照名] はデフォルトの空白を除いた名前になります。文字、数字、アンダースコア文字のみを使用でき
ます。
5. [カテゴリ] を選択します。これは、インスタンス化したアクションリンクグループをフィード要素上のど
こに表示するかを示します。[プライマリ] を選択すると、アクションリンクグループはフィード要素の本
文に表示されます。[オーバーフロー] を選択すると、アクションリンクグループはフィード要素のオーバー
フローメニューに表示されます。
アクションリンクグループテンプレートが [プライマリ] の場合、最大 3 個のアクションリンクテンプレー
トを含めることができます。アクションリンクグループテンプレートが [オーバーフロー] の場合、最大 4
個のアクションリンクテンプレートを含めることができます。
6. [実行可] の数を選択します。これは、このテンプレートからインスタンス化されたアクションリンクグ
ループを何回実行できるかを示します (1 つのグループ内に同じアクションリンクを含めることはできませ
ん)。Unlimited を選択すると、グループ内のアクションリンクを種別 Api または ApiAsync にすることはで
きません。
7. (省略可能) [有効期限までの時間] を入力します。これは、アクションリンクグループを作成してから、ア
クションリンクグループが関連するフィード要素から削除され実行できなくなるまでの時間数です。最大
値は、8760 です。
「アクションリンクグループの有効期限の設定」を参照してください。
8. [保存] をクリックします。
83
Chatter REST API の機能
アクションリンクテンプレート
9. [新規] をクリックしてアクションリンクテンプレートを作成します。
アクションリンクテンプレートは、自動的に主従関係でアクションリンクグループテンプレートに関連付
けられます。
10. [アクション種別] をクリックします。
値は次のとおりです。
• Api — アクションリンクは、アクション URL で同期 API をコールします。Salesforce は、サーバから返さ
れた HTTP 状況コードに基づいて状況を SuccessfulStatus または FailedStatus に設定します。
• ApiAsync — アクションリンクは、アクション URL で非同期 API をコールします。アクションは、非同
期操作の完了時にサードパーティが /connect/action-links/actionLinkId への要求を行って状況
を SuccessfulStatus または FailedStatus に設定するまで、PendingStatus 状態のままになりま
す。
• Download — アクションリンクは、アクション URL からファイルをダウンロードします。
• Ui — アクションリンクは、アクション URL で Web ページをユーザに表示します。
11. [アクション URL] を入力します。これはアクションリンクの URL です。
UI アクションリンクの場合、URL は Web ページになります。Download アクションリンクの場合、URL は、
ダウンロードするファイルへのリンクになります。Api アクションリンクまたは ApiAsync アクションリ
ンクの場合、URL は REST リソースになります。
Salesforce サーバでホストされるリソースへのリンクは、 / で開始する相対リンクにすることができます。
他のすべてのリンクは、https:// で始まる絶対リンクにする必要があります。この項目には、バインド
変数を {!Bindings.key} 形式で含めることができます
(https://www.example.com/{!Bindings.itemId} など)。バインド変数の値は、テンプレートからア
クションリンクグループをインスタンス化するときに設定します。たとえば、次の Chatter REST API の例で
は、itemId の値が 8675309 に設定されます。
POST /connect/action-link-group-definitions
{
"templateId" : "07gD00000004C9r",
"templateBindings" : [
{
"key":"itemId",
"value": "8675309"
}
]
84
Chatter REST API の機能
アクションリンクテンプレート
}
この項目には、コンテキスト変数を含めることもできます。コンテキスト変数を使用して、アクションリ
ンクを実行したユーザに関する情報をサーバ側のコードに渡すことができます。たとえば、次のアクショ
ンリンクは、アンケートに回答するためにアクションリンクをクリックしたユーザの ID を、アンケートを
ホストするサーバに渡します。
actionUrl=https://example.com/doSurvey?surveyId=1234&salesforceUserId={!userId}
12. HTTP 要求の実行に使用する [HTTP メソッド] を入力します。
13. (省略可能) [アクション種別] が Api または ApiAsync の場合、[HTTP リクエストボディ] を入力します。
この項目には、バインド変数とコンテキスト変数を含めることができます。
14. (省略可能) [アクション種別] が Api または ApiAsync の場合、[HTTP ヘッダー] を入力します。
この項目には、バインド変数とコンテキスト変数を含めることができます。
テンプレートからインスタンス化されたアクションリンクが Salesforce リソースへの要求を実行する場合、
テンプレートには Content-Type ヘッダーが必要です。
15. (省略可能) このアクションリンクをグループのデフォルトリンク (UI で特殊な形式を使用) にするには、[グ
ループ内のデフォルトリンク] を選択します。各グループに含めることができるデフォルトリンクは 1 つの
みです。
16. (省略可能) アクションリンクが実行される前にユーザに確認ダイアログを表示するには、[要確認] を選択
します。
17. このテンプレートからインスタンス化されたアクションリンクグループ内のアクションリンクの相対 [位
置] を入力します。最初の位置は 0 です。
18. [表示ラベルキー] を入力します。この値は、状況 NewStatus、PendingStatus、SuccessfulStatus、FailedStatus に対
して表示される UI 表示ラベルセットのキーです。
たとえば、[投稿] セットには、[投稿]、[投稿待機中]、[投稿済み]、[投稿失敗] の表示ラベルが含まれます。
次の画像は、状況の値が SuccessfulStatus のときの [投稿] 表示ラベルキーを持つアクションリンクを示しま
す。
85
Chatter REST API の機能
アクションリンクテンプレート
19. (省略可能) アクションリンクに適した [表示ラベルキー] 値がない場合、[表示ラベルキー] を [なし] に設定
して、[表示ラベル] 項目に値を入力します。
アクションリンクには、NewStatus、PendingStatus、SuccessStatus、FailedStatus の 4 つの状況があります。次の
文字列が、各状況の表示ラベルに追加されます。
• 表示ラベル
• 表示ラベル待機中
• 表示ラベル成功
• 表示ラベル失敗
たとえば、label の値が「See Example」の場合、4 つのアクションリンクの状態の値は「See Example」、
「See Example 待機中」、「See Example 成功」、および「See Example 失敗」になります。
アクションリンクでは、表示ラベル名の生成に LabelKey または Label を使用できますが、両方は使用
できません。
20. [ユーザ表示設定] を選択します。これはアクションリンクグループを表示できるユーザを示します。
[作成者のマネージャのみに表示] を選択した場合、マネージャはアクションリンクグループがインスタン
ス化されたときの作成者のマネージャになります。アクションリンクグループがインスタンス化された後
に作成者のマネージャが変わった場合、変更は反映されません。
21. (省略可能) [カスタムユーザのみに表示] または [カスタムユーザ以外の全員に表示] を選択した場合は、[カ
スタムユーザ(別名)] を入力します。
バインド変数の値を設定する場合と同様に、文字列を入力し、アクションリンクグループをインスタンス
化するときにその値を設定します。ただし、テンプレートではバインド変数の構文は使用せずに、値のみ
86
Chatter REST API の機能
アクションリンクテンプレート
を入力してください。たとえば、ExpenseApprover などと入力します。次の Chatter REST API の例では、
ExpenseApprover の値を 005B0000000Ge16 に設定します。
POST /connect/action-link-group-definitions
{
"templateId" : "07gD00000004C9r",
"templateBindings" : [
{
"key":"ExpenseApprover",
"value": "005B0000000Ge16"
}
]
}
22. このアクションリンクグループテンプレートに別のアクションリンクテンプレートを作成するには、[保存
& 新規] をクリックします。
23. このアクションリンクグループテンプレートへのアクションリンクテンプレートの追加が完了したら、[保
存] をクリックします。
24. アクションリンクグループテンプレートを公開するには、[最後に開いたビューへ] をクリックして [アク
ションリンクグループテンプレート] リストビューに戻ります。
重要: Apex または Chatter REST API でアクションリンクグループをテンプレートからインスタンス化する
には、事前にテンプレートを公開する必要があります。
25. 公開するアクションリンクグループテンプレートの [編集] をクリックします。
26. [公開済み] を選択して、[保存] をクリックします。
87
Chatter REST API の機能
アクションリンクテンプレート
アクションリンクテンプレートの編集
未公開のアクションリンクグループテンプレートおよび関連付けられているア
クションリンクテンプレートのすべての項目を編集できます。
エディション
1. [設定] で、[作成] > [アクションリンクテンプレート] をクリックします。
使用可能なエディション:
Personal Edition を除くす
べてのエディション。
2. アクションリンクグループテンプレートを編集するには、名前の横にある
[編集] をクリックします。
グループテンプレートが公開されていない場合は、任意の項目を編集しま
す。公開されている場合は、[名前] 項目のみを編集します。
3. アクションリンクテンプレートを編集する手順は次のとおりです。
a. 主アクションリンクグループテンプレートの名前をクリックします。
b. アクションリンクテンプレート ID をクリックして、アクションリンクテ
ンプレートの詳細ページを表示します。
c. [編集] をクリックします。
関連付けられているアクションリンクグループテンプレートが公開され
ていない場合は、任意の項目を編集します。公開されている場合は、次
のいずれかの項目を編集します。
ユーザ権限
アクションリンクグルー
プテンプレートを編集す
る
• 「アプリケーションの
カスタマイズ」
アクションリンクテンプ
レートを編集する
• 「アプリケーションの
カスタマイズ」
• アクション URL
• HTTP リクエストボディ
• HTTP ヘッダー
上記の項目は、コンテキスト変数およびバインド変数をサポートします。
これらのいずれかの項目のコンテキスト変数を追加および削除できます。
新しいバインド変数を追加することはできません。可能な操作は次のとおりです。
• バインド変数をアクションリンクテンプレートの別の編集可能項目に移動する。
• アクションリンクテンプレートでバインド変数を複数回使用する。
• 同じアクションリンクグループテンプレートに関連付けられている任意のアクションリンクテンプ
レートでバインド変数を複数回使用する。
• バインド変数を削除する。
88
Chatter REST API の機能
アクションリンクテンプレート
アクションリンクグループテンプレートの削除
アクションリンクグループテンプレートを削除すると、関連付けられているア
クションリンクテンプレートと、そのテンプレートからインスタンス化されて
いるすべてのアクションリンクグループが削除されます。削除されたアクショ
ンリンクグループは、関連付けられているすべてのフィード要素に表示されな
くなります。
エディション
使用可能なエディション:
Personal Edition を除くす
べてのエディション。
1. [設定] で、[作成] > [アクションリンクテンプレート] をクリックします。
2. アクションリンクグループテンプレートを削除するには、名前の横にある
[削除] をクリックします。
重要: アクションリンクグループテンプレートを削除すると、関連付け
られているアクションリンクテンプレートと、そのテンプレートからイ
ンスタンス化されているすべてのアクションリンクグループが削除され
ます。アクションリンクグループは、関連付けられているすべてのフィー
ド要素から削除されます。つまり、アクションリンクはフィードの投稿
に表示されなくなります。
3. アクションリンクテンプレートを削除する手順は、次のとおりです。
ユーザ権限
アクションリンクグルー
プテンプレートを削除す
る
• 「アプリケーションの
カスタマイズ」
アクションリンクテンプ
レートを削除する
• 「アプリケーションの
カスタマイズ」
a. 主アクションリンクグループテンプレートの名前をクリックします。
b. アクションリンクテンプレート ID をクリックして、アクションリンクテンプレートの詳細ページを表示
します。
c. [削除] をクリックします。
重要: 公開されているアクションリンクグループテンプレートに関連付けられているアクションリン
クテンプレートは削除できません。
アクションリンクテンプレートのパッケージ化
アクションリンクテンプレートをパッケージ化して他の Salesforce 組織に配布で
きます。
エディション
アクションリンクグループテンプレートを追加すると、関連付けられているア
クションリンクテンプレートもパッケージに追加されます。アクションリンク
グループテンプレートは、未管理パッケージまたは管理パッケージに追加でき
ます。アクションリンクグループテンプレートは、パッケージ化できるコンポー
ネントとして管理パッケージのすべての機能 (AppExchangeのリスト、転送アップ
グレード、インストール後 Apex スクリプト、ライセンス管理、高度な登録者サ
ポートなど) も活用できます。管理パッケージを作成するには、Developer Edition
組織を使用する必要があります。
使用可能なエディション:
Personal Edition を除くす
べてのエディション。
• 「パッケージの作成および編集」(https://help.salesforce.com) を参照してくださ
い。
89
ユーザ権限
アクションリンクテンプ
レートをパッケージ化す
る
• 「AppExchange パッ
ケージの作成」
Chatter REST API の機能
コミュニティの使用
コミュニティの使用
コミュニティは、従業員、お客様、およびパートナーが接続するブランド空間です。ビジネスニーズに合わせ
てコミュニティをカスタマイズしながら作成することができ、その後もコミュニティ間をシームレスに移行で
きます。
特定のコミュニティでは、ほとんどのChatter REST APIリソースを要求できます。たとえば、特定のコミュニティ
内で、Feeds、Files、Groups、Topics、Users リソースに対して要求を実行できます。コミュニティでリソースを使
用できる場合、そのドキュメントには /connect/communities/communityId で始まるリソースが含まれま
す。
一部の Chatter REST API リソースは、コミュニティ内でのみ使用できます。これには、コンテンツのフラグ設定
とモデレート、管理トピックの使用、ユーザの評価に関する情報の取得を行うためのリソースが含まれます。
コミュニティで使用できるリソースは、ログインなしでのアクセスを許可するかどうかに関係なく使用できま
す。ただし、コミュニティでログインなしでのアクセスが許可されている場合、ゲストユーザはどの Chatter
REST API リソースにもアクセスできません。
次の表に、コミュニティ内でのみ使用できるリソースを示します。
リソース
HTTP メソッド ToDo
/connect/communities
GET
コンテキストユーザが使用できるすべてのコ
ミュニティリストを返します。
/connect/communities/communityId
GET
指定されたコミュニティに関する情報を返し
ます。
/connect/communities/communityId/
chatter/comments/commentId/
moderation-flags
GET、POST、
DELETE
コンテキストユーザがコミュニティモデレー
タの場合、コミュニティメンバーが 1 つのコメ
ントにフラグを設定した回数を返します。ま
た、モデレーションのためにコメントにフラ
グを設定したり、コメントのすべてのフラグ
を削除したりします。
コンテキストユーザがコミュニティモデレー
タでない場合は、ユーザがコメントにフラグ
を設定したかどうかを返します。また、モデ
レーションのためにコメントにフラグを設定
したり、ユーザが以前に追加したフラグを削
除したりします。
/connect/communities/communityId/
GET、POST、
chatter/feed-elements/feedElementId/ DELETE
capabilities/moderation
90
フィード要素のモデレーション機能に関する
情報の取得、フィード要素へのモデレーショ
ンフラグの追加、またはフィード要素のすべ
てのモデレーションフラグの削除を行います。
Chatter REST API の機能
コミュニティの使用
リソース
HTTP メソッド ToDo
/connect/communities/communityId/
chatter/files/moderation
GET
コンテキストユーザがコミュニティモデレー
タの場合、コミュニティメンバーによってフ
ラグが設定されたファイルを返します。
/connect/communities/communityId/
GET、POST、
chatter/files/fileId/moderation-flags DELETE
コンテキストユーザがコミュニティモデレー
タの場合、コミュニティメンバーが 1 つのファ
イルにフラグを設定した回数を返します。ま
た、モデレーションのためにファイルにフラ
グを設定したり、ファイルのすべてのフラグ
を削除したりします。
コンテキストユーザがコミュニティモデレー
タでない場合は、ユーザがファイルにフラグ
を設定したかどうかを返します。また、モデ
レーションのためにファイルにフラグを設定
したり、ユーザが以前に追加したフラグを削
除したりします。
/connect/communities/communityId/
GET
chatter/feeds/moderation/feed-elements
コンテキストユーザが「コミュニティフィー
ドのモデレート」権限を持つコミュニティモ
デレータの場合、コミュニティメンバーによっ
てフラグが設定された、コミュニティ内のす
べてのフィード要素とコメントのリストを返
します。デフォルトでは、結果ページごとに
25 件のフィード要素を返します。
/connect/communities/communityId/
chatter/feeds/home/feed-elements
GET
コミュニティの管理トピックに関連付けられ
たすべてのフィード要素のリストを返します。
/connect/communities/communityId/
managed-topics
GET、POST、
PATCH
コミュニティのすべての管理トピックを取得
します。管理トピックを作成します。管理ト
ピックを並び替えます。
/connect/communities/communityId/
managed-topics/managedTopicId
GET、DELETE
コミュニティの管理トピックの情報取得また
は削除を行います。
/connect/communities/communityId/
chatter/users/userId/reputation
GET
指定されたコミュニティユーザの評価を返し
ます。
関連トピック:
Chatter REST API リソース URL の作成
コミュニティで要求を実行する
91
Chatter REST API の機能
フィードおよびフィード要素の使用
フィードおよびフィード要素の使用
API バージョン 30.0 以前では、Chatter フィードはフィード項目のコンテナでした。API バージョン 31.0 では、
フィードの定義が拡張され、フィード項目モデルに完全には適合しない新しいオブジェクトが追加されまし
た。Chatter フィードは、フィード要素のコンテナになりました。API バージョン 32.0 では、フィード要素は
フィード項目または汎用フィード要素のどちらにすることもできます。フィードとフィード要素はChatterの中
核部分であるため、Chatter REST APIを使用してアプリケーションを開発するには、これらの理解が不可欠です。
メモ: Salesforce ヘルプでは、フィード項目を投稿といいます。
機能
フィードを多様化する取り組みの一環として、フィード要素の持つさまざまな機能性を個々の機能に分割しま
した。機能では、一貫した方法でフィードのオブジェクトを操作できます。フィード要素で使用できる機能を
判別するためにフィード要素種別を調べないでください。使用可能な機能を明示的に示す機能オブジェクトを
調べてください。機能が存在するかどうかを確認することで、フィード要素に対してクライアントが実行でき
る操作を判別します。
すべてのフィード要素に capabilities プロパティがあり、このプロパティに Feed Element Capabilities レスポ
ンスボディが保持されています。Feed Element Capabilities レスポンスボディには 1 つ以上のプロパティがあり、
それぞれのプロパティにフィード要素の機能が保持されています。
機能には、ある操作が可能であることを示す情報と、その操作に関連付けられたデータが含まれます。フィー
ド要素に機能が存在する場合、機能に関連付けられたデータがまだなくてもその機能を使用できます。たとえ
ば、chatterLikes 機能プロパティがフィード要素に存在する場合 (chatterLikes.page.items プロパティ
内のいいね! リストにいいね! が含まれているかどうかに関係なく)、コンテキストユーザはそのフィード要素に
いいね! と言うことができます。その機能プロパティがフィード要素に存在しない場合、そのフィード要素に
いいね! と言うことはできません。
Salesforce UI でのフィード項目の表示
「機能」で学んだように、クライアントは capabilities プロパティを使用して、フィード要素で可能な操
作やフィード要素を表示する方法を判別します。フィード項目以外のすべてのフィード要素では、クライアン
トはフィード要素の種別を知る必要はなく、機能を確認できます。フィード項目には機能がありますが、actor
などのプロパティもいくつかあり、これらは機能として公開されていません。このため、フィード項目はフィー
ド要素とは異なる方法で処理する必要があります。
一貫したフィード項目のビューを顧客に提供し、容易に UI を作成する手段を開発者に提供するために、Salesforce
UI では、1 つのレイアウトを使用して各フィード項目を表示しています。このレイアウトには常に同じ要素が
含まれ、要素は常に同じ位置にあります。変化するのはレイアウト要素のコンテンツのみです。
92
Chatter REST API の機能
フィードおよびフィード要素の使用
次のフィード項目レイアウト要素があります。
1. アクター (Feed Item レスポンスボディの actor プロパティ) — フィード項目の作成者の写真またはアイコン
2. ヘッダー (Feed Item レスポンスボディの header プロパティ) — コンテキストを提供します。同じフィード
項目に、誰がどこに投稿したかに応じて異なるヘッダーを設定できます。たとえば、Gordon がこのフィー
ド項目を自分のプロファイルに投稿したとします。そのフィード項目をグループと共有すると、グループ
フィードのフィード項目のヘッダーは「Gordon Johnson (元の投稿者: Gordon Johnson)」となります。「元の投
稿者」テキストが Gordon のプロファイルのフィード項目へのリンクになります。
3. 内容 (Feed Item レスポンスボディの body プロパティ) — すべてのフィード項目には内容がありますが、ユー
ザがフィード項目のテキストを指定しない場合は、内容が null になることがあります。内容は null に
なる可能性があるため、テキスト表示のデフォルトケースとして使用できません。代わりに、常に値が含
まれる、フィード項目のヘッダーの text プロパティを使用します。
4. 補助内容 (Feed Item レスポンスボディの capabilities プロパティ) — フィード項目の機能の視覚化。「機
能」を参照してください。
重要: attachment プロパティは、API バージョン 32.0 以降でサポートされていません。代わりに、Feed
Element Capabilities レスポンスボディを保持する capabilities プロパティを使用して、フィード要素
に表示する内容を確認します。
5. 作成者タイムスタンプ (Feed Item レスポンスボディの relativeCreatedDate プロパティ) — フィード項目
が投稿された日時。フィード項目の作成後 2 日を経過していない場合、日時は相対的なローカライズされ
た文字列として書式設定されます (「17 分前」、「昨日」など)。それ以外の場合は、日時は絶対的なロー
カライズされた文字列として書式設定されます。
Salesforce UI でのバンドルの表示
メモ: バンドル投稿にはフィード追跡変更が含まれます。Salesforce1 ダウンロード可能アプリケーション
では、バンドル投稿がレコードフィードのみにあります。
「機能」セクションで学んだように、クライアントは ConnectApi.FeedElement.capabilities プロパティ
を使用して、フィード要素で可能な操作やフィード要素を表示する方法を判別する必要があります。このセク
ションでは、フィード要素の表示方法の一例としてバンドルを使用しますが、これらのプロパティはどのフィー
ド要素でも使用できます。
93
Chatter REST API の機能
フィードおよびフィード要素の使用
きれいに整理されたフィードをユーザに提供するために、フィード変更追跡のフィード項目はバンドルに集約
できます。個々のフィード項目を表示するには、バンドルをクリックします。
バンドルは、バンドル機能を備えた汎用フィード要素です。次のバンドルレイアウト要素があります。
1. ヘッダー (Generic Feed Element レスポンスボディの header プロパティ) — フィード変更追跡バンドルの場
合、このテキストは「このレコードは更新されました。」です。
ヘッダーの下にある時間は、Generic Feed Element レスポンスボディの relativeCreatedDate プロパティ
です。
2. 補助内容 (Generic Feed Element レスポンスボディの capabilities.bundle.changes プロパティ) — バンド
ルは、バンドル内の最初の 2 つのフィード変更追跡について fieldName、oldValue、および newValue
プロパティを表示します。フィード変更追跡が 3 つ以上ある場合は、バンドルが [すべての更新を表示] リ
ンクを表示します。
フィード要素の表示
ユーザに表示されるフィード要素は、システム管理者によるフィード追跡、共有ルール、および項目レベルセ
キュリティの設定に応じて異なります。たとえば、ユーザにレコードへのアクセス権がない場合、そのレコー
ドの更新は表示されません。フィード要素の親を表示できるユーザは、そのフィード要素を表示できます。通
常、ユーザには次のフィード更新が表示されます。
• ユーザに @メンションしているフィード要素 (ユーザがそのフィード要素の親にアクセスできる場合)
• ユーザがメンバーであるグループに @メンションしているフィード要素
• ユーザが親レコードを表示できるレコードに対するレコード項目の変更 (User、Group、および File レコード
を含む)
• ユーザに投稿されたフィード要素
• ユーザが所有するか、ユーザがメンバーであるグループに投稿されたフィード要素
94
Chatter REST API の機能
フィードおよびフィード要素の使用
• 標準およびカスタムレコードのフィード要素 (ToDo、行動、リード、取引先、ファイルなど)
フィード種別
フィードには多くの種別があります。各フィード種別は、フィード要素のコレクションを定義するアルゴリズ
ムです。
重要: このアルゴリズム、つまりフィード要素のコレクションは、リリースが変わると変更される可能性
があります。
フィード種別はリソースで次のように公開されます。
/chatter/feeds/feedType
/chatter/feeds/feedType/subjectId
たとえば、次のリソースは、ニュースフィードとトピックフィードのリソースです。
/chatter/feeds/news/subjectId
/chatter/feeds/topics/subjectId
各フィード種別とその説明は、次のとおりです。
• Bookmarks — コンテキストユーザがブックマークとして保存したすべてのフィード項目が含まれます。
• Company — 種別 TrackedChange のフィード項目を除くすべてのフィード項目が含まれます。ユーザが
フィード項目を表示するには、親への共有アクセス権が必要です。
• Files — コンテキストユーザがフォローしている人またはグループによって投稿されたファイルを含むす
べてのフィード項目が含まれます。
• Filter — 指定したオブジェクト種別の親を持つフィード項目を含むように絞り込まれたニュースフィー
ドが含まれます。
• Groups — コンテキストユーザが所有するか、メンバーであるすべてのグループのすべてのフィード項目
が含まれます。
• Home — コミュニティの管理トピックに関連付けられたすべてのフィード項目が含まれます。
• Moderation — モデレーション用にフラグが設定されたすべてのフィード項目が含まれます。このコミュ
ニティモデレーションフィードは、「コミュニティフィードのモデレート」権限を持つユーザのみが使用
できます。
• News — コンテキストユーザがフォローする人、ユーザがメンバーとなっているグループ、およびユーザ
がフォローするファイルとレコードからのすべての更新が含まれます。また、親がコンテキストユーザで
あるレコード、およびコンテキストユーザをメンションするかコンテキストユーザがメンバーとなってい
るグループをメンションするすべてのフィード項目とコメントのすべての更新も含まれます。
• People — コンテキストユーザがフォローしているすべての人によって投稿されたすべてのフィード項目
が含まれます。
• Record — 親が指定したレコードであるすべてのフィード項目が含まれます。レコードは、グループ、ユー
ザ、オブジェクト、ファイル、その他の標準またはカスタムオブジェクトの場合があります。レコードが
95
Chatter REST API の機能
フィードおよびフィード要素の使用
グループの場合、フィードにはそのグループにメンションしているフィード項目も含まれます。レコード
がユーザの場合、フィードにはそのユーザに対するフィード項目のみが含まれます。
• To — コンテキストユーザのメンションを含むすべてのフィード項目、コンテキストユーザがコメントし
たフィード項目、コンテキストユーザが作成し、コメントされたフィード項目が含まれます。
• Topics — 指定したトピックを含むすべてのフィード項目が含まれます。
• UserProfile — フィードで追跡可能なレコードをユーザが変更したときに作成されたフィード項目、親
がユーザであるフィード項目、およびユーザに @メンションしているフィード項目が含まれます。この
フィードは、グループ更新など、より多くのフィード項目を返すニュースフィードとは異なります。
• Favorites — コンテキストユーザが保存したお気に入りが含まれます。お気に入りには、フィード検索、
リストビュー、およびトピックがあります。
• Filter — 指定したエンティティ種別の親を持つ項目を含むように絞り込まれたニュースフィードが含ま
れます。
/chatter/feed-elements を使用したフィード項目の投稿
ヒント: /chatter/feed-elements リソースを使用すると、フィード種別を渡す必要がないため、非常
に簡単に効率よくフィード項目を投稿できます。API バージョン 31.0 では、投稿できるフィード要素種別
はフィード項目のみです。将来的に他のフィード要素種別が追加される可能性があるため、アプリケー
ションを今後の変更にも対応できるように、このリソースを使用します。
フィード項目を投稿するには、次のリソースを使用します。
POST /chatter/feed-elements
フィード項目を投稿するときには、標準オブジェクトまたはカスタムオブジェクトの子を作成します。
subjectId 要求パラメータ、または Feed Item Input リクエストボディの subjectId プロパティに、親オブジェ
クトを指定します。
投稿されたフィード項目の parent プロパティには、親オブジェクトに関する情報が含まれます。
ユーザプロファイルへの投稿
次の例では、要求パラメータを使用して、テキスト投稿をコンテキストユーザのユーザプロファイルに投
稿します。
POST /chatter/feed-elements?feedElementType=FeedItem&subjectId=me&text=Test
subjectId に、別名 me を指定します。コンテキストユーザのユーザ ID を指定することもできます。
新しく投稿されたフィード項目の parent プロパティには、コンテキストユーザの User Summary レスポン
スボディが含まれます。
別のユーザへの投稿
次の例では、リクエストボディを使用して、別のユーザに投稿します。subjectId プロパティでは、ユー
ザの ID を指定します。
POST /chatter/feed-elements
{
96
Chatter REST API の機能
フィードおよびフィード要素の使用
"feedElementType":"FeedItem",
"subjectId":"005RR000000DmOg",
"body" : {
"messageSegments" : [
{
"type" : "Text",
"text" : "When should we meet for release planning?"
}
]
}
}
新しく投稿されたフィード項目の parent プロパティには、対象ユーザの User Summary レスポンスボディ
が含まれます。
グループへの投稿
次の例では、リクエストボディを使用して、グループに投稿します。subjectId プロパティでは、グルー
プ ID を指定します。
POST /chatter/feed-elements
{
"feedElementType":"FeedItem",
"subjectId":"0F9RR0000004CPw",
"body" : {
"messageSegments" : [
{
"type" : "Text",
"text" : "When should we meet for release planning?"
}
]
97
Chatter REST API の機能
フィードおよびフィード要素の使用
}
}
新しく投稿されたフィード項目の parent プロパティには、指定されたグループの Group レスポンスボディ
が含まれます。
レコード (ファイルや取引先など) への投稿
次の例では、リクエストボディを使用して、レコードフィードでユーザにメンションします。subjectId
プロパティでは、レコード ID を指定します。
POST /chatter/feed-elements
{
"feedElementType" : "FeedItem",
"subjectId" : "001RR000002G4Y0",
"body" : {
"messageSegments" : [
{
"type" : "Mention",
"id" : "005RR000000DmOg"
},
{
"type" : "Text",
"text" : " Have you checked on this account recently?"
}
]
}
}
新しいフィード項目の parent プロパティは、指定されたレコードタイプに応じて異なります。レコード
タイプが File の場合、親は File Summary レスポンスボディです。レコードタイプが Group の場合、親は Group
レスポンスボディです。レコードタイプが User の場合、親は User Summary レスポンスボディです。その他
すべてのレコードタイプの場合、親は Record Summary レスポンスボディです。
98
Chatter REST API の機能
フィードおよびフィード要素の使用
フィードからのフィード要素の取得
ヒント: フィード要素を含むフィードを返すには、次のメソッドをコールします。API バージョン 31.0 で
は、フィード要素種別はフィード項目とバンドルのみですが、これは今後変更される可能性があります。
フィードからフィード要素を取得する方法は、どのフィード種別でも似ていますが同一ではありません。
会社フィード、ホームフィードまたはモデレーションフィードからフィード要素を取得する場合は、件名 ID
を指定しないでください。
フィード種別
リソース
Company
/chatter/feeds/company/feed-elements
ホーム
/connect/communities/communityId/chatter/feeds/home/feed-elements
Moderation
/connect/communities/communityId
/chatter/feeds/moderation/feed-elements
お気に入りフィードおよびフィルタフィードからフィード要素を取得するには、favoriteId または keyPrefix
を指定します。keyPrefix はオブジェクト ID の最初の 3 文字であり、オブジェクト種別を示します。次の
フィードの場合、subjectId は、コンテキストユーザの ID または別名 me である必要があります。
フィード種別
リソース
Favorites
/chatter/feeds/favorites/subjectId/favoriteId/feed-elements
Filter
/chatter/feeds/filter/subjectId/keyPrefix/feed-elements
レコードフィードからフィード要素を取得するには、レコード ID を指定します。
フィード種別
リソース
Record
/chatter/feeds/record/recordId/feed-elements
ヒント: recordId は、フィードをサポートする任意のタイプのレコードにすることができます (グルー
プを含む)。Salesforce UI のグループページ上のフィードは、レコードフィードです。
その他すべてのフィード種別からフィード要素を取得するには、件名 ID を指定します。別のフィードを指定
するには、feedType を置き換えます。ユーザプロファイルフィードとトピックフィードを除く、次の表のす
べてのフィード種別で、subjectId はコンテキストユーザの ID または別名 me である必要があります。
99
Chatter REST API の機能
フィード種別
Salesforce Files の使用
リソース
Bookmarks、Files、Groups、 /chatter/feeds/feedType/subjectId/feed-elements
News、People、To、Topics、 例: /chatter/feeds/news/me/feed-elements
User Profile
関連トピック:
Feeds リソース
Salesforce Files の使用
Chatter REST API を使用して、Salesforce Files Sync を含む、Salesforce Files を操作できます。
Salesforce Files を使用すると、クラウドでファイルのアップロード、保存、検索、フォロー、共有、およびコラ
ボレーションができます。
Salesforce Files Sync を使用すると、Chatter、デスクトップ、モバイルデバイス間でファイルをセキュアに保存、
同期、および共有できます。ファイルとフォルダにどこからでもアクセスして、即座に組織全体で更新して最
新の状態を維持できます。
リソース
HTTP メソッド ToDo
/chatter/feed-elements
GET、POST
フィード要素の投稿や、組織のすべてのフィー
ド要素の検索を行います。
/chatter/feeds/files/me/feed-elements GET
コンテキストユーザがフォローしている人ま
たはグループによって投稿されたファイルを
含むすべてのフィード要素を返します。
/chatter/feeds/news/me/feed-elements GET
コンテキストユーザが所有するグループかメ
ンバーであるグループすべてからの全フィー
ド要素と、コンテキストユーザがフォローし
ている全ファイル、レコード、およびユーザ
からの全フィード要素。このリソースは、
フィード要素に関する情報を取得し、フィー
ド要素を投稿するために使用します。
GET
コンテキストユーザがフォローしているすべ
てのレコードのフィード要素、または指定さ
れた recordId のすべてのフィード要素を返
します。このリソースは、フィードの検索や
特定のフィードのフィード要素の取得に使用
します。このリソースを使用してグループの
フィード要素を取得するには、グループ ID を
recordId として指定します。
/chatter/feeds/records/
recordId/feed-elements
100
Chatter REST API の機能
Salesforce Files の使用
リソース
HTTP メソッド ToDo
/chatter/feeds/user-profile/
userId/feed-elements
GET
/chatter/files/fileId
GET、POST、
外部ファイルへの参照を含む、指定されたファ
PATCH、DELETE イルに関する情報を取得します。外部ファイ
ルへの参照を含む、既存のファイルの新バー
ジョンをアップロードします。ファイルの名
称変更、別のフォルダへの移動、ファイルの
削除を行います。
/chatter/files/fileId/content
GET
外部ファイルへの参照を含む、ファイルのコ
ンテンツを返します。コンテンツは、レスポ
ンスボディとしてストリーミングされます。
/chatter/files/fileId/file-shares
GET、POST
指定されたファイルの共有先であるオブジェ
クトに関する情報を返します。オブジェクト
はユーザ、グループ、またはレコードの場合
があります。指定されたファイルをユーザと
共有する場合にも使用できます。
フィードで追跡可能なすべてのレコードに対
するすべてのアクションのフィード要素を返
します。
/chatter/files/fileId/file-shares/link GET、PUT、
DELETE
リンクとして共有されるファイルの説明。ファ
イルの共有リンクの作成、アクセス、または
削除を行います。
/chatter/files/fileId/rendition
GET
ファイルの変換。変換とは、ファイルのバイ
ナリプレビューです。バイナリの形式は、要
求で指定された形式によって異なります。
/chatter/files/batch/fileIds
GET、DELETE
ファイル ID によって指定されたファイルのリ
ストに関する情報。ファイルのリストに関す
る情報の取得や、ファイルのリストの削除を
行います。
/chatter/folders/folderId
GET、PATCH、
DELETE
指定されたフォルダに関する情報を取得しま
す。フォルダの移動、名前の変更、および削
除を行います。ルートフォルダを同期します。
/chatter/folders/folderId/items
GET、POST
フォルダの内容に関する情報を取得します。
フォルダへのファイルの追加や、フォルダの
作成を行います。ルートフォルダを同期しま
す。
/chatter/groups/groupId/files
GET
指定されたグループに投稿されたファイルに
関する情報を返します。
/connect/topics/topicId/files
GET
指定されたトピックに最近投稿された 5 つの
ファイルに関する情報を返します。
101
Chatter REST API の機能
Salesforce Files の使用
リソース
HTTP メソッド ToDo
/chatter/users/userId/files
GET、POST
外部ファイルへの参照を含む、Salesforce Files
Sync へのファイルの投稿、またはユーザが所
有するファイルに関する情報の取得を行いま
す。ユーザと共有されているファイル、ユー
ザがフォローしているファイル、一般的な組
織ファイルは対象外です。
/chatter/users/me/files/filter/groups GET
指定されたユーザがメンバーであるグループ
に投稿されたファイルに関する情報を返しま
す。
/chatter/users/me/files/filter/shared-with-me GET
指定されたユーザと共有されているファイル
に関する情報を返します。
メモ: 別名 me は、コンテキストユーザの ユーザ ID に置き換えることができます。
102
第4章
Chatter REST API の例
Chatter REST API の例を使用してタスクを実行します。
Chatter REST API を使用するときは、次の事項に留意してください。
• 要求パラメータは Chatter REST API リソース URL の一部として組み込まれることがあります
(/chatter/users?q=searchtext など)。リクエストボディは、要求の一部として組み込まれる可能性の
あるリッチ入力です。リソースにアクセスするときは、リクエストボディまたは要求パラメータのいずれ
かを使用できます。両方は使用できません。
• リクエストボディでは、Content-Type: application/json または Content-Type: application/xml
を使用します。
• 要求パラメータでは、Content-Type: application/x-www-form-urlencoded を使用します。
リクエストボディについての詳細は、「入力での POST、PATCH、または PUT の使用」を参照してください。
バイナリファイルのアップロード方法の例については、「バイナリファイルのアップロード」を参照してくだ
さい。
このセクションの内容:
レスポンスボディを絞り込む
コミュニティで要求を実行する
フィード項目を投稿する
フィード要素を投稿し、Salesforce のファイルを含める
コメントを投稿する
コメントを投稿し、Salesforce のファイルを含める
バイナリファイルを投稿する
@メンションを投稿する
複数の @メンションを投稿する
@メンション提案のリストを取得する
アクションリンクを定義し、フィード要素を使用して投稿する
テンプレートのアクションリンクを定義し、フィード要素を使用して投稿する
アクションリンクの状況を更新するかアクションリンクを呼び出す
フィード項目にいいね! と言う
フィード項目にいいね! と言い、いいね! の総数を返す
フィード項目を共有する
最後の要求以降に更新されたフィード要素を取得する
自分のニュースフィードの更新をポーリングする
103
Chatter REST API の例
レスポンスボディを絞り込む
自分のニュースフィードを取得する
グループフィードを取得する
内部のフィード項目のみを含むフィードを取得する
フィードを検索する
ユーザがフォローしているレコードのリストを取得する
ユーザの Chatter 活動の統計情報を取得する
フォローするユーザのおすすめを取得する
グループを作成する
グループの写真を更新およびトリミングする
グループに参加する
非公開グループへの参加を要求する
非公開グループへの参加要求を承認または却下する
グループに投稿する
レコードをフォローする
レコードのフォローを停止する
レコードフィードを取得する
ユーザプロファイルを更新する
ユーザの写真を更新およびトリミングする
非公開メッセージを送信する
複数のユーザのユーザ情報を取得する
レスポンスボディを絞り込む
リソース
すべて
HTTP メソッド
GET
要求パラメータ
exclude、include、および filterGroup
要求を行うときにレスポンスボディを絞り込むには、exclude および include クエリパラメータを使用
します。クエリ値は、バー (|) で区切られたプロパティのリストです。URL は、バーを %7C として符号化し
ます。各プロパティ名の前にスラッシュ (/) を使用します。
返すレスポンスボディ (Big、Medium、または Small) を指定するには、filterGroup クエリパラメータ
を使用します。各レスポンスボディのすべてのプロパティにこれらのグループサイズのいずれかが割り当
てられます。
104
Chatter REST API の例
コミュニティで要求を実行する
要求パラメータの例
この News Feed URL リソースは次のようになります。
/chatter/users/me?include=/aboutMe%7C/address
ルールと例についての詳細は、「応答サイズの指定」を参照してください。
戻り値
絞り込まれたレスポンスボディ
上記の要求パラメータの例では、Feed レスポンスボディに対して次を返します。
{
"aboutMe": "Salesforce Administrator and Citizen Developer",
"address": {
"city": "San Francisco",
"country": "US",
"formattedAddress": "1 Market St\nSan Francisco, CA 94105\nUS",
"state": "CA",
"street": "1 Market St",
"zip": "94105"
}
}
コミュニティで要求を実行する
リソース
ドキュメントにサポート対象外と明記されている場合を除き、リソースはコミュニティをサポートします。
HTTP メソッド
不特定
例
特定のコミュニティへの要求を実行するには、リソースにプレフィックス
/connect/communities/communityId を付けます。たとえば、次のリソースは、特定のコミュニティ
の新しいフィードからフィード項目を取得します。
/connect/communities/communityId/chatter/feeds/news/me/feed-elements
詳細は、「Chatter REST API リソース URL の作成」および「Salesforce Communities への接続」を参照してくださ
い。
戻り値
不特定
105
Chatter REST API の例
フィード項目を投稿する
フィード項目を投稿する
リソース
/chatter/feed-elements
HTTP メソッド
POST
リクエストボディ
Feed Item Input
要求パラメータ
feedElementType、subjectId、text
リクエストボディの例
subjectId に、フィード項目の親になるユーザ、グループ、またはレコードを指定します。
{
"body" : {
"messageSegments" : [
{
"type" : "Text",
"text" : "When should we meet for release planning? "
},
{
"type" : "Mention",
"id" : "005D00000016Qxp"
}]
},
"feedElementType" : "FeedItem",
"subjectId" : "0F9B000000000W2"
}
要求パラメータの例
/services/data/v34.0/chatter/feed-elements?feedElementType=FeedItem&subjectId=0F9B000000000W2&text=New+post
戻り値
Feed Item
106
Chatter REST API の例
フィード要素を投稿し、Salesforce のファイルを含める
フィード要素を投稿し、Salesforce のファイルを含める
この例では、Salesforceにアップロードされているファイルを含むフィード要素を投稿します。新しいファイル
をアップロードするには、「バイナリファイルのアップロード」を参照してください。
リソース
/chatter/feed-elements
HTTP メソッド
POST
リクエストボディ
Feed Item Input
リクエストボディの例
{
"body":{
"messageSegments":[
{
"type":"Text",
"text":"Please take a look at this file."
}
]
},
"capabilities":{
"content":{
"contentDocumentId":"069D00000001pyS"
}
},
"subjectId":"me",
"feedElementType":"FeedItem"
}
戻り値
Feed Item
107
Chatter REST API の例
コメントを投稿する
コメントを投稿する
リソース
/chatter/feed-elements/feedElementId/capabilities/comments/items
HTTP メソッド
POST
リクエストボディ
Comment Input
要求パラメータ
text
リクエストボディの例
{
"body":{
"messageSegments":[
{
"type":"Text",
"text":"New comment"
}
]
}
}
要求パラメータの例
/services/data/v34.0/chatter/feed-elements/feedElementId/capabilities/comments/items?text=New+comment
戻り値
Comment
コメントを投稿し、Salesforce のファイルを含める
この例では、すでにSalesforceにアップロードされているファイルを含むコメントを投稿します。新しいファイ
ルをアップロードするには、「バイナリファイルのアップロード」を参照してください。
リソース
/chatter/feed-elements/feedElementId/capabilities/comments/items
HTTP メソッド
POST
108
Chatter REST API の例
バイナリファイルを投稿する
リクエストボディ
Comment Input
要求パラメータ
text
リクエストボディの例
{
"body":{
"messageSegments":[
{
"type":"Text",
"text":"Please take a look at this file."
}
]
},
"capabilities":{
"content":{
"contentDocumentId":"069D00000001pyS"
}
}
}
戻り値
Comment
バイナリファイルを投稿する
バイナリファイルを投稿する方法についての詳細は、「Chatter REST API 入力の使用」を参照してください。
• バイナリファイルを含むフィード要素の投稿
• バイナリファイルを含むフィード要素の一括投稿
• バイナリファイルを含むコメントの投稿
• バイナリファイルを含むコメントの一括投稿
• ユーザの写真の投稿およびトリミング
• [ファイル] リストへのバイナリファイルの投稿
109
Chatter REST API の例
@メンションを投稿する
@メンションを投稿する
リソース
メンションを含むフィード項目を投稿するには、/chatter/feed-elements を使用します。
メンションを含むコメントを投稿するに
は、/chatter/feed-elements/feedElementId/capabilities/comments/items を使用します。
HTTP メソッド
POST
リクエストボディ
フィード項目の場合、Feed Item Input を使用します。
コメントの場合、Feed Item Input を使用します。
どちらの入力の場合も、Message Segment Input: Mention を使用します。
リクエストボディの例
次にフィード項目の例を示します。
{
"body" : {
"messageSegments" : [
{
"type" : "Text",
"text" : "When should we meet for release planning? "
},
{
"type" : "Mention",
"id" : "005T0000000mzCy"
}
]
},
"feedElementType" : "FeedItem",
"subjectId" : "005D00000016Qxp"
}
110
Chatter REST API の例
複数の @メンションを投稿する
次にコメントの例を示します。
{ "body" :
{
"messageSegments" : [
{
"type": "mention",
"id" : "005D0000001GpHp"
},
{
"type": "text",
"text" : " Did you see the new plans?"
}
]
}
}
メモ: メンションの前後に空白が自動的に追加されることはないため、テキストメッセージセグメン
トには空白を含めます。
戻り値
Feed Item
Comment
複数の @メンションを投稿する
リソース
最大 25 個のメンションを含むフィード項目を投稿するには、/chatter/feed-elements を使用します。
最大 25 個のメンションを含むコメントを投稿するに
は、/chatter/feed-elements/feedElementId/capabilities/comments/items を使用します。
HTTP メソッド
POST
リクエストボディ
フィード項目の場合、Feed Item Input を使用します。
コメントの場合、Feed Item Input を使用します。
どちらの入力の場合も、Message Segment Input: Mention を使用します。
111
Chatter REST API の例
複数の @メンションを投稿する
リクエストボディの例
次にフィード項目の例を示します。
{
"body" : {
"messageSegments" : [
{
"type" : "Text",
"text" : "When should we meet for release planning? "
},
{
"type" : "Mention",
"id" : "005T0000000mzCy"
},
{
"type" : "Text",
"text" : " "
},
{
"type" : "Mention",
"id" : "005B0000000Ek1S"
}
]
},
"feedElementType" : "FeedItem",
"subjectId" : "005D00000016Qxp"
}
次にコメントの例を示します。
{ "body" :
112
Chatter REST API の例
複数の @メンションを投稿する
{
"messageSegments" : [
{
"type": "mention",
"id":"005D0000001LL8YIAW"
},
{
"type" : "Text",
"text" : " "
},
{
"type": "mention",
"id":"005D0000001LL8sIAG"
},
{
"type": "text",
"text":" Did you see the new plans?"
}
]
}
}
メモ: メンションの前後に空白が自動的に追加されることはないため、必要な位置に空白を含めます。
戻り値
Feed Item
Comment
113
Chatter REST API の例
@メンション提案のリストを取得する
@メンション提案のリストを取得する
リソース
メンション提案のリストを取得するには、Mentions Completions リソース (/chatter/mentions/completions)
を使用します。コンテキストユーザに対して有効な提案を判定するには、Mentions Validations リソース
(/chatter/mentions/validations) を使用します。
HTTP メソッド
GET
要求パラメータ
contextId、page、pageSize、q、type
戻り値
Mention Completion Page
Mention Validations
アクションリンクを定義し、フィード要素を使用して投稿する
ステップ 1: アクションリンクグループを定義する
ラジオボタンと同様に、アクションリンクはグループ内にネストする必要があります。グループ内のアクショ
ンリンクは、グループのプロパティを共有し、相互に排他的です (クリックできるのは、グループ内の 1 つの
アクションリンクのみです)。1 つのアクションリンクを定義する場合でも、アクションリンクグループに含め
る必要があります。
アクションリンクはフィード項目のボタンと考えます。ボタンのように、アクションリンクには表示ラベル
(labelKey) があります。アクションリンク定義には、URL (actionUrl) や HTTP メソッド (method) のほか、省
略可能なリクエストボディ (requestBody) や HTTP ヘッダー (headers) など、他にもプロパティがあります。
ユーザがこのアクションリンクをクリックすると、Chatter REST API に対して HTTP POST 要求が実行され、フィー
ド項目がChatterに投稿されます。requestBody プロパティは、新しいフィード項目のテキストなど、actionUrl
リソースのリクエストボディを保持します。この例では、新しいフィード項目にテキストしか含まれていませ
んが、添付ファイルやアンケートなどの他の機能やアクションリンクも含めることができます。
リソース
/connect/action-link-group-definitions
HTTP メソッド
POST
リクエストボディ
Action Link Group Definition Input
このリクエストボディには、Action Link Definition Input リクエストボディのコレクションを保持する
actionLinks プロパティがあります。この例では 1 つのアクションリンクがあります。
リクエストボディの例
POST /services/data/v34.0/connect/action-link-group-definitions
114
Chatter REST API の例
アクションリンクを定義し、フィード要素を使用して投
稿する
{
"executionsAllowed":"OncePerUser",
"expirationDate":"2015-05-20T19:32:10+0000",
"category":"Primary",
"actionLinks":[
{
"actionType":"Api",
"actionUrl":"/services/data/v34.0/chatter/feed-elements",
"labelKey":"Post",
"method":"HttpPost",
"requiresConfirmation":"false",
"requestBody":"{\"subjectId\": \"me\",\"feedElementType\": \"FeedItem\",\"body\":
{\"messageSegments\": [{\"type\": \"Text\",\"text\": \"This post was created via an API
action link.\"}]}}",
"headers":[
{
"name":"Content-Type",
"value":"application/json"
},
{
"name":"Authorization",
"value":"OAuth 00DD00000007WNP!ARsAQHhIdgwbihG7e8ga"
}
]
}
]
}
115
Chatter REST API の例
アクションリンクを定義し、フィード要素を使用して投
稿する
cURL を使用した要求の例
cURL を使用して要求を実行するには、次のように入力し、Developer Edition インスタンス名および OAuth 情報
を置き換えます。
curl -H "X-PrettyPrint: 1" -H "Content-Type: application/json"
-d '{ "executionsAllowed":"OncePerUser", "expirationDate":"2015-09-20T19:32:10+0000",
"category":"Primary",
"actionLinks":[ { "actionType":"Api",
"actionUrl":"/services/data/v34.0/chatter/feed-elements",
"groupDefault":"true", "labelKey":"Post", "method":"HttpPost",
"requiresConfirmation":"true",
"requestBody":"{\"subjectId\": \"me\",\"feedElementType\": \"FeedItem\",\"body\":
{\"messageSegments\": [{\"type\": \"Text\",\"text\": \"This is a test post created via
an API action link.\"}]}}",
"headers":[ { "name":"Content-Type", "value":"application/json" }, {
"name":"Authorization", "value":"OAuth 00DD00000007WNP!ARsAQHhIdgwbihG7e8ga" }] }] }'
-X POST "https://instance_name/services/data/v34.0/connect/action-link-group-definitions"
-H 'Authorization: OAuth 00DRR0000000N0g!RWaPj94O6yOD.lfjB9LqMk' --insecure
レスポンスボディ
Action Link Group Definition
ステップ 2: アクションリンクグループをフィード項目に関連付けて
投稿する
1 つのフィード要素には、最大 10 個のアクションリンクグループを関連付けられます。
リソース
/chatter/feed-elements
HTTP メソッド
POST
リクエストボディ
Feed Item Input
リクエストボディの例
ステップ 1 の Action Link Group Definition レスポンスの id からアクションリンクグループ ID を取得します。
POST /services/data/v34.0/chatter/feed-elements
{
116
Chatter REST API の例
アクションリンクを定義し、フィード要素を使用して投
稿する
"body": {
"messageSegments": [
{
"type": "Text",
"text": "Click to post a feed item."
}
]
},
"subjectId": "me",
"feedElementType": "feedItem",
"capabilities": {
"associatedActions": {
"actionLinkGroupIds": ["0AgRR0000004CTr0AM"]
}
}
}
cURL を使用した要求の例
cURL を使用して要求を実行するには、次のように入力し、ステップ 1 で返された アクションリンクグルー
プ ID、Developer Edition インスタンス名、および OAuth 情報を置き換えます。
curl -H "X-PrettyPrint: 1" -H "Content-Type: application/json" -d '{ "body": {
"messageSegments":
[ { "type": "Text", "text": "Click to post a feed item." } ] }, "subjectId": "me",
"feedElementType": "feedItem", "capabilities":
{ "associatedActions": { "actionLinkGroupIds": ["0AgRR0000004CTr0AM"] } } }'
-X POST "https://instance_name/services/data/v34.0/chatter/feed-elements"
-H 'Authorization: OAuth OOARoAQETAKEIddnMWXh462dprYAgRWaPj94O6yOD' --insecure
117
Chatter REST API の例
テンプレートのアクションリンクを定義し、フィード要
素を使用して投稿する
レスポンスボディ
Feed Item
関連トピック:
アクションリンクの使用
アクションリンクテンプレート
Action Link Group Definitions
Feed Elements, Post and Search
テンプレートのアクションリンクを定義し、フィード要素を使用して投稿する
テンプレートのアクションリンクを定義し、フィード要素を使用して投稿する
テンプレートのアクションリンクを定義し、フィード要素を使用
して投稿する
ステップ 1: アクションリンクテンプレートを作成する
ラジオボタンと同様に、アクションリンクはグループ内にネストする必要があります。グループ内のアクショ
ンリンクは、グループのプロパティを共有し、相互に排他的です (クリックできるのは、グループ内の 1 つの
アクションリンクのみです)。1 つのアクションリンクを定義する場合でも、アクションリンクグループに含め
る必要があります。アクションリンクテンプレートおよびアクションリンクグループテンプレートでも同様で
す。
この例では、アクションリンクグループ内の 1 つのアクションリンクを使用します。ユーザがこのアクション
リンクをクリックすると、Chatter REST API に対して HTTP POST 要求が実行され、フィード項目が Chatter に投稿さ
れます。[HTTP リクエストボディ] 項目は、新しいフィード項目のテキストなど、[アクション URL] リソー
スのリクエストボディを保持します。この例では、新しいフィード項目にテキストしか含まれていませんが、
添付ファイルやアンケートなどの他の機能やアクションリンクも含めることができます。
1. [設定] で、[作成] > [アクションリンクテンプレート] をクリックします。
2. 新しいアクションリンクグループテンプレートで次の値を使用します。
項目
値
名前
ドキュメントの例
開発者名
Doc_Example
カテゴリ
プライマリアクション
実行可
ユーザごとに 1 回
3. 新しいアクションリンクテンプレートで次の値を使用します。
118
Chatter REST API の例
テンプレートのアクションリンクを定義し、フィード要
素を使用して投稿する
項目
値
アクションリンクグループテンプレート
ドキュメントの例
アクションの種類
Api
アクション URL
/services/data/{!Bindings.ApiVersion}/chatter/feed-elements
ユーザ表示設定
全員に表示
HTTP リクエストボディ
{"subjectId": "{!Bindings.SubjectId}","feedElementType":
"FeedItem","body": {"messageSegments": [{"type": "Text","text":
"{!Bindings.Text}"}]}}
HTTP ヘッダー
Content-Type: application/json
位置
0
表示ラベルキー
投稿
HTTP メソッド
POST
4. アクションリンクグループテンプレートに戻り、[公開済み] を選択します。[保存] をクリックします。
アクションリンクグループテンプレート ID をメモし、ステップ 3 に進みます。
ステップ 2: アクションリンクグループテンプレート ID を取得する
[設定] でアクションリンクグループテンプレートへのアクセス権がある場合は、アクションリンググループテ
ンプレート ID を取得してステップ 3 に進むことができます。
リソース
/services/data/v33.0/query
HTTP メソッド
GET
要求パラメータ
q — SOQL クエリ文字列。
要求パラメータの例
GET
/services/data/v34.0/query?q=SELECT+id+FROM+ActionLinkGroupTemplate+WHERE+DeveloperName='Doc_Example'
cURL の例
curl
https://na1.salesforce.com/services/data/v34.0/query?q=SELECT+id+FROM+ActionLinkGroupTemplate+
WHERE+DeveloperName='Doc_Example' -H "Authorization: Bearer token"
119
Chatter REST API の例
テンプレートのアクションリンクを定義し、フィード要
素を使用して投稿する
レスポンスボディ
クエリ結果レコードの配列。
{
"totalSize":1,
"done":true,
"records":[
{
"attributes":{
"type":"ActionLinkGroupTemplate",
"url":"/services/data/v34.0/sobjects/ActionLinkGroupTemplate/07gD00000004CEhIAM"
},
"Id":"07gD00000004CEhIAM"
}
]
}
ステップ 3: アクションリンクグループをインスタンス化する
リソース
/connect/action-link-group-definitions
HTTP メソッド
POST
リクエストボディ
Action Link Group Definition Input
リクエストボディの例
POST /services/data/v34.0/connect/action-link-group-definitions
{
"templateId":"07gD00000004CEhIAM",
"templateBindings" : [
{
"key":"ApiVersion",
120
Chatter REST API の例
テンプレートのアクションリンクを定義し、フィード要
素を使用して投稿する
"value":"v33.0"
},
{
"key":"Text",
"value":"This post was created by an API Action Link!"
},
{
"key":"SubjectId",
"value":"me"
}
]
}
cURL を使用した要求の例
cURL を使用して要求を実行するには、次のように入力し、Developer Edition インスタンス名および OAuth 情報
を置き換えます。
curl -H "X-PrettyPrint: 1" -H "Content-Type: application/json" -d '{
"templateId":"07gD00000004CEhIAM",
"templateBindings" : [ { "key":"ApiVersion", "value":"v34.0" },
{ "key":"Text", "value":"This post was created by an API Action Link!" }, {
"key":"SubjectId", "value":"me" } ] }'
-X POST
"https://instance_name/services/data/v34.0/connect/action-link-group-definitions"
-H 'Authorization: OAuth 00DRR0000000N0g!RWaPj94O6yOD.lfjB9LqMk' --insecure
レスポンスボディ
Action Link Group Definition
ステップ 4: アクションリンクグループをフィード要素に関連付けて
投稿する
1 つのフィード要素には、最大 10 個のアクションリンクグループを関連付けられます。
リソース
/chatter/feed-elements
121
Chatter REST API の例
テンプレートのアクションリンクを定義し、フィード要
素を使用して投稿する
HTTP メソッド
POST
リクエストボディ
Feed Item Input
リクエストボディの例
ステップ 3 の Action Link Group Definition レスポンスの id からアクションリンクグループ ID を取得します。
POST /services/data/v34.0/chatter/feed-elements
{
"body": {
"messageSegments": [
{
"type": "Text",
"text": "Click to post a feed item."
}
]
},
"subjectId": "me",
"feedElementType": "feedItem",
"capabilities": {
"associatedActions": {
"actionLinkGroupIds": ["0AgRR0000004CTr0AM"]
}
}
}
cURL を使用した要求の例
cURL を使用して要求を実行するには、次のように入力し、ステップ 2 で返された アクションリンクグルー
プ ID、Developer Edition インスタンス名、および OAuth 情報を置き換えます。
curl -H "X-PrettyPrint: 1" -H "Content-Type: application/json" -d '{ "body": {
"messageSegments": [ { "type": "Text", "text": "Click to post a feed item." } ] },
"subjectId": "me", "feedElementType": "feedItem", "capabilities": { "associatedActions":
122
Chatter REST API の例
アクションリンクの状況を更新するかアクションリンク
を呼び出す
{ "actionLinkGroupIds": ["0AgRR0000004CTr0AM"] } } }' -X POST
"https://instance_name/services/data/v34.0/chatter/feed-elements" -H 'Authorization:
OAuth OOARoAQETAKEIddnMWXh462dprYAgRWaPj94O6yOD' --insecure
レスポンスボディ
Feed Item
関連トピック:
Action Link Group Definitions
Feed Elements, Post and Search
アクションリンクテンプレート
アクションリンクの使用
アクションリンクを定義し、フィード要素を使用して投稿する
アクションリンクの状況を更新するかアクションリンクを呼び出
す
使用方法
このリソースを使用して、アクションリンクの status プロパティを更新します。Api または ApiAsync
アクションリンクを呼び出すには、状況を PendingStatus に設定します。アクションリンクの status
と Action Link Definition Input の labelKey プロパティの組み合わせにより、UI に表示されるテキストが決まり
ます。
さまざまな種別のアクションリンクには、さまざまな status ワークフローを指定できます。
Api
アプリケーションから Api アクションリンクを呼び出すには、PATCH 要求を実行してリンクを
PendingStatus としてマークします。Salesforce により、Action Link Definition Input で指定された actionUrl
へのコールアウトが処理されます。Api アクションリンクの場合、Salesforce がサーバから返された HTTP
状況コードに基づいて status を SuccessfulStatus または FailedStatus に設定します。
ApiAsync
アプリケーションからこのアクションリンクを呼び出すには、PATCH 要求を実行してリンクを
PendingStatus としてマークします。Salesforce により、Action Link Definition Input で指定された actionUrl
へのコールアウトが処理されます。ApiAsync アクションリンクの場合、コールアウトによってサーバ
での非同期操作が開始されます。Salesforce により status が PendingStatus に設定されます。ただ
し、コールでエラー状況コードが返された場合は、status は FailedStatus に設定されます。非同
期処理を終了したサーバは、アクションリンクをコールバックし、PATCH を実行してアクションリンク
を SuccessfulStatus または FailedStatus に設定します。
Download と Ui
Platform Action レスポンスボディの actionUrl のリンクから、ユーザにダウンロードや UI アクセスを行
わせます。PATCH 要求を実行して status を SuccessfulStatus または FailedStatus に設定する時
期は、アプリケーションで決定する必要があります。
123
Chatter REST API の例
フィード項目にいいね! と言う
メモ: 次の場合、アクションリンクの status に対する PATCH 要求はできません。
• 別の status から NewStatus に戻す。
• 最終的な status (FailedStatus または SuccessfulStatus) から NewStatus または
PendingStatus に変更する。
• アクションリンクが属するアクションリンクグループの executionsAllowed プロパティが
Unlimited である。
• Api または ApiAsync アクションリンクの executionsAllowed プロパティが Once の場合、ユー
ザが初めて PATCH を実行して status を PendingStatus に設定すると、アクションリンクへの
コールアウトが行われます。同じユーザが PATCH を実行して状況を PendingStatus に再度設定す
ると、Salesforce から現在のアクションリンクの情報が返されます。ただし、別のユーザが PATCH を
実行して状況を PendingStatus に設定すると、エラーが発生します。いずれの場合も、アクショ
ンリンクへのコールアウトは再送信されません。
リソース
/connect/action-links/actionLinkId
HTTP メソッド
PATCH
リクエストボディ
Action Link Input
要求パラメータ
status
リクエストボディの例
{ "status":"SuccessfulStatus" }
要求パラメータの例
/services/data/v34.0/connect/action-links/actionLinkId?status=SuccessfulStatus
戻り値
Platform Action
フィード項目にいいね! と言う
リソース
/chatter/feed-elements/feedElementId/capabilities/chatter-likes/items
HTTP メソッド
POST
例
/services/data/v34.0/chatter/feed-elements/feedElementId/capabilities/chatter-likes/items
戻り値
Like
124
Chatter REST API の例
フィード項目にいいね! と言い、いいね! の総数を返す
フィード項目にいいね! と言い、いいね! の総数を返す
リソース
/connect/batch/
HTTP メソッド
POST
リクエストボディ
Generic Batch Collection Input
リクエストボディの例
{
"batchRequests" : [
{
"method" : "Post",
"url" :
"/v34.0/chatter/feed-elements/feedElementId/capabilities/chatter-likes/items"
},
{
"method" : "Get",
"url" :
"/v34.0/chatter/feed-elements/feedElementId/capabilities/chatter-likes/items"
}
],
"haltOnError" : "false"
}
戻り値
Batch Results
フィード項目を共有する
リソース
/chatter/feed-elements
HTTP メソッド
POST
125
Chatter REST API の例
最後の要求以降に更新されたフィード要素を取得する
リクエストボディ
Feed Item Input
要求パラメータ
originalFeedElementId、subjectId
リクエストボディの例
{
"originalFeedElementId": "0D5D0000000DaZBKA0",
"subjectId": "me"}
要求パラメータの例
/services/data/v34.0/chatter/feed-elements?originalFeedElementId=0D5D0000000DaZBKA0&subjectId=me
戻り値
Feed Item
最後の要求以降に更新されたフィード要素を取得する
リソース
最後のコール以降に更新されたフィード要素のみを取得するには、Feed Element Page レスポンスボディの
updatesUrl プロパティの値に対して要求を実行します。
次のフィードは updatesUrl プロパティを返します。
• 会社 — /chatter/feeds/company/feed-elements
• ファイル — /chatter/feeds/files/me/feed-elements
• 条件 — /chatter/feeds/filter/me/filterId/feed-elements
• グループ — /chatter/feeds/groups/me/feed-elements
• ニュース — /chatter/feeds/news/me/feed-elements
• 人 — /chatter/feeds/people/me/feed-elements
• レコード — /chatter/feeds/record/recordId/feed-elements
次の Feed Elements Page レスポンスボディからの抜粋は、updatesUrl プロパティのサンプル値を示してい
ます。
{
...
..."updatesUrl" : "/services/data/v34.0/chatter/feeds
/news/005D0000001LL8OIAW/feed-elements?updatedSince=2:1384811809000"
...
}
126
Chatter REST API の例
自分のニュースフィードの更新をポーリングする
フィード要素は、最後のフィード要求の時刻以降に作成されたか、最後のフィード要求の時刻以降にフィー
ド要素に sort=LastModifiedDateDesc およびコメントが追加された場合、更新されたものとみなされ
ます。いいね! やトピックを追加してもフィード要素は更新されません。
HTTP メソッド
GET
戻り値
Feed Element Page
自分のニュースフィードの更新をポーリングする
リソース
1. /chatter/feeds/news/me/feed-elements、/chatter/feeds/news/me のいずれかのリソースを
使用して、ニュースフィードから最新の要素を取得するか、フィードに関する情報を取得します。
どちらのリソースのレスポンスボディにも、isModifiedUrl プロパティがあります。このプロパティ
には Is-Modified リソースの URL があり、フィードの最終更新日を定義する since 要求パラメータが含ま
れています。ニュースフィード要求の並び替え順が変わると、ニュースフィードが変更されます。
2. isModifiedUrl プロパティの URL に対して GET 要求を発行します。
Feed Modified Info 応答には、次のプロパティが含まれます。
• isModified — 最後にチェックしてからフィードが更新されたかどうかを示す boolean。このプロパ
ティが true となる条件は、ニュースフィードの元の要求の並び替え順によって異なります。たと
えば、フィードが投稿日 (CreatedDateDesc) で並び替えられ、コメントが追加されていると、
isModified は false になります。
• nextPollUrl — Is-Modified リソースの URL を含む文字列。このプロパティには、isModified が
false の場合にのみ URL が含まれます。isModified が true の場合、nextPollUrl は null にな
ります。
3. isModified プロパティが true の場合は、News Feed Elements リソースに GET 要求を発行して、ニュー
スフィードを更新します。
4. isModified プロパティが false の場合は、nextPollUrl プロパティの URL に対して GET 要求を発行
します。この要求は、isModified プロパティと nextPollUrl プロパティを含む Feed Modified Info レス
ポンスボディも返します。
メモ: 1 分間に 1 回を超えてニュースフィードをポーリングしないでください。
HTTP メソッド
GET
例
この News Feed URL リソースは次のようになります。
/chatter/feeds/news/me
127
Chatter REST API の例
自分のニュースフィードを取得する
Feed レスポンスボディに対して次を返します。
{
"feedElementPostUrl": "/services/data/v34.0/chatter/feed-elements",
"feedElementsUrl":
"/services/data/v34.0/chatter/feeds/news/005xx000001Sv1mAAB/feed-elements",
"isModifiedUrl":
"/services/data/v34.0/chatter/feeds/news/005xx000001Sv1mAAB/is-modified?since=2%3A1344352279000"
}
このニュースフィードをポーリングするための Is-modified リソースは、次のようになります。
/chatter/feeds/news/005xx000001Sv1mAAB/is-modified?since=2%3A1344352279000
戻り値
Feed Modified Info
自分のニュースフィードを取得する
リソース
/chatter/feeds/news/me/feed-elements
HTTP メソッド
GET
例
/services/data/v34.0/chatter/feeds/news/me/feed-elements
戻り値
Feed Element Page
グループフィードを取得する
リソース
/chatter/feeds/record/recordId/feed-elements
recordId をグループ ID に置き換えます。
HTTP メソッド
GET
例
/services/data/v34.0/chatter/feeds/record/0F9D00000000I4O/feed-elements
戻り値
Feed Element Page
128
Chatter REST API の例
内部のフィード項目のみを含むフィードを取得する
内部のフィード項目のみを含むフィードを取得する
リソース
/chatter/feeds/record/recordId/feed-elements
HTTP メソッド
GET
要求パラメータ
showInternalOnly
例
/services/data/v34.0/chatter/feeds/record/0F9D00000000I4O/feed-elements?showInternalOnly=true
戻り値
Feed Element Page
フィードを検索する
リソース
/chatter/feed-elements?q=searchString
検索文字列にはワイルドカード文字を含めることができ、ワイルドカード文字を除く 2 文字以上が含まれ
ている必要があります。
HTTP メソッド
GET
要求パラメータ
q
要求パラメータの例
/services/data/v34.0/chatter/feed-elements?q=track
戻り値
Feed Element Page
ユーザがフォローしているレコードのリストを取得する
リソース
/chatter/users/userId/following
HTTP メソッド
GET
要求パラメータ
page (省略可能)
要求パラメータの例
/services/data/v34.0/chatter/users/005D0000001GLowIAB/following?page=1
129
Chatter REST API の例
ユーザの Chatter 活動の統計情報を取得する
戻り値
Subscription Page
ユーザの Chatter 活動の統計情報を取得する
リソース
/chatter/users/userId
HTTP メソッド
GET
例
/services/data/v34.0/chatter/users/005D0000001GLowIAB?include=/chatterActivity
戻り値
User Detail
フォローするユーザのおすすめを取得する
リソース
/chatter/users/me/recommendations/follow/users
HTTP メソッド
GET
例
/services/data/v34.0/chatter/users/me/recommendations/follow/users
戻り値
Recommendations
グループを作成する
リソース
/chatter/groups
HTTP メソッド
POST
リクエストボディ
Group Input
要求パラメータ (必須)
name、visibility
リクエストボディの例
{
"name" : "Chatter API",
130
Chatter REST API の例
グループの写真を更新およびトリミングする
"visibility" : "PublicAccess"
}
要求パラメータの例
/services/data/v34.0/chatter/groups?name=Chatter+API&visibility=PublicAccess
戻り値
Group Detail
グループの写真を更新およびトリミングする
この例では、既存の写真 (すでにアップロードされている写真) をトリミングします。写真を新たにアップロー
ドしてから、トリミングすることもできます。新しい写真をアップロードするには、マルチパート/フォーム
データ要求を使用する必要があります。「バイナリファイルのアップロード」を参照してください。
リソース
/chatter/groups/groupId/photo
HTTP メソッド
POST
リクエストボディ
Photo Input
要求パラメータ
cropSize、cropX、cropY、fileId
リクエストボディの例
{
"cropSize" : "240",
"cropX" : "20",
"cropY" : "20",
"fileId" : "069D00000001IOh"
}
要求パラメータの例
/services/data/v34.0/chatter/groups/0F9300000008ORJ
/photo?cropSize=240&cropX=20&cropY=20&fileId=069D00000001IOh
戻り値
Photo
131
Chatter REST API の例
グループに参加する
グループに参加する
リソース
/chatter/groups/groupId/members
HTTP メソッド
POST
リクエストボディ
Group Member Input
要求パラメータ
userId
リクエストボディの例
{"userId": "005D0000001GpHp" }
要求パラメータの例
/services/data/v34.0/chatter/groups/0F9D000000006bOKAQ
/members?userId=005D0000001GpHp
戻り値
グループメンバー
非公開グループへの参加を要求する
リソース
/chatter/groups/groupId/members/requests
HTTP メソッド
POST
例
/services/data/v34.0/chatter/groups/0F9D000000006bOKAQ/members/requests
戻り値
Group Membership Request
非公開グループへの参加要求を承認または却下する
リソース
/chatter/group-memberships-requests/requestId
HTTP メソッド
PATCH
リクエストボディ
Group Membership Request Update
132
Chatter REST API の例
グループに投稿する
要求パラメータ
status および responseMessage
responseMessage パラメータは、status の値が Declined の場合にのみ使用されます。
リクエストボディの例
{ "status " : "Accepted" }
要求パラメータの例
/services/data/v34.0/chatter/group-membership-requests
/0I5D000000002fwKAA?status=Accepted
戻り値
Group Membership Request
グループに投稿する
リソース
/chatter/feed-elements
HTTP メソッド
POST
リクエストボディ
Feed Item Input
要求パラメータ
feedElementType、subjectId、text
リクエストボディの例
subjectId にグループを指定します。
{
"body" : {
"messageSegments" : [
{
"type" : "Text",
"text" : "When should we meet for release planning?"
},
{
"type" : "Mention",
"id" : "005D00000016Qxp"
133
Chatter REST API の例
レコードをフォローする
}]
},
"feedElementType" : "FeedItem",
"subjectId" : "0F9B000000000W2"
}
要求パラメータの例
/services/data/v34.0/chatter
/feed-elements?feedElementType=FeedItem&subjectId=0F9B000000000W2&text=New+post
戻り値
Feed Item
レコードをフォローする
リソース
/chatter/users/me/following
HTTP メソッド
POST
リクエストボディ
Following Input
要求パラメータ
subjectId
subjectId はフォローする項目の ID です。バージョン 29.0 以上では、subjectId をトピック ID にするこ
とができます。
リクエストボディの例
{ "subjectId" : "001D000000Iyu2p" }
要求パラメータの例
/services/data/v34.0/chatter/users/me/following?subjectId=001D000000Iyu2p
戻り値
Subscription
レコードのフォローを停止する
リソース
/chatter/subscriptions/subscriptionId
HTTP メソッド
DELETE
134
Chatter REST API の例
レコードフィードを取得する
例
/services/data/v34.0/chatter/subscriptions/0E8D00000001JkFKAU
戻り値
204: DELETE が成功しました
完全に構造化されたレスポンスボディは返されず、戻りコードのみが返されます。
レコードフィードを取得する
リソース
/chatter/feeds/record/recordId/feed-elements
HTTP メソッド
GET
例
/services/data/v34.0/chatter/feeds/record/005x0000001oXx9AAE
/feed-elements
戻り値
Feed Element Page
ユーザプロファイルを更新する
リソース
/chatter/users/userId
HTTP メソッド
PATCH
リクエストボディ
User Input
要求パラメータ
aboutMe
リクエストボディの例
{
"aboutMe": "Writer at Salesforce"}
要求パラメータの例
/services/data/v34.0/chatter/users/me?aboutMe=Writer+at+Salesforce
戻り値
User Detail
135
Chatter REST API の例
ユーザの写真を更新およびトリミングする
ユーザの写真を更新およびトリミングする
この例では、既存の写真 (すでにアップロードされている写真) をトリミングします。写真を新たにアップロー
ドしてから、トリミングすることもできます。新しい写真をアップロードするには、マルチパート/フォーム
データ要求を使用する必要があります。「バイナリファイルのアップロード」を参照してください。この例を
使用してグループの写真を更新およびトリミングするには、/chatter/groups/groupId/photo に置き換え
ます。
リソース
/chatter/users/userId/photo
HTTP メソッド
POST
リクエストボディ
Photo Input
要求パラメータ
cropSize、cropX、cropY、fileId
リクエストボディの例
{
"cropSize" : "240",
"cropX" : "20",
"cropY" : "20",
"fileId" : "069D00000001IOh"
}
要求パラメータの例
/services/data/v34.0/chatter/users
/me/photo?cropSize=240&cropX=20&cropY=20&fileId=069D00000001IOh
戻り値
Photo
非公開メッセージを送信する
リソース
/chatter/users/me/messages/
HTTP メソッド
POST
リクエストボディ
User Message
要求パラメータ
recipients または inReplyTo
136
Chatter REST API の例
複数のユーザのユーザ情報を取得する
text
リクエストボディの例
{ "body" : "Are we ready for next week's customer meeting?",
"recipients" : ["005D0000001GOYpIAO", "005D0000001GbdHIAS"]
}
要求パラメータの例
/services/data/v34.0/chatter/users/me/messages?recipients=
005D0000001GOYpIAO,005D0000001GbdHIAS&text=Are+we+ready+for+next+week's+customer+meeting?
戻り値
Message
複数のユーザのユーザ情報を取得する
リソース
/chatter/users/batch/user_list。user_list はユーザ ID のリストです。場合によっては、アプリ
ケーションがChatter REST APIを 2 回コールする必要があります。1 回目はフィード項目とユーザ ID を取得し、
2 回目はユーザ ID のリストを使用してこのリソースをコールします。
HTTP メソッド
GET
例
/services/data/v34.0/chatter/users
/batch/005D0000001Kl6xIAC,005D0000005J3D4HVB, . . .
戻り値
Batch Results
137
第5章
Chatter REST API リソース
この章では、Chatter REST API リソースについて説明します。REST リソースは、エンドポイントと呼ばれること
もあります。
このセクションの内容:
Action Links リソース
アクションリンクは、フィード要素上のボタンです。アクションリンクをクリックすると、ユーザを特定
の Web ページに移動したり、ファイルダウンロードを開始したり、Salesforce または外部サーバへの API コー
ルを呼び出したりできます。アクションリンクには、URL と HTTP メソッドが含まれ、リクエストボディと
ヘッダー情報 (認証用の OAuth トークンなど) を含めることができます。アクションリンクを使用してSalesforce
およびサードパーティサービスをフィードに統合することで、ユーザはアクションを実行して生産性を高
め、イノベーションを促進できます。
Announcements リソース
お知らせに関する情報。既存のお知らせの表示期限の情報取得や更新を行います。お知らせは、削除され
るか、別のお知らせで置き換えられない限り、その表示期限の 11:59 p.m. まで Salesforce UI の指定の場所に表
示されます。
Batch リソース
最大 25 個のサブ要求から成るバッチを含むリクエストボディを作成し、1 つの要求としてサーバに送信し
て、アプリケーションのパフォーマンスを向上させます。バッチ内の各サブ要求のレスポンスボディと HTTP
状況は、1 つのレスポンスボディ内で返されます。各サブ要求は、レート制限にカウントされます。
Chatter リソース
Chatter フィード、グループ、およびユーザリソースのディレクトリ。
Comments リソース
コメントの情報取得、編集、削除、またはコメントへのいいね! を行います。コンテキストユーザがコメン
トを編集できるかどうかを判別します。
Communities リソース
コンテキストユーザが使用できるコミュニティに関する情報、または特定のコミュニティに関する情報。
Communities Moderation リソース
ユーザがフィード要素、コメント、またはファイルに不適切フラグを設定したかどうかに関する情報。フ
ラグの削除にも使用されます。
Connect リソース
コンテキストユーザの組織と設定に関する情報、およびコンテキストユーザがメンバーであるコミュニティ
に関する情報。
Dashboard Component Snapshot リソース
ダッシュボードコンポーネントのスナップショット。
Datacloud リソース
Data.com の取引先責任者または会社を購入するために使用する Datacloud リソースに関する情報。
138
Chatter REST API リソース
Feed Elements リソース
フィード要素に関する情報。フィード要素へのアクセス、フィード要素の編集、投稿、検索、削除を行い
ます。バンドルやそのフィード要素など、フィード要素の機能にアクセスします。
Feed Items リソース
フィード項目に関する情報。フィード項目のアクセス、検索、削除、ブックマーク、いいね! を行います。
コメントのアクセスと投稿、アンケートのアクセスと投票、トピックのアクセス、追加、削除を行います。
Feed リソース
フィードは、フィード項目で構成されます。さまざまなフィード種別があります。フィード種別ごとに、
どのフィード項目を含むかを決めるアルゴリズムがあります。
Files Connect Repository リソース
Files Connect リポジトリは、Salesforce に接続している外部コンテンツリポジトリです。これらのリソースを
使用して、リポジトリのリストの取得、リポジトリまたはリポジトリファイルに関する情報の取得、リポ
ジトリファイルのコンテンツの取得を行います。また、リポジトリフォルダ内のファイルとフォルダに関
する情報の取得にもこれらのリソースを使用します。
Files リソース
コンテンツ、表示されているバージョン、共有など、ファイルに関する情報。
Folders リソース
フォルダまたはフォルダの内容に関する情報。フォルダの変更と削除、フォルダへの項目の追加、および
ルートフォルダの同期を行います。
Groups リソース
グループのメンバー、写真、および組織内のグループなど、グループに関する情報。グループの作成およ
び削除、グループへのメンバーの追加、グループの写真の変更を行います。
Influence リソース
組織のユーザを Chatter での影響度によって分類するために使用するパーセントしきい値のリスト。
Likes リソース
指定されたいいね! に関する情報。いいね! の削除にも使用されます。
Managed Topics リソース
コミュニティの管理トピック。管理トピックのリストを取得します。コミュニティの管理トピックの作成、
削除、または並び替えを行います。
Mentions リソース
フィード項目またはコメントの本文でメンション可能なユーザおよびグループに関する情報。ユーザまた
はグループは、メンションされると通知を受け取ります。
Motifs リソース
小、中、大の一連の motif アイコンの URL を返します。レコードの一連の motif アイコンは、レコードタイプ
によって異なります。motif にはレコードタイプのベース色を含めることもできます。
Push Notifications リソース
モバイル転送通知をユーザのデバイスの接続アプリケーションに送信します。受信者の接続アプリケーショ
ンと同じ組織で開発された、または同じパッケージにインストールされた接続アプリケーションでセッショ
ンが確立されている場合にのみこのリソースにアクセスできます。
139
Chatter REST API リソース
Action Links リソース
Question and Answers Suggestions リソース
質問および回答の提案を取得します。
おすすめ定義リソース
おすすめ定義を使用すると、コミュニティに表示されるカスタムおすすめを作成して、ユーザに動画の閲
覧やトレーニングの受講などを促すことができます。これらのリソースは、おすすめ定義の情報取得、作
成、変更、削除に使用します。また、おすすめ定義の写真の情報取得、アップロード、変更、および削除
にも使用します。
Records リソース
レコードをフォローしている人に関する情報を取得します。レコードに対するトピックの追加や削除を行
います。
スケジュール済みおすすめリソース
スケジュール済みおすすめに関する情報の取得、スケジュール済みおすすめの作成、変更、削除を行いま
す。
Subscriptions リソース
指定された登録に関する情報。登録の削除 (レコードまたはトピックのフォロー解除など) にも使用されま
す。
Topics リソース
組織のトピックのリスト、指定されたテキスト文字列、フィード項目、またはレコードの推奨トピックの
リスト、組織のトピックのトレンドのリスト、指定されたトピックに関する情報、指定されたトピックの
支持、指定されたトピックに最近投稿されたファイルに関する情報、指定されたトピックに最近投稿した
グループに関する情報、指定されたトピックに関する知識のあるユーザ、および指定されたトピックに関
連するトピックのリスト。
User Profiles リソース
ユーザのプロファイルに関する詳細を返します。このユーザプロファイルデータが、プロファイルページ
(Chatter プロファイルページとも呼ばれる) に入力されます。このデータには、ユーザ情報 (住所、マネー
ジャ、電話番号など)、一部のユーザ機能 (権限)、および一連のサブタブアプリケーション (プロファイル
ページのカスタムタブ) が含まれます。
Users リソース
ユーザをフォローしている人、ユーザのファイルやおすすめなど、ユーザに関する情報。フィード項目の
post 送信と会話状況の更新にも使用されます。
Zones リソース
Chatter アンサーゾーンに関する情報。
Action Links リソース
アクションリンクは、フィード要素上のボタンです。アクションリンクをクリックすると、ユーザを特定の
Web ページに移動したり、ファイルダウンロードを開始したり、Salesforce または外部サーバへの API コールを
呼び出したりできます。アクションリンクには、URL と HTTP メソッドが含まれ、リクエストボディとヘッダー
情報 (認証用の OAuth トークンなど) を含めることができます。アクションリンクを使用して Salesforce および
サードパーティサービスをフィードに統合することで、ユーザはアクションを実行して生産性を高め、イノ
ベーションを促進できます。
140
Chatter REST API リソース
Action Link Group Definitions
アクションリンクとアクションリンクグループには、定義ビューとコンテキストユーザビューという 2 つの
ビューがあります。定義には、認証情報などの機密情報が含まれる可能性があります。コンテキストユーザ
ビューは、表示オプションによって絞り込まれ、コンテキストユーザの状態が値に反映されます。
使用可能なリソース:
リソース
説明
/connect/action-link-group-definitions
アクションリンクグループ定義を作成します。アク
ションリンクをフィード要素に関連付けるには、まず
アクションリンクグループ定義を作成します。次に、
関連付けられたアクション機能を含むフィード要素を
投稿します。
/connect/action-link-group-definitions
/actionLinkGroupId
アクションリンクグループ定義の情報取得や削除を行
います。アクションリンクグループ定義を削除する
と、その定義へのすべての参照がフィード要素から削
除されます。アクションリンクグループ定義の取得や
削除を行うには、クライアントは定義を作成した接続
アプリケーションと同じである必要があり、ユーザは
定義を作成したか「すべてのデータの参照」権限を
持っている必要があります。
/connect/action-link-groups/actionLinkGroupId コンテキストユーザの状態を含む、アクションリンク
グループに関する情報を取得します。
/connect/action-links/actionLinkId
アクションリンクの status の情報取得や更新を行い
ます。アクションリンクの status と Action Link
Definition Input の labelKey プロパティの組み合わせ
により、UI に表示されるテキストが決まります。Api
および ApiAsync アクションリンクの API 要求をトリ
ガするには、status を PendingStatus に設定しま
す。
/connect/action-links/actionLinkId
/diagnostic-info
アクションリンクが実行されたときに返された診断情
報を取得します。診断情報は、アクションリンクにア
クセスできるユーザに対してのみ提供されます。
関連トピック:
アクションリンクの使用
アクションリンクを定義し、フィード要素を使用して投稿する
Action Link Group Definitions
アクションリンクグループ定義を作成します。アクションリンクをフィード要素に関連付けるには、まずアク
ションリンクグループ定義を作成します。次に、関連付けられたアクション機能を含むフィード要素を投稿し
ます。
141
Chatter REST API リソース
Action Link Group Definitions
すべてのアクションリンクはグループに属している必要があります。1 つのグループ内のアクションリンク
は、相互排他的で、同じプロパティを共有します。各自のアクショングループでスタンドアロンアクションを
定義します。
この画像は、[ダウンロード] と [注文] という 2 つのアクションリンクを含む 1 つのアクションリンクグループ
があるフィード要素を示しています。
リソース
/connect/action-link-group-definitions
/connect/communities/communityId/action-link-group-definitions
適用開始バージョン
33.0
Chatter が必要かどうか
いいえ
HTTP メソッド
POST
Action Link Group Definitions リソースは、POST のクエリパラメータをサポートしていません。Action Link Group
Definition Input リクエストボディを使用する必要があります。
POST のリクエストボディ
Action Link Group Definition Input
POST のレスポンスボディ
Action Link Group Definition
POST の例
アクションリンクグループをフィード項目に関連付けるには、まずアクションリンクグループ定義を作成
します。
142
Chatter REST API リソース
Action Link Group Definitions
メモ: Salesforce リソースへの actionUrl は、相対リンクにすることができます。他のすべてのリンク
は、https:// で始まる絶対リンクにする必要があります。
POST /connect/action-link-group-definitions
{
"actionLinks": [
{
"actionType" : "Api",
"actionUrl" : "https://www.example.com/api/v1/cofirm",
"groupDefault" : "true",
"headers" : [
{
"name" : "Authorization",
"value" : "OAuth 00DRR0000000N0g!ARoAQMZyQtsP1Gs27EZ8hl7vdpYXH5O5rv1
VNprqTeD12xYnvygD3JgPnNR._nmE6thZakAbBVJUsjUInMUaKMlkNKaWXdHO"
},
{
"name" : "Content-Type",
"value" : "application/json"
},
{
"name" : "Accept",
"value" : "application/json"
},
{
"name" : "X-PrettyPrint",
"value" : "1"
}
143
Chatter REST API リソース
Action Link Group Definitions
],
"labelKey" : "Confirm",
"method" : "HttpPost",
"requiresConfirmation" : "true"
},
{
"actionType" : "Api",
"actionUrl" : "https://www.example.com/api/v1/deny",
"groupDefault"
: "false",
"headers" : [
{
"name" : "Authorization",
"value" : "OAuth 00DRR0000000N0g!ARoAQMZyQtsP1Gs27EZ8hl7vdpYXH5O5rv1
VNprqTeD12xYnvygD3JgPnNR._nmE6thZakAbBVJUsjUInMUaKMlkNKaWXdHO"
},
{
"name" : "Content-Type",
"value" : "application/json"
},
{
"name" : "Accept",
"value" : "application/json"
},
{
"name" : "X-PrettyPrint",
"value" : "1"
}
144
Chatter REST API リソース
Action Link Group Definitions
],
"labelKey": "Deny",
"method" : "HttpPost",
"requiresConfirmation"
: "true"
},
{
"actionType": "Ui",
"actionUrl" : "https://www.example.com/reviewPage.html",
"groupDefault" : "false",
"labelKey" : "Review",
"method" : "HttpGet",
"requiresConfirmation" : "false"
},
"executionsAllowed" : "OncePerUser",
"category" : "Primary",
"expirationDate" :
"2014-05-09T18:45:39.000Z"
}
次に、アクションリンクグループをフィード項目に関連付けて、フィード項目を post 送信しま
す。/connect/action-link-group-definitions 応答からアクションリンクグループ ID を取得し、POST
要求で /chatter/feed-elements に渡します。
POST
/chatter/feed-elements
{
"body": {
"messageSegments": [
{
"type": "Text",
"text": "Please confirm or deny this item. You can also click Review to provide
145
Chatter REST API リソース
Action Link Group Definition
more feedback."
}
]
},
"subjectId": "me",
"feedElementType": "FeedItem",
"capabilities": {
"associatedActions": {
"actionLinkGroupIds": ["0AgRR0000004CTr0AM"]
}
}
}
さまざまな種別のアクションリンクのさまざまなワークフローで status プロパティが設定されます。値
は UI に表示されます。詳細は、/connect/action-links/actionLinkIdを参照してください。
メモ: この例では、他の機能は含まれていませんが、アクションリンクのあるフィード項目では、コ
ンテンツ、アンケート、リンクなど、他の機能がサポートされます。
関連トピック:
アクションリンクを定義し、フィード要素を使用して投稿する
アクションリンクテンプレート
アクションリンクを定義し、フィード要素を使用して投稿する
テンプレートのアクションリンクを定義し、フィード要素を使用して投稿する
Action Link Group Definition
アクションリンクグループ定義の情報取得や削除を行います。アクションリンクグループ定義を削除すると、
その定義へのすべての参照がフィード要素から削除されます。アクションリンクグループ定義の取得や削除を
行うには、クライアントは定義を作成した接続アプリケーションと同じである必要があり、ユーザは定義を作
成したか「すべてのデータの参照」権限を持っている必要があります。
リソース
/connect/action-link-group-definitions/actionLinkGroupId
/connect/communities/communityId/action-link-group-definitions/actionLinkGroupId
適用開始バージョン
33.0
146
Chatter REST API リソース
Action Link Group
Chatter が必要かどうか
いいえ
HTTP メソッド
GET、DELETE、HEAD
GET のレスポンスボディ
Action Link Group Definition
DELETE のレスポンスボディ
204: DELETE が成功しました
Action Link Group
コンテキストユーザの状態を含む、アクションリンクグループに関する情報を取得します。
すべてのアクションリンクはグループに属している必要があります。1 つのグループ内のアクションリンク
は、相互排他的で、同じプロパティを共有します。アクションリンクグループ定義とは異なり、アクションリ
ンクグループは、クライアントからアクセスできます。
リソース
/connect/action-link-groups/actionLinkGroupId
/connect/communities/communityId/action-link-groups/actionLinkGroupId
適用開始バージョン
33.0
Chatter が必要かどうか
いいえ
HTTP メソッド
GET、HEAD
GET のレスポンスボディ
Platform Action Group
Action Link
アクションリンクの status の情報取得や更新を行います。アクションリンクの status と Action Link Definition
Input の labelKey プロパティの組み合わせにより、UI に表示されるテキストが決まります。Api および
ApiAsync アクションリンクの API 要求をトリガするには、status を PendingStatus に設定します。
この画像には 2 つのアクションリンクがあります。この画像では、両方のアクションリンクの status が
NewStatus です。
147
Chatter REST API リソース
Action Link
Pam Smith が [確認] をクリックすると、アクションリンク status が SuccessfulStatus に設定され、その結
果、この画像のフィード項目が表示されます。
さまざまな種別のアクションリンクには、さまざまな status ワークフローを指定できます。
Api
アプリケーションから Api アクションリンクを呼び出すには、PATCH 要求を実行してリンクを
PendingStatus としてマークします。Salesforce により、Action Link Definition Input で指定された actionUrl
へのコールアウトが処理されます。Api アクションリンクの場合、Salesforce がサーバから返された HTTP 状
況コードに基づいて status を SuccessfulStatus または FailedStatus に設定します。
ApiAsync
アプリケーションからこのアクションリンクを呼び出すには、PATCH 要求を実行してリンクを
PendingStatus としてマークします。Salesforce により、Action Link Definition Input で指定された actionUrl
へのコールアウトが処理されます。ApiAsync アクションリンクの場合、コールアウトによってサーバで
148
Chatter REST API リソース
Action Link
の非同期操作が開始されます。Salesforce により status が PendingStatus に設定されます。ただし、コー
ルでエラー状況コードが返された場合は、status は FailedStatus に設定されます。非同期処理を終了
したサーバは、アクションリンクをコールバックし、PATCH を実行してアクションリンクを
SuccessfulStatus または FailedStatus に設定します。
Download と Ui
Platform Action レスポンスボディの actionUrl のリンクから、ユーザにダウンロードや UI アクセスを行わ
せます。PATCH 要求を実行して status を SuccessfulStatus または FailedStatus に設定する時期は、
アプリケーションで決定する必要があります。
メモ: 次の場合、アクションリンクの status に対する PATCH 要求はできません。
• 別の status から NewStatus に戻す。
• 最終的な status (FailedStatus または SuccessfulStatus) から NewStatus または PendingStatus
に変更する。
• アクションリンクが属するアクションリンクグループの executionsAllowed プロパティが Unlimited
である。
• Api または ApiAsync アクションリンクの executionsAllowed プロパティが Once の場合、ユーザ
が初めて PATCH を実行して status を PendingStatus に設定すると、アクションリンクへのコール
アウトが行われます。同じユーザが PATCH を実行して状況を PendingStatus に再度設定すると、
Salesforce から現在のアクションリンクの情報が返されます。ただし、別のユーザが PATCH を実行して
状況を PendingStatus に設定すると、エラーが発生します。いずれの場合も、アクションリンクへ
のコールアウトは再送信されません。
リソース
/connect/action-links/actionLinkId
/connect/communities/communityId/action-links/actionLinkId
適用開始バージョン
33.0
Chatter が必要かどうか
いいえ
HTTP メソッド
GET、PATCH、HEAD
PATCH のリクエストボディ
ルート XML タグ
<actionLink>
JSON の例
{
"status" : "SuccessfulStatus"
}
149
Chatter REST API リソース
Action Link
プロパティ
名前
型
説明
必須項目/省略
可能
status
String
アクションの現在の実行状況。値 必須項目
は次のとおりです。
使用可能なバー
ジョン
33.0
• FailedStatus — アクション
リンクの実行に失敗しまし
た。
• NewStatus — アクションリ
ンクの実行の準備が整ってい
ます。Download および Ui
アクションリンクでのみ使用
できます。
• PendingStatus — アクショ
ンリンクが実行されていま
す。この値を選択すると、
Api および ApiAsync アク
ションリンクの API コールが
トリガされます。
• SuccessfulStatus — アク
ションリンクが正常に実行さ
れました。
PATCH の要求パラメータ
名前
型
説明
使用可能なバージョン
status
String
値は次のとおりです。
33.0
• FailedStatus — ア
クションリンクの実行
に失敗しました。
• NewStatus — アク
ションリンクの実行の
準備が整っています。
Download および Ui
アクションリンクでの
み使用できます。
• PendingStatus — ア
クションリンクが実行
されています。この値
を選択すると、Api お
150
Chatter REST API リソース
名前
Action Link Diagnostic Information
型
説明
使用可能なバージョン
よび ApiAsync アク
ションリンクの API
コールがトリガされま
す。
• SuccessfulStatus
— アクションリンク
が正常に実行されまし
た。
GET または PATCH のレスポンスボディ
Platform Action
PATCH の例
PATCH /connect/action-links/0AnRR0000004CTS0A2?status=FailedStatus
Action Link Diagnostic Information
アクションリンクが実行されたときに返された診断情報を取得します。診断情報は、アクションリンクにアク
セスできるユーザに対してのみ提供されます。
リソース
/connect/action-links/actionLinkId/diagnostic-info
/connect/communities/communityId/action-links/actionLinkId/diagnostic-info
使用可能なバージョン
33.0
Chatter が必要かどうか
いいえ
HTTP メソッド
GET、HEAD
レスポンスボディ
Action Link Diagnostic
Announcements リソース
お知らせに関する情報。既存のお知らせの表示期限の情報取得や更新を行います。お知らせは、削除される
か、別のお知らせで置き換えられない限り、その表示期限の 11:59 p.m. まで Salesforce UI の指定の場所に表示さ
れます。
お知らせは、情報を強調表示するために使用します。ユーザは、グループフィードのお知らせに対するディス
カッション、いいね!、コメントの投稿ができます。他の投稿と同様に、お知らせが投稿されると、グループ
151
Chatter REST API リソース
Announcements リソース
メンバーは選択したグループメール通知頻度に応じてメール通知を受信します。フィード投稿を削除するとお
知らせが削除されます。
次のSalesforceの画像では、お知らせが黄色で表示されています。お知らせを作成すると、お知らせのテキスト
を含むフィード項目も作成されます。これもこの画像で確認できます。
グループにお知らせを投稿したり、グループ内のすべてのお知らせに関する情報を取得したりするには、Group
Announcements リソース (/chatter/groups/groupId/announcements) を使用します。
リソース
/chatter/announcements/announcementId
/connect/communities/communityId/chatter/announcements/announcementId
適用開始バージョン
31.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、PATCH、DELETE、HEAD
PATCH の要求パラメータ
パラメータ名
値
説明
必須項目/省略可能
expirationDate
Date
別のお知らせが最初 必須項目
に投稿されていない
限り、この日付の
11:59 p.m. まで
152
使用可能なバージョ
ン
31.0
Chatter REST API リソース
パラメータ名
Batch リソース
値
説明
必須項目/省略可能
使用可能なバージョ
ン
Salesforce UI にお知ら
せが表示されます。
Salesforce UI では、
expirationDate
の時間値は無視され
ます。ただし、時間
値を使用して各自の
UI で独自の表示ロ
ジックを作成するこ
とはできます。
GET、PATCH のレスポンスボディ
Announcement
DELETE のレスポンスボディ
HTTP 状況コード 204
Batch リソース
最大 25 個のサブ要求から成るバッチを含むリクエストボディを作成し、1 つの要求としてサーバに送信して、
アプリケーションのパフォーマンスを向上させます。バッチ内の各サブ要求のレスポンスボディと HTTP 状況
は、1 つのレスポンスボディ内で返されます。各サブ要求は、レート制限にカウントされます。
このリソースは、クライアントとサーバ間の往復回数を最小限に抑えるために作成します。たとえば、モバイ
ルアプリケーションで、ユーザがフィード項目にいいね! と言うためにボタンをタップすると、レスポンスボ
ディにはいいね! に関する情報が含まれますが、フィード項目に対するいいね! の総数は含まれません。フィー
ド項目にいいね! と言うには、POST で要求を
/chatter/feed-elements/feedElementId/capabilities/chatter-likes/items に送信します。いい
ね! の合計を取得するには、GET で
/chatter/feed-elements/feedElementId/capabilities/chatter-likes/items からフィード項目情
報を取得します。
次のように、両方の要求を Generic Batch Collection Input リクエストボディに追加し、1 つの POST 要求で両方を
/connect/batch に送信します。
{
"batchRequests" : [
{
"method" : "Post",
"url" : "/v34.0/chatter/feed-elements/feedElementId/capabilities/chatter-likes/items"
153
Chatter REST API リソース
Batch リソース
},
{
"method" : "Get",
"url" : "/v34.0/chatter/feed-elements/feedElementId/capabilities/chatter-likes/items"
}
],
"haltOnError" : "false"
}
バッチ内の各要求はサブ要求と呼ばれます。サブ要求はすべて同じユーザのコンテキスト内で実行されます。
各サブ要求は独立しており、相互に情報を渡すことはできません。サブ要求は、リクエストボディ内の順序に
従って実行されます。サブ要求が正常に実行されると、データがコミットされます。コミットは、以降のサブ
要求の出力に反映されます (前の例のように、フィード項目にいいね! と言ってから、いいね! の総数を取得す
るなど)。サブ要求が失敗した場合、前のサブ要求で行われたコミットはロールバックされません。
リソース
/connect/batch
適用開始バージョン
28.0
Chatter が必要かどうか
いいえ
HTTP メソッド
POST
リクエストボディ
Generic Batch Collection Input
ルート XML タグ
<batch>
JSON
{
"batchRequests" : [
{
"method" : "Get",
"url" : "/v34.0/chatter/feeds/news/me"
},
154
Chatter REST API リソース
Batch リソース
{
"method" : "Get",
"url" : "/v34.0/chatter/feeds/user-profile/me"
}
]
}
プロパティ
名前
型
説明
batchRequests
Generic Batch Input[]
実行するサブ要求の URL を含む、Batch 28.0
Request Input リクエストボディのコレ
クション。
haltOnError
Boolean
デフォルト値は、false です。
値が false で、バッチ内のサブ要求
が完了しない場合、Salesforceは、バッ
チ内の後続のサブ要求を実行しようと
試みます。
値が true で、HTTP 応答 400 番台また
は 500 番台のエラーが含まれるために
バッチ内のサブ要求が完了しない場
合、Salesforce は実行を停止します。
バッチ内にある後続のサブ要求の実行
は試みず、後続のサブ要求ごとに HTTP
412 状況コードと前の要求が失敗した
ことを示す
BATCH_PROCESSING_HALTED エラー
メッセージを返しま
す。/connect/batch への最上位要
求は、HTTP 200 を返し、応答内の
hasErrors プロパティが true に設
定されます。
要求パラメータ
なし。
応答
Batch Results
155
使用可能な
バージョン
28.0
Chatter REST API リソース
Batch リソース
例
この単純な例では、https://instance_name/services/data/v34.0/connect/batch に対する POST
要求に、2 つのサブ要求を持つ次のリクエストボディが含まれています。
{
"batchRequests" : [
{
"method" : "Get",
"url" : "/v34.0/chatter/feeds/user-profile/me"
},
{
"method" : "Get",
"url" : "/v34.0/chatter/feeds/news/me"
}
]
}
Batch Results レスポンスボディには、サブ要求ごとに Batch Result Item レスポンスボディが含まれます。
{
"hasErrors": false,
"results": [
{
"result": {
"feedElementPostUrl": "/services/data/v34.0/chatter/feed-elements",
"feedElementsUrl": "/services/data/v34.0/chatter/feeds
/user-profile/005D0000001LL8OIAW/feed-elements",
"isModifiedUrl": null
},
"statusCode": 200
},
156
Chatter REST API リソース
Batch リソース
{
"result": {
"feedElementPostUrl": "/services/data/v34.0/chatter/feed-elements",
"feedElementsUrl": "/services/data/v34.0/chatter/feeds
/news/005D0000001LL8OIAW/feed-elements",
"isModifiedUrl": null
},
"statusCode": 200
}
]
}
例: haltOnError が true の場合
これは前と同じ例ですが、最初のサブ要求にエラーが含まれ、haltOnError が true に設定されていま
す。最初のサブ要求には入力ミスがあります。
{
"batchRequests" : [
{
"method" : "Get",
"url" : "/v34.0/chatter/feeds/user-profile/men"
},
{
"method" : "Get",
"url" : "/v34.0/chatter/feeds/news/me"
}
],
"haltOnError" : "true"
}
Batch Results レスポンスボディには、サブ要求ごとに Batch Result Item レスポンスボディが含まれま
す。/connect/batch への最上位要求は HTTP 200 を返しますが、最初のサブ要求はリソースが見つからな
157
Chatter REST API リソース
Batch リソース
いため HTTP 404 を返します。haltOnError が true であるため、次のサブ要求は HTTP 412 を返します。ま
た、hasErrors は true に設定されています。
{
"hasErrors": true,
"results": [
{
"result": [{
"errorCode": "NOT_FOUND",
"message": "The requested resource does not exist"
}],
"statusCode": 404
},
{
"result": [{
"errorCode": "BATCH_PROCESSING_HALTED",
"message": "Batch processing halted per request"
}],
"statusCode": 412
}
]
}
バイナリファイルを含む複数のコメントの投稿
この例は、2 つのサブ要求が含まれる https://instance_name/services/data/v34.0/connect/batch
への汎用バッチ要求です。各サブ要求はフィード項目にコメントし、バイナリファイルをコメントにアッ
プロードします。
richInput プロパティには、各サブ要求のリクエストボディを含める必要があります。
また、binaryPartName および binaryPartNameAlias プロパティには、バイナリパートに関する情報
を含める必要もあります。
次に cURL の例を示します。
curl -H "X-PrettyPrint: 1" -F 'json={ "haltOnError":true, "batchRequests":[ {
"url":"/v33.0/chatter/feed-elements/0D5D0000000YG0N/capabilities/comments/items",
158
Chatter REST API リソース
Batch リソース
"method":"Post", "binaryPartName":"binaryPart1",
"binaryPartNameAlias":"feedElementFileUpload", "richInput":{ "body":{ "messageSegments":[
{ "type":"Text", "text":"Check out this file, it may help." } ] },
"capabilities":{ "content":{ "title":"Presentation1.txt" } } } }, {
"url":"/v33.0/chatter/feed-elements/0D5D0000000YG0M/capabilities/comments/items",
"method":"Post", "binaryPartName":"binaryPart2",
"binaryPartNameAlias":"feedElementFileUpload", "richInput":{ "body":{ "messageSegments":[
{ "type":"Text", "text":"Check out this file, it may help." } ] },
"capabilities":{ "content":{ "title":"Presentation2.txt" } } } } ]
};type=application/json' -F
"binaryPart1=@/Users/jbleyle/Desktop/Presentation1.txt;type=application/octet-stream"
-F "binaryPart2=@/Users/jbleyle/Desktop/Presentation2.txt;type=application/octet-stream"
-X POST https://instance_name/services/data/v34.0/connect/batch
-H 'Authorization: OAuth 00DD00000007HoR!...' --insecure
これは、マルチパート/フォームデータリクエストボディです。
https://instance_name/services/data/v34.0/connect/batch
Authorization: OAuth 00DD0000000Jhd2!...
Accept: application/json
Host: instance_name
Content-Type: multipart/form-data; boundary=123123
--123123
Content-Disposition: form-data; name="json"
Content-Type: application/json
{
"haltOnError":true,
"batchRequests":[
159
Chatter REST API リソース
Batch リソース
{
"url":"/v34.0/chatter/feed-elements/0D5D0000000YG0D/capabilities/comments/items",
"method":"Post",
"binaryPartName":"binaryPart1",
"binaryPartNameAlias":"feedElementFileUpload",
"richInput":{
"body":{
"messageSegments":[
{
"type":"Text",
"text":"Check out this file, it may help."
}
]
},
"capabilities":{
"content":{
"title":"Presentation1.txt"
}
}
}
},
{
"url":"/v34.0/chatter/feed-elements/0D5D0000000YG0H/capabilities/comments/items",
"method":"Post",
"binaryPartName":"binaryPart2",
"binaryPartNameAlias":"feedElementFileUpload",
160
Chatter REST API リソース
Batch リソース
"richInput":{
"body":{
"messageSegments":[
{
"type":"Text",
"text":"Check out this file, it may help."
}
]
},
"capabilities":{
"content":{
"title":"Presentation2.txt"
}
}
}
}
]
}
--123123
Content-Disposition: form-data; name="binaryPart1"; filename="Presentation1.txt"
Content-Type: application/octet-stream; charset=ISO-8859-1
Content-Transfer-Encoding: binary
This is the content of file 1
--123123
161
Chatter REST API リソース
Chatter リソース
Content-Disposition: form-data; name="binaryPart2"; filename="Presentation2.txt"
Content-Type: application/octet-stream; charset=ISO-8859-1
Content-Transfer-Encoding: binary
This is the content of file 2
--123123--
関連トピック:
フィード項目にいいね! と言い、いいね! の総数を返す
Feed Elements, Batch Post
Chatter リソース
Chatter フィード、グループ、およびユーザリソースのディレクトリ。
リソース
/chatter
/connect/communities/communityId/chatter
適用開始バージョン
23.0
Chatter が必要かどうか
いいえ
HTTP メソッド
GET または HEAD
レスポンスボディ
Chatter Directory
レスポンスボディの例
{
"feeds": "/services/data/v34.0/chatter/feeds",
"groups": "/services/data/v34.0/chatter/groups",
"users": "/services/data/v34.0/chatter/users"
}
162
Chatter REST API リソース
Comments リソース
Comments リソース
コメントの情報取得、編集、削除、またはコメントへのいいね! を行います。コンテキストユーザがコメント
を編集できるかどうかを判別します。
使用可能なリソース:
リソース
説明
/chatter/comments/commentId
コメントの情報取得、編集、または削除を行います。
/chatter/comments/commentId/capabilities
/edit/is-editable-by-me
コンテキストユーザがコメントを編集できるかどうか
を判別します。
/chatter/comments/commentId/likes
コメントへのいいね! に関する情報を取得します。コ
メントへのいいね! にも使用されます。
Comment
コメントの情報取得、編集、または削除を行います。
リソース
/chatter/comments/commentId
/connect/communities/communityId/chatter/comments/commentId
適用開始バージョン
23.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、DELETE、PATCH
PATCH はバージョン 34.0 以降でサポートされます。
PATCH のリクエストボディ
ルート XML タグ
<comment>
プロパティ
名前
型
説明
使用可能な
バージョン
attachment
種別によって異なる。
省略可能。値は次のとおりです。
24.0 ～ 31.0
• Attachment Input: Existing Content
• Attachment Input: New File Upload
163
Chatter REST API リソース
名前
Comments リソース
型
説明
使用可能な
バージョン
重要: バージョン 32.0 以降では、
capabilities プロパティを使
用します。
body
Message Body Input
メッセージ本文の説明
23.0
capabilities
Comment Capabilities Input
添付ファイルなど、コメントの機能。 32.0
GET および PATCH のレスポンスボディ
Comment
例
ニュースフィードやレコードフィードなど、任意のフィードからの特定のコメントの ID を検索できます。
コメントに関する情報を返すには、次のリソースと HTTP GET メソッドを使用します。
/chatter/comments/0D7D00000000NtkKAE
Comment Capability, Editability
コンテキストユーザがコメントを編集できるかどうかを判別します。
リソース
/chatter/comments/commentId/capabilities/edit/is-editable-by-me
/connect/communities/communityId/chatter/comments/commentId/capabilities/edit/is-editable-by-me
適用開始バージョン
34.0
Chatter が必要かどうか
はい
HTTP メソッド
GET
GET のレスポンスボディ
Feed Entity Is Editable
Comment Likes
コメントへのいいね! に関する情報を取得します。コメントへのいいね! にも使用されます。
リソース
/chatter/comments/commentId/likes
/connect/communities/communityId/chatter/comments/commentId/likes
164
Chatter REST API リソース
Communities リソース
適用開始バージョン
23.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、POST、または HEAD
GET または HEAD の要求パラメータ
メモ: POST は、要求パラメータもリクエストボディも取りません。
パラメータ名
型
説明
page
Integer
返すページのページ番号を指定し
ます。
pageSize
Integer
ページあたりの項目数を指定しま
す。有効な値は 1 ～ 100 です。サ
イズを指定しない場合、デフォル
トは 25 です。
GET のレスポンスボディ
Like Page
POST のレスポンスボディ
Like
Communities リソース
コンテキストユーザが使用できるコミュニティに関する情報、または特定のコミュニティに関する情報。
次のリソースを使用できます。
リソース
説明
/connect/communities
コンテキストユーザが使用できるすべてのコミュニ
ティリストを返します。
/connect/communities/communityId
指定されたコミュニティに関する情報を返します。
List of Communities
コンテキストユーザが使用できるすべてのコミュニティリストを返します。ユーザがシステム管理者の場合、
絞り込み条件を満たすコミュニティすべてのリストを返します。ユーザがシステム管理者ではない場合、絞り
込み条件を満たす有効なコミュニティすべてのリストを返します。
165
Chatter REST API リソース
Communities リソース
リソース
/connect/communities
適用開始バージョン
28.0
Chatter が必要かどうか
いいえ
HTTP メソッド
GET または HEAD
要求パラメータ
名前
型
説明
status
String
28.0
特定の状況のコミュニ
ティのみを返します。有
効な値は、次のとおりで
す。
• Live
• Inactive
• UnderConstruction
「ネットワークの管理」
権限が有効化されている
ユーザのみが、
Inactive 状況のコミュ
ニティを表示できます。
このパラメータは省略可
能です。
レスポンスボディ
Community Page
Community Information
指定されたコミュニティに関する情報を返します。
リソース
/connect/communities/communityId
166
使用可能なバージョン
Chatter REST API リソース
Communities Moderation リソース
指定されたコミュニティの一部であるリソースにアクセスするには、URL のバージョン情報の後、アクセス
するリソースの前にこのセグメントを挿入します。たとえば、コミュニティの News Feed リソースにアクセ
スするには、次の URL を使用します。
https://instance_name/services/data/v34.0/connect
/communities/communityId/chatter/feeds/news/me/feed-elements
詳細は、「Chatter REST API リソース URL の作成」 (ページ 5)を参照してください。
適用開始バージョン
26.0
Chatter が必要かどうか
いいえ
HTTP メソッド
GET または HEAD
レスポンスボディ
Community
Communities Moderation リソース
ユーザがフィード要素、コメント、またはファイルに不適切フラグを設定したかどうかに関する情報。フラグ
の削除にも使用されます。
次のリソースを使用できます。
リソース
説明
/connect/communities/communityId/
chatter/feed-elements/feedElementId/
capabilities/moderation
フィード要素のモデレーション機能に関する情報の取
得、フィード要素へのモデレーションフラグの追加、
またはフィード要素のすべてのモデレーションフラグ
の削除を行います。
/connect/communities/communityId/
コンテキストユーザがコミュニティモデレータの場
chatter/comments/commentId/moderation-flags 合、コミュニティメンバーが 1 つのコメントにフラグ
を設定した回数を返します。また、モデレーションの
ためにコメントにフラグを設定したり、コメントのす
べてのフラグを削除したりします。
コンテキストユーザがコミュニティモデレータでない
場合は、ユーザがコメントにフラグを設定したかどう
かを返します。また、モデレーションのためにコメン
トにフラグを設定したり、ユーザが以前に追加したフ
ラグを削除したりします。
167
Chatter REST API リソース
Communities Moderation リソース
リソース
説明
/connect/communities/communityId/
chatter/files/moderation
コミュニティでフラグが設定されたファイル。
/connect/communities/communityId/
chatter/files/fileId/moderation-flags
コンテキストユーザがコミュニティモデレータの場
合、コミュニティメンバーが 1 つのファイルにフラグ
を設定した回数を返します。また、モデレーションの
ためにファイルにフラグを設定したり、ファイルのす
べてのフラグを削除したりします。
コンテキストユーザがコミュニティモデレータの場
合、コミュニティメンバーによってフラグが設定され
たファイルを返します。
コンテキストユーザがコミュニティモデレータでない
場合は、ユーザがファイルにフラグを設定したかどう
かを返します。また、モデレーションのためにファイ
ルにフラグを設定したり、ユーザが以前に追加したフ
ラグを削除したりします。
Moderation Flags on Posts
コンテキストユーザが「コミュニティフィードのモデレート」権限を持つコミュニティモデレータの場合、コ
ミュニティメンバーが 1 つの投稿にフラグを設定した回数を返します。また、モデレーションのために投稿に
フラグを設定したり、投稿のすべてのフラグを削除したりします。
コンテキストユーザがコミュニティモデレータでない場合は、ユーザが投稿にフラグを設定したかどうかを返
します。また、モデレーションのために投稿にフラグを設定したり、ユーザが以前に追加したフラグを削除し
たりします。
リソース
/connect/communities/communityId/chatter/feed-items/feedItemId/moderation-flags
使用可能なバージョン
29.0 ～ 31.0
重要: バージョン 32.0 以降では、Feed Elements Capability, Moderation を使用します。
Chatter が必要かどうか
はい
HTTP メソッド
GET、DELETE、HEAD、POST
168
Chatter REST API リソース
Communities Moderation リソース
GET の要求パラメータ
名前
型
説明
必須項目/ 使用可能な
省略可能 バージョン
visibility
String
さまざまなユーザ種別でのフラグの表示動作を指定し 省略可能
ます。
30.0 ～ 31.0
• ModeratorsOnly — フラグは、フラグが付けられ
た要素または項目に対するモデレーション権限を
持つユーザにのみ表示されます。
• SelfAndModerators — フラグは、フラグの作成
者とフラグが付けられた要素または項目に対する
モデレーション権限を持つユーザに表示されます。
POST のリクエストボディ
ルート XML タグ
<moderationFlag>
JSON
{
"visibility" : "ModeratorsOnly"
}
プロパティ
名前
型
説明
visibility
String
さまざまなユーザ種別でのフラグの表示動 30.0
作を指定します。
• ModeratorsOnly — フラグは、フラグ
が付けられた要素または項目に対する
モデレーション権限を持つユーザにの
み表示されます。
• SelfAndModerators — フラグは、フ
ラグの作成者とフラグが付けられた要
素または項目に対するモデレーション
権限を持つユーザに表示されます。
169
使用可能なバー
ジョン
Chatter REST API リソース
Communities Moderation リソース
POST の要求パラメータ
名前
型
説明
必須項目/ 使用可能な
省略可能 バージョン
visibility
String
さまざまなユーザ種別でのフラグの表示動作を指定し 省略可能
ます。
30.0 ～ 31.0
• ModeratorsOnly — フラグは、フラグが付けられ
た要素または項目に対するモデレーション権限を
持つユーザにのみ表示されます。
• SelfAndModerators — フラグは、フラグの作成
者とフラグが付けられた要素または項目に対する
モデレーション権限を持つユーザに表示されます。
DELETE の要求パラメータ
名前
型
説明
必須項目/省略可 使用
能
可能
な
バー
ジョ
ン
userId
String
コンテキストユーザの ID。指定されている場合、ユー 省略可能
ザが以前に投稿に追加したフラグが削除されます。指
定されておらず、コンテキストユーザがコミュニティ
モデレータの場合は、投稿のすべてのフラグが削除さ
れます。
29.0
～
31.0
GET および POST のレスポンスボディ
Moderation Flags
Moderation Flags on Comments
コンテキストユーザがコミュニティモデレータの場合、コミュニティメンバーが 1 つのコメントにフラグを設
定した回数を返します。また、モデレーションのためにコメントにフラグを設定したり、コメントのすべての
フラグを削除したりします。
コンテキストユーザがコミュニティモデレータでない場合は、ユーザがコメントにフラグを設定したかどうか
を返します。また、モデレーションのためにコメントにフラグを設定したり、ユーザが以前に追加したフラグ
を削除したりします。
リソース
/connect/communities/communityId/chatter/comments/commentId/moderation-flags
170
Chatter REST API リソース
Communities Moderation リソース
適用開始バージョン
29.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、DELETE、HEAD、POST
GET の要求パラメータ
名前
型
説明
必須項目/ 使用可能な
省略可能 バージョン
visibility
String
さまざまなユーザ種別でのフラグの表示動作を指定し 省略可能
ます。
30.0
• ModeratorsOnly — フラグは、フラグが付けられ
た要素または項目に対するモデレーション権限を
持つユーザにのみ表示されます。
• SelfAndModerators — フラグは、フラグの作成
者とフラグが付けられた要素または項目に対する
モデレーション権限を持つユーザに表示されます。
POST のリクエストボディ
ルート XML タグ
<moderationFlag>
JSON
{
"visibility" : "ModeratorsOnly"
}
プロパティ
名前
型
説明
使用可能なバー
ジョン
visibility
String
さまざまなユーザ種別でのフラグの表示動 30.0
作を指定します。
• ModeratorsOnly — フラグは、フラグ
が付けられた要素または項目に対する
モデレーション権限を持つユーザにの
み表示されます。
• SelfAndModerators — フラグは、フ
ラグの作成者とフラグが付けられた要
171
Chatter REST API リソース
Communities Moderation リソース
名前
型
説明
使用可能なバー
ジョン
素または項目に対するモデレーション
権限を持つユーザに表示されます。
POST の要求パラメータ
名前
型
説明
必須項目/ 使用可能な
省略可能 バージョン
visibility
String
さまざまなユーザ種別でのフラグの表示動作を指定し 省略可能
ます。
30.0
• ModeratorsOnly — フラグは、フラグが付けられ
た要素または項目に対するモデレーション権限を
持つユーザにのみ表示されます。
• SelfAndModerators — フラグは、フラグの作成
者とフラグが付けられた要素または項目に対する
モデレーション権限を持つユーザに表示されます。
DELETE の要求パラメータ
名前
型
説明
必須項目/ 使用可能な
省略可能 バージョン
userId
String
コンテキストユーザの ID。指定されている場合、ユー 省略可能
ザが以前にコメントに追加したフラグが削除されま
す。指定されておらず、コンテキストユーザがコミュ
ニティモデレータの場合は、コメントのすべてのフラ
グが削除されます。
29.0
GET および POST のレスポンスボディ
Moderation Flags
Moderation Flags on Files
コンテキストユーザがコミュニティモデレータの場合、コミュニティメンバーが 1 つのファイルにフラグを設
定した回数を返します。また、モデレーションのためにファイルにフラグを設定したり、ファイルのすべての
フラグを削除したりします。
コンテキストユーザがコミュニティモデレータでない場合は、ユーザがファイルにフラグを設定したかどうか
を返します。また、モデレーションのためにファイルにフラグを設定したり、ユーザが以前に追加したフラグ
を削除したりします。
172
Chatter REST API リソース
Communities Moderation リソース
リソース
/connect/communities/communityId/chatter/files/fileId/moderation-flags
適用開始バージョン
30.0
Chatter が必要かどうか
いいえ
HTTP メソッド
GET、DELETE、HEAD、POST
GET の要求パラメータ
名前
型
説明
必須項目/ 使用可能な
省略可能 バージョン
visibility
String
さまざまなユーザ種別でのフラグの表示動作を指定し 省略可能
ます。
30.0
• ModeratorsOnly — フラグは、フラグが付けられ
た要素または項目に対するモデレーション権限を
持つユーザにのみ表示されます。
• SelfAndModerators — フラグは、フラグの作成
者とフラグが付けられた要素または項目に対する
モデレーション権限を持つユーザに表示されます。
POST のリクエストボディ
ルート XML タグ
<moderationFlag>
JSON
{
"visibility" : "ModeratorsOnly"
}
プロパティ
名前
型
説明
visibility
String
さまざまなユーザ種別でのフラグの表示動 30.0
作を指定します。
• ModeratorsOnly — フラグは、フラグ
が付けられた要素または項目に対する
173
使用可能なバー
ジョン
Chatter REST API リソース
Communities Moderation リソース
名前
型
説明
使用可能なバー
ジョン
モデレーション権限を持つユーザにの
み表示されます。
• SelfAndModerators — フラグは、フ
ラグの作成者とフラグが付けられた要
素または項目に対するモデレーション
権限を持つユーザに表示されます。
POST の要求パラメータ
名前
型
説明
必須項目/ 使用可能な
省略可能 バージョン
visibility
String
さまざまなユーザ種別でのフラグの表示動作を指定し 省略可能
ます。
30.0
• ModeratorsOnly — フラグは、フラグが付けられ
た要素または項目に対するモデレーション権限を
持つユーザにのみ表示されます。
• SelfAndModerators — フラグは、フラグの作成
者とフラグが付けられた要素または項目に対する
モデレーション権限を持つユーザに表示されます。
DELETE の要求パラメータ
名前
型
説明
必須項目/ 使用可能な
省略可能 バージョン
userId
String
コンテキストユーザの ID。指定されている場合、ユー 省略可能
ザが以前にファイルに追加したフラグが削除されま
す。指定されておらず、コンテキストユーザがコミュ
ニティモデレータの場合は、ファイルのすべてのフラ
グが削除されます。
GET および POST のレスポンスボディ
Moderation Flags
Flagged Files
コミュニティでフラグが設定されたファイル。
174
30.0
Chatter REST API リソース
Connect リソース
コンテキストユーザがコミュニティモデレータの場合、コミュニティメンバーによってフラグが設定された
ファイルを返します。
リソース
/connect/communities/communityId/chatter/files/moderation
適用開始バージョン
30.0
Chatter が必要かどうか
いいえ
HTTP メソッド
GET、HEAD
GET の要求パラメータ
名前
型
説明
必須項目/ 使用可能な
省略可能 バージョン
page
Integer
返すページのページ番号を指定します。
省略可能
30.0
pageSize
Integer
ページあたりの項目数を指定します。有効な値は 1 ～ 省略可能
100 です。サイズを指定しない場合、デフォルトは 25
です。
30.0
q
String
結果を絞り込むクエリ文字列。文字列にはワイルド 省略可能
カード文字を除いて 2 文字以上が含まれている必要が
あります。ワイルドカードについての詳細は、「ワイ
ルドカード」を参照してください。
33.0
レスポンスボディ
File Summary
Connect リソース
コンテキストユーザの組織と設定に関する情報、およびコンテキストユーザがメンバーであるコミュニティに
関する情報。
メモ: これらのリソースの基本 URL は、/services/data/v34.0/chatter ではな
く、/services/data/v34.0/connect です。
次のリソースを使用できます。
リソース
説明
/connect
コンテキストユーザが使用できる組織およびコミュニ
ティのリソースのディレクトリ。
/connect/organization
コンテキストユーザの組織と設定に関する情報。
175
Chatter REST API リソース
Dashboard Component Snapshot リソース
リソース
説明
/connect/communities
コンテキストユーザが使用できるすべてのコミュニ
ティリストを返します。
Connect
コンテキストユーザが使用できる組織およびコミュニティのリソースのディレクトリ。
リソース
/connect
適用開始バージョン
24.0
Chatter が必要かどうか
いいえ
HTTP メソッド
GET および HEAD
レスポンスボディ
Connect Directory
Organization
コンテキストユーザの組織と設定に関する情報。
リソース
/connect/organization
適用開始バージョン
24.0
Chatter が必要かどうか
いいえ
HTTP メソッド
GET または HEAD
レスポンスボディ
Organization
関連トピック:
News Feed リソース
Dashboard Component Snapshot リソース
ダッシュボードコンポーネントのスナップショット。
176
Chatter REST API リソース
Dashboard Component Snapshot リソース
このリソースは、ダッシュボードコンポーネントのスナップショットをユーザ、グループ、またはダッシュ
ボードフィードに投稿して、他のユーザがデータの変更をフォローできるようにするために使用します。
リソース
/connect/dashboards/components/componentId/snapshots
適用開始バージョン
25.0
Chatter が必要かどうか
はい
HTTP メソッド
POST
リクエストボディ
ルート XML タグ
<dashboardComponentSnapshot>
JSON
{
"parentId" : "0F9D00000000I4O",
"feedItemBody" : {
"messageSegments" : [
{
"text" : "Sales Heat",
"type" : "Text"
}
]
}
}
プロパティ
名前
型
説明
parentId
String
スナップショットの post 送信 25.0
先となるユーザ、グループ、
またはダッシュボードの ID。
filterId1
String
省略可能。ダッシュボード絞 25.0
り込み項目の ID。
177
使用可能なバージョン
Chatter REST API リソース
Datacloud リソース
名前
型
説明
使用可能なバージョン
filterId2
String
省略可能。2 つ目のダッシュ 25.0
ボード絞り込み項目の ID。
filterId3
String
省略可能。3 つ目のダッシュ 25.0
ボード絞り込み項目の ID。
feedItemBody
Message Body Input ダッシュボードコンポーネン 25.0
トスナップショットに関連付
けられたフィード項目に付随
するテキストが含まれます。
runningUserId
String
省略可能。ダッシュボードの 25.0
ビューの作成元となるユーザ
ID (作成者以外の場合)。
要求パラメータ
名前
型
説明
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 を返します。
Datacloud リソース
Data.com の取引先責任者または会社を購入するために使用する Datacloud リソースに関する情報。
178
Chatter REST API リソース
Datacloud Company Information
Datacloud リソースを使用して Data.com の取引先責任者または会社を購入し、利用できるクレジット数など、購
入に関する情報を取得します。
リソース
説明
/connect/datacloud/companies/companyId
指定された companyId の会社項目の値を返します。
/connect/datacloud/contacts/contactId
指定された取引先責任者の取引先責任者情報を返しま
す。
/connect/datacloud/orders/orderId/companies
指定された注文に含まれるすべての会社に関するすべ
ての情報を返します。
/connect/datacloud/orders/orderId/contacts
取引先責任者の特定の orderId の注文情報をすべて
返します。
/connect/datacloud/orders
リストされた ID の取引先責任者または会社を購入し
ます。POST 要求には取引先責任者 ID または会社 ID を
指定できますが、両方は指定できません。
orderInput。
/connect/datacloud/usage/userId
Monthly ユーザまたは Listpool ユーザの利用状況情報を
返します。
Datacloud Company Information
指定された companyId の会社項目の値を返します。
リソース
/connect/datacloud/companies/companyId
使用可能なバージョン
32.0
Chatter が必要かどうか
いいえ
HTTP メソッド
GET
レスポンスボディ
DatacloudCompanyRepresentation
Datacloud Contact Information
指定された取引先責任者の取引先責任者情報を返します。
リソース
/connect/datacloud/contacts/contactId
179
Chatter REST API リソース
Datacloud OrderId Information
使用可能なバージョン
32.0
Chatter が必要かどうか
いいえ
HTTP メソッド
GET
レスポンスボディ
DatacloudContactRepresentation
Datacloud OrderId Information
特定の orderId の情報を返します。
リソース
注文情報には、orderId、orderId で購入したレコード数、注文情報の URL、購入したレコードのリスト
の URL が含まれます。
/connect/datacloud/orders/orderId
使用可能なバージョン
32.0
Chatter が必要かどうか
いいえ
HTTP メソッド
GET
レスポンスボディ
DatacloudOrderRepresentation
Datacloud Company Order Information
指定された注文に含まれるすべての会社に関するすべての情報を返します。
orderId は購入した会社のものである必要があります。取引先責任者の orderId への要求は失敗します。注
文情報には、orderId、その注文で購入したレコード数、購入した会社の情報、次ページと前ページの URL が
含まれます。
リソース
/connect/datacloud/orders/orderId/companies
使用可能なバージョン
32.0
Chatter が必要かどうか
いいえ
HTTP メソッド
GET
180
Chatter REST API リソース
Datacloud Contact Order Information
GET の要求パラメータ
パラメータ名
型
説明
必須項目/省略可 使用可能なバー
能
ジョン
page
Integer
現在のページの URL として設定す 必須項目
るページ番号。
32.0
pageSize
Integer
返すページの数。デフォルトの
ページサイズは 25 です。
32.0
省略可能
GET のレスポンスボディ
DatacloudCompanyCollectionRepresentation
Datacloud Contact Order Information
取引先責任者の特定の orderId の注文情報をすべて返します。
注文情報には、orderId、orderId で購入したレコード数、注文情報の URL、購入した取引先責任者の詳細が
含まれます。orderId は、購入した取引先責任者のものである必要があります。購入した会社の orderId を
含む要求は失敗します。
リソース
/connect/datacloud/orders/orderId/contacts
使用可能なバージョン
32.0
Chatter が必要かどうか
いいえ
HTTP メソッド
GET
GET の要求パラメータ
パラメータ名
型
説明
必須項目/省略可 使用可能なバー
能
ジョン
page
Integer
返すページの数。
省略可能
32.0
pageSize
Integer
ページごとに返す取引先責任者の 省略可能
数。デフォルトのページサイズは
25 です。
32.0
GET のレスポンスボディ
DatacloudContactCollectionRepresentation
181
Chatter REST API リソース
Datacloud Orders
Datacloud Orders
リストされた ID の取引先責任者または会社を購入します。POST 要求には取引先責任者 ID または会社 ID を指定
できますが、両方は指定できません。orderInput。
1 回の POST 要求で取引先責任者または会社を購入し、指定します。
リソース
/connect/datacloud/orders
使用可能なバージョン
32.0
Chatter が必要かどうか
いいえ
HTTP メソッド
POST
POST のリクエストボディ
ルート XML タグ
<DatacloudOrder>
JSON の例
{
"companyIds":[
"23456",
"24548"
],
"userType":"Monthly"
}
プロパティ
名前
型
説明
必須項目/省 使用可能な
略可能
バージョン
companyIds String
購入する会社のリスト。contactIds と
必須項目
companyIds が共に含まれていると、購入は
失敗します。
32.0
contactIds String
購入する取引先責任者のリスト。リストには 必須項目
取引先責任者のみを含めることをお勧めしま
す。companyIds と contactIds が共に含
まれていると、購入は失敗します。
32.0
182
Chatter REST API リソース
Datacloud Usage
名前
型
説明
必須項目/省 使用可能な
略可能
バージョン
userType
String
Data.com ユーザ種別。
省略可能 —
ユーザ種別
が指定され
ていない場
合、デフォ
ルトは
Monthly で
す。
• Monthy — Data.com レコードの購入の毎月
のポイント制限が割り当てられるユーザ
種別。毎月のポイントを使用できるのは、
割り当てられたユーザのみです。ポイン
トは、月末に期限切れになります。Monthly
は、DatacloudUserType のデフォルト
設定です。
32.0
• Listpool — Data.com レコードを購入す
るためのポイントをユーザがプールから
引き出すことを許可するユーザ種別。
POST の要求パラメータ
パラメータ名
型
説明
必須項目/省略可 使用可能なバー
能
ジョン
orderInput
Object
取引先責任者 ID または会社 ID の 必須項目
リストを含むリクエストボディ。
POST のレスポンスボディ
DatacloudOrderRepresentation
Datacloud Usage
Monthly ユーザまたは Listpool ユーザの利用状況情報を返します。
リソース
/connect/datacloud/usage/userId
使用可能なバージョン
32.0
Chatter が必要かどうか
いいえ
HTTP メソッド
GET
レスポンスボディ
DatacloudPurchaseUsageRepresentation
183
32.0
Chatter REST API リソース
Feed Elements リソース
Feed Elements リソース
フィード要素に関する情報。フィード要素へのアクセス、フィード要素の編集、投稿、検索、削除を行いま
す。バンドルやそのフィード要素など、フィード要素の機能にアクセスします。
使用可能なリソース:
リソース
説明
/chatter/feed-elements
フィード要素の投稿や、組織のすべ
てのフィード要素の検索を行いま
す。
/chatter/feed-elements/batch
最大 500 件のフィード要素を一括投
稿します。
/chatter/feed-elements/batch/feedElementIds
最大 500 個のフィード要素から成る
カンマ区切りのリストに関する情報
を取得します。読み込みできない
フィード要素のエラーは、結果で返
されます。
/chatter/feed-elements/feedElementId
フィード要素へのアクセス、あるい
はその編集または削除を行います。
フィード要素の種類のうち、編集可
能なのはフィード項目のみです。
/chatter/feed-elements/feedElementId/capabilities
フィード要素の機能セットにアクセ
スします。
/chatter/feed-elements/feedElementId/capabilities/approval フィード要素の承認機能にアクセス
します。
フィード要素の関連付けられたアク
ション機能にアクセスします。
/chatter/feed-elements/feedElementId
/capabilities/associated-actions
/chatter/feed-elements/feedElementId/capabilities/banner フィード要素のバナー機能にアクセ
スします。
フィード要素がブックマークされて
いるかどうかの情報の取得や、
フィード要素へのブックマークの追
加を行います。
/chatter/feed-elements/feedElementId
/capabilities/bookmarks
/chatter/feed-elements/feedElementId/capabilities/bundle フィード要素のバンドル機能にアク
セスします。
バンドルとして一緒にグループ化さ
れているフィード要素のすべてにア
クセスします。
/chatter/feed-elements/feedElementId
/capabilities/bundle/feed-elements
184
Chatter REST API リソース
Feed Elements リソース
リソース
説明
/chatter/feed-elements/feedElementId/capabilities/canvas フィード要素のキャンバス機能にア
クセスします。
/chatter/feed-elements/feedElementId
/capabilities/case-comment
フィード要素のケースコメント機能
にアクセスします。
/chatter/feed-elements/feedElementId
/capabilities/chatter-likes
フィード要素の Chatter のいいね! 機
能に関する情報にアクセスします
/chatter/feed-elements/feedElementId
/capabilities/chatter-likes/items
フィード要素のいいね! のページに
アクセスするか、フィード要素にい
いね! を追加します。
/chatter/feed-elements/feedElementId/capabilities/comments フィード要素のコメント機能にアク
セスします。
フィード要素のコメントにアクセス
するか、フィード要素にコメントを
追加します。
/chatter/feed-elements/feedElementId
/capabilities/comments/items
/chatter/feed-elements/feedElementId/capabilities/content フィード要素のコンテンツ機能にア
クセスします。
/chatter/feed-elements/feedElementId
/capabilities/dashboard-component-snapshot
フィード要素のダッシュボードコン
ポーネント機能にアクセスします。
/chatter/feed-elements/feedElementId
/capabilities/edit/is-editable-by-me
コンテキストユーザがフィード要素
を編集できるかどうかを示します。
フィード要素の種類のうち、編集可
能なのはフィード項目のみです。
/chatter/feed-elements/feedElementId
/capabilities/email-message
フィード要素のメールメッセージ機
能にアクセスします。
/chatter/feed-elements/feedElementId
/capabilities/enhanced-link
フィード要素の拡張リンク機能にア
クセスします。
/chatter/feed-elements/feedElementId/capabilities/link
フィード要素のリンク機能にアクセ
スします。
/chatter/feed-elements/feedElementId
/capabilities/moderation
フィード要素のモデレーション機能
に関する情報の取得、フィード要素
へのモデレーションフラグの追加、
またはフィード要素のすべてのモデ
レーションフラグの削除を行いま
す。
/chatter/feed-elements/feedElementId/capabilities/origin フィード要素の発生源機能にアクセ
スします。フィード要素にこの機能
185
Chatter REST API リソース
Feed Elements, Post and Search
リソース
説明
がある場合、そのフィード要素は
フィードアクションによって作成さ
れています。
/chatter/feed-elements/feedElementId/capabilities/poll
フィード要素のアンケートへのアク
セス、アンケートの作成、またはア
ンケートへの投票を行います。
/chatter/feed-elements/feedElementId
/capabilities/question-and-answers
フィード要素の質問と回答へのアク
セス、またはフィード要素の質問と
回答の更新を行います。
/chatter/feed-elements/feedElementId
/capabilities/recommendations
フィード要素のおすすめ機能にアク
セスします。
/chatter/feed-elements/feedElementId
/capabilities/record-snapshot
フィード要素のレコードスナップ
ショット機能にアクセスします。
/chatter/feed-elements/feedElementId/capabilities/topics フィード要素の質問と回答へのアク
セス、またはフィード要素の質問と
回答の更新を行います。
フィード要素の変更追跡機能にアク
セスします。
/chatter/feed-elements/feedElementId
/capabilities/tracked-changes
Feed Elements, Post and Search
フィード要素の投稿や、組織のすべてのフィード要素の検索を行います。
リソース
/chatter/feed-elements
/connect/communities/communityId/chatter/feed-elements
使用可能なバージョン
31.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、POST
186
Chatter REST API リソース
Feed Elements, Post and Search
GET の要求パラメータ
パラメータ名
型
説明
page
String
情報ページの表示に使用される 省略可能
ページトークンを指定します。
ページトークンは、
currentPageToken または
nextPageToken のように、応
答クラスの一部として返されま
す。null を渡すと、最初のペー
ジが返されます。
31.0
pageSize
Integer
ページあたりのフィード要素数 省略可能
を指定します。有効な値は 1 ～
100 です。null を渡すと、デ
フォルトサイズの 25 に設定され
ます。
31.0
q
String
コンテキストユーザに表示され 必須項目
るフィード要素に含まれる 1 つ
以上の検索キーワード。検索文
字列にはワイルドカード文字を
含めることができ、ワイルド
カード文字を除く 2 文字以上が
含まれている必要があります。
「ワイルドカード」を参照して
ください。
31.0
フィード要素ごとに返されるコ 省略可能
メントの最大数。デフォルト値
は 3 です。
31.0
作成日や最終更新日などで並び 省略可能
替えて返される順序を指定しま
す。
31.0
recentCommentCount Integer
sort
String
必須項目/省略
可能
• CreatedDateDesc — 作成日
の新しい順に並び替えます。
• LastModifiedDateDesc —
活動の新しい順に並び替えら
れます。
GET のレスポンスボディ
Feed Element Page
187
使用可能なバー
ジョン
Chatter REST API リソース
Feed Elements, Post and Search
POST のリクエストボディ
Feed Item Input
POST の要求パラメータ
パラメータ名
型
feedElementType String
説明
必須項目/省略可 使用可能なバー
能
ジョン
フィード要素は、フィードに含ま 必須項目
れる最上位の項目です。フィード
は、フィード要素コンテナです。
31.0
使用可能な値は FeedItem のみで
す。
originalFeed
ElementId
String
このフィード要素が共有されてい 省略可能
る場合、これは元のフィード要素
の 18 文字の ID です。
31.0
subjectId
String
このフィード要素が投稿された親 必須項目
の ID。この値は、ユーザ、グルー
プ、レコードの ID、またはコンテ
キストユーザを示す文字列 me に
なります。
31.0
text
String
フィード要素のテキスト。
必須項目
31.0
visibility
String
フィード要素を表示できるユーザ 省略可能
の種別を指定します。
31.0
• AllUsers — 表示は内部ユー
ザに限定されません。
• InternalUsers — 表示は内部
ユーザに限定されます。
POST のレスポンスボディ
Feed Item
POST の例
次の例では、ユーザにメンションするテキストを投稿します。
POST /chatter/feed-elements
{
"body" : {
"messageSegments" : [
188
Chatter REST API リソース
Feed Elements, Batch Post
{
"type" : "Text",
"text" : "When should we meet for release planning? "
},
{
"type" : "Mention",
"id" : "005D00000016Qxp"
}]
},
"feedElementType" : "FeedItem",
"subjectId" : "005D00000016Qxp"
}
関連トピック:
アクションリンクテンプレート
アクションリンクを定義し、フィード要素を使用して投稿する
テンプレートのアクションリンクを定義し、フィード要素を使用して投稿する
Feed Elements, Batch Post
最大 500 件のフィード要素を一括投稿します。
リソース
/chatter/feed-elements/batch
/connect/communities/communityId/chatter/feed-elements/batch
使用可能なバージョン
32.0
Chatter が必要かどうか
はい
HTTP メソッド
POST、HEAD
POST のリクエストボディ
Batch Collection Input
このバッチコレクションのリッチ入力は Feed Item Input です。
189
Chatter REST API リソース
Feed Elements, Batch Post
POST のレスポンスボディ
Batch Results
Batch Results レスポンスボディには、それぞれのリクエストボディに対応する Feed Item レスポンスボディが
含まれます。Feed Item レスポンスボディは、リクエストボディと同じ順序で返されます。
この要求は、要求全体に影響を与えるエラー (解析エラーなど) が発生しない限り、HTTP 200 状況コードを返
します。個々のリクエストボディでエラーが発生した場合、Batch Results Item の statusCode プロパティに
は、該当する HTTP 状況コードが含まれます。
フィード要素の一括投稿
この例では、/chatter/feed-elements/batch リソースを使用してフィード要素を一括投稿します。次
の例では cURL を使用します。
curl -H "X-PrettyPrint: 1" -F
'json={"inputs":[{"richInput":{"subjectId":"me","body":{"messageSegments":[{"type":"Text","text":"Post
Number
1"}]},"feedElementType":"FeedItem"}},{"richInput":{"subjectId":"me","body":{"messageSegments":[{"type":"Text","text":"Post
Number 2"}]},"feedElementType":"FeedItem"}}]};type=application/json' -X POST
https://instance_name/services/data/v34.0/chatter/feed-elements/batch -H 'Authorization:
OAuth 00DD00000007HoR!...' --insecure
次に、同じ例のリクエストボディのみを示します。
{
"inputs": [
{
"richInput": {
"subjectId": "me",
"body": {
"messageSegments": [
{
"type": "Text",
"text": "Post Number 1"
}
]
},
"feedElementType": "FeedItem"
}
},
190
Chatter REST API リソース
Feed Elements, Batch Post
{
"richInput": {
"subjectId": "me",
"body": {
"messageSegments": [
{
"type": "Text",
"text": "Post Number 2"
}
]
},
"feedElementType": "FeedItem"
}
}
]
}
バイナリファイルを含むフィード要素の一括投稿
次の例では、/chatter/feed-elements/batch リソースを使用してフィード要素を一括投稿し、2 つの
バイナリファイルをアップロードして、バッチ内のフィード要素に添付します。リクエストボディにはバ
イナリパートに関する情報を含める必要があります。次の例では cURL を使用します。
curl -H "X-PrettyPrint: 1" -F 'json={"inputs":[{"binaryPartNames":["bin1"],
"richInput":{"subjectId":"me","body":{
"messageSegments":[{"type":"Text","text":"Please accept this receipt"}]},"capabilities":
{"content" : {"description": "Receipt for expenses",
"title":"receipt.pdf"}},"feedElementType":"FeedItem"}},
{"binaryPartNames":["bin2"],"richInput":{"subjectId":"me","body":{"messageSegments":[{"type":"Text","text":"Post
Number 2"}]},
"capabilities": {"content" : {"description": "Receipt for expenses",
"title":"receipt2.pdf"}},"feedElementType":"FeedItem"}}]};type=application/json'
-F "bin1=@/Users/jsmith/Desktop/receipt.pdf;type=application/octet-stream" -F
"bin2=@/Users/jsmith/Desktop/receipt2.pdf;type=application/octet-stream"
191
Chatter REST API リソース
Feed Elements, Batch Post
-X POST https://instance_name/services/data/v34.0/chatter/feed-elements/batch
-H 'Authorization: OAuth 00DD00000007HoR44QATPNzhzYEJBfU' --insecure
以下に、上記の例を、リクエストボディパートが確認できる形式に変えた例を示します。
POST /services/data/v34.0/chatter/feed-elements/batch HTTP/1.1
Authorization: OAuth 00DRR0000000N0g!...
User-Agent: Jakarta Commons-HttpClient/3.0.1
Host: instance_name
Content-Length: 845
Content-Type: multipart/form-data; boundary=a7V4kRcFA8E79pivMuV2tukQ85cmNKeoEgJgq
Accept: application/json
--a7V4kRcFA8E79pivMuV2tukQ85cmNKeoEgJgq
Content-Disposition: form-data; name="json"
Content-Type: application/json; charset=UTF-8
{
"inputs": [
{
"binaryPartNames": [
"bin1"
],
"richInput": {
"subjectId": "me",
"body": {
"messageSegments": [
{
"type": "Text",
"text": "Please accept this receipt"
192
Chatter REST API リソース
Feed Elements, Batch Post
}
]
},
"capabilities": {
"content": {
"description": "Receipt for expenses",
"title": "receipt.pdf"
}
},
"feedElementType": "FeedItem"
}
},
{
"binaryPartNames": [
"bin2"
],
"richInput": {
"subjectId": "me",
"body": {
"messageSegments": [
{
"type": "Text",
"text": "Post Number 2"
}
]
},
"capabilities": {
193
Chatter REST API リソース
Feed Elements, Batch Post
"content": {
"description": "Receipt for expenses",
"title": "receipt2.pdf"
}
},
"feedElementType": "FeedItem"
}
}
]
}
--a7V4kRcFA8E79pivMuV2tukQ85cmNKeoEgJgq
Content-Disposition: form-data; name="bin1"; filename="receipt.pdf"
Content-Type: application/octet-stream; charset=ISO-8859-1
...contents of receipt.pdf...
--a7V4kRcFA8E79pivMuV2tukQ85cmNKeoEgJgq
Content-Disposition: form-data; name="bin2"; filename="receipt2.pdf"
Content-Type: application/octet-stream; charset=ISO-8859-1
...contents of receipt2.pdf...
--a7V4kRcFA8E79pivMuV2tukQ85cmNKeoEgJgq--
194
Chatter REST API リソース
Feed Elements, Batch Get
メモ: binaryPartNames プロパティ内のバイナリパート名は、バイナリリクエストパートの name プ
ロパティ内のバイナリパート名と一致する必要があります。
関連トピック:
Chatter REST API 入力の使用
Batch リソース
Feed Elements, Batch Get
最大 500 個のフィード要素から成るカンマ区切りのリストに関する情報を取得します。読み込みできないフィー
ド要素のエラーは、結果で返されます。
リソース
/chatter/feed-elements/batch/feedElementIds
/connect/communities/communityId/chatter/feed-elements/batch/feedElementIds
使用可能なバージョン
31.0
Chatter が必要かどうか
はい
HTTP メソッド
GET
GET のレスポンスボディ
Batch Results
Feed Element
フィード要素へのアクセス、あるいはその編集または削除を行います。フィード要素の種類のうち、編集可能
なのはフィード項目のみです。
リソース
/chatter/feed-elements/feedElementId
/connect/communities/communityId/chatter/feed-elements/feedElementId
使用可能なバージョン
31.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、DELETE、PATCH
PATCH はバージョン 34.0 以降でサポートされます。
195
Chatter REST API リソース
Feed Element Capabilities
GET の要求パラメータ
パラメータ名
型
説明
必須項目/省略 使用可能な
可能
バージョン
elementsPerBundle
Integer
バンドルあたりの最大フィード 省略可能
要素数。デフォルトおよび最大
値は、10 です。
31.0
recentCommentCount Integer
フィード要素ごとに返されるコ 省略可能
メントの最大数。デフォルト値
は 3 です。
31.0
PATCH のリクエストボディ
Feed Item Input
PATCH のレスポンスボディ
Feed Item
GET のレスポンスボディ
Generic Feed Element または Feed Item
DELETE のレスポンスボディ
204: DELETE が成功しました
Feed Element Capabilities
フィード要素の機能セットにアクセスします。
リソース
/chatter/feed-elements/feedElementId/capabilities
/connect/communities/communityId/chatter/feed-elements/feedElementId/capabilities
使用可能なバージョン
31.0
Chatter が必要かどうか
はい
HTTP メソッド
GET
GET の要求パラメータ
パラメータ名
型
elementsPerBundle Integer
説明
必須項目/省略
可能
バンドルあたりの最大フィード要 省略可能
素数。デフォルトおよび最大値
は、10 です。
196
使用可能なバー
ジョン
31.0
Chatter REST API リソース
パラメータ名
Feed Elements Capability, Approval
型
recentCommentCount Integer
説明
必須項目/省略
可能
フィード要素ごとに返されるコメ 省略可能
ントの最大数。デフォルト値は 3
です。
使用可能なバー
ジョン
31.0
GET のレスポンスボディ
Feed Element Capabilities
Feed Elements Capability, Approval
フィード要素の承認機能にアクセスします。
リソース
/chatter/feed-elements/feedElementId/capabilities/approval
/connect/communities/communityId/chatter/feed-elements/feedElementId/capabilities/approval
使用可能なバージョン
32.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、HEAD
GET のレスポンスボディ
Approval Capability
フィード要素がこの機能をサポートしていない場合、応答は 404: Not Found になります。
Feed Elements Capability, Associated Actions
フィード要素の関連付けられたアクション機能にアクセスします。
リソース
/chatter/feed-elements/feedElementId/capabilities/associated-actions
/connect/communities/communityId/chatter/feed-elements/feedElementId/capabilities/associated-actions
使用可能なバージョン
33.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、HEAD
197
Chatter REST API リソース
Feed Elements Capability, Banner
GET のレスポンスボディ
Associated Actions Capability
フィード要素がこの機能をサポートしていない場合、応答は 404: Not Found になります。
Feed Elements Capability, Banner
フィード要素のバナー機能にアクセスします。
リソース
/chatter/feed-elements/feedElementId/capabilities/banner
/connect/communities/communityId/chatter/feed-elements/feedElementId/capabilities/banner
使用可能なバージョン
32.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、HEAD
GET のレスポンスボディ
Banner Capability
フィード要素がこの機能をサポートしていない場合、応答は 404: Not Found になります。
Feed Elements Capability, Bookmarks
フィード要素がブックマークされているかどうかの情報の取得や、フィード要素へのブックマークの追加を行
います。
リソース
/chatter/feed-elements/feedElementId/capabilities/bookmarks
/connect/communities/communityId/chatter/feed-elements/feedElementId/capabilities/bookmarks
使用可能なバージョン
32.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、PATCH
PATCH のリクエストボディ
ルート XML タグ
<bookmarksCapability>
<isBookmarkedByCurrentUser>true</isBookmarkedByCurrentUser>
198
Chatter REST API リソース
Feed Elements Capability, Bundle
</bookmarksCapability>
JSON の例
{
"isBookmarkedByCurrentUser": true
}
プロパティ
名前
型
isBookmarked Boolean
ByCurrentUser
説明
必須項目/省略
可能
フィード要素をユーザのために 必須項目
ブックマークする必要があるか
(true)、否か (false) を指定しま
す。
使用可能なバー
ジョン
32.0
PATCH の要求パラメータ
パラメータ名
型
isBookmarked Boolean
ByCurrentUser
説明
必須項目/省略可 使用可能なバー
能
ジョン
フィード要素をユーザのために
ブックマークする必要があるか
(true)、否か (false) を指定しま
す。
必須項目
32.0
GET、PATCH のレスポンスボディ
Bookmarks Capability
フィード要素がこの機能をサポートしていない場合、応答は 404: Not Found になります。
Feed Elements Capability, Bundle
フィード要素のバンドル機能にアクセスします。
リソース
/chatter/feed-elements/feedElementId/capabilities/bundle
/connect/communities/communityId/chatter/feed-elements/feedElementId/capabilities/bundle
使用可能なバージョン
31.0
199
Chatter REST API リソース
Feed Elements Capability, Bundle Elements
Chatter が必要かどうか
はい
HTTP メソッド
GET、HEAD
GET の要求パラメータ
パラメータ名
型
説明
必須項目/省略
可能
使用可能なバー
ジョン
elementsPerBundle Integer
バンドルあたりの最大フィード要 省略可能
素数。デフォルトおよび最大値
は、10 です。
31.0
recentCommentCount Integer
フィード要素ごとに返されるコメ 省略可能
ントの最大数。デフォルト値は 3
です。
31.0
GET のレスポンスボディ
次のいずれかのレスポンスボディになります。
• Generic Bundle Capability
• Tracked Change Bundle Capability
フィード要素がこの機能をサポートしていない場合、応答は 404: Not Found になります。
Feed Elements Capability, Bundle Elements
バンドルとして一緒にグループ化されているフィード要素のすべてにアクセスします。
メモ: バンドル投稿にはフィード追跡変更が含まれます。Salesforce1 ダウンロード可能アプリケーション
では、バンドル投稿がレコードフィードのみにあります。
リソース
/chatter/feed-elements/feedElementId/capabilities/bundle/feed-elements
connect/communities/communityId/chatter/feed-elements/feedElementId/capabilities/bundle/feed-elements
使用可能なバージョン
31.0
Chatter が必要かどうか
はい
HTTP メソッド
GET
200
Chatter REST API リソース
Feed Elements Capability, Canvas
GET の要求パラメータ
パラメータ名
型
elementsPerBundle Integer
説明
必須項目/省略 使用可能なバー
可能
ジョン
バンドルあたりの最大フィード 省略可能
要素数。デフォルトおよび最大
値は、10 です。
31.0
page
String
情報ページの表示に使用される 省略可能
ページトークンを指定します。
ページトークンは、
currentPageToken または
nextPageToken のように、応
答クラスの一部として返されま
す。null を渡すと、最初のペー
ジが返されます。
31.0
pageSize
Integer
ページあたりのフィード要素数 省略可能
を指定します。有効な値は 1 ～
100 です。null を渡すと、デ
フォルトサイズの 25 に設定され
ます。
31.0
recentCommentCount Integer
フィード要素ごとに返されるコ 省略可能
メントの最大数。デフォルト値
は 3 です。
31.0
GET のレスポンスボディ
Feed Element Page
フィード要素がこの機能をサポートしていない場合、応答は 404: Not Found になります。
Feed Elements Capability, Canvas
フィード要素のキャンバス機能にアクセスします。
リソース
/chatter/feed-elements/feedElementId/capabilities/canvas
/connect/communities/communityId/chatter/feed-elements/feedElementId/capabilities/canvas
使用可能なバージョン
32.0
Chatter が必要かどうか
はい
201
Chatter REST API リソース
Feed Elements Capability, Case Comment
HTTP メソッド
GET、HEAD
GET のレスポンスボディ
Canvas Capability
フィード要素がこの機能をサポートしていない場合、応答は 404: Not Found になります。
Feed Elements Capability, Case Comment
フィード要素のケースコメント機能にアクセスします。
リソース
/chatter/feed-elements/feedElementId/capabilities/case-comment
/connect/communities/communityId/chatter/feed-elements/feedElementId/capabilities/case-comment
使用可能なバージョン
32.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、HEAD
GET のレスポンスボディ
Case Comment Capability
フィード要素がこの機能をサポートしていない場合、応答は 404: Not Found になります。
Feed Elements Capability, Chatter Likes
フィード要素の Chatter のいいね! 機能に関する情報にアクセスします
リソース
/chatter/feed-elements/feedElementId/capabilities/chatter-likes
/connect/communities/communityId/chatter/feed-elements/feedElementId/capabilities/chatter-likes
使用可能なバージョン
32.0
Chatter が必要かどうか
はい
HTTP メソッド
GET
応答
Chatter Likes Capability
フィード要素がこの機能をサポートしていない場合、応答は 404: Not Found になります。
202
Chatter REST API リソース
Feed Elements Capability, Chatter Likes Items
Feed Elements Capability, Chatter Likes Items
フィード要素のいいね! のページにアクセスするか、フィード要素にいいね! を追加します。
リソース
/chatter/feed-elements/feedElementId/capabilities/chatter-likes/items
/connect/communities/communityId/chatter/feed-elements/feedElementId/capabilities/chatter-likes/items
使用可能なバージョン
32.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、POST
GET の要求パラメータ
パラメータ名
型
説明
必須項目/省略可 使用可能なバー
能
ジョン
page
Integer
返すページのページ番号を指定し 省略可能
ます。値を指定しないと、最初の
ページが返されます。
32.0
pageSize
Integer
1 ページあたりのいいね! の数を指 省略可能
定します。有効な値は 1 ～ 100 で
す。サイズを指定しない場合、デ
フォルトは 25 です。
32.0
POST のレスポンスボディ
Like
フィード要素がこの機能をサポートしていない場合、応答は 404: Not Found になります。
GET のレスポンスボディ
Like Page
フィード要素がこの機能をサポートしていない場合、応答は 404: Not Found になります。
Feed Elements Capability, Comments
フィード要素のコメント機能にアクセスします。
リソース
/chatter/feed-elements/feedElementId/capabilities/comments
/connect/communities/communityId/chatter/feed-elements/feedElementId/capabilities/comments
203
Chatter REST API リソース
Feed Elements Capability, Comments Items
使用可能なバージョン
32.0
Chatter が必要かどうか
はい
HTTP メソッド
GET
GET のレスポンスボディ
Comments Capability
フィード要素がこの機能をサポートしていない場合、応答は 404: Not Found になります。
Feed Elements Capability, Comments Items
フィード要素のコメントにアクセスするか、フィード要素にコメントを追加します。
コメントの post 送信についての詳細は、「入力での POST、PATCH、または PUT の使用」を参照してください。
コメントに添付するバイナリファイルをアップロードするには、マルチパート/フォームデータ要求に含めて
送信する必要があります。コメントのテキストを送信するには、マルチパート/フォームデータ要求に JSON ま
たは XML リッチ入力ボディパートを含める方法があります。または、その情報を要求パラメータパートで渡す
ように選択することもできます。マルチパート/フォームデータメッセージを作成する方法についての詳細は、
「バイナリファイルのアップロード」を参照してください。
リソース
/chatter/feed-elements/feedElementId/capabilities/comments/items
/connect/communities/communityId/chatter/feed-elements/feedElementId/capabilities/comments/items
使用可能なバージョン
32.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、POST
POST のリクエストボディ
ルート XML タグ
<comment>
プロパティ
名前
型
説明
使用可能な
バージョン
attachment
種別によって異なる。
省略可能。値は次のとおりです。
24.0 ～ 31.0
• Attachment Input: Existing Content
• Attachment Input: New File Upload
204
Chatter REST API リソース
Feed Elements Capability, Content
名前
型
説明
使用可能な
バージョン
重要: バージョン 32.0 以降では、
capabilities プロパティを使
用します。
body
Message Body Input
メッセージ本文の説明
23.0
capabilities
Comment Capabilities Input
添付ファイルなど、コメントの機能。 32.0
POST の要求パラメータ
パラメータ名
型
説明
必須項目/省略可 使用可能なバー
能
ジョン
text
String
コメントのテキスト。
必須項目
32.0
GET の要求パラメータ
パラメータ名
型
説明
必須項目/省略可 使用可能なバー
能
ジョン
page
String
コメントの次のページへの URL。
省略可能
32.0
pageSize
Integer
ページあたりのコメント数。デ
フォルト値は 3 です。
省略可能
32.0
GET のレスポンスボディ
Comment Page
フィード要素がこの機能をサポートしていない場合、応答は 404: Not Found になります。
POST のレスポンスボディ
Comment
フィード要素がこの機能をサポートしていない場合、応答は 404: Not Found になります。
Feed Elements Capability, Content
フィード要素のコンテンツ機能にアクセスします。
リソース
/chatter/feed-elements/feedElementId/capabilities/content
/connect/communities/communityId/chatter/feed-elements/feedElementId/capabilities/content
205
Chatter REST API リソース
Feed Elements Capability, Dashboard Component Snapshot
使用可能なバージョン
32.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、HEAD
GET のレスポンスボディ
Content Capability
フィード要素がこの機能をサポートしていない場合、応答は 404: Not Found になります。
Feed Elements Capability, Dashboard Component Snapshot
フィード要素のダッシュボードコンポーネント機能にアクセスします。
リソース
/chatter/feed-elements/feedElementId/capabilities/dashboard-component-snapshot
/connect/communities/communityId/chatter/feed-elements/feedElementId/capabilities/dashboard-component-snapshot
使用可能なバージョン
32.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、HEAD
GET のレスポンスボディ
Dashboard Component Snapshot Capability
フィード要素がこの機能をサポートしていない場合、応答は 404: Not Found になります。
Feed Elements Capability, Editability
コンテキストユーザがフィード要素を編集できるかどうかを示します。フィード要素の種類のうち、編集可能
なのはフィード項目のみです。
リソース
/chatter/feed-elements/feedElementId/capabilities/edit/is-editable-by-me
/connect/communities/communityId/chatter/feed-elements/feedElementId/capabilities/edit/is-editable-by-me
使用可能なバージョン
34.0
Chatter が必要かどうか
はい
206
Chatter REST API リソース
Feed Elements Capability, Email Message
HTTP メソッド
GET
GET のレスポンスボディ
Feed Entity Is Editable
Feed Elements Capability, Email Message
フィード要素のメールメッセージ機能にアクセスします。
リソース
/chatter/feed-elements/feedElementId/capabilities/email-message
/connect/communities/communityId/chatter/feed-elements/feedElementId/capabilities/email-message
使用可能なバージョン
32.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、HEAD
GET のレスポンスボディ
Email Message Capability
フィード要素がこの機能をサポートしていない場合、応答は 404: Not Found になります。
Feed Elements Capability, Enhanced Link
フィード要素の拡張リンク機能にアクセスします。
リソース
/chatter/feed-elements/feedElementId/capabilities/enhanced-link
/connect/communities/communityId/chatter/feed-elements/feedElementId/capabilities/enhanced-link
使用可能なバージョン
32.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、HEAD
GET のレスポンスボディ
Enhanced Link Capability
フィード要素がこの機能をサポートしていない場合、応答は 404: Not Found になります。
207
Chatter REST API リソース
Feed Elements Capability, Link
Feed Elements Capability, Link
フィード要素のリンク機能にアクセスします。
リソース
/chatter/feed-elements/feedElementId/capabilities/link
/connect/communities/communityId/chatter/feed-elements/feedElementId/capabilities/link
使用可能なバージョン
32.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、HEAD
GET のレスポンスボディ
Link Capability
フィード要素がこの機能をサポートしていない場合、応答は 404: Not Found になります。
Feed Elements Capability, Moderation
フィード要素のモデレーション機能に関する情報の取得、フィード要素へのモデレーションフラグの追加、ま
たはフィード要素のすべてのモデレーションフラグの削除を行います。
リソース
/connect/communities/communityId/chatter/feed-elements
/feedElementId/capabilities/moderation
使用可能なバージョン
31.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、POST、DELETE、HEAD
GET および POST の要求パラメータ
パラメータ名
型
説明
必須項目/省略可 使用可能なバー
能
ジョン
visibility
String
さまざまなユーザ種別でのフラグ 省略可能
の表示動作を指定します。次のい
ずれかの値にします。
• ModeratorsOnly — フラグ
は、フラグが付けられた要素ま
208
31.0
Chatter REST API リソース
パラメータ名
Feed Elements Capability, Moderation
型
説明
必須項目/省略可 使用可能なバー
能
ジョン
たは項目に対するモデレーショ
ン権限を持つユーザにのみ表示
されます。
• SelfAndModerators — フラ
グは、フラグの作成者とフラグ
が付けられた要素または項目に
対するモデレーション権限を持
つユーザに表示されます。
POST のリクエストボディ
ルート XML タグ
<moderationFlag>
JSON
{
"visibility" : "ModeratorsOnly"
}
プロパティ
名前
型
説明
visibility
String
さまざまなユーザ種別でのフラグの表示動 30.0
作を指定します。
• ModeratorsOnly — フラグは、フラグ
が付けられた要素または項目に対する
モデレーション権限を持つユーザにの
み表示されます。
• SelfAndModerators — フラグは、フ
ラグの作成者とフラグが付けられた要
素または項目に対するモデレーション
権限を持つユーザに表示されます。
GET および POST のレスポンスボディ
Moderation Capability
フィード要素がこの機能をサポートしていない場合、応答は 404: Not Found になります。
209
使用可能なバー
ジョン
Chatter REST API リソース
Feed Elements Capability, Origin
Feed Elements Capability, Origin
フィード要素の発生源機能にアクセスします。フィード要素にこの機能がある場合、そのフィード要素はフィー
ドアクションによって作成されています。
リソース
/chatter/feed-elements/feedElementId/capabilities/origin
/connect/communities/communityId/chatter/feed-elements/feedElementId/capabilities/origin
使用可能なバージョン
33.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、HEAD
GET のレスポンスボディ
Origin Capability
フィード要素がこの機能をサポートしていない場合、応答は 404: Not Found になります。
Feed Elements Capability, Poll
フィード要素のアンケートへのアクセス、アンケートの作成、またはアンケートへの投票を行います。
リソース
/chatter/feed-elements/feedElementId/capabilities/poll
/connect/communities/communityId/chatter/feed-elements/feedElementId/capabilities/poll
使用可能なバージョン
32.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、PATCH
PATCH のリクエストボディ
XML の例
<pollCapability>
<pollChoices>
<choice>Monday</choice>
<choice>Tuesday</choice>
</pollChoices>
210
Chatter REST API リソース
Feed Elements Capability, Question and Answers
</pollCapability>
JSON の例
{
"choices" : [
"Monday", "Tuesday"
]
}
プロパティ
名前
型
説明
必須項目/省略
可能
使用可能なバー
ジョン
choices
String []
新しいアンケートの作成に使用す アンケートの作 32.0
る選択肢。アンケートには 2 個か 成では必須
ら 10 個のアンケート選択肢を指
定する必要があります。
myChoiceId
String
フィードアンケートの既存の選択 アンケートへの 32.0
肢の ID。既存のアンケートに投票 投票では必須
するために使用されます。
PATCH の要求パラメータ
パラメータ名
型
説明
必須項目/省略可 使用可能なバー
能
ジョン
myChoiceId
String
アンケート選択肢 ID。
必須項目
32.0
GET、PATCH のレスポンスボディ
Poll Capability
フィード要素がこの機能をサポートしていない場合、応答は 404: Not Found になります。
Feed Elements Capability, Question and Answers
フィード要素の質問と回答へのアクセス、またはフィード要素の質問と回答の更新を行います。
211
Chatter REST API リソース
Feed Elements Capability, Question and Answers
リソース
/chatter/feed-elements/feedElementId/capabilities/question-and-answers
/connect/communities/communityId/chatter/feed-elements/feedElementId/capabilities/question-and-answers
使用可能なバージョン
32.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、PATCH
PATCH のリクエストボディ
ルート XML タグ
<questionAndAnswersCapability>
<bestAnswerId>0D7D00000000lMAKAY</bestAnswerId>
</questionAndAnswersCapability>
JSON の例
{
"bestAnswerId": "0D7D00000000lMAKAY"
}
プロパティ
名前
型
bestAnswerId String
questionTitle String
説明
必須項目/省略
可能
質問フィード要素の最良の回答と
して使用するコメント ID。最良の
回答コメントは、質問フィード要
素にすでに存在する必要がありま
す。
フィード要素の 32.0
PATCH では必須
です。
質問フィード要素のタイトル。
フィード要素の 32.0
POST では必須で
す。
POST 要求ではサ
ポートされてい
ません。
PATCH 要求では
サポートされて
いません。
212
使用可能なバー
ジョン
Chatter REST API リソース
Feed Elements Capability, Recommendations
PATCH の要求パラメータ
パラメータ名
型
説明
必須項目/省略可 使用可能なバー
能
ジョン
bestAnswerId
String
質問フィード要素の最良の回答と 必須項目
して使用するコメント ID。最良の
回答コメントは、質問フィード要
素にすでに存在する必要がありま
す。
32.0
GET、PATCH のレスポンスボディ
Question and Answers Capability
フィード要素がこの機能をサポートしていない場合、応答は 404: Not Found になります。
Feed Elements Capability, Recommendations
フィード要素のおすすめ機能にアクセスします。
リソース
/chatter/feed-elements/feedElementId/capabilities/recommendations
/connect/communities/communityId/chatter/feed-elements/feedElementId/capabilities/recommendations
使用可能なバージョン
32.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、HEAD
GET のレスポンスボディ
Recommendations Capability
フィード要素がこの機能をサポートしていない場合、応答は 404: Not Found になります。
Feed Elements Capability, Record Snapshot
フィード要素のレコードスナップショット機能にアクセスします。
リソース
/chatter/feed-elements/feedElementId/capabilities/record-snapshot
/connect/communities/communityId/chatter/feed-elements/feedElementId/capabilities/record-snapshot
使用可能なバージョン
32.0
213
Chatter REST API リソース
Feed Elements Capability, Topics
Chatter が必要かどうか
はい
HTTP メソッド
GET、HEAD
GET のレスポンスボディ
Record Snapshot Capability
フィード要素がこの機能をサポートしていない場合、応答は 404: Not Found になります。
Feed Elements Capability, Topics
フィード要素に関連付けられたトピックの取得、削除、および投稿を行います。
リソース
/chatter/feed-elements/feedElementId/capabilities/topics
/connect/communities/communityId/chatter/feed-elements/feedElementId/capabilities/topics
使用可能なバージョン
32.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、DELETE、POST
POST のリクエストボディ
ルート XML タグ
<feedItemTopic>
JSON
次の例では、フィード項目に新規のトピックを添付します。
{ "topicName": "W3C"
}
プロパティ
名前
型
説明
必須項目/省略可能
topicId
String
既存のトピックの ID
topicName プロパティが 29.0
使用されていない場合、既
存のトピックに必要です。
214
使用可
能な
バー
ジョン
Chatter REST API リソース
Feed Elements Capability, Topics
名前
型
説明
必須項目/省略可能
使用可
能な
バー
ジョン
topicName
String
新規または既存のトピック 新規のトピック、および 29.0
の名前 (最大 150 文字)
topicId プロパティが使
用されていない場合の既存
のトピックに必要です。
POST の要求パラメータ
パラメータ名
型
説明
必須項目/省略可 使用可能なバー
能
ジョン
topicId
String
既存のトピックの ID。
topicName プロ 32.0
パティが使用さ
れていない場
合、既存のト
ピックに必要で
す。
topicName
String
32.0
新規または既存のトピックの名前 新規のトピッ
(最大 150 文字)。
ク、および
topicId プロパ
ティが使用され
ていない場合の
既存のトピック
に必要です。
DELETE の要求パラメータ
パラメータ名
型
説明
必須項目/省略可 使用可能なバー
能
ジョン
topicId
String
既存のトピック ID。
必須項目
POST のレスポンスボディ
Topic
フィード要素がこの機能をサポートしていない場合、応答は 404: Not Found になります。
GET のレスポンスボディ
Topics Capability
フィード要素がこの機能をサポートしていない場合、応答は 404: Not Found になります。
215
32.0
Chatter REST API リソース
Feed Elements Capability, Tracked Changes
Feed Elements Capability, Tracked Changes
フィード要素の変更追跡機能にアクセスします。
リソース
/chatter/feed-elements/feedElementId/capabilities/tracked-changes
/connect/communities/communityId/chatter/feed-elements/feedElementId/capabilities/tracked-changes
使用可能なバージョン
32.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、HEAD
GET のレスポンスボディ
Tracked Changes Capability
Feed Items リソース
フィード項目に関する情報。フィード項目のアクセス、検索、削除、ブックマーク、いいね! を行います。コ
メントのアクセスと投稿、アンケートのアクセスと投票、トピックのアクセス、追加、削除を行います。
重要: Feed Item リソースは、バージョン 32.0 以降では使用できません。バージョン 32.0 以降では、Feed
Elements Resources を使用します。
Feed-Items Batch
フィード項目のバッチ。複数のフィード項目に関する情報を 1 つの要求で取得します。
最大 500 件のフィード項目のカンマ区切りのリストに関する情報を取得します。読み込みできないフィード項
目のエラーは、結果に返されます。
リソース
/chatter/feed-items/batch/feedItemIds
使用可能なバージョン
29.0 ～ 31.0
重要: バージョン 32.0 以降では、Feed Elements, Batch Get を使用します。
Chatter が必要かどうか
はい
HTTP メソッド
GET、HEAD
GET のレスポンスボディ
Batch Results
216
Chatter REST API リソース
Feed-Items Query
Feed-Items Query
フィード項目のページ設定されたコレクション。このリソースは、フィード項目の検索に使用します。
クエリパラメータ (q) が必要です。追跡変更を含む、すべての種別のフィード項目が検索されます。検索では、
フィード項目本文に検索語が含まれるフィード項目と、コメントに検索語が含まれるフィード項目を返しま
す。クエリパラメータにワイルドカードを使用することもできます。
リソース
/chatter/feed-items?q=searchTerm
使用可能なバージョン
23.0 ～ 31.0
重要: バージョン 32.0 以降では、Feed Elements, Post and Search を使用します。
Chatter が必要かどうか
はい
HTTP メソッド
GET、HEAD
要求パラメータ
パラメータ名
型
説明
必須項 適用開始
目/省略 バージョ
可能
ン
page
String 生成されたトークン。フィード内のフィード項目のビューを 省略可
示します。
能
23.0 ～ 31.0
pageSize
Integer ページあたりの項目数を指定します。有効な値は 1 ～ 100 で 省略可
す。サイズを指定しない場合、デフォルトは 25 です。
能
23.0 ～ 31.0
q
String 検索する文字列を指定します。検索文字列にはワイルドカー 必須項
ド文字を除いて 2 文字以上が含まれている必要があります。 目
ワイルドカードについての詳細は、「ワイルドカード」を参
照してください。
23.0 ～ 31.0
クエリパラメータは、追跡変更を含む、すべての種別のフィー
ド項目を検索します。検索では、フィード項目本文に検索語
が含まれるフィード項目と、コメントに検索語が含まれる
フィード項目を返します。
recentCommentCount Integer フィード項目ごとに含めるコメントの最大数。デフォルト値 省略可
は 3 です。
sort
29.0 ～ 31.0
能
String 結果の並び替え順。値は次のとおりです。
• CreatedDateDesc
• LastModifiedDateDesc
デフォルト値は、CreatedDateDesc です。
217
省略可
能
28.0 ～ 31.0
Chatter REST API リソース
Feed-Items, Specific Feed Item
レスポンスボディ
Feed Item Page
Feed-Items, Specific Feed Item
特定のフィード項目のアクセス、削除、またはブックマークを行います。
リソース
/chatter/feed-items/feedItemId
使用可能なバージョン
23.0 ～ 31.0
重要: バージョン 32.0 以降では、Feed Element を使用します。
Chatter が必要かどうか
はい
HTTP メソッド
GET、DELETE、PATCH、または HEAD
PATCH のリクエストボディ
XML ルートタグは <feedItem> です。
パラメータ名
型
説明
isBookmarkedByCurrentUser
Boolean
現在のユーザのブックマーク済み
フィード項目のリストに現在の
フィード項目を追加するには、
true を指定します。現在のユー
ザのブックマーク済みフィード項
目のリストからこのフィード項目
を削除するには、false を指定し
ます。
パラメータ名
型
説明
isBookmarkedByCurrentUser
Boolean
現在のユーザのブックマーク済み
フィード項目のリストに現在の
フィード項目を追加するには、
true を指定します。現在のユー
ザのブックマーク済みフィード項
目のリストからこのフィード項目
を削除するには、false を指定し
ます。
PATCH の要求パラメータ
218
Chatter REST API リソース
Feed Items Comments
GET、PATCH、または HEAD のレスポンスボディ
Feed Item
例
この PATCH 要求はフィード項目をブックマークします。
/chatter/feed-items/0D5D0000000JvckKAC?isBookmarkedByCurrentUser=true
Feed Items Comments
フィード項目のコメントにアクセスするか、コメントを post 送信します。
デフォルトでは、3 件のコメントが取得されます。コメントをさらに取得するには、pageSize パラメータの
値を増やします。
コメントの post 送信についての詳細は、「入力での POST、PATCH、または PUT の使用」を参照してください。
コメントに添付するバイナリファイルをアップロードするには、マルチパート/フォームデータ要求に含めて
送信する必要があります。コメントのテキストを送信するには、マルチパート/フォームデータ要求に JSON ま
たは XML リッチ入力ボディパートを含める方法があります。または、その情報を要求パラメータパートで渡す
ように選択することもできます。マルチパート/フォームデータメッセージを作成する方法についての詳細は、
「バイナリファイルのアップロード」を参照してください。
コメントには 5000 文字まで使用できます。
リソース
/chatter/feed-items/feedItemId/comments
適用開始バージョン
23.0 ～ 31.0
重要: バージョン 32.0 以降では、Feed Elements Capability, Comments Items を使用します。
Chatter が必要かどうか
はい
HTTP メソッド
GET、POST、または HEAD
POST のリクエストボディ
ルート XML タグ
<comment>
プロパティ
名前
型
説明
使用可能な
バージョン
attachment
種別によって異なる。
省略可能。値は次のとおりです。
24.0 ～ 31.0
• Attachment Input: Existing Content
• Attachment Input: New File Upload
219
Chatter REST API リソース
Feed Items Comments
名前
型
説明
使用可能な
バージョン
重要: バージョン 32.0 以降では、
capabilities プロパティを使
用します。
body
Message Body Input
メッセージ本文の説明
23.0
capabilities
Comment Capabilities Input
添付ファイルなど、コメントの機能。 32.0
POST の要求パラメータ
既存のファイルを添付するためのパラメータ
パラメータ名
説明
必須項目/省略可能
使用可能なバージョ
ン
attachmentType String
添付ファイルの種別。値
ExistingContent を含める必要
があります。
必須項目
27.0 ～ 31.0
contentDocumentId String
post 送信する既存のファイルの ID。 必須項目
24.0 ～ 31.0
コメントのテキスト。
23.0 ～ 31.0
text
型
String
省略可能
テキストを post 送信するためのパラメータ
パラメータ名
型
説明
必須項目/省略可能
使用可能なバージョ
ン
text
String
コメントのテキス
ト。
必須項目
23.0 ～ 31.0
必須項目/省略可能
使用可能なバージョ
ン
GET または HEAD の要求パラメータ
パラメータ名
型
説明
page
String
生成されたトーク 省略可能
ン。フィード内の
フィード項目の
ビューを示します。
ページトークンは、
レスポンスボディの
一部として、
nextPageURL な
220
23.0 ～ 31.0
Chatter REST API リソース
パラメータ名
Feed-Items Likes
型
説明
必須項目/省略可能
使用可能なバージョ
ン
ど、いずれかの URL
パラメータで返され
ます。
pageSize
Integer
ページあたりの項目 省略可能
数を指定します。有
効な値は 1 ～ 100 で
す。サイズを指定し
ない場合、デフォル
トは 25 です。
23.0 ～ 31.0
このパラメータは、
ページあたりのコメ
ント数を指定しま
す。
GET または HEAD のレスポンスボディ
Comment Page
POST のレスポンスボディ
Comment
例: コメントの post 送信
この POST 要求では、要求パラメータを使用してフィード項目へのコメントを post 送信します。
/chatter/feed-items/0D5D0000000JvckKAC/comments?text=I+completely+agree
例: コメントの post 送信と既存のファイルの添付
この POST 要求では、コメントを post 送信し、ユーザの組織にすでにアップロードされているファイルを添
付します。
/chatter/feed-items/0D5D0000000JvckKAC/comments?text=yes&attachmentType=ExistingContent&contentDocumentId=069D00000001FHF
例: コメントの post 送信とアップロード、新規ファイルの添付
「バイナリファイルのアップロード」 (ページ 13)を参照してください。
Feed-Items Likes
特定のフィード項目のいいね! へのアクセス、または特定の項目へのいいね! の追加に使用されます。
リソース
/chatter/feed-items/feedItemId/likes
使用可能なバージョン
23.0 ～ 31.0
重要: バージョン 32.0 以降では、Feed Elements Capability, Chatter Likes Items を使用します。
221
Chatter REST API リソース
Feed-Items Polls
Chatter が必要かどうか
はい
HTTP メソッド
GET、POST、または HEAD
GET または HEAD の要求パラメータ
メモ: POST には要求パラメータはありません。
パラメータ名
型
説明
page
Integer
返すページのページ番号を指定し
ます。
pageSize
Integer
ページあたりの項目数を指定しま
す。有効な値は 1 ～ 100 です。サ
イズを指定しない場合、デフォル
トは 25 です。
GET または HEAD のレスポンスボディ
Like Page
POST のレスポンスボディ
Like
関連トピック:
フィード項目にいいね! と言う
Feed-Items Polls
既存のアンケートにアクセスまたは投票するために使用されます。
リソース
/chatter/feed-items/feedItemId/poll
feedItemId は PollPost 型である必要があります。
使用可能なバージョン
26.0 ～ 31.0
重要: バージョン 32.0 以降では、Feed Elements Capability, Poll を使用します。
Chatter が必要かどうか
はい
HTTP メソッド
GET、PATCH、または HEAD
PATCH を使用して既存のアンケートに投票するか、現在のユーザの投票を変更します。
222
Chatter REST API リソース
Feed-Items Topics
PATCH のリクエストボディ
ルート XML タグ
<feedPoll>
プロパティ
名前
型
説明
使用可能なバージョン
myChoiceId
String
フィードアンケートの既 26.0 ～ 31.0
存の選択肢の ID。現在の
ユーザが投票するアン
ケート選択肢の ID を指定
するために使用されま
す。
PATCH の要求パラメータ
名前
型
説明
使用可能なバージョン
myChoiceId
String
フィードアンケートの既 26.0 ～ 31.0
存の選択肢の ID。現在の
ユーザが投票するアン
ケート選択肢の ID を指定
するために使用されま
す。
レスポンスボディ
Feed Item Attachment: Poll
Feed-Items Topics
特定のフィード項目に関連付けられたトピック。新規または既存のトピックを特定のフィード項目に関連付け
ます。トピックを特定のフィード項目から削除します。フィード項目で既存のトピックを追加または削除でき
るのは、「トピックの割り当て」権限を持つユーザのみです。フィード項目に新規のトピックを追加できるの
は、「トピックの作成」権限を持つユーザのみです。
リソース
/chatter/feed-items/feedItemId/topics
使用可能なバージョン
28.0 ～ 31.0
重要: バージョン 32.0 以降では、Feed Elements Capability, Topics を使用します。
Chatter が必要かどうか
はい
223
Chatter REST API リソース
Feed-Items Topics
HTTP メソッド
DELETE、POST
DELETE の要求パラメータ
パラメータ名
型
説明
必須項目/省略可能
topicId
String
既存のトピックの ID 必須項目
使用可能なバージョ
ン
28.0 ～ 31.0
POST のリクエストボディ
ルート XML タグ
<feedItemTopic>
JSON
次の例では、フィード項目に新規のトピックを添付します。
{ "topicName": "W3C"
}
プロパティ
名前
型
説明
必須項目/省略可能
使用可
能な
バー
ジョン
topicId
String
既存のトピックの ID
topicName プロパティが 29.0
使用されていない場合、既
存のトピックに必要です。
topicName
String
新規または既存のトピック 新規のトピック、および 29.0
の名前 (最大 150 文字)
topicId プロパティが使
用されていない場合の既存
のトピックに必要です。
POST の要求パラメータ
パラメータ名
型
説明
必須項目/省略可能
topicId
String
既存のトピックの ID topicName パラ
28.0 ～ 31.0
メータが使用されて
いない場合、既存の
トピックに必要で
す。
224
使用可能なバージョ
ン
Chatter REST API リソース
Feed リソース
パラメータ名
型
説明
必須項目/省略可能
使用可能なバージョ
ン
topicName
String
新規または既存のト 新規のトピック、お 28.0 ～ 31.0
ピックの名前 (最大 よび topicId パラ
150 文字)
メータが使用されて
いない場合の既存の
トピックに必要で
す。
DELETE のレスポンスボディ
204: DELETE が成功しました
POST のレスポンスボディ
Topic
POST の例
この例では、既存のトピックの ID を topidId パラメータで渡してフィード項目に関連付けます。
/chatter/feed-items/0D5D0000000JmiB/topics?topicId=0TOD0000000090r
Feed リソース
フィードは、フィード項目で構成されます。さまざまなフィード種別があります。フィード種別ごとに、どの
フィード項目を含むかを決めるアルゴリズムがあります。
ニュースフィード、レコードフィード、およびユーザプロファイルフィードは GET および POST 要求をサポー
トしています。その他のすべてのフィードは GET 要求をサポートしています。
このセクションの内容:
Bookmarks Feed リソース
コンテキストユーザがブックマークとして保存したフィード要素を含むフィード。
Communities Home Feed リソース
コミュニティの管理トピックに関連付けられたすべてのフィード要素のリストを返します。
Communities Moderation Feed リソース
コミュニティでモデレーション用にフラグが設定されたフィード要素とコメントを含むフィード。
Company Feed リソース
会社全体からのすべてのフィード要素とコメントを含むフィード。
Favorites Feed リソース
コンテキストユーザが保存したお気に入りを含むフィード。
Feeds リソース
コンテキストユーザが表示可能なすべてのフィードのリスト。
225
Chatter REST API リソース
Bookmarks Feed リソース
Files Feed リソース
コンテキストユーザがフォローしている人またはグループによって投稿されたファイルを含むすべての
フィード要素を含むフィード。
Filter Feed リソース
フィルタフィードは、指定されたオブジェクト種別の親を持つフィード要素のみが表示されるように絞り
込まれたニュースフィードです。
Groups Feed リソース
現在のユーザが所有するか、メンバーである全グループからのすべてのフィード要素を含むフィード。
News Feed リソース
コンテキストユーザが関心を示しているフィード要素を含むフィード。ニュースフィードへのフィード項
目の post 送信に使用できます。
People Feed リソース
コンテキストユーザがフォローしているすべての人によって投稿されたすべてのフィード要素。
Record Feed リソース
指定されたレコードのフィード。レコードは、グループ、人、オブジェクト、ファイルなどの場合があり
ます。レコードフィードへのフィード項目の post 送信に使用できます。
To Feed リソース
コンテキストユーザのすべての @メンションと、コンテキストユーザのフィードに対して行われたすべて
の投稿を含むフィード。
Topics Feed リソース
特定のトピックのフィード。
User Profile Feed リソース
フィードで追跡可能なレコードに対して現在のユーザが行ったアクションを含むフィード。このフィード
は、投稿、グループ更新、レコード更新などのより多くの要素を返す /chatter/feeds/news とは異なり
ます。User-Profile Feed へのフィード項目の post 送信に使用できます。
関連トピック:
フィードおよびフィード要素の使用
Bookmarks Feed リソース
コンテキストユーザがブックマークとして保存したフィード要素を含むフィード。
項目をブックマークするには、PATCH を使用し、Feed Elements Capability, Bookmarks リソースと
isBookmarkedByCurrentUser パラメータを指定します。次に例を示します。
/chatter/feed-elements/0D5D0000000Ir6zKAC/capabilities/bookmarks?isBookmarkedByCurrentUser=true
次のリソースを使用できます。
226
Chatter REST API リソース
Bookmarks Feed リソース
リソース
説明
/chatter/feeds/bookmarks/me
コンテキストユーザのブックマークフィードの URL を
返します。
/chatter/feeds/bookmarks/me/feed-elements コンテキストユーザがブックマークしたすべての
フィード要素を返します。
Bookmarks Feed URL
コンテキストユーザのブックマークフィードの URL を返します。
リソース
/chatter/feeds/bookmarks/userId
/connect/communities/communityId/chatter/feeds/bookmarks/userId
メモ: userId は、コンテキストユーザの ID または別名 me である必要があります。
適用開始バージョン
24.0
Chatter が必要かどうか
はい
HTTP メソッド
GET または HEAD
要求パラメータ
パラメータ名
型
説明
sort
String
作成日や最終更新日などで並び替
えて返される順序を指定します。
• CreatedDateDesc — 作成日
の新しい順に並び替えます。
• LastModifiedDateDesc — 活
動の新しい順に並び替えられま
す。
デフォルト値は、
CreatedDescDate です。
レスポンスボディ
Feed
Bookmarks Feed Elements
コンテキストユーザがブックマークしたすべてのフィード要素を返します。
227
Chatter REST API リソース
Bookmarks Feed リソース
リソース
/chatter/feeds/bookmarks/userId/feed-elements
/connect/communities/communityId/chatter/feeds/bookmarks/userId/feed-elements
メモ: userId は、コンテキストユーザの ID または別名 me である必要があります。
適用開始バージョン
24.0
Chatter が必要かどうか
はい
HTTP メソッド
GET または HEAD
GET の要求パラメータ
パラメータ名
型
説明
必須項 使用可能
目/省略 なバー
可能
ジョン
density
String
フィードの密度。次のいずれかの値にしま
す。
省略可
能
31.0
バンドルに含める最大フィード要素数。値は 省略可
0 ～ 10 の整数である必要があります。デフォ 能
ルト値は 3 です。
31.0
• AllUpdates — ユーザがフォローする人
とレコード、およびユーザがメンバーと
なっているグループからのすべての更新
が表示されます。
• FewerUpdates — ユーザがフォローする
人とレコード、およびユーザがメンバー
となっているグループからのすべての更
新が表示されますが、レコードからのシ
ステム生成された更新は非表示になりま
す。
デフォルト値は、AllUpdates です。
elementsPerBundle Integer
メモ: バンドル投稿にはフィード追跡
変更が含まれます。Salesforce1 ダウン
ロード可能アプリケーションでは、バ
ンドル投稿がレコードフィードのみに
あります。
228
Chatter REST API リソース
Bookmarks Feed リソース
パラメータ名
型
説明
必須項 使用可能
目/省略 なバー
可能
ジョン
page
String
生成されたトークン。フィード内のフィード 省略可
要素のビューを示します。
能
31.0
ページトークンは、レスポンスボディの一部
として、nextPageURL など、いずれかの URL
パラメータで返されます。たとえば、次のよ
うになります。
"nextPageUrl":
"/services/data/v34.0/
chatter/feeds/news/
005D0000001GLowIAN
/feed-elements
?page=2011-03-30T17:34:50Z,
0D5D0000000DSv4KAG"
pageSize
Integer
ページあたりの要素数を指定します。有効な 省略可
値は 1 ～ 100 です。サイズを指定しない場
能
合、デフォルトは 25 です。
31.0
q
String
このフィード内のフィード要素の本文とコメ 省略可
ントに含まれる 1 つ以上の検索キーワード。 能
31.0
検索文字列にはワイルドカード文字を含める
ことができ、ワイルドカード文字を除く 2 文
字以上が含まれている必要があります。「ワ
イルドカード」を参照してください。
recentComment Integer
Count
sort
String
フィード要素ごとに含めるコメントの最大 省略可
数。デフォルト値は 3 です。最大値は、25 で 能
す。
31.0
作成日や最終更新日などで並び替えて返され 省略可
る順序を指定します。
能
31.0
• CreatedDateDesc — 作成日の新しい順
に並び替えます。
• LastModifiedDateDesc — 活動の新し
い順に並び替えられます。
デフォルト値は、CreatedDescDate です。
229
Chatter REST API リソース
Bookmarks Feed リソース
レスポンスボディ
Feed Element Page
Bookmarks Feed Items
コンテキストユーザがブックマークしたすべてのフィード項目を返します。
リソース
/chatter/feeds/bookmarks/me/feed-items
または
/chatter/feeds/bookmarks/userId/feed-items
メモ: userId は、コンテキストユーザの ID または別名 me である必要があります。
使用可能なバージョン
24.0 ～ 31.0
重要: バージョン 32.0 以降では、Bookmarks Feed Elements を使用します。
Chatter が必要かどうか
はい
HTTP メソッド
GET または HEAD
要求パラメータ
パラメータ名
型
説明
必須項 使用可能
目/省略 なバー
可能
ジョン
density
String
フィードの密度。次のいずれかの値にしま
す。
省略可
能
• AllUpdates — ユーザがフォローする人
とレコード、およびユーザがメンバーと
なっているグループからのすべての更新
が表示されます。
• FewerUpdates — ユーザがフォローする
人とレコード、およびユーザがメンバー
となっているグループからのすべての更
新が表示されますが、レコードからのシ
ステム生成された更新は非表示になりま
す。
デフォルト値は、AllUpdates です。
230
29.0 ～ 31.0
Chatter REST API リソース
Bookmarks Feed リソース
パラメータ名
型
説明
必須項 使用可能
目/省略 なバー
可能
ジョン
page
String
生成されたトークン。フィード内のフィード 省略可
項目のビューを示します。ページトークン 能
は、レスポンスボディの一部として、
nextPageURL など、いずれかの URL パラメー
タで返されます。たとえば、次のようになり
ます。
23.0 ～ 31.0
"nextPageUrl":
"/services/data/v34.0/
chatter/feeds/news/
005D0000001GLowIAN
/feed-items
?page=2011-03-30T17:34:50Z,
0D5D0000000DSv4KAG"
pageSize
Integer
ページあたりの項目数を指定します。有効な 省略可
値は 1 ～ 100 です。サイズを指定しない場
能
合、デフォルトは 25 です。
23.0 ～ 31.0
q
String
このフィード内のフィード項目の本文とコメ 省略可
ントに含まれる 1 つ以上の検索キーワード。 能
28.0 ～ 31.0
検索文字列にはワイルドカード文字を含める
ことができ、ワイルドカード文字を除く 2 文
字以上が含まれている必要があります。「ワ
イルドカード」を参照してください。
recentComment Integer
Count
sort
String
フィード項目ごとに含めるコメントの最大 省略可
数。デフォルト値は 3 です。最大値は、25 で 能
す。
29.0 ～ 31.0
作成日や最終更新日などで並び替えて返され 省略可
る順序を指定します。
能
23.0 ～ 31.0
• CreatedDateDesc — 作成日の新しい順
に並び替えます。
• LastModifiedDateDesc — 活動の新し
い順に並び替えられます。
デフォルト値は、CreatedDescDate です。
231
Chatter REST API リソース
Bookmarks Feed リソース
レスポンスボディ
Feed Item Page
Bookmarks Feed Items Flat
このリソースは、バージョン 26.0 で廃止されました。
フラットフィードを返します。つまり、フィード項目とコメントの間に階層がなく、フィード項目とコメント
はすべて同じレベルに配置されます。すべての項目は、時系列に返されます。
リソース
/chatter/feeds/bookmarks/me/feed-items/flat
または
/chatter/feeds/bookmarks/userId/feed-items/flat
メモ: userId は、コンテキストユーザの ID または別名 me である必要があります。
適用開始バージョン
25.0 ～ 26.0
Chatter が必要かどうか
はい
HTTP メソッド
GET または HEAD
要求パラメータ
パラメータ名
型
説明
numFeedItems
Integer
返されるフィード項目数を指定し
ます。有効な値は 0 ～ 100 です。
デフォルト値は 25 です。フィード
項目にはコメントが含まれる場合
があるため、25 個のフラット
フィード項目を指定しても、実際
に返される数がそれより多くなる
ことがあります。たとえば、各
フィード項目に 1 つのコメントが
あり、recentCommentCount が
1 よりも大きい場合、50 個のフラッ
トフィード項目が返されます。
page
String
生成されたトークン。フィード内
のフィード項目のビューを示しま
す。ページトークンは、レスポン
スボディの一部として、
232
Chatter REST API リソース
Communities Home Feed リソース
パラメータ名
型
説明
nextPageURL など、いずれかの
URL パラメータで返されます。
recentCommentCount
Integer
sort
String。次のいずれかになります。 返されたフィードを、作成日の昇
順、または最終更新日の昇順で並
• CreatedDateDesc
び替えます。デフォルトは
• LastModifiedDateDesc
LastModifiedDateDesc です。
返される最近のコメントの数を指
定します。有効な値は 0 ～ 25 で
す。デフォルト値は 3 です。
レスポンスボディ
Flat Feed
関連トピック:
フィードおよびフィード要素の使用
Communities Home Feed リソース
コミュニティの管理トピックに関連付けられたすべてのフィード要素のリストを返します。
リソース
/connect/communities/communityId/chatter/feeds/home/feed-elements
適用開始バージョン
32.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、HEAD
GET パラメータ
パラメータ名
型
説明
必須項 使用可能
目/省略 なバー
可能
ジョン
filter
String
フィードに適用可能な検索条件値を指定し
ます。
省略可
能
• AllQuestions — 質問であるフィード要
素のみ。
• CommunityScoped — 今後の使用のため
の予約。
233
32.0
Chatter REST API リソース
パラメータ名
Communities Home Feed リソース
型
説明
必須項 使用可能
目/省略 なバー
可能
ジョン
• SolvedQuestions — 質問で最良の回答
があるフィード要素のみ。
• UnansweredQuestions — 質問で回答が
ないフィード要素のみ。
• UnsolvedQuestions — 質問で最良の回
答がないフィード要素のみ。
page
String
生成されたトークン。フィード内のフィー
ド要素のビューを示します。ページトーク
ンは、レスポンスボディの一部として、
nextPageURL など、いずれかの URL パラ
メータで返されます。たとえば、次のよう
になります。
省略可
能
29.0
"nextPageUrl":
"/services/data/v34.0/
chatter/feeds/news/
005D0000001GLowIAN
/feed-elements
?page=2011-03-30T17:34:50Z,
0D5D0000000DSv4KAG"
pageSize
Integer
ページあたりの要素数を指定します。有効 省略可
な値は 1 ～ 100 です。サイズを指定しない場 能
合、デフォルトは 25 です。
29.0
q
String
このフィード内のフィード要素の本文とコ
メントに含まれる 1 つ以上の検索キーワー
ド。
29.0
検索文字列にはワイルドカード文字を含め
ることができ、ワイルドカード文字を除く
2 文字以上が含まれている必要があります。
「ワイルドカード」を参照してください。
234
省略可
能
Chatter REST API リソース
Communities Moderation Feed リソース
パラメータ名
型
説明
必須項 使用可能
目/省略 なバー
可能
ジョン
sort
String
作成日や最終更新日などで並び替えて返さ
れる順序を指定します。
省略可
能
29.0
• CreatedDateDesc — 作成日の新しい順
に並び替えます。
• LastModifiedDateDesc — 活動の新し
い順に並び替えられます。
デフォルト値は、CreatedDescDate です。
GET のレスポンスボディ
Feed Element Page
Communities Moderation Feed リソース
コミュニティでモデレーション用にフラグが設定されたフィード要素とコメントを含むフィード。
次のリソースを使用できます。
リソース
説明
/connect/communities/communityId
/chatter/feeds/moderation/feed-elements
コンテキストユーザが「コミュニティフィードのモデ
レート」権限を持つコミュニティモデレータの場合、
コミュニティメンバーによってフラグが設定された、
コミュニティ内のすべてのフィード要素とコメントの
リストを返します。デフォルトでは、結果ページごと
に 25 件のフィード要素を返します。
Communities Moderation Feed Elements
コンテキストユーザが「コミュニティフィードのモデレート」権限を持つコミュニティモデレータの場合、コ
ミュニティメンバーによってフラグが設定された、コミュニティ内のすべてのフィード要素とコメントのリス
トを返します。デフォルトでは、結果ページごとに 25 件のフィード要素を返します。
リソース
/connect/communities/communityId/chatter/feeds/moderation/feed-elements
適用開始バージョン
31.0
Chatter が必要かどうか
はい
235
Chatter REST API リソース
Communities Moderation Feed リソース
HTTP メソッド
GET、HEAD
GET パラメータ
パラメータ名
型
説明
必須項 使用可能
目/省略 なバー
可能
ジョン
page
String
生成されたトークン。フィード内のフィー
ド要素のビューを示します。ページトーク
ンは、レスポンスボディの一部として、
nextPageURL など、いずれかの URL パラ
メータで返されます。たとえば、次のよう
になります。
省略可
能
29.0
"nextPageUrl":
"/services/data/v34.0/
chatter/feeds/news/
005D0000001GLowIAN
/feed-elements
?page=2011-03-30T17:34:50Z,
0D5D0000000DSv4KAG"
pageSize
Integer
ページあたりの要素数を指定します。有効 省略可
な値は 1 ～ 100 です。サイズを指定しない場 能
合、デフォルトは 25 です。
29.0
q
String
このフィード内のフィード要素の本文とコ
メントに含まれる 1 つ以上の検索キーワー
ド。
省略可
能
29.0
省略可
能
29.0
検索文字列にはワイルドカード文字を含め
ることができ、ワイルドカード文字を除く
2 文字以上が含まれている必要があります。
「ワイルドカード」を参照してください。
sort
String
作成日や最終更新日などで並び替えて返さ
れる順序を指定します。
• CreatedDateDesc — 作成日の新しい順
に並び替えます。
• LastModifiedDateDesc — 活動の新し
い順に並び替えられます。
236
Chatter REST API リソース
パラメータ名
Communities Moderation Feed リソース
型
説明
必須項 使用可能
目/省略 なバー
可能
ジョン
デフォルト値は、CreatedDescDate です。
GET のレスポンスボディ
Feed Element Page
フィード要素にコメントが含まれる場合、Comment Page レスポンスボディの total プロパティにコメント
数を示す値が含まれます。ただし、comments プロパティにはコメントのコレクションは含まれません。
たとえば、次の応答の抜粋ではコメントが全部で 2 つあることが示されますが、コメントに関する情報は
示されません。
"comments": {
"comments": [],
"currentPageUrl": "/services/data/v34.0/connect/communities/0DBD000000002etOAA
/chatter/feed-elements/0D5D0000000LYi9KAG/comments",
"nextPageUrl": null,
"total": 2
},
Communities Moderation Feed Items
コンテキストユーザが「コミュニティフィードのモデレート」権限を持つコミュニティモデレータの場合、コ
ミュニティメンバーによってフラグが設定された、コミュニティ内のすべてのフィード要素とコメントのリス
トを返します。デフォルトでは、結果ページごとに 25 件のフィード項目を返します。
リソース
/connect/communities/communityId/chatter/feeds/moderation/feed-items
使用可能なバージョン
29.0 ～ 31.0
重要: バージョン 32.0 以降では、Communities Moderation Feed Elements を使用します。
Chatter が必要かどうか
はい
HTTP メソッド
GET、HEAD
237
Chatter REST API リソース
Communities Moderation Feed リソース
GET パラメータ
パラメータ名
型
説明
必須項 使用可能
目/省略 なバー
可能
ジョン
page
String
生成されたトークン。フィード内のフィー
ド項目のビューを示します。ページトーク
ンは、レスポンスボディの一部として、
nextPageURL など、いずれかの URL パラ
メータで返されます。たとえば、次のよう
になります。
省略可
能
29.0 ～ 31.0
"nextPageUrl":
"/services/data/v34.0/
chatter/feeds/news/
005D0000001GLowIAN
/feed-items
?page=2011-03-30T17:34:50Z,
0D5D0000000DSv4KAG"
pageSize
Integer
ページあたりの項目数を指定します。有効 省略可
な値は 1 ～ 100 です。サイズを指定しない場 能
合、デフォルトは 25 です。
29.0 ～ 31.0
q
String
このフィード内のフィード項目の本文とコ
メントに含まれる 1 つ以上の検索キーワー
ド。
省略可
能
29.0 ～ 31.0
省略可
能
29.0 ～ 31.0
検索文字列にはワイルドカード文字を含め
ることができ、ワイルドカード文字を除く
2 文字以上が含まれている必要があります。
「ワイルドカード」を参照してください。
sort
String
作成日や最終更新日などで並び替えて返さ
れる順序を指定します。
• CreatedDateDesc — 作成日の新しい順
に並び替えます。
• LastModifiedDateDesc — 活動の新し
い順に並び替えられます。
デフォルト値は、CreatedDescDate です。
238
Chatter REST API リソース
Company Feed リソース
GET のレスポンスボディ
Feed Item Page
フィード項目にコメントが含まれる場合、Comment Page レスポンスボディの total プロパティにコメント
数を示す値が含まれます。ただし、comments プロパティにはコメントのコレクションは含まれません。
たとえば、次の応答の抜粋ではコメントが全部で 2 つあることが示されますが、コメントに関する情報は
示されません。
"comments": {
"comments": [],
"currentPageUrl": "/services/data/v34.0/connect/communities/0DBD000000002etOAA
/chatter/feed-items/0D5D0000000LYi9KAG/comments",
"nextPageUrl": null,
"total": 2
},
GET の例
次の例では GET 要求を行います。
GET /connect/communities/0DBD000000002etOAA/chatter/feeds/moderation/feed-items
応答は Feed Item Page レスポンスボディです。
関連トピック:
フィードおよびフィード要素の使用
Company Feed リソース
会社全体からのすべてのフィード要素とコメントを含むフィード。
会社フィードには、以下からの投稿とコメントが含まれます。
• 社内のユーザ。ユーザがフォローしている人とフォローしていない人の両方。
• 公開グループ。ユーザがメンバーでないグループを含む。
• ユーザがメンバーである非公開グループ。
• システム管理者がフィード追跡を有効に設定したレコードおよび項目の更新。ユーザがフォローしていな
いものも含む。ただし、ユーザに表示されるのは、ユーザにアクセスが許可されているレコードの更新の
みです。
次の点に注意してください。
• これらのリソースはコミュニティでは使用できません。
次のリソースを使用できます。
239
Chatter REST API リソース
Company Feed リソース
リソース
説明
/chatter/feeds/company
会社フィードへの URL を返します。
/chatter/feeds/company/feed-elements
会社フィードのフィード要素を返します。
Company Feed URL
会社フィードへの URL を返します。
リソース
/chatter/feeds/company
/connect/communities/communityId/chatter/feeds/company
適用開始バージョン
23.0
Chatter が必要かどうか
はい
HTTP メソッド
GET または HEAD
要求パラメータ
パラメータ名
型
説明
sort
String
作成日や最終更新日などで並び替
えて返される順序を指定します。
• CreatedDateDesc — 作成日
の新しい順に並び替えます。
• LastModifiedDateDesc — 活
動の新しい順に並び替えられま
す。
デフォルト値は、
CreatedDescDate です。
レスポンスボディ
Feed
Company Feed Elements
会社フィードのフィード要素を返します。
240
Chatter REST API リソース
Company Feed リソース
リソース
/chatter/feeds/company/feed-elements
/connect/communities/communityId/chatter/feeds/company/feed-elements
適用開始バージョン
31.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、HEAD
要求パラメータ
パラメータ名
型
説明
必須項
目/省略
可能
使用可能
なバー
ジョン
density
String
フィードの密度。次のいずれかの値にします。 省略可能 31.0
• AllUpdates — ユーザがフォローする人とレ
コード、およびユーザがメンバーとなってい
るグループからのすべての更新が表示されま
す。
• FewerUpdates — ユーザがフォローする人
とレコード、およびユーザがメンバーとなっ
ているグループからのすべての更新が表示さ
れますが、レコードからのシステム生成され
た更新は非表示になります。
デフォルト値は、AllUpdates です。
elementsPerBundle Integer
page
String
バンドルに含める最大フィード要素数。値は 0 省略可能 31.0
～ 10 の整数である必要があります。デフォルト
値は 3 です。
生成されたトークン。フィード内のフィード要 省略可能 31.0
素のビューを示します。
ページトークンは、レスポンスボディの一部と
して、nextPageURL など、いずれかの URL パラ
メータで返されます。たとえば、次のようにな
ります。
"nextPageUrl":
"/services/data/v34.0/
chatter/feeds/news/
241
Chatter REST API リソース
パラメータ名
Company Feed リソース
型
説明
必須項
目/省略
可能
使用可能
なバー
ジョン
005D0000001GLowIAN
/feed-elements
?page=2011-03-30T17:34:50Z,
0D5D0000000DSv4KAG"
pageSize
Integer
ページあたりの要素数を指定します。有効な値 省略可能 31.0
は 1 ～ 100 です。サイズを指定しない場合、デ
フォルトは 25 です。
q
String
このフィード内のフィード要素の本文とコメン 省略可能 31.0
トに含まれる 1 つ以上の検索キーワード。
検索文字列にはワイルドカード文字を含めるこ
とができ、ワイルドカード文字を除く 2 文字以
上が含まれている必要があります。「ワイルド
カード」を参照してください。
recentComment
Count
Integer
フィード要素ごとに含めるコメントの最大数。 省略可能 31.0
デフォルト値は 3 です。最大値は、25 です。
sort
String
作成日や最終更新日などで並び替えて返される 省略可能 31.0
順序を指定します。
• CreatedDateDesc — 作成日の新しい順に並
び替えます。
• LastModifiedDateDesc — 活動の新しい順
に並び替えられます。
デフォルト値は、CreatedDescDate です。
updatedSince
String
フィードの変更タイムスタンプと並び替え順を 省略可能 31.0
定義する不透明トークン。
このトークンは作成しません。Feed Element Page
レスポンスボディの updatesToken プロパティ
から、このトークンを取得します。
レスポンスボディ
Feed Element Page
242
Chatter REST API リソース
Company Feed リソース
Company Feed Items
会社フィードのフィード項目を返します。
リソース
/chatter/feeds/company/feed-items
使用可能なバージョン
23.0 ～ 31.0
重要: バージョン 32.0 以降では、Company Feed Elements を使用します。
Chatter が必要かどうか
はい
HTTP メソッド
GET、HEAD
要求パラメータ
パラメータ名
型
説明
必須項
目/省略
可能
使用可能
なバー
ジョン
density
String
フィードの密度。次のいずれかの値にします。 省略可能 29.0 ～ 31.0
• AllUpdates — ユーザがフォローする人とレ
コード、およびユーザがメンバーとなってい
るグループからのすべての更新が表示されま
す。
• FewerUpdates — ユーザがフォローする人
とレコード、およびユーザがメンバーとなっ
ているグループからのすべての更新が表示さ
れますが、レコードからのシステム生成され
た更新は非表示になります。
デフォルト値は、AllUpdates です。
page
String
生成されたトークン。フィード内のフィード要 省略可能 23.0 ～ 31.0
素のビューを示します。
ページトークンは、レスポンスボディの一部と
して、nextPageURL など、いずれかの URL パラ
メータで返されます。たとえば、次のようにな
ります。
"nextPageUrl":
"/services/data/v34.0/
chatter/feeds/news/
243
Chatter REST API リソース
パラメータ名
Company Feed リソース
型
説明
必須項
目/省略
可能
使用可能
なバー
ジョン
005D0000001GLowIAN
/feed-elements
?page=2011-03-30T17:34:50Z,
0D5D0000000DSv4KAG"
pageSize
Integer
ページあたりの項目数を指定します。有効な値 省略可能 23.0 ～ 31.0
は 1 ～ 100 です。サイズを指定しない場合、デ
フォルトは 25 です。
q
String
このフィード内のフィード要素の本文とコメン 省略可能 28.0 ～ 31.0
トに含まれる 1 つ以上の検索キーワード。
検索文字列にはワイルドカード文字を含めるこ
とができ、ワイルドカード文字を除く 2 文字以
上が含まれている必要があります。「ワイルド
カード」を参照してください。
recentComment
Count
Integer
フィード項目ごとに含めるコメントの最大数。 省略可能 29.0 ～ 31.0
デフォルト値は 3 です。最大値は、25 です。
sort
String
作成日や最終更新日などで並び替えて返される 省略可能 23.0 ～ 31.0
順序を指定します。
• CreatedDateDesc — 作成日の新しい順に並
び替えます。
• LastModifiedDateDesc — 活動の新しい順
に並び替えられます。
デフォルト値は、CreatedDescDate です。
updatedSince
String
フィードの変更タイムスタンプと並び替え順を 省略可能 30.0 ～ 31.0
定義する不透明トークン。
このトークンは作成しません。Feed Element Page
レスポンスボディの updatesToken プロパティ
から、このトークンを取得します。
レスポンスボディ
Feed Item Page
関連トピック:
フィードおよびフィード要素の使用
244
Chatter REST API リソース
Favorites Feed リソース
Favorites Feed リソース
コンテキストユーザが保存したお気に入りを含むフィード。
お気に入りとは、コンテキストユーザが Chatter のお気に入りとして追加した検索、リストビュー、およびト
ピックです。
次のリソースを使用できます。
リソース
説明
/chatter/feeds/favorites/me
コンテキストユーザのすべてのお気に入りを返しま
す。Chatterフィード検索またはトピックのお気に入り
を作成します。
/chatter/feeds/favorites/me/favoriteId
指定されたお気に入りのフィードを返します。指定さ
れたお気に入りを削除します。指定されたお気に入り
の最終参照日を更新します。
/chatter/feeds/favorites/me/favoriteId/feed-elements 絞り込み済みのフィードを返し、指定されたお気に入
りの絞り込まれたフィード要素のみを表示します。
List of Favorites
コンテキストユーザのすべてのお気に入りを返します。Chatterフィード検索またはトピックのお気に入りを作
成します。
メモ: 応答には、Web UI を使用して保存されたフィード検索が含まれます。ただし、Chatter API を使用して
フィード検索を保存することはできません。
リソース
/chatter/feeds/favorites/userId
/connect/communities/communityId/chatter/feeds/favorites/userId
メモ: userId は、コンテキストユーザの ID または別名 me である必要があります。
適用開始バージョン
24.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、HEAD、または POST
POST のリクエストボディ
ルート XML タグ
<favorite>
245
Chatter REST API リソース
Favorites Feed リソース
POST の JSON
{
"searchText" : "release",
"targetId" : "0TOD0000000099d"
}
POST のプロパティ
名前
型
説明
使用可能なバージョン
searchText
String
フィード検索のテキス 24.0
ト。このパラメータは、
フィード検索にのみ使用
します。
targetId
String
トピックの ID。このパラ 28.0
メータは、トピックにの
み使用します。
POST の要求パラメータ
名前
型
説明
使用可能なバージョン
searchText
String
24.0
フィード検索のテキス
ト。このパラメータは、
フィード検索にのみ使用
します。
targetId
String
トピックの ID。このパラ 28.0
メータは、トピックにの
み使用します。
GET のレスポンスボディ
Favorites Page
POST のレスポンスボディ
Favorite
Favorite
指定されたお気に入りのフィードを返します。指定されたお気に入りを削除します。指定されたお気に入りの
最終参照日を更新します。
246
Chatter REST API リソース
Favorites Feed リソース
リソース
/chatter/feeds/favorites/userId/favoriteId
/connect/communities/communityId/chatter/feeds/favorites/userId/favoriteId
メモ: userId は、コンテキストユーザの ID または別名 me である必要があります。
適用開始バージョン
24.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、HEAD、PATCH、または DELETE
GET または HEAD の要求パラメータ
パラメータ名
型
説明
sort
String
作成日や最終更新日などで並び替
えて返される順序を指定します。
• CreatedDateDesc — 作成日
の新しい順に並び替えます。
• LastModifiedDateDesc — 活
動の新しい順に並び替えられま
す。
デフォルト値は、
CreatedDescDate です。
PATCH のリクエストボディ
ルート XML タグ
<favorite>
PATCH の JSON
{
"updateLastViewDate" : "true"
}
PATCH のプロパティ
名前
型
説明
updateLastViewDate
Boolean
指定されたフィードのお 24.0
気に入りの最終参照日を
現在のシステム時刻に設
247
使用可能なバージョン
Chatter REST API リソース
名前
Favorites Feed リソース
型
説明
使用可能なバージョン
定します。デフォルト値
は false です。
PATCH の要求パラメータ
パラメータ名
型
説明
updateLastViewDate
Boolean
指定されたフィードのお気に入り
の最終参照日を現在のシステム時
刻に設定します。デフォルト値は
false です。
GET のレスポンスボディ
Favorite
PATCH のレスポンスボディ
Favorite
Favorites Feed Items
絞り込み済みのフィードを返し、指定されたお気に入りの絞り込まれたフィード項目のみを表示します。
リソース
/chatter/feeds/favorites/me/favoriteId/feed-items
または
/chatter/feeds/favorites/userId/favoriteId/feed-items
メモ: userId は、コンテキストユーザの ID または別名 me である必要があります。
使用可能なバージョン
24.0 ～ 31.0
重要: バージョン 32.0 以降では、Favorites Feed Elements を使用します。
Chatter が必要かどうか
はい
HTTP メソッド
GET または HEAD
248
Chatter REST API リソース
Favorites Feed リソース
要求パラメータ
パラメータ名
型
説明
必須項 使用可能
目/省略 なバー
可能
ジョン
density
String
フィードの密度。次のいずれかの値にしま
す。
省略可
能
29.0 ～ 31.0
生成されたトークン。フィード内のフィード 省略可
項目のビューを示します。ページトークン 能
は、レスポンスボディの一部として、
nextPageURL など、いずれかの URL パラメー
タで返されます。たとえば、次のようになり
ます。
23.0 ～ 31.0
• AllUpdates — ユーザがフォローする人
とレコード、およびユーザがメンバーと
なっているグループからのすべての更新
が表示されます。
• FewerUpdates — ユーザがフォローする
人とレコード、およびユーザがメンバー
となっているグループからのすべての更
新が表示されますが、レコードからのシ
ステム生成された更新は非表示になりま
す。
デフォルト値は、AllUpdates です。
page
String
"nextPageUrl":
"/services/data/v34.0/
chatter/feeds/news/
005D0000001GLowIAN
/feed-items
?page=2011-03-30T17:34:50Z,
0D5D0000000DSv4KAG"
pageSize
Integer
ページあたりの項目数を指定します。有効な 省略可
値は 1 ～ 100 です。サイズを指定しない場
能
合、デフォルトは 25 です。
249
23.0 ～ 31.0
Chatter REST API リソース
Favorites Feed リソース
パラメータ名
型
説明
必須項 使用可能
目/省略 なバー
可能
ジョン
q
String
このフィード内のフィード項目の本文とコメ 省略可
ントに含まれる 1 つ以上の検索キーワード。 能
28.0 ～ 31.0
検索文字列にはワイルドカード文字を含める
ことができ、ワイルドカード文字を除く 2 文
字以上が含まれている必要があります。「ワ
イルドカード」を参照してください。
recentComment Integer
Count
sort
String
フィード項目ごとに含めるコメントの最大 省略可
数。デフォルト値は 3 です。最大値は、25 で 能
す。
29.0 ～ 31.0
作成日や最終更新日などで並び替えて返され 省略可
る順序を指定します。
能
23.0 ～ 31.0
• CreatedDateDesc — 作成日の新しい順
に並び替えます。
• LastModifiedDateDesc — 活動の新し
い順に並び替えられます。
デフォルト値は、CreatedDescDate です。
レスポンスボディ
Feed Item Page
関連トピック:
フィードおよびフィード要素の使用
Favorites Feed Elements
絞り込み済みのフィードを返し、指定されたお気に入りの絞り込まれたフィード要素のみを表示します。
リソース
/chatter/feeds/favorites/userId/favoriteId/feed-elements
/connect/communities/communityId/chatter/feeds/favorites/userId/favoriteId/feed-elements
メモ: userId は、コンテキストユーザの ID または別名 me である必要があります。
使用可能なバージョン
31.0
Chatter が必要かどうか
はい
250
Chatter REST API リソース
Favorites Feed リソース
HTTP メソッド
GET
GET の要求パラメータ
パラメータ名
型
説明
必須項目/省略可 使用可能なバー
能
ジョン
elementsPer
Bundle
Integer
バンドルあたりの最大フィード要 省略可能
素数。デフォルトおよび最大値
は、10 です。
31.0
メモ: バンドル投稿には
フィード追跡変更が含まれ
ます。Salesforce1 ダウンロー
ド可能アプリケーションで
は、バンドル投稿がレコー
ドフィードのみにあります。
page
String
ページの表示に使用するページ
省略可能
トークン。ページトークンは、
currentPageToken または
nextPageToken のように、応答
クラスの一部として返されます。
null を渡すと、最初のページが
返されます。
31.0
pageSize
Integer
ページあたりのフィード要素数を 省略可能
指定します。有効な値は 1 ～ 100
です。null を渡すと、デフォル
トサイズの 25 に設定されます。
31.0
recentComment Integer
Count
フィード要素ごとに返されるコメ 省略可能
ントの最大数。デフォルト値は 3
です。
31.0
作成日や最終更新日などで並び替 省略可能
えて返される順序を指定します。
31.0
sort
String
• CreatedDateDesc — 作成日
の新しい順に並び替えます。
• LastModifiedDateDesc — 活
動の新しい順に並び替えられま
す。
null を渡すと、デフォルト値の
CreatedDescDate が使用されま
す。
251
Chatter REST API リソース
Feeds リソース
GET のレスポンスボディ
Feed Element Page
Feeds リソース
コンテキストユーザが表示可能なすべてのフィードのリスト。
ユーザによって表示されるフィードが異なる場合があります。このリソースは、使用可能なフィードを判定す
るために使用します。さらに、各フィードが一意の URL と表示ラベルを持つ場合があります。表示ラベルの値
をハードコードすることは避け、このリソースで返された表示ラベルを使用するようにしてください。
リソース
/chatter/feeds/
/connect/communities/communityId/chatter/feeds/
適用開始バージョン
23.0
Chatter が必要かどうか
はい
HTTP メソッド
GET または HEAD
レスポンスボディ
Feed Directory
Files Feed リソース
コンテキストユーザがフォローしている人またはグループによって投稿されたファイルを含むすべてのフィー
ド要素を含むフィード。
次のリソースを使用できます。
リソース
説明
/chatter/feeds/files/me
コンテキストユーザがフォローしているユーザまたは
グループによって投稿されたファイルを含むフィード
要素への URL を返します。
/chatter/feeds/files/me/feed-elements
コンテキストユーザがフォローしている人またはグ
ループによって投稿されたファイルを含むすべての
フィード要素を返します。
Files Feed URL
コンテキストユーザがフォローしているユーザまたはグループによって投稿されたファイルを含むフィード要
素への URL を返します。
252
Chatter REST API リソース
Files Feed リソース
リソース
/chatter/feeds/files/userId
/connect/communities/communityId/chatter/feeds/files/userId
メモ: userId は、コンテキストユーザの ID または別名 me である必要があります。
適用開始バージョン
23.0
Chatter が必要かどうか
はい
HTTP メソッド
GET または HEAD
要求パラメータ
パラメータ名
型
説明
sort
String
作成日や最終更新日などで並び替
えて返される順序を指定します。
• CreatedDateDesc — 作成日
の新しい順に並び替えます。
• LastModifiedDateDesc — 活
動の新しい順に並び替えられま
す。
デフォルト値は、
CreatedDescDate です。
レスポンスボディ
Feed
Files Feed Elements
コンテキストユーザがフォローしている人またはグループによって投稿されたファイルを含むすべてのフィー
ド要素を返します。
リソース
/chatter/feeds/files/userId/feed-elements
/connect/communities/communityId/chatter/feeds/files/userId/feed-elements
メモ: userId は、コンテキストユーザの ID または別名 me である必要があります。
適用開始バージョン
31.0
253
Chatter REST API リソース
Files Feed リソース
Chatter が必要かどうか
はい
HTTP メソッド
GET、HEAD
要求パラメータ
パラメータ名
型
説明
必須項
目/省略
可能
使用可能
なバー
ジョン
density
String
フィードの密度。次のいずれかの値にします。 省略可能 31.0
• AllUpdates — ユーザがフォローする人とレ
コード、およびユーザがメンバーとなってい
るグループからのすべての更新が表示されま
す。
• FewerUpdates — ユーザがフォローする人
とレコード、およびユーザがメンバーとなっ
ているグループからのすべての更新が表示さ
れますが、レコードからのシステム生成され
た更新は非表示になります。
デフォルト値は、AllUpdates です。
elementsPerBundle Integer
page
String
バンドルに含める最大フィード要素数。値は 0 省略可能 31.0
～ 10 の整数である必要があります。デフォルト
値は 3 です。
生成されたトークン。フィード内のフィード要 省略可能 31.0
素のビューを示します。
ページトークンは、レスポンスボディの一部と
して、nextPageURL など、いずれかの URL パラ
メータで返されます。たとえば、次のようにな
ります。
"nextPageUrl":
"/services/data/v34.0/
chatter/feeds/news/
005D0000001GLowIAN
/feed-elements
?page=2011-03-30T17:34:50Z,
0D5D0000000DSv4KAG"
254
Chatter REST API リソース
Files Feed リソース
パラメータ名
型
説明
必須項
目/省略
可能
使用可能
なバー
ジョン
pageSize
Integer
ページあたりの要素数を指定します。有効な値 省略可能 31.0
は 1 ～ 100 です。サイズを指定しない場合、デ
フォルトは 25 です。
q
String
このフィード内のフィード要素の本文とコメン 省略可能 31.0
トに含まれる 1 つ以上の検索キーワード。
検索文字列にはワイルドカード文字を含めるこ
とができ、ワイルドカード文字を除く 2 文字以
上が含まれている必要があります。「ワイルド
カード」を参照してください。
recentComment
Count
Integer
フィード要素ごとに含めるコメントの最大数。 省略可能 31.0
デフォルト値は 3 です。最大値は、25 です。
sort
String
作成日や最終更新日などで並び替えて返される 省略可能 31.0
順序を指定します。
• CreatedDateDesc — 作成日の新しい順に並
び替えます。
• LastModifiedDateDesc — 活動の新しい順
に並び替えられます。
デフォルト値は、CreatedDescDate です。
updatedSince
String
フィードの変更タイムスタンプと並び替え順を 省略可能 31.0
定義する不透明トークン。
このトークンは作成しません。Feed Element Page
レスポンスボディの updatesToken プロパティ
から、このトークンを取得します。
レスポンスボディ
Feed Element Page
Files Feed Items
コンテキストユーザがフォローしている人またはグループによって投稿されたファイルを含むすべてのフィー
ド項目を返します。
リソース
/chatter/feeds/files/me/feed-items
255
Chatter REST API リソース
Files Feed リソース
または
/chatter/feeds/files/userId/feed-items
メモ: userId は、コンテキストユーザの ID または別名 me である必要があります。
使用可能なバージョン
23.0 ～ 31.0
重要: バージョン 32.0 以降では、Files Feed Elements を使用します。
Chatter が必要かどうか
はい
HTTP メソッド
GET、HEAD
要求パラメータ
パラメータ名
型
説明
必須項
目/省略
可能
使用可能
なバー
ジョン
density
String
フィードの密度。次のいずれかの値にします。 省略可能 29.0 ～ 31.0
• AllUpdates — ユーザがフォローする人とレ
コード、およびユーザがメンバーとなってい
るグループからのすべての更新が表示されま
す。
• FewerUpdates — ユーザがフォローする人
とレコード、およびユーザがメンバーとなっ
ているグループからのすべての更新が表示さ
れますが、レコードからのシステム生成され
た更新は非表示になります。
デフォルト値は、AllUpdates です。
page
String
生成されたトークン。フィード内のフィード要 省略可能 23.0 ～ 31.0
素のビューを示します。
ページトークンは、レスポンスボディの一部と
して、nextPageURL など、いずれかの URL パラ
メータで返されます。たとえば、次のようにな
ります。
"nextPageUrl":
"/services/data/v34.0/
chatter/feeds/news/
005D0000001GLowIAN
256
Chatter REST API リソース
パラメータ名
Files Feed リソース
型
説明
必須項
目/省略
可能
使用可能
なバー
ジョン
/feed-elements
?page=2011-03-30T17:34:50Z,
0D5D0000000DSv4KAG"
pageSize
Integer
ページあたりの項目数を指定します。有効な値 省略可能 23.0 ～ 31.0
は 1 ～ 100 です。サイズを指定しない場合、デ
フォルトは 25 です。
q
String
このフィード内のフィード要素の本文とコメン 省略可能 28.0 ～ 31.0
トに含まれる 1 つ以上の検索キーワード。
検索文字列にはワイルドカード文字を含めるこ
とができ、ワイルドカード文字を除く 2 文字以
上が含まれている必要があります。「ワイルド
カード」を参照してください。
recentComment
Count
Integer
フィード項目ごとに含めるコメントの最大数。 省略可能 29.0 ～ 31.0
デフォルト値は 3 です。最大値は、25 です。
sort
String
作成日や最終更新日などで並び替えて返される 省略可能 23.0 ～ 31.0
順序を指定します。
• CreatedDateDesc — 作成日の新しい順に並
び替えます。
• LastModifiedDateDesc — 活動の新しい順
に並び替えられます。
デフォルト値は、CreatedDescDate です。
updatedSince
String
フィードの変更タイムスタンプと並び替え順を 省略可能 30.0 ～ 31.0
定義する不透明トークン。
このトークンは作成しません。Feed Element Page
レスポンスボディの updatesToken プロパティ
から、このトークンを取得します。
レスポンスボディ
Feed Item Page
Files Feed Items Flat
このリソースは、バージョン 26.0 で廃止されました。
257
Chatter REST API リソース
Files Feed リソース
フラットフィードを返します。つまり、フィード項目とコメントの間に階層がなく、フィード項目とコメント
はすべて同じレベルに配置されます。すべての項目は、時系列に返されます。
リソース
/chatter/feeds/files/me/feed-items/flat
または
/chatter/feeds/files/userId/feed-items/flat
メモ: userId は、コンテキストユーザの ID または別名 me である必要があります。
適用開始バージョン
25.0 ～ 26.0
Chatter が必要かどうか
はい
HTTP メソッド
GET または HEAD
要求パラメータ
パラメータ名
型
説明
numFeedItems
Integer
返されるフィード項目数を指定し
ます。有効な値は 0 ～ 100 です。
デフォルト値は 25 です。フィード
項目にはコメントが含まれる場合
があるため、25 個のフラット
フィード項目を指定しても、実際
に返される数がそれより多くなる
ことがあります。たとえば、各
フィード項目に 1 つのコメントが
あり、recentCommentCount が
1 よりも大きい場合、50 個のフラッ
トフィード項目が返されます。
page
String
生成されたトークン。フィード内
のフィード項目のビューを示しま
す。ページトークンは、レスポン
スボディの一部として、
nextPageURL など、いずれかの
URL パラメータで返されます。
recentCommentCount
Integer
返される最近のコメントの数を指
定します。有効な値は 0 ～ 25 で
す。デフォルト値は 3 です。
258
Chatter REST API リソース
Filter Feed リソース
パラメータ名
型
説明
sort
String。次のいずれかになります。 返されたフィードを、作成日の昇
順、または最終更新日の昇順で並
• CreatedDateDesc
び替えます。デフォルトは
• LastModifiedDateDesc
LastModifiedDateDesc です。
レスポンスボディ
Flat Feed
関連トピック:
フィードおよびフィード要素の使用
Filter Feed リソース
フィルタフィードは、指定されたオブジェクト種別の親を持つフィード要素のみが表示されるように絞り込ま
れたニュースフィードです。
次のリソースを使用できます。
リソース
説明
/chatter/feeds/filter/userId
コンテキストユーザが使用できるフィルタフィードに関
する情報が含まれる、フィードディレクトリオブジェク
トのコレクション。各オブジェクトには、フィルタフィー
ドの URL、フィルタフィード内のフィード項目または
フィード要素の URL、およびフィードの絞り込みに使用
されるオブジェクトを説明する表示ラベルが含まれます。
/chatter/feeds/filter/userId/idPrefix
コンテキストユーザが使用できる特定のフィルタフィー
ドに関する情報が含まれる、フィードオブジェクト。
/chatter/feeds/filter/userId/idPrefix
/feed-elements
コンテキストユーザがメンバーであるすべてのグループ
からのフィード要素など、指定されたキープレフィック
スが含まれる親を持つコンテキストユーザのニュース
フィードからのフィード要素。
List of Filter Feed URLs
コンテキストユーザが使用できるフィルタフィードに関する情報が含まれる、フィードディレクトリオブジェ
クトのコレクション。各オブジェクトには、フィルタフィードの URL、フィルタフィード内のフィード項目ま
たはフィード要素の URL、およびフィードの絞り込みに使用されるオブジェクトを説明する表示ラベルが含ま
れます。各 URL には、キープレフィックスと呼ばれるフィルタオブジェクトの最初の 3 文字が含まれます。こ
れによりオブジェクト種別が示されます。このリソースを使用して、コンテキストユーザが独自のニュース
259
Chatter REST API リソース
Filter Feed リソース
フィードに適用できるキープレフィックスフィルタフィードのリストを返します。「Filter Feed Items」および
「Filter Feed Elements」を参照してください。
メモ: フィードディレクトリオブジェクトのコレクションには、User (005) および Group (0F9) オブジェク
ト種別が含まれることはありません。ただし、これらのオブジェクト種別を使用してフィードを絞り込
むことはできます。
リソース
/chatter/feeds/filter/userId
/connect/communities/communityId/chatter/feeds/filter/userId
userId は、コンテキストユーザの ID または別名 me である必要があります。
適用開始バージョン
23.0
Chatter が必要かどうか
はい
HTTP メソッド
GET または HEAD
レスポンスボディ
Feed Directory
レスポンスボディが空である場合、ユーザはどのレコードもフォローしていないということです。
Specific Filter Feed URL
コンテキストユーザが使用できる特定のフィルタフィードに関する情報が含まれる、フィードオブジェクト。
リソース URL 内の keyPrefix はオブジェクト ID の最初の 3 文字であり、オブジェクト種別を示します。
リソース
/chatter/feeds/filter/userId/keyPrefix
/connect/communities/communityId/chatter/feeds/filter/userId/keyPrefix
userId は、コンテキストユーザの ID または別名 me である必要があります。
適用開始バージョン
23.0
Chatter が必要かどうか
はい
HTTP メソッド
GET または HEAD
260
Chatter REST API リソース
Filter Feed リソース
要求パラメータ
パラメータ名
型
説明
sort
String
作成日や最終更新日などで並び替
えて返される順序を指定します。
• CreatedDateDesc — 作成日
の新しい順に並び替えます。
• LastModifiedDateDesc — 活
動の新しい順に並び替えられま
す。
デフォルト値は、
CreatedDescDate です。
レスポンスボディ
Feed
レスポンスボディの例
この要求では、User オブジェクト (キープレフィックス 005) で絞り込まれたフィルタフィード項目リソー
スの URL が返されます。
GET /chatter/feeds/filter/me/005
Filter Feed Items
コンテキストユーザがメンバーであるすべてのグループからのフィード項目など、指定されたキープレフィッ
クスが含まれる親を持つコンテキストユーザのニュースフィードからのフィード項目。キープレフィックスは
オブジェクト ID の最初の 3 文字であり、オブジェクト種別を示します。
User 親オブジェクトを持つフィード項目で絞り込むには、キープレフィックス 005 を使用します。
Group 親オブジェクトを持つフィード項目で絞り込むには、キープレフィックス 0F9 を使用します。
コンテキストユーザがフォローしている親オブジェクト (取引先など) を持つフィード項目で絞り込むには、List
of Filter Feed URLs リソースを使用して親オブジェクトを返します。
たとえば、コンテキストユーザが 5 つのグループのメンバーであるとします。次のリソースは、それらの 5 つ
のグループに投稿されたすべてのフィード項目を返します。
/chatter/feeds/filter/me/0F9/feed-items
特定のグループに投稿されるフィード項目をすべて返す Record Feed Items リソースへの要求と比べてみましょ
う。
/chatter/feeds/record/0F9XXXXXXXXX/feed-items
フィルタフィードは、コンテキストユーザに表示されるフィード項目のみを返します。最初の例では、リソー
スはコンテキストユーザがメンバーであるグループのフィード項目を返しません。2 番目の例では、このグ
ループが公開グループであれば、コンテキストユーザがメンバーではなくても、グループのすべてのフィード
項目が返されます。
261
Chatter REST API リソース
Filter Feed リソース
リソース
/chatter/feeds/filter/me/keyPrefix/feed-items
または
/chatter/feeds/filter/userId/keyPrefix/feed-items
userId は、コンテキストユーザの ID または別名 me である必要があります。
使用可能なバージョン
23.0 ～ 31.0
重要: バージョン 32.0 以降では、Filter Feed Elements を使用します。
Chatter が必要かどうか
はい
HTTP メソッド
GET または HEAD
要求パラメータ
パラメータ名
型
説明
必須項
目/省略
可能
使用可能
なバー
ジョン
density
String
フィードの密度。次のいずれかの値にします。 省略可能 29.0 ～ 31.0
• AllUpdates — ユーザがフォローする人とレ
コード、およびユーザがメンバーとなってい
るグループからのすべての更新が表示されま
す。
• FewerUpdates — ユーザがフォローする人
とレコード、およびユーザがメンバーとなっ
ているグループからのすべての更新が表示さ
れますが、レコードからのシステム生成され
た更新は非表示になります。
デフォルト値は、AllUpdates です。
page
String
生成されたトークン。フィード内のフィード要 省略可能 23.0 ～ 31.0
素のビューを示します。
ページトークンは、レスポンスボディの一部と
して、nextPageURL など、いずれかの URL パラ
メータで返されます。たとえば、次のようにな
ります。
"nextPageUrl":
"/services/data/v34.0/
262
Chatter REST API リソース
パラメータ名
Filter Feed リソース
型
説明
必須項
目/省略
可能
使用可能
なバー
ジョン
chatter/feeds/news/
005D0000001GLowIAN
/feed-elements
?page=2011-03-30T17:34:50Z,
0D5D0000000DSv4KAG"
pageSize
Integer
ページあたりの項目数を指定します。有効な値 省略可能 23.0 ～ 31.0
は 1 ～ 100 です。サイズを指定しない場合、デ
フォルトは 25 です。
q
String
このフィード内のフィード要素の本文とコメン 省略可能 28.0 ～ 31.0
トに含まれる 1 つ以上の検索キーワード。
検索文字列にはワイルドカード文字を含めるこ
とができ、ワイルドカード文字を除く 2 文字以
上が含まれている必要があります。「ワイルド
カード」を参照してください。
recentComment
Count
Integer
フィード項目ごとに含めるコメントの最大数。 省略可能 29.0 ～ 31.0
デフォルト値は 3 です。最大値は、25 です。
sort
String
作成日や最終更新日などで並び替えて返される 省略可能 23.0 ～ 31.0
順序を指定します。
• CreatedDateDesc — 作成日の新しい順に並
び替えます。
• LastModifiedDateDesc — 活動の新しい順
に並び替えられます。
デフォルト値は、CreatedDescDate です。
updatedSince
String
フィードの変更タイムスタンプと並び替え順を 省略可能 30.0 ～ 31.0
定義する不透明トークン。
このトークンは作成しません。Feed Element Page
レスポンスボディの updatesToken プロパティ
から、このトークンを取得します。
レスポンスボディ
Feed Item Page
263
Chatter REST API リソース
Filter Feed リソース
例
この要求では、User オブジェクトである親を持ち、コンテキストユーザに表示されるすべてのフィード項
目が取得されます。
GET https://instance_name/services/data/v34.0/chatter/feeds/filter/me/005/feed-items
Filter Feed Items Flat
このリソースは、バージョン 26.0 で廃止されました。
フラットフィードを返します。つまり、フィード項目とコメントの間に階層がなく、フィード項目とコメント
はすべて同じレベルに配置されます。すべての項目は、時系列に返されます。
リソース
/chatter/feeds/filter/me/feed-items/flat
または
/chatter/feeds/filter/userId/feed-items/flat
メモ: userId は、コンテキストユーザの ID または別名 me である必要があります。
適用開始バージョン
25.0 ～ 26.0
Chatter が必要かどうか
はい
HTTP メソッド
GET または HEAD
要求パラメータ
パラメータ名
型
説明
numFeedItems
Integer
返されるフィード項目数を指定し
ます。有効な値は 0 ～ 100 です。
デフォルト値は 25 です。フィード
項目にはコメントが含まれる場合
があるため、25 個のフラット
フィード項目を指定しても、実際
に返される数がそれより多くなる
ことがあります。たとえば、各
フィード項目に 1 つのコメントが
あり、recentCommentCount が
1 よりも大きい場合、50 個のフラッ
トフィード項目が返されます。
page
String
生成されたトークン。フィード内
のフィード項目のビューを示しま
す。ページトークンは、レスポン
264
Chatter REST API リソース
パラメータ名
Filter Feed リソース
型
説明
スボディの一部として、
nextPageURL など、いずれかの
URL パラメータで返されます。
返される最近のコメントの数を指
定します。有効な値は 0 ～ 25 で
す。デフォルト値は 3 です。
recentCommentCount
Integer
sort
String。次のいずれかになります。 返されたフィードを、作成日の昇
順、または最終更新日の昇順で並
• CreatedDateDesc
び替えます。デフォルトは
• LastModifiedDateDesc
LastModifiedDateDesc です。
レスポンスボディ
Flat Feed
Filter Feed Elements
コンテキストユーザがメンバーであるすべてのグループからのフィード要素など、指定されたキープレフィッ
クスが含まれる親を持つコンテキストユーザのニュースフィードからのフィード要素。
キープレフィックスはオブジェクト ID の最初の 3 文字であり、オブジェクト種別を示します。
User 親オブジェクトを持つフィード要素で絞り込むには、キープレフィックス 005 を使用します。
Group 親オブジェクトを持つフィード要素で絞り込むには、キープレフィックス 0F9 を使用します。
コンテキストユーザがフォローしている親オブジェクト (取引先など) を持つフィード要素で絞り込むには、List
of Filter Feed URLs リソースを使用して親オブジェクトを返します。
たとえば、コンテキストユーザが 5 つのグループのメンバーであるとします。次のリソースは、それらの 5 つ
のグループのすべてのフィード要素を返します。
/chatter/feeds/filter/me/0F9/feed-elements
フィルタフィードは、コンテキストユーザに表示されるフィード要素のみを返します。この例では、リソース
はコンテキストユーザがメンバーとなっていないグループのフィード要素は返しません。
リソース
/chatter/feeds/filter/userId/keyPrefix/feed-elements
/connect/communities/communityId/chatter/feeds/filter/userId/keyPrefix/feed-elements
userId は、コンテキストユーザの ID または別名 me である必要があります。
使用可能なバージョン
31.0
Chatter が必要かどうか
はい
265
Chatter REST API リソース
Filter Feed リソース
HTTP メソッド
GET
GET の要求パラメータ
パラメータ名
型
説明
必須項目/省略可 使用可能なバー
能
ジョン
density
String
• AllUpdates — ユーザがフォ 省略可能
ローする人とレコード、および
ユーザがメンバーとなっている
グループからのすべての更新が
表示されます。
31.0
• FewerUpdates — ユーザが
フォローする人とレコード、お
よびユーザがメンバーとなって
いるグループからのすべての更
新が表示されますが、レコード
からのシステム生成された更新
は非表示になります。
elementsPer
Bundle
Integer
バンドルあたりの最大フィード要 省略可能
素数。デフォルトおよび最大値
は、10 です。
31.0
メモ: バンドル投稿には
フィード追跡変更が含まれ
ます。Salesforce1 ダウンロー
ド可能アプリケーションで
は、バンドル投稿がレコー
ドフィードのみにあります。
page
String
ページの表示に使用するページ
省略可能
トークン。ページトークンは、
currentPageToken または
nextPageToken のように、応答
クラスの一部として返されます。
null を渡すと、最初のページが
返されます。
31.0
pageSize
Integer
ページあたりのフィード要素数を 省略可能
指定します。有効な値は 1 ～ 100
です。null を渡すと、デフォル
トサイズの 25 に設定されます。
31.0
q
String
コンテキストユーザに表示される 省略可能
フィード要素に含まれる 1 つ以上
31.0
266
Chatter REST API リソース
パラメータ名
Groups Feed リソース
型
説明
必須項目/省略可 使用可能なバー
能
ジョン
の検索キーワード。検索文字列に
はワイルドカード文字を含めるこ
とができ、ワイルドカード文字を
除く 2 文字以上が含まれている必
要があります。「ワイルドカー
ド」を参照してください。
recentComment Integer
Count
sort
String
フィード要素ごとに返されるコメ 省略可能
ントの最大数。デフォルト値は 3
です。
31.0
作成日や最終更新日などで並び替 省略可能
えて返される順序を指定します。
31.0
• CreatedDateDesc — 作成日
の新しい順に並び替えます。
• LastModifiedDateDesc — 活
動の新しい順に並び替えられま
す。
null を渡すと、デフォルト値の
CreatedDescDate が使用されま
す。
updatedSince
String
フィードの変更タイムスタンプと 省略可能
並び替え順を定義する不透明トー
クン。
31.0
GET のレスポンスボディ
Feed Element Page
Groups Feed リソース
現在のユーザが所有するか、メンバーである全グループからのすべてのフィード要素を含むフィード。
次のリソースを使用できます。
リソース
説明
/chatter/feeds/groups/me
現在のサインインユーザがメンバーである全グループ
のフィード要素への URL を返します。
/chatter/feeds/groups/me/feed-elements
現在のユーザが所有するか、メンバーである全グルー
プの全フィード要素を返します。
267
Chatter REST API リソース
Groups Feed リソース
Groups Feed URL
現在のサインインユーザがメンバーである全グループのフィード要素への URL を返します。
リソース
/chatter/feeds/groups/userId
/connect/communities/communityId/chatter/feeds/groups/userId
メモ: userId は、コンテキストユーザの ID または別名 me である必要があります。
レスポンスボディ
Feed
Groups Feed Elements
現在のユーザが所有するか、メンバーである全グループの全フィード要素を返します。
特定のグループのフィード要素を取得するには、Record Feed リソース
(/chatter/feeds/record/recordId/feed-elements) を使用して、recordId にグループ ID を代入しま
す。
リソース
/chatter/feeds/groups/userId/feed-elements
/connect/communities/communityId/chatter/feeds/groups/userId/feed-elements
メモ: userId は、コンテキストユーザの ID または別名 me である必要があります。
適用開始バージョン
31.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、HEAD
要求パラメータ
パラメータ名
型
説明
必須項
目/省略
可能
density
String
フィードの密度。次のいずれかの値にします。 省略可能 31.0
• AllUpdates — ユーザがフォローする人とレ
コード、およびユーザがメンバーとなってい
るグループからのすべての更新が表示されま
す。
• FewerUpdates — ユーザがフォローする人
とレコード、およびユーザがメンバーとなっ
268
使用可能
なバー
ジョン
Chatter REST API リソース
パラメータ名
Groups Feed リソース
型
説明
必須項
目/省略
可能
使用可能
なバー
ジョン
ているグループからのすべての更新が表示さ
れますが、レコードからのシステム生成され
た更新は非表示になります。
デフォルト値は、AllUpdates です。
elementsPerBundle Integer
page
String
バンドルに含める最大フィード要素数。値は 0 省略可能 31.0
～ 10 の整数である必要があります。デフォルト
値は 3 です。
生成されたトークン。フィード内のフィード要 省略可能 31.0
素のビューを示します。
ページトークンは、レスポンスボディの一部と
して、nextPageURL など、いずれかの URL パラ
メータで返されます。たとえば、次のようにな
ります。
"nextPageUrl":
"/services/data/v34.0/
chatter/feeds/news/
005D0000001GLowIAN
/feed-elements
?page=2011-03-30T17:34:50Z,
0D5D0000000DSv4KAG"
pageSize
Integer
ページあたりの要素数を指定します。有効な値 省略可能 31.0
は 1 ～ 100 です。サイズを指定しない場合、デ
フォルトは 25 です。
q
String
このフィード内のフィード要素の本文とコメン 省略可能 31.0
トに含まれる 1 つ以上の検索キーワード。
検索文字列にはワイルドカード文字を含めるこ
とができ、ワイルドカード文字を除く 2 文字以
上が含まれている必要があります。「ワイルド
カード」を参照してください。
recentComment
Count
Integer
フィード要素ごとに含めるコメントの最大数。 省略可能 31.0
デフォルト値は 3 です。最大値は、25 です。
269
Chatter REST API リソース
Groups Feed リソース
パラメータ名
型
説明
必須項
目/省略
可能
使用可能
なバー
ジョン
sort
String
作成日や最終更新日などで並び替えて返される 省略可能 31.0
順序を指定します。
• CreatedDateDesc — 作成日の新しい順に並
び替えます。
• LastModifiedDateDesc — 活動の新しい順
に並び替えられます。
デフォルト値は、CreatedDescDate です。
updatedSince
String
フィードの変更タイムスタンプと並び替え順を 省略可能 31.0
定義する不透明トークン。
このトークンは作成しません。Feed Element Page
レスポンスボディの updatesToken プロパティ
から、このトークンを取得します。
レスポンスボディ
Feed Element Page
Groups Feed Items
現在のユーザが所有するか、メンバーである全グループの全フィード項目を返します。
特定のグループのフィード項目を取得するには、Record Feed リソース
(/chatter/feeds/record/recordId/feed-items) を使用して、recordId にグループ ID を代入します。
リソース
/chatter/feeds/groups/me/feed-items
または
/chatter/feeds/groups/userId/feed-items
メモ: userId は、コンテキストユーザの ID または別名 me である必要があります。
使用可能なバージョン
23.0 ～ 31.0
重要: バージョン 32.0 以降では、Groups Feed Elements を使用します。
Chatter が必要かどうか
はい
HTTP メソッド
GET、HEAD
270
Chatter REST API リソース
Groups Feed リソース
要求パラメータ
パラメータ名
型
説明
必須項
目/省略
可能
使用可能
なバー
ジョン
density
String
フィードの密度。次のいずれかの値にします。 省略可能 29.0 ～ 31.0
• AllUpdates — ユーザがフォローする人とレ
コード、およびユーザがメンバーとなってい
るグループからのすべての更新が表示されま
す。
• FewerUpdates — ユーザがフォローする人
とレコード、およびユーザがメンバーとなっ
ているグループからのすべての更新が表示さ
れますが、レコードからのシステム生成され
た更新は非表示になります。
デフォルト値は、AllUpdates です。
page
String
生成されたトークン。フィード内のフィード要 省略可能 23.0 ～ 31.0
素のビューを示します。
ページトークンは、レスポンスボディの一部と
して、nextPageURL など、いずれかの URL パラ
メータで返されます。たとえば、次のようにな
ります。
"nextPageUrl":
"/services/data/v34.0/
chatter/feeds/news/
005D0000001GLowIAN
/feed-elements
?page=2011-03-30T17:34:50Z,
0D5D0000000DSv4KAG"
pageSize
Integer
ページあたりの項目数を指定します。有効な値 省略可能 23.0 ～ 31.0
は 1 ～ 100 です。サイズを指定しない場合、デ
フォルトは 25 です。
q
String
このフィード内のフィード要素の本文とコメン 省略可能 28.0 ～ 31.0
トに含まれる 1 つ以上の検索キーワード。
検索文字列にはワイルドカード文字を含めるこ
とができ、ワイルドカード文字を除く 2 文字以
271
Chatter REST API リソース
パラメータ名
Groups Feed リソース
型
説明
必須項
目/省略
可能
使用可能
なバー
ジョン
上が含まれている必要があります。「ワイルド
カード」を参照してください。
recentComment
Count
Integer
フィード項目ごとに含めるコメントの最大数。 省略可能 29.0 ～ 31.0
デフォルト値は 3 です。最大値は、25 です。
sort
String
作成日や最終更新日などで並び替えて返される 省略可能 23.0 ～ 31.0
順序を指定します。
• CreatedDateDesc — 作成日の新しい順に並
び替えます。
• LastModifiedDateDesc — 活動の新しい順
に並び替えられます。
デフォルト値は、CreatedDescDate です。
updatedSince
String
フィードの変更タイムスタンプと並び替え順を 省略可能 30.0 ～ 31.0
定義する不透明トークン。
このトークンは作成しません。Feed Element Page
レスポンスボディの updatesToken プロパティ
から、このトークンを取得します。
レスポンスボディ
Feed Item Page
Groups Feed Items Flat
このリソースは、バージョン 26.0 で廃止されました。
フラットフィードを返します。つまり、フィード項目とコメントの間に階層がなく、フィード項目とコメント
はすべて同じレベルに配置されます。すべての項目は、時系列に返されます。
リソース
/chatter/feeds/groups/me/feed-items/flat
または
/chatter/feeds/groups/userId/feed-items/flat
メモ: userId は、コンテキストユーザの ID または別名 me である必要があります。
適用開始バージョン
25.0 ～ 26.0
Chatter が必要かどうか
はい
272
Chatter REST API リソース
Groups Feed リソース
HTTP メソッド
GET または HEAD
要求パラメータ
パラメータ名
型
説明
numFeedItems
Integer
返されるフィード項目数を指定し
ます。有効な値は 0 ～ 100 です。
デフォルト値は 25 です。フィード
項目にはコメントが含まれる場合
があるため、25 個のフラット
フィード項目を指定しても、実際
に返される数がそれより多くなる
ことがあります。たとえば、各
フィード項目に 1 つのコメントが
あり、recentCommentCount が
1 よりも大きい場合、50 個のフラッ
トフィード項目が返されます。
page
String
生成されたトークン。フィード内
のフィード項目のビューを示しま
す。ページトークンは、レスポン
スボディの一部として、
nextPageURL など、いずれかの
URL パラメータで返されます。
recentCommentCount
Integer
返される最近のコメントの数を指
定します。有効な値は 0 ～ 25 で
す。デフォルト値は 3 です。
sort
String。次のいずれかになります。 返されたフィードを、作成日の昇
順、または最終更新日の昇順で並
• CreatedDateDesc
び替えます。デフォルトは
• LastModifiedDateDesc
LastModifiedDateDesc です。
レスポンスボディ
Flat Feed
関連トピック:
Groups リソース
Record Feed リソース
フィードおよびフィード要素の使用
273
Chatter REST API リソース
News Feed リソース
News Feed リソース
コンテキストユーザが関心を示しているフィード要素を含むフィード。ニュースフィードへのフィード項目の
post 送信に使用できます。
メモ: このフィードの構成は、Chatter Web UI に表示されているフィードと一致させるために、リリースに
よって異なる場合があります。
次のリソースを使用できます。
リソース
説明
/chatter/feeds/news/me
コンテキストユーザの全フィードのフィード要素への
URL を返します。また、フィードをポーリングして更
新するための Is-Modified リソースも返します。
/chatter/feeds/news/me/is-modified
指定した日時以降、ニュースフィードが更新または変
更されたかどうかについての情報を返します。
/chatter/feeds/news/me/feed-elements
コンテキストユーザが所有するグループかメンバーで
あるグループすべてからの全フィード要素と、コンテ
キストユーザがフォローしている全ファイル、レコー
ド、およびユーザからの全フィード要素。このリソー
スは、フィード要素に関する情報を取得し、フィード
要素を投稿するために使用します。
News Feed URL
コンテキストユーザの全フィードのフィード要素への URL を返します。また、フィードをポーリングして更新
するための Is-Modified リソースも返します。
リソース
/chatter/feeds/news/userId
/connect/communities/communityId/chatter/feeds/news/userId
メモ: userId は、コンテキストユーザの ID または別名 me である必要があります。
適用開始バージョン
23.0
Chatter が必要かどうか
はい
HTTP メソッド
GET または HEAD
274
Chatter REST API リソース
News Feed リソース
要求パラメータ
パラメータ名
型
説明
sort
String
作成日や最終更新日などで並び替
えて返される順序を指定します。
• CreatedDateDesc — 作成日
の新しい順に並び替えます。
• LastModifiedDateDesc — 活
動の新しい順に並び替えられま
す。
デフォルト値は、
CreatedDescDate です。
レスポンスボディ
Feed
レスポンスボディの例
{
"feedElementPostUrl": "/services/data/v34.0/chatter/feed-elements",
"feedElementsUrl":
"/services/data/v34.0/chatter/feeds/news/005xx000001Sv1mAAB/feed-elements",
"isModifiedUrl":
"/services/data/v34.0/chatter/feeds/news/005xx000001Sv1mAAB/is-modified?since=2%3A1344352279000"
}
News Feed Is-Modified
指定した日時以降、ニュースフィードが更新または変更されたかどうかについての情報を返します。
メモ: Is-Modified リソースは正式リリースされていますが、組織にそれを事前設定なしで使用する権限が
ない場合があります。このリソースにアクセスできない場合は、Salesforce 担当者に連絡して、「Chatter
フィードのポーリングの有効化」権限についてお問い合わせください。
Is-Modified リソースを導入する前に、News Feed Items リソースを使用してニュースフィードを直接ポーリングし
てから比較し、ニュースフィードが変更されたかどうかを確認する必要があります。ニュースフィードの取得
は、コンピュータリソースを大量に消費します。また、フィードを直接ポーリングすると、Chatter REST API で
指定されたレート制限を超える可能性が高くなります。
アプリケーションでニュースフィードを直接ポーリングする場合は、コードで Is-Modified リソースを使用して、
レート制限に到達する可能性を抑えコンピュータリソースを節約することをお勧めします。
275
Chatter REST API リソース
News Feed リソース
メモ: ISV としてリモート組織と連携している場合、Organization リソースと、Features レスポンスボディの
feedPolling プロパティを使用して、ポーリング方針を決定します。feedPolling が有効になってい
ない場合、新規コンテンツをポーリングする頻度を抑えます。
Is-Modified リソースを使用したニュースフィードのポーリング
1. /chatter/feeds/news/me/feed-elements、/chatter/feeds/news/me のいずれかのリソースを
使用して、ニュースフィードから最新の要素を取得するか、フィードに関する情報を取得します。
どちらのリソースのレスポンスボディにも、isModifiedUrl プロパティがあります。このプロパティ
には Is-Modified リソースの URL があり、フィードの最終更新日を定義する since 要求パラメータが含ま
れています。ニュースフィード要求の並び替え順が変わると、ニュースフィードが変更されます。
2. isModifiedUrl プロパティの URL に対して GET 要求を発行します。
Feed Modified Info 応答には、次のプロパティが含まれます。
• isModified — 最後にチェックしてからフィードが更新されたかどうかを示す boolean。このプロパ
ティが true となる条件は、ニュースフィードの元の要求の並び替え順によって異なります。たと
えば、フィードが投稿日 (CreatedDateDesc) で並び替えられ、コメントが追加されていると、
isModified は false になります。
• nextPollUrl — Is-Modified リソースの URL を含む文字列。このプロパティには、isModified が
false の場合にのみ URL が含まれます。isModified が true の場合、nextPollUrl は null にな
ります。
3. isModified プロパティが true の場合は、News Feed Elements リソースに GET 要求を発行して、ニュー
スフィードを更新します。
4. isModified プロパティが false の場合は、nextPollUrl プロパティの URL に対して GET 要求を発行
します。この要求は、isModified プロパティと nextPollUrl プロパティを含む Feed Modified Info レス
ポンスボディも返します。
メモ: 1 分間に 1 回を超えてポーリングしないでください。
リソース
/chatter/feeds/news/userId/is-modified
/connect/communities/communityId/chatter/feeds/news/userId/is-modified
メモ: userId は、コンテキストユーザの ID または別名 me である必要があります。
適用開始バージョン
26.0
Chatter が必要かどうか
はい
HTTP メソッド
GET または HEAD
276
Chatter REST API リソース
News Feed リソース
要求パラメータ
パラメータ名
型
説明
必須項目/省略可能 適用開始
バージョ
ン
since
String
フィードの変更タイムスタンプと並び替え 必須項目
順に関する情報を含む不透明トークン。
23.0
このトークンは作成しません。Feed Item Page
または Feed Modified Info レスポンスボディの
isModifiedToken プロパティから、この
トークンを取得します。
レスポンスボディ
Feed Modified Info
News Feed Elements
コンテキストユーザが所有するグループかメンバーであるグループすべてからの全フィード要素と、コンテキ
ストユーザがフォローしている全ファイル、レコード、およびユーザからの全フィード要素。このリソース
は、フィード要素に関する情報を取得し、フィード要素を投稿するために使用します。
フィード要素の投稿についての詳細は、「Feed Elements, Post and Search」を参照してください。
バイナリファイルのアップロードとフィード要素への添付についての詳細は、「バイナリファイルのアップ
ロード」を参照してください。
このリソースの GET 要求は isModifiedUrl プロパティを返します。このプロパティには、フィードをポーリ
ングして更新するための News Feed Is-Modified リソースが含まれます。
リソース
/chatter/feeds/news/userId/feed-elements
/connect/communities/communityId/chatter/feeds/news/userId/feed-elements
メモ: userId は、コンテキストユーザの ID または別名 me である必要があります。
適用開始バージョン
31.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、HEAD
277
Chatter REST API リソース
News Feed リソース
GET の要求パラメータ
パラメータ名
型
説明
必須項
目/省略
可能
使用可能
なバー
ジョン
density
String
フィードの密度。次のいずれかの値にします。 省略可能 31.0
• AllUpdates — ユーザがフォローする人とレ
コード、およびユーザがメンバーとなってい
るグループからのすべての更新が表示されま
す。
• FewerUpdates — ユーザがフォローする人
とレコード、およびユーザがメンバーとなっ
ているグループからのすべての更新が表示さ
れますが、レコードからのシステム生成され
た更新は非表示になります。
デフォルト値は、AllUpdates です。
elementsPerBundle Integer
バンドルに含める最大フィード要素数。値は 0 省略可能 31.0
～ 10 の整数である必要があります。デフォルト
値は 3 です。
メモ: バンドル投稿にはフィード追跡変更
が含まれます。Salesforce1 ダウンロード可
能アプリケーションでは、バンドル投稿が
レコードフィードのみにあります。
filter
String
フィードに適用可能な検索条件の値を指定しま 省略可能 32.0
す。
• AllQuestions — 質問であるフィード要素
のみ。
• CommunityScoped — 今後の使用のために予
約されています。
• SolvedQuestions — 質問で最良の回答があ
るフィード要素のみ。
• UnansweredQuestions — 質問で回答がな
いフィード要素のみ。
• UnsolvedQuestions — 質問で最良の回答が
ないフィード要素のみ。
278
Chatter REST API リソース
News Feed リソース
パラメータ名
型
説明
必須項
目/省略
可能
使用可能
なバー
ジョン
page
String
生成されたトークン。フィード内のフィード要 省略可能 31.0
素のビューを示します。
ページトークンは、レスポンスボディの一部と
して、nextPageURL など、いずれかの URL パラ
メータで返されます。
"nextPageUrl":
"/services/data/v34.0/
chatter/feeds/news/
005D0000001GLowIAN
/feed-elements
?page=2011-03-30T17:34:50Z,
0D5D0000000DSv4KAG"
pageSize
Integer
ページあたりの要素数を指定します。有効な値 省略可能 31.0
は 1 ～ 100 です。サイズを指定しない場合、デ
フォルトは 25 です。
q
String
このフィード内のフィード要素の本文とコメン 省略可能 31.0
トに含まれる 1 つ以上の検索キーワード。
検索文字列にはワイルドカード文字を含めるこ
とができ、ワイルドカード文字を除く 2 文字以
上が含まれている必要があります。「ワイルド
カード」を参照してください。
recentComment
Count
Integer
フィード要素ごとに含めるコメントの最大数。 省略可能 31.0
デフォルト値は 3 です。最大値は、25 です。
sort
String
作成日や最終更新日などで並び替えて返される 省略可能 31.0
順序を指定します。
• CreatedDateDesc — 作成日の新しい順に並
び替えます。
• LastModifiedDateDesc — 活動の新しい順
に並び替えられます。
デフォルト値は、CreatedDescDate です。
279
Chatter REST API リソース
News Feed リソース
パラメータ名
型
説明
必須項
目/省略
可能
使用可能
なバー
ジョン
updatedSince
String
フィードの変更タイムスタンプと並び替え順を 省略可能 31.0
定義する不透明トークン。
このトークンは作成しません。Feed Element Page
レスポンスボディの updatesToken プロパティ
から、このトークンを取得します。
GET のレスポンスボディ
Feed Element Page
News Feed Items
コンテキストユーザが所有するグループかメンバーであるグループすべてからの全フィード要素と、コンテキ
ストユーザがフォローしている全ファイル、レコード、およびユーザからの全フィード項目。このリソース
は、フィード項目に関する情報の取得と、フィード項目の投稿 (ファイルを添付する、リンク、アンケート、
質問を投稿する、投稿を共有するなど) に使用します。
フィード項目の post 送信についての詳細は、「入力での POST、PATCH、または PUT の使用」 (ページ 13)を参照
してください。
バイナリファイルのアップロードとフィード項目への添付についての詳細は、「バイナリファイルのアップ
ロード」 (ページ 13)を参照してください。
このリソースの GET 要求は isModifiedUrl プロパティを返します。このプロパティには、フィードをポーリ
ングして更新するための News Feed Is-Modified リソースが含まれます。
API バージョン 29.0 では、フィード項目に 5000 文字まで含めることができます。この変更には後方互換性があ
り、以前のすべての API バージョンで 5000 文字の制限がサポートされています。
リソース
/chatter/feeds/news/userId/feed-items
メモ: userId は、コンテキストユーザの ID または別名 me である必要があります。
使用可能なバージョン
23.0 ～ 31.0
重要: バージョン 32.0 以降では、News Feed Elements を使用します。
Chatter が必要かどうか
はい
HTTP メソッド
GET、POST、HEAD
280
Chatter REST API リソース
News Feed リソース
GET の要求パラメータ
パラメータ名
型
説明
必須項 使用可能
目/省略 なバー
可能
ジョン
density
String
フィードの密度。次のいずれかの値にしま
す。
省略可
能
29.0 ～ 31.0
生成されたトークン。フィード内のフィード 省略可
項目のビューを示します。ページトークン 能
は、レスポンスボディの一部として、
nextPageURL など、いずれかの URL パラメー
タで返されます。
23.0 ～ 31.0
• AllUpdates — ユーザがフォローする人
とレコード、およびユーザがメンバーと
なっているグループからのすべての更新
が表示されます。
• FewerUpdates — ユーザがフォローする
人とレコード、およびユーザがメンバー
となっているグループからのすべての更
新が表示されますが、レコードからのシ
ステム生成された更新は非表示になりま
す。
デフォルト値は、AllUpdates です。
page
String
"nextPageUrl":
"/services/data/v34.0/
chatter/feeds/news/
005D0000001GLowIAN
/feed-items
?page=2011-03-30T17:34:50Z,
0D5D0000000DSv4KAG"
pageSize
Integer
ページあたりの項目数を指定します。有効な 省略可
値は 1 ～ 100 です。サイズを指定しない場
能
合、デフォルトは 25 です。
281
23.0 ～ 31.0
Chatter REST API リソース
News Feed リソース
パラメータ名
型
説明
必須項 使用可能
目/省略 なバー
可能
ジョン
q
String
このフィード内のフィード項目の本文とコメ 省略可
ントに含まれる 1 つ以上の検索キーワード。 能
28.0 ～ 31.0
検索文字列にはワイルドカード文字を含める
ことができ、ワイルドカード文字を除く 2 文
字以上が含まれている必要があります。「ワ
イルドカード」を参照してください。
recentComment Integer
Count
String
sort
フィード項目ごとに含めるコメントの最大 省略可
数。デフォルト値は 3 です。最大値は、25 で 能
す。
29.0 ～ 31.0
作成日や最終更新日などで並び替えて返され 省略可
る順序を指定します。
能
23.0 ～ 31.0
• CreatedDateDesc — 作成日の新しい順
に並び替えます。
• LastModifiedDateDesc — 活動の新し
い順に並び替えられます。
デフォルト値は、CreatedDescDate です。
updatedSince String
フィードの変更タイムスタンプと並び替え順 省略可
を定義する不透明トークン。
能
このトークンは作成しません。Feed Item Page
レスポンスボディの updatesToken プロパ
ティから、このトークンを取得します。
POST のリクエストボディ
ルート XML タグ
<feedItem>
JSON
次の例では、フィード項目にアンケートを添付します。
{
"body":{
"messageSegments":[
{
"type":"Text",
282
30.0 ～ 31.0
Chatter REST API リソース
News Feed リソース
"text":"When should we meet for release planning?"
}
]
},
"capabilities":{
"poll":{
"choices":[
"Monday",
"Tuesday"
]
}
},
"feedElementType":"FeedItem",
"subjectId":"me"
}
フィード項目は複数の機能をサポートします。次の例では、ファイルをフィード項目に添付し、ブック
マークします。
{
"body":{
"messageSegments":[
{
"type":"Text",
"text":"Check out the latest marketing collateral."
}
]
},
"capabilities":{
"bookmarks":{
283
Chatter REST API リソース
News Feed リソース
"isBookmarkedByCurrentUser": true
},
"content":{
"contentDocumentId": "069D00000001uQO"
}
},
"feedElementType":"FeedItem",
"subjectId":"me"
}
プロパティ
名前
型
説明
必須項目/省略可能 使用可能
なバー
ジョン
attachment
種別によって異な
る。
attachment パラメータには、 省略可能
次のいずれか 1 つの値のみを
指定できます。値は次のとお
りです。
• Attachment Input: Canvas App
(v29.0 ～ 31.0)
• Attachment Input: Existing
Content (v23.0 ～ 31.0)
• Attachment Input: Feed Poll
(v26.0 ～ 31.0)
• Attachment Input: Link (v23.0
～ 31.0)
• Attachment Input: New File
Upload (v23.0 ～ 31.0)
重要: API バージョン
32.0 以降では、
capabilities プロパ
ティを使用します。
284
Chatter REST API リソース
News Feed リソース
名前
型
説明
必須項目/省略可能 使用可能
なバー
ジョン
body
Message Body Input
メッセージ本文の説明。本文 フィード項目にコ
には 25 文字まで使用できま ンテンツ機能また
す。
はリンク機能があ
フィード項目を共有するため る場合を除き、必
の originalFeedItemId を 須
23.0
指定する場合、body プロパ
ティを使用してコメントを
フィード項目に追加します。
このフィード項目が共有され
ている場合、この値は最初の
コメントの本文です。
capabilities
Feed Element
Capabilities Input
このフィード要素の動作を定 省略可能
義する機能。
31.0
isBookmarked
ByCurrentUser
Boolean
新しいフィード項目をユーザ 省略可能
のためにブックマークするか
(true)、否か (false) を指定
します。デフォルト値は、
false です。
24.0 ～
31.0
重要: API バージョン
32.0 以降では、
capabilities.bookmarks.
isBookmarkedByCurrentUser
プロパティを使用しま
す。
feedElementType String
この入力が表すフィード要素 必須項目
の種別。
31.0
有効な値は FeedItem のみ
です。
originalFeedElementId String
このフィード要素が共有され 省略可能
ている場合、これは元の
フィード要素の 18 文字の ID
です。
メモ: このパラメータ
は、他のすべてのパラ
メータよりも優先され
ます。たとえば、投稿
285
31.0
Chatter REST API リソース
名前
News Feed リソース
型
説明
必須項目/省略可能 使用可能
なバー
ジョン
を共有し、さらにファ
イルのアップロードも
試みる場合、生成され
たフィード項目には共
有された投稿のみが含
まれます。1 つの POST
内では、投稿の共有か
ファイルのアップロー
ドのどちらか 1 つのみ
(両方ではなく) を行う
必要があります。
originalFeedItemId String
このフィード項目が共有され 省略可能
ている場合、これは元の
フィード項目の 18 文字の ID
です。
24.0 ～
31.0
重要: API バージョン
32.0 以降は、
originalFeedElementId
プロパティを使用しま
す。
subjectId
String
このフィード要素が投稿され 必須項目
た親の ID。この値は、ユー
ザ、グループ、レコードの
ID、またはコンテキストユー
ザを示す文字列 me になりま
す。
31.0
visibility
String
投稿を表示できるユーザ。有 省略可能
効な値は、次のとおりです。
26.0
• InternalUsers — コ
ミュニティが有効な場合
は、デフォルトの内部コ
ミュニティのメンバーに
対してのみフィード項目
を表示できます。
• AllUsers — コミュニ
ティが有効な場合は、コ
ミュニティのすべてのメ
286
Chatter REST API リソース
名前
News Feed リソース
型
説明
必須項目/省略可能 使用可能
なバー
ジョン
ンバーに対してフィード
項目を表示できます。
デフォルト値は、次のとおり
です。
• 外部ユーザの場合、デ
フォルト値は AllUsers
です。外部ユーザが投稿
を表示するには、この値
を使用する必要がありま
す。
• 内部ユーザの場合、デ
フォルト値は
InternalUsers です。
内部ユーザは、この値を
受け入れるか、値
AllUsers を使用して外
部ユーザに投稿の表示を
許可します。
フィード項目の親が User また
は Group の場合、フィード項
目の visibility は
AllUsers である必要があり
ます。
POST の要求パラメータ
次のいずれかのパラメータセットを使用します。たとえば、リンクの post 送信とファイルの添付を同じ要
求で行うことはできません。
既存のファイルを添付するためのパラメータ
パラメータ名
型
説明
必須項
目/省略
可能
attachmentType
String
添付ファイルの種別。値 ExistingContent
を含める必要があります。
必須項目 27.0 ～
31.0
contentDocumentId
String
既存のファイルの 18 文字の ID。
必須項目 23.0 ～
31.0
287
使用可
能な
バー
ジョン
Chatter REST API リソース
News Feed リソース
パラメータ名
型
説明
必須項
目/省略
可能
使用可
能な
バー
ジョン
isBookmarked
ByCurrentUser
Boolean 新しいフィード項目をユーザのためにブック 省略可能 26.0 ～
31.0
マークするか (true)、否か (false) を指定し
ます。デフォルト値は、false です。
text
String
フィード項目のテキスト。
visibility
String
投稿を表示できるユーザ。有効な値は、次の 省略可能 26.0 ～
31.0
とおりです。
省略可能 23.0 ～
31.0
• InternalUsers — コミュニティが有効な
場合は、デフォルトの内部コミュニティの
メンバーに対してのみフィード項目を表示
できます。
• AllUsers — コミュニティが有効な場合
は、コミュニティのすべてのメンバーに対
してフィード項目を表示できます。
デフォルト値は、次のとおりです。
• 外部ユーザの場合、デフォルト値は
AllUsers です。外部ユーザが投稿を表示
するには、この値を使用する必要がありま
す。
• 内部ユーザの場合、デフォルト値は
InternalUsers です。内部ユーザは、こ
の値を受け入れるか、値 AllUsers を使用
して外部ユーザに投稿の表示を許可しま
す。
フィード項目の親が User または Group の場合、
フィード項目の visibility は AllUsers で
ある必要があります。
新規のファイルを添付するためのパラメータ
パラメータ名
型
説明
必須項
目/省略
可能
attachmentType
String
添付ファイルの種別。値 NewFile を含める必 必須項目 27.0 ～
31.0
要があります。
288
使用可
能な
バー
ジョン
Chatter REST API リソース
News Feed リソース
パラメータ名
型
説明
必須項
目/省略
可能
desc
String
post 送信するファイルの説明。
省略可能 23.0 ～
26.0
注意: このパラメータは、バージョン 27.0
以降では使用しないでください。代わり
に description を使用します。
使用可
能な
バー
ジョン
description
String
post 送信するファイルの説明。
省略可能 27.0 ～
31.0
fileName
String
post 送信するファイルのファイル名。
必須項目 23.0 ～
24.0
注意: このパラメータは、バージョン 24.0
以降では使用しないでください。代わり
に title を使用します。
isBookmarked
ByCurrentUser
Boolean 新しいフィード項目をユーザのためにブック 省略可能 26.0 ～
31.0
マークするか (true)、否か (false) を指定し
ます。デフォルト値は、false です。
text
String
フィード項目のテキスト。
title
String
アップロードまたは post 送信するファイルの 必須項目 24.0 ～
31.0
ファイル名。
visibility
String
投稿を表示できるユーザ。有効な値は、次の 省略可能 26.0 ～
31.0
とおりです。
• InternalUsers — コミュニティが有効な
場合は、デフォルトの内部コミュニティの
メンバーに対してのみフィード項目を表示
できます。
• AllUsers — コミュニティが有効な場合
は、コミュニティのすべてのメンバーに対
してフィード項目を表示できます。
デフォルト値は、次のとおりです。
• 外部ユーザの場合、デフォルト値は
AllUsers です。外部ユーザが投稿を表示
するには、この値を使用する必要がありま
す。
• 内部ユーザの場合、デフォルト値は
InternalUsers です。内部ユーザは、こ
の値を受け入れるか、値 AllUsers を使用
289
省略可能 23.0 ～
31.0
Chatter REST API リソース
パラメータ名
News Feed リソース
型
説明
必須項
目/省略
可能
使用可
能な
バー
ジョン
して外部ユーザに投稿の表示を許可しま
す。
フィード項目の親が User または Group の場合、
フィード項目の visibility は AllUsers で
ある必要があります。
リンクを post 送信するためのパラメータ
パラメータ名
型
説明
必須項目/ 使用可
省略可能 能な
バー
ジョン
attachmentType
String
添付ファイルの種別。値 Link を含める 必須項目
必要があります。
27.0 ～
31.0
isBookmarked
ByCurrentUser
Boolean
新しいフィード項目をユーザのために
省略可能
ブックマークするか (true)、否か (false)
を指定します。デフォルト値は、false
です。
26.0 ～
31.0
text
String
フィード項目のテキスト。
省略可能
23.0 ～
31.0
url
String
リンクの URL。
必須項目
23.0 ～
31.0
urlName
String
URL の名前。
省略可能
23.0 ～
31.0
visibility
String
投稿を表示できるユーザ。有効な値は、 省略可能
次のとおりです。
26.0 ～
31.0
• InternalUsers — コミュニティが有
効な場合は、デフォルトの内部コミュ
ニティのメンバーに対してのみフィー
ド項目を表示できます。
• AllUsers — コミュニティが有効な
場合は、コミュニティのすべてのメン
バーに対してフィード項目を表示でき
ます。
デフォルト値は、次のとおりです。
290
Chatter REST API リソース
パラメータ名
News Feed リソース
型
説明
必須項目/ 使用可
省略可能 能な
バー
ジョン
• 外部ユーザの場合、デフォルト値は
AllUsers です。外部ユーザが投稿を
表示するには、この値を使用する必要
があります。
• 内部ユーザの場合、デフォルト値は
InternalUsers です。内部ユーザ
は、この値を受け入れるか、値
AllUsers を使用して外部ユーザに投
稿の表示を許可します。
フィード項目の親が User または Group の
場合、フィード項目の visibility は
AllUsers である必要があります。
アンケートを post 送信するためのパラメータ
パラメータ名
型
説明
必須項目/ 使用可
省略可能 能な
バー
ジョン
attachmentType
String
添付ファイルの種別。値 Poll を含める 必須項目 27.0 ～
31.0
必要があります。
isBookmarked
ByCurrentUser
Boolean
新しいフィード項目をユーザのために
省略可能 26.0 ～
31.0
ブックマークするか (true)、否か (false)
を指定します。デフォルト値は、false
です。
pollChoice1 ～
pollChoice10
String
この選択肢を使用して、アンケートを含 必須項目 26.0 ～
31.0
むフィード項目を作成します。アンケー
トには 2 個から 10 個のアンケート選択肢
を指定します。
text
String
フィード項目のテキスト。
visibility
String
投稿を表示できるユーザ。有効な値は、 省略可能 26.0 ～
31.0
次のとおりです。
• InternalUsers — コミュニティが有
効な場合は、デフォルトの内部コミュ
291
必須項目 23.0 ～
31.0
Chatter REST API リソース
パラメータ名
News Feed リソース
型
説明
必須項目/ 使用可
省略可能 能な
バー
ジョン
ニティのメンバーに対してのみフィー
ド項目を表示できます。
• AllUsers — コミュニティが有効な場
合は、コミュニティのすべてのメン
バーに対してフィード項目を表示でき
ます。
デフォルト値は、次のとおりです。
• 外部ユーザの場合、デフォルト値は
AllUsers です。外部ユーザが投稿を
表示するには、この値を使用する必要
があります。
• 内部ユーザの場合、デフォルト値は
InternalUsers です。内部ユーザ
は、この値を受け入れるか、値
AllUsers を使用して外部ユーザに投
稿の表示を許可します。
フィード項目の親が User または Group の
場合、フィード項目の visibility は
AllUsers である必要があります。
投稿を共有するためのパラメータ
パラメータ名
型
説明
必須項目/ 使用可
省略可能 能な
バー
ジョン
isBookmarked
ByCurrentUser
Boolean
新しいフィード項目をユーザのためにブッ 省略可能
クマークするか (true)、否か (false) を
指定します。デフォルト値は、false で
す。
26.0 ～
31.0
originalFeedItemId
String
共有するフィード項目の 18 文字の ID。
24.0 ～
31.0
メモ: 投稿の共有は、ファイルの
アップロードよりも優先されます。
1 つの POST 内では、投稿の共有と
ファイルのアップロードの両方は行
わないでください。
292
必須項目
Chatter REST API リソース
News Feed リソース
パラメータ名
型
説明
必須項目/ 使用可
省略可能 能な
バー
ジョン
text
String
共有されるフィード項目に対するコメン 省略可能
ト。
28.0 ～
31.0
visibility
String
投稿を表示できるユーザ。有効な値は、 省略可能
次のとおりです。
26.0 ～
31.0
• InternalUsers — コミュニティが有
効な場合は、デフォルトの内部コミュ
ニティのメンバーに対してのみフィー
ド項目を表示できます。
• AllUsers — コミュニティが有効な場
合は、コミュニティのすべてのメン
バーに対してフィード項目を表示でき
ます。
デフォルト値は、次のとおりです。
• 外部ユーザの場合、デフォルト値は
AllUsers です。外部ユーザが投稿を
表示するには、この値を使用する必要
があります。
• 内部ユーザの場合、デフォルト値は
InternalUsers です。内部ユーザ
は、この値を受け入れるか、値
AllUsers を使用して外部ユーザに投
稿の表示を許可します。
フィード項目の親が User または Group の
場合、フィード項目の visibility は
AllUsers である必要があります。
テキストのみを post 送信するためのパラメータ
パラメータ名
型
説明
必須項目/ 使用可
省略可能 能な
バー
ジョン
isBookmarked
ByCurrentUser
Boolean
新しいフィード項目をユーザのためにブッ 省略可能
クマークするか (true)、否か (false) を
指定します。デフォルト値は、false で
す。
293
26.0 ～
31.0
Chatter REST API リソース
News Feed リソース
パラメータ名
型
説明
必須項目/ 使用可
省略可能 能な
バー
ジョン
text
String
フィード項目のテキスト。最大文字数は 必須項目
1000 文字です。
23.0 ～
31.0
visibility
String
投稿を表示できるユーザ。有効な値は、 省略可能
次のとおりです。
26.0 ～
31.0
• InternalUsers — コミュニティが有
効な場合は、デフォルトの内部コミュ
ニティのメンバーに対してのみフィー
ド項目を表示できます。
• AllUsers — コミュニティが有効な場
合は、コミュニティのすべてのメン
バーに対してフィード項目を表示でき
ます。
デフォルト値は、次のとおりです。
• 外部ユーザの場合、デフォルト値は
AllUsers です。外部ユーザが投稿を
表示するには、この値を使用する必要
があります。
• 内部ユーザの場合、デフォルト値は
InternalUsers です。内部ユーザ
は、この値を受け入れるか、値
AllUsers を使用して外部ユーザに投
稿の表示を許可します。
フィード項目の親が User または Group の
場合、フィード項目の visibility は
AllUsers である必要があります。
キャンバスアプリケーションを post 送信するためのパラメータ
パラメータ名
型
説明
必須項目/ 使用可
省略可能 能な
バー
ジョン
attachmentType
String
添付ファイルの種別。値 Canvas を含める必 必須項目
要があります。
29.0 ～
31.0
description
String
キャンバスアプリケーションの説明
29.0 ～
31.0
294
省略可能
Chatter REST API リソース
News Feed リソース
パラメータ名
型
説明
必須項目/ 使用可
省略可能 能な
バー
ジョン
developerName
String
キャンバスアプリケーションの開発者名 (API
名)
必須項目
29.0 ～
31.0
height
String
キャンバスアプリケーションの高さ (ピクセル 省略可能
単位)。デフォルトの高さは 200 ピクセルです。
29.0 ～
31.0
isBookmarked
ByCurrentUser
Boolean 新しいフィード項目をユーザのためにブック 省略可能
マークするか (true)、否か (false) を指定し
ます。デフォルト値は、false です。
29.0 ～
31.0
namespacePrefix
String
キャンバスアプリケーションが作成された
Developer Edition 組織の名前空間プレフィック
ス。
省略可能
29.0 ～
31.0
parameters
String
キャンバスアプリケーションに渡される JSON 省略可能
形式のパラメータ。JSON は URL でエンコード
されている必要があります。
29.0 ～
31.0
parameters={'isUpdated'='true';}"
text
String
フィード項目のテキスト
省略可能
29.0 ～
31.0
thumbnailUrl
String
キャンバスアプリケーションのサムネイル画 省略可能
像の URL。最大サイズは 120x120 ピクセルです。
29.0 ～
31.0
title
String
キャンバスアプリケーションへのリンクのタ 省略可能
イトル
29.0 ～
31.0
visibility
String
投稿を表示できるユーザ。有効な値は、次の 省略可能
とおりです。
29.0 ～
31.0
• InternalUsers — コミュニティが有効な
場合は、デフォルトの内部コミュニティの
メンバーに対してのみフィード項目を表示
できます。
• AllUsers — コミュニティが有効な場合
は、コミュニティのすべてのメンバーに対
してフィード項目を表示できます。
デフォルト値は、次のとおりです。
• 外部ユーザの場合、デフォルト値は
AllUsers です。外部ユーザが投稿を表示
するには、この値を使用する必要がありま
す。
295
Chatter REST API リソース
パラメータ名
News Feed リソース
型
説明
必須項目/ 使用可
省略可能 能な
バー
ジョン
• 内部ユーザの場合、デフォルト値は
InternalUsers です。内部ユーザは、こ
の値を受け入れるか、値 AllUsers を使用
して外部ユーザに投稿の表示を許可しま
す。
フィード項目の親が User または Group の場合、
フィード項目の visibility は AllUsers で
ある必要があります。
GET のレスポンスボディ
Feed Item Page
POST のレスポンスボディ
Feed Item
ファイルポストの例
この例では、新しい添付ファイルがある投稿でニュースフィードを更新します。
curl https://instance_name/services/data/v31.0/chatter/feeds/news/me/feed-items
--form "feedItemFileUpload=@Desktop/textFile.txt"
--form "title=Sample"
--form "description=Just a Text File"
--form "text=Please review"
--form "attachmentType=NewFile"
--header 'Authorization: Bearer
00DD0000000Jhd2!AQIAQBgn42jbvCW2SX8JaRO2_JjX1fNKXWBrjYQPXODtDyaT6gT4DJVs4Ki7s6GoxvO8a.Z7gTHKkfqjW6S1.ujlD413PYpF'
これは、ファイルポストでニュースフィードを更新する Java の例です。
import java.io.File;
import org.apache.commons.httpclient.*;
import org.apache.commons.httpclient.methods.PostMethod;
import org.apache.commons.httpclient.methods.multipart.*;
296
Chatter REST API リソース
News Feed リソース
...
String oauthToken = "00Dx0000000X42V!AQgAQClp6UqGWNJUf4d3LQkVCysBIS6a";
String url = "https://instance_name/services/data/v31.0/chatter/" +
"feeds/user-profile/me/feed-items";
String text = "I love posting files to Chatter!";
File contentFile = getFile();
String description = "This is a test file that I'm posting.";
String title = "contentFile";
Part[] parts = {
new StringPart("description", description),
new StringPart("title", fileName),
new StringPart("text", text),
new FilePart("feedItemFileUpload", contentFile),
};
final PostMethod postMethod = new PostMethod(url);
try {
postMethod.setRequestEntity(new MultipartRequestEntity(parts,
postMethod.getParams()));
postMethod.setRequestHeader("Authorization", "Bearer " + oauthToken);
postMethod.setRequestHeader("Content-type", "multipart/form-data")
postMethod.addRequestHeader("X-PrettyPrint", "1");
HttpClient httpClient = new HttpClient();
httpClient.getParams().setSoTimeout(60000);
297
Chatter REST API リソース
News Feed リソース
int returnCode = httpClient.executeMethod(postMethod);
System.out.println(postMethod.getResponseBodyAsString());
assertTrue("Expected return code of: " + HttpStatus.SC_CREATED,
returnCode == HttpStatus.SC_CREATED);
} finally {
postMethod.releaseConnection();
}
リンクポストの例
この要求では、要求パラメータを使用してリンクポストを作成します。
/chatter/feeds/news/me/feed-items?text=Did+you+see+this?&url=http://www.chatter.com
次のリクエストボディは、フィード項目投稿内にリンクを作成します。
{ "body" : {
"messageSegments" : [
{
"type": "Link",
"url" : "http://www.chatter.com"
},
{
"type": "Text",
"text" : "Is everyone following this?"
}
]
}
}
298
Chatter REST API リソース
News Feed リソース
次のリクエストボディには、フィード項目投稿への添付ファイルとしてリンクが含まれます。
{ "body" : {
"messageSegments" : [
{
"type": "Text",
"text" : "Is everyone following this?"
}
]
},
"attachment" :{
"url" : "http://www.chatter.com",
"urlName" : "The Future of Social Enterprise"
}
}
News Feed Items Flat
このリソースは、バージョン 26.0 で廃止されました。
フラットフィードを返します。つまり、フィード項目とコメントの間に階層がなく、フィード項目とコメント
はすべて同じレベルに配置されます。すべての項目は、時系列に返されます。
リソース
/chatter/feeds/news/me/feed-items/flat
または
/chatter/feeds/news/userId/feed-items/flat
メモ: userId は、コンテキストユーザの ID または別名 me である必要があります。
適用開始バージョン
25.0 ～ 26.0
重要: API バージョン 32.0 以降は、/chatter/feeds/news/userId/feed-elements を使用します。
Chatter が必要かどうか
はい
HTTP メソッド
GET または HEAD
299
Chatter REST API リソース
People Feed リソース
要求パラメータ
パラメータ名
型
説明
numFeedItems
Integer
返されるフィード項目数を指定し
ます。有効な値は 0 ～ 100 です。
デフォルト値は 25 です。フィード
項目にはコメントが含まれる場合
があるため、25 個のフラット
フィード項目を指定しても、実際
に返される数がそれより多くなる
ことがあります。たとえば、各
フィード項目に 1 つのコメントが
あり、recentCommentCount が
1 よりも大きい場合、50 個のフラッ
トフィード項目が返されます。
page
String
生成されたトークン。フィード内
のフィード項目のビューを示しま
す。ページトークンは、レスポン
スボディの一部として、
nextPageURL など、いずれかの
URL パラメータで返されます。
recentCommentCount
Integer
返される最近のコメントの数を指
定します。有効な値は 0 ～ 25 で
す。デフォルト値は 3 です。
sort
String。次のいずれかになります。 返されたフィードを、作成日の昇
順、または最終更新日の昇順で並
• CreatedDateDesc
び替えます。デフォルトは
• LastModifiedDateDesc
LastModifiedDateDesc です。
レスポンスボディ
Flat Feed
関連トピック:
フィードおよびフィード要素の使用
People Feed リソース
コンテキストユーザがフォローしているすべての人によって投稿されたすべてのフィード要素。
次のリソースを使用できます。
300
Chatter REST API リソース
People Feed リソース
リソース
説明
/chatter/feeds/people/me
コンテキストユーザがフォローしているすべての人の
フィード要素への URL を返します。
/chatter/feeds/people/me/feed-elements
コンテキストユーザがフォローしているすべての人か
らのすべてのフィード要素を返します。
People Feed URL
コンテキストユーザがフォローしているすべての人のフィード要素への URL を返します。
リソース
/chatter/feeds/people/userId
/connect/communities/communityId/chatter/feeds/people/userId
メモ: userId は、コンテキストユーザの ID または別名 me である必要があります。
適用開始バージョン
23.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、HEAD
要求パラメータ
パラメータ名
型
説明
sort
String
作成日や最終更新日などで並び替
えて返される順序を指定します。
• CreatedDateDesc — 作成日
の新しい順に並び替えます。
• LastModifiedDateDesc — 活
動の新しい順に並び替えられま
す。
デフォルト値は、
CreatedDescDate です。
レスポンスボディ
Feed
People Feed Elements
コンテキストユーザがフォローしているすべての人からのすべてのフィード要素を返します。
301
Chatter REST API リソース
People Feed リソース
リソース
/chatter/feeds/people/userId/feed-elements
/connect/communities/communityId/chatter/feeds/people/userId/feed-elements
メモ: userId は、コンテキストユーザの ID または別名 me である必要があります。
適用開始バージョン
31.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、HEAD
要求パラメータ
パラメータ名
型
説明
必須項
目/省略
可能
使用可能
なバー
ジョン
density
String
フィードの密度。次のいずれかの値にします。 省略可能 31.0
• AllUpdates — ユーザがフォローする人とレ
コード、およびユーザがメンバーとなってい
るグループからのすべての更新が表示されま
す。
• FewerUpdates — ユーザがフォローする人
とレコード、およびユーザがメンバーとなっ
ているグループからのすべての更新が表示さ
れますが、レコードからのシステム生成され
た更新は非表示になります。
デフォルト値は、AllUpdates です。
elementsPerBundle Integer
page
String
バンドルに含める最大フィード要素数。値は 0 省略可能 31.0
～ 10 の整数である必要があります。デフォルト
値は 3 です。
生成されたトークン。フィード内のフィード要 省略可能 31.0
素のビューを示します。
ページトークンは、レスポンスボディの一部と
して、nextPageURL など、いずれかの URL パラ
メータで返されます。たとえば、次のようにな
ります。
"nextPageUrl":
"/services/data/v34.0/
302
Chatter REST API リソース
パラメータ名
People Feed リソース
型
説明
必須項
目/省略
可能
使用可能
なバー
ジョン
chatter/feeds/news/
005D0000001GLowIAN
/feed-elements
?page=2011-03-30T17:34:50Z,
0D5D0000000DSv4KAG"
pageSize
Integer
ページあたりの要素数を指定します。有効な値 省略可能 31.0
は 1 ～ 100 です。サイズを指定しない場合、デ
フォルトは 25 です。
q
String
このフィード内のフィード要素の本文とコメン 省略可能 31.0
トに含まれる 1 つ以上の検索キーワード。
検索文字列にはワイルドカード文字を含めるこ
とができ、ワイルドカード文字を除く 2 文字以
上が含まれている必要があります。「ワイルド
カード」を参照してください。
recentComment
Count
Integer
フィード要素ごとに含めるコメントの最大数。 省略可能 31.0
デフォルト値は 3 です。最大値は、25 です。
sort
String
作成日や最終更新日などで並び替えて返される 省略可能 31.0
順序を指定します。
• CreatedDateDesc — 作成日の新しい順に並
び替えます。
• LastModifiedDateDesc — 活動の新しい順
に並び替えられます。
デフォルト値は、CreatedDescDate です。
updatedSince
String
フィードの変更タイムスタンプと並び替え順を 省略可能 31.0
定義する不透明トークン。
このトークンは作成しません。Feed Element Page
レスポンスボディの updatesToken プロパティ
から、このトークンを取得します。
レスポンスボディ
Feed Element Page
303
Chatter REST API リソース
People Feed リソース
People Feed Items
コンテキストユーザがフォローしているすべての人からのすべてのフィード項目を返します。
リソース
/chatter/feeds/people/me/feed-items
または
/chatter/feeds/people/userId/feed-items
メモ: userId は、コンテキストユーザの ID または別名 me である必要があります。
使用可能なバージョン
23.0 ～ 31.0
重要: バージョン 32.0 以降では、People Feed Elements を使用します。
Chatter が必要かどうか
はい
HTTP メソッド
GET、HEAD
要求パラメータ
パラメータ名
型
説明
必須項
目/省略
可能
使用可能
なバー
ジョン
density
String
フィードの密度。次のいずれかの値にします。 省略可能 29.0 ～ 31.0
• AllUpdates — ユーザがフォローする人とレ
コード、およびユーザがメンバーとなってい
るグループからのすべての更新が表示されま
す。
• FewerUpdates — ユーザがフォローする人
とレコード、およびユーザがメンバーとなっ
ているグループからのすべての更新が表示さ
れますが、レコードからのシステム生成され
た更新は非表示になります。
デフォルト値は、AllUpdates です。
page
String
生成されたトークン。フィード内のフィード要 省略可能 23.0 ～ 31.0
素のビューを示します。
ページトークンは、レスポンスボディの一部と
して、nextPageURL など、いずれかの URL パラ
304
Chatter REST API リソース
パラメータ名
People Feed リソース
型
説明
必須項
目/省略
可能
使用可能
なバー
ジョン
メータで返されます。たとえば、次のようにな
ります。
"nextPageUrl":
"/services/data/v34.0/
chatter/feeds/news/
005D0000001GLowIAN
/feed-elements
?page=2011-03-30T17:34:50Z,
0D5D0000000DSv4KAG"
pageSize
Integer
ページあたりの項目数を指定します。有効な値 省略可能 23.0 ～ 31.0
は 1 ～ 100 です。サイズを指定しない場合、デ
フォルトは 25 です。
q
String
このフィード内のフィード要素の本文とコメン 省略可能 28.0 ～ 31.0
トに含まれる 1 つ以上の検索キーワード。
検索文字列にはワイルドカード文字を含めるこ
とができ、ワイルドカード文字を除く 2 文字以
上が含まれている必要があります。「ワイルド
カード」を参照してください。
recentComment
Count
Integer
フィード項目ごとに含めるコメントの最大数。 省略可能 29.0 ～ 31.0
デフォルト値は 3 です。最大値は、25 です。
sort
String
作成日や最終更新日などで並び替えて返される 省略可能 23.0 ～ 31.0
順序を指定します。
• CreatedDateDesc — 作成日の新しい順に並
び替えます。
• LastModifiedDateDesc — 活動の新しい順
に並び替えられます。
デフォルト値は、CreatedDescDate です。
updatedSince
String
フィードの変更タイムスタンプと並び替え順を 省略可能 30.0 ～ 31.0
定義する不透明トークン。
このトークンは作成しません。Feed Element Page
レスポンスボディの updatesToken プロパティ
から、このトークンを取得します。
305
Chatter REST API リソース
People Feed リソース
レスポンスボディ
Feed Item Page
People Feed Items Flat
このリソースは、バージョン 26.0 で廃止されました。
フラットフィードを返します。つまり、フィード項目とコメントの間に階層がなく、フィード項目とコメント
はすべて同じレベルに配置されます。すべての項目は、時系列に返されます。
リソース
/chatter/feeds/people/me/feed-items/flat
または
/chatter/feeds/people/userId/feed-items/flat
メモ: userId は、コンテキストユーザの ID または別名 me である必要があります。
適用開始バージョン
25.0 ～ 26.0
Chatter が必要かどうか
はい
HTTP メソッド
GET または HEAD
要求パラメータ
パラメータ名
型
説明
numFeedItems
Integer
返されるフィード項目数を指定し
ます。有効な値は 0 ～ 100 です。
デフォルト値は 25 です。フィード
項目にはコメントが含まれる場合
があるため、25 個のフラット
フィード項目を指定しても、実際
に返される数がそれより多くなる
ことがあります。たとえば、各
フィード項目に 1 つのコメントが
あり、recentCommentCount が
1 よりも大きい場合、50 個のフラッ
トフィード項目が返されます。
page
String
生成されたトークン。フィード内
のフィード項目のビューを示しま
す。ページトークンは、レスポン
スボディの一部として、
306
Chatter REST API リソース
パラメータ名
Record Feed リソース
型
説明
nextPageURL など、いずれかの
URL パラメータで返されます。
recentCommentCount
Integer
sort
String。次のいずれかになります。 返されたフィードを、作成日の昇
順、または最終更新日の昇順で並
• CreatedDateDesc
び替えます。デフォルトは
• LastModifiedDateDesc
LastModifiedDateDesc です。
返される最近のコメントの数を指
定します。有効な値は 0 ～ 25 で
す。デフォルト値は 3 です。
レスポンスボディ
Flat Feed
関連トピック:
フィードおよびフィード要素の使用
Record Feed リソース
指定されたレコードのフィード。レコードは、グループ、人、オブジェクト、ファイルなどの場合がありま
す。レコードフィードへのフィード項目の post 送信に使用できます。
次のリソースを使用できます。
リソース
説明
/chatter/feeds/record/recordId
現在のユーザがフォローしているすべてのレコードの
フィード要素への URL、または指定された recordId
のすべてのフィード要素への URL を返します。このリ
ソースは、グループフィードを取得するために使用し
ます。
/chatter/feeds/record/recordId/feed-elements コンテキストユーザがフォローしているすべてのレ
コードのフィード要素、または指定された recordId
のすべてのフィード要素を返します。このリソース
は、フィードの検索や特定のフィードのフィード要素
の取得に使用します。このリソースを使用してグルー
プのフィード要素を取得するには、グループ ID を
recordId として指定します。
307
Chatter REST API リソース
Record Feed リソース
Record Feed URL
現在のユーザがフォローしているすべてのレコードのフィード要素への URL、または指定された recordId の
すべてのフィード要素への URL を返します。このリソースは、グループフィードを取得するために使用しま
す。
リソース
/chatter/feeds/record/recordId
/connect/communities/communityId/chatter/feeds/record/recordId
メモ: recordId がユーザ ID の場合、現在のユーザまたは別名 me と同じである必要があります。
適用開始バージョン
23.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、HEAD
要求パラメータ
パラメータ名
型
説明
sort
String
作成日や最終更新日などで並び替
えて返される順序を指定します。
• CreatedDateDesc — 作成日
の新しい順に並び替えます。
• LastModifiedDateDesc — 活
動の新しい順に並び替えられま
す。
デフォルト値は、
CreatedDescDate です。
レスポンスボディ
Feed
Record Feed Elements
コンテキストユーザがフォローしているすべてのレコードのフィード要素、または指定された recordId の
すべてのフィード要素を返します。このリソースは、フィードの検索や特定のフィードのフィード要素の取得
に使用します。このリソースを使用してグループのフィード要素を取得するには、グループ ID を recordId
として指定します。
308
Chatter REST API リソース
Record Feed リソース
リソース
/chatter/feeds/record/recordId/feed-elements
/connect/communities/communityId/chatter/feeds/record/recordId/feed-elements
メモ: recordId がユーザ ID の場合、現在のユーザまたは別名 me と同じである必要があります。
適用開始バージョン
23.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、HEAD
GET の要求パラメータ
パラメータ名
型
説明
必須項 使用可能
目/省略 なバー
可能
ジョン
density
String
フィードの密度。次のいずれかの値にしま
す。
省略可
能
31.0
バンドルに含める最大フィード要素数。値は 省略可
0 ～ 10 の整数である必要があります。デフォ 能
ルト値は 3 です。
31.0
• AllUpdates — ユーザがフォローする人
とレコード、およびユーザがメンバーと
なっているグループからのすべての更新
が表示されます。
• FewerUpdates — ユーザがフォローする
人とレコード、およびユーザがメンバー
となっているグループからのすべての更
新が表示されますが、レコードからのシ
ステム生成された更新は非表示になりま
す。
デフォルト値は、AllUpdates です。
elementsPerBundle Integer
メモ: バンドル投稿にはフィード追跡
変更が含まれます。Salesforce1 ダウン
ロード可能アプリケーションでは、バ
ンドル投稿がレコードフィードのみに
あります。
309
Chatter REST API リソース
Record Feed リソース
パラメータ名
型
説明
必須項 使用可能
目/省略 なバー
可能
ジョン
filter
String
フィードに適用可能な検索条件値を指定しま 省略可
す。
能
32.0
• AllQuestions — 質問であるフィード要
素のみ。
• CommunityScoped — 今後の使用のため
に予約されています。
• SolvedQuestions — 質問で最良の回答
があるフィード要素のみ。
• UnansweredQuestions — 質問で回答が
ないフィード要素のみ。
• UnsolvedQuestions — 質問で最良の回
答がないフィード要素のみ。
page
String
生成されたトークン。フィード内のフィード 省略可
要素のビューを示します。
能
31.0
ページトークンは、レスポンスボディの一部
として、nextPageURL など、いずれかの URL
パラメータで返されます。たとえば、次のよ
うになります。
"nextPageUrl":
"/services/data/v34.0/
chatter/feeds/news/
005D0000001GLowIAN
/feed-elements
?page=2011-03-30T17:34:50Z,
0D5D0000000DSv4KAG"
pageSize
Integer
ページあたりの要素数を指定します。有効な 省略可
値は 1 ～ 100 です。サイズを指定しない場
能
合、デフォルトは 25 です。
31.0
q
String
このフィード内のフィード要素の本文とコメ 省略可
ントに含まれる 1 つ以上の検索キーワード。 能
31.0
検索文字列にはワイルドカード文字を含める
ことができ、ワイルドカード文字を除く 2 文
310
Chatter REST API リソース
パラメータ名
Record Feed リソース
型
説明
必須項 使用可能
目/省略 なバー
可能
ジョン
字以上が含まれている必要があります。「ワ
イルドカード」を参照してください。
recentComment Integer
Count
フィード要素ごとに含めるコメントの最大 省略可
数。デフォルト値は 3 です。最大値は、25 で 能
す。
31.0
showInternal Boolean
Only
内部 (コミュニティ以外の) ユーザからの
省略可
フィード要素のみを表示するか (true)、否か 能
(false) を指定します。デフォルト値は、
false です。
31.0
作成日や最終更新日などで並び替えて返され 省略可
る順序を指定します。
能
31.0
sort
String
• CreatedDateDesc — 作成日の新しい順
に並び替えます。
• LastModifiedDateDesc — 活動の新し
い順に並び替えられます。
デフォルト値は、CreatedDescDate です。
updatedSince String
フィードの変更タイムスタンプと並び替え順 省略可
を定義する不透明トークン。
能
31.0
このトークンは作成しません。Feed Element
Page レスポンスボディの updatesToken プ
ロパティから、このトークンを取得します。
GET のレスポンスボディ
Feed Element Page
Record Feed Items
コンテキストユーザがフォローしているすべてのレコードのフィード項目、または指定された recordId の
すべてのフィード項目を返します。このリソースは、新しいフィード項目の post 送信やフィードの検索に使用
します。このリソースを使用して特定のグループのフィード項目を取得するには、グループ ID を recordId
として指定します。
フィード項目の post 送信についての詳細は、「入力での POST、PATCH、または PUT の使用」を参照してくださ
い。
バイナリファイルのアップロードとフィード項目への添付についての詳細は、「バイナリファイルのアップ
ロード」を参照してください。
311
Chatter REST API リソース
Record Feed リソース
メモ: レコードタイプが ContentDocument の場合は、レコードフィードへのフィード項目の post 送信は
できません。
API バージョン 29.0 では、フィード項目に 5000 文字まで含めることができます。この変更には後方互換性があ
り、以前のすべての API バージョンで 5000 文字の制限がサポートされています。
リソース
/chatter/feeds/record/me/feed-items
または
/chatter/feeds/record/recordId/feed-items
メモ: recordId がユーザ ID の場合、現在のユーザまたは別名 me と同じである必要があります。
使用可能なバージョン
23.0 ～ 31.0
重要: バージョン 32.0 以降では、Record Feed Elements を使用します。
Chatter が必要かどうか
はい
HTTP メソッド
GET、POST、HEAD
GET の要求パラメータ
パラメータ名
型
説明
必須項 使用可能
目/省略 なバー
可能
ジョン
density
String
フィードの密度。次のいずれかの値にしま
す。
省略可
能
29.0 ～ 31.0
生成されたトークン。フィード内のフィード 省略可
項目のビューを示します。ページトークン 能
は、レスポンスボディの一部として、
23.0 ～ 31.0
• AllUpdates — ユーザがフォローする人
とレコード、およびユーザがメンバーと
なっているグループからのすべての更新
が表示されます。
• FewerUpdates — ユーザがフォローする
人とレコード、およびユーザがメンバー
となっているグループからのすべての更
新が表示されますが、レコードからのシ
ステム生成された更新は非表示になりま
す。
デフォルト値は、AllUpdates です。
page
String
312
Chatter REST API リソース
パラメータ名
Record Feed リソース
型
説明
必須項 使用可能
目/省略 なバー
可能
ジョン
nextPageURL など、いずれかの URL パラメー
タで返されます。たとえば、次のようになり
ます。
"nextPageUrl":
"/services/data/v34.0/
chatter/feeds/news/
005D0000001GLowIAN
/feed-items
?page=2011-03-30T17:34:50Z,
0D5D0000000DSv4KAG"
pageSize
Integer
ページあたりの項目数を指定します。有効な 省略可
値は 1 ～ 100 です。サイズを指定しない場
能
合、デフォルトは 25 です。
23.0 ～ 31.0
q
String
このフィード内のフィード項目の本文とコメ 省略可
ントに含まれる 1 つ以上の検索キーワード。 能
28.0 ～ 31.0
検索文字列にはワイルドカード文字を含める
ことができ、ワイルドカード文字を除く 2 文
字以上が含まれている必要があります。「ワ
イルドカード」を参照してください。
recentComment Integer
Count
フィード項目ごとに含めるコメントの最大 省略可
数。デフォルト値は 3 です。最大値は、25 で 能
す。
29.0 ～ 31.0
showInternal Boolean
Only
内部 (コミュニティ以外の) ユーザからの
省略可
フィード項目のみを表示するか (true)、否か 能
(false) を指定します。デフォルト値は、
false です。
30.0 ～ 31.0
作成日や最終更新日などで並び替えて返され 省略可
る順序を指定します。
能
23.0 ～ 31.0
sort
String
• CreatedDateDesc — 作成日の新しい順
に並び替えます。
• LastModifiedDateDesc — 活動の新し
い順に並び替えられます。
313
Chatter REST API リソース
Record Feed リソース
パラメータ名
型
説明
必須項 使用可能
目/省略 なバー
可能
ジョン
デフォルト値は、CreatedDescDate です。
updatedSince String
フィードの変更タイムスタンプと並び替え順 省略可
を定義する不透明トークン。
能
このトークンは作成しません。Feed Item Page
レスポンスボディの updatesToken プロパ
ティから、このトークンを取得します。
POST のリクエストボディ
ルート XML タグ
<feedItem>
JSON
次の例では、フィード項目にアンケートを添付します。
{
"body":{
"messageSegments":[
{
"type":"Text",
"text":"When should we meet for release planning?"
}
]
},
"capabilities":{
"poll":{
"choices":[
"Monday",
"Tuesday"
]
}
314
30.0 ～ 31.0
Chatter REST API リソース
Record Feed リソース
},
"feedElementType":"FeedItem",
"subjectId":"me"
}
フィード項目は複数の機能をサポートします。次の例では、ファイルをフィード項目に添付し、ブック
マークします。
{
"body":{
"messageSegments":[
{
"type":"Text",
"text":"Check out the latest marketing collateral."
}
]
},
"capabilities":{
"bookmarks":{
"isBookmarkedByCurrentUser": true
},
"content":{
"contentDocumentId": "069D00000001uQO"
}
},
"feedElementType":"FeedItem",
"subjectId":"me"
}
315
Chatter REST API リソース
Record Feed リソース
プロパティ
名前
型
説明
必須項目/省略可能 使用可能
なバー
ジョン
attachment
種別によって異な
る。
attachment パラメータには、 省略可能
次のいずれか 1 つの値のみを
指定できます。値は次のとお
りです。
• Attachment Input: Canvas App
(v29.0 ～ 31.0)
• Attachment Input: Existing
Content (v23.0 ～ 31.0)
• Attachment Input: Feed Poll
(v26.0 ～ 31.0)
• Attachment Input: Link (v23.0
～ 31.0)
• Attachment Input: New File
Upload (v23.0 ～ 31.0)
重要: API バージョン
32.0 以降では、
capabilities プロパ
ティを使用します。
body
Message Body Input
メッセージ本文の説明。本文 フィード項目にコ
には 25 文字まで使用できま ンテンツ機能また
す。
はリンク機能があ
フィード項目を共有するため る場合を除き、必
の originalFeedItemId を 須
23.0
指定する場合、body プロパ
ティを使用してコメントを
フィード項目に追加します。
このフィード項目が共有され
ている場合、この値は最初の
コメントの本文です。
capabilities
Feed Element
Capabilities Input
このフィード要素の動作を定 省略可能
義する機能。
31.0
isBookmarked
ByCurrentUser
Boolean
新しいフィード項目をユーザ 省略可能
のためにブックマークするか
(true)、否か (false) を指定
24.0 ～
31.0
316
Chatter REST API リソース
名前
Record Feed リソース
型
説明
必須項目/省略可能 使用可能
なバー
ジョン
します。デフォルト値は、
false です。
重要: API バージョン
32.0 以降では、
capabilities.bookmarks.
isBookmarkedByCurrentUser
プロパティを使用しま
す。
feedElementType String
この入力が表すフィード要素 必須項目
の種別。
31.0
有効な値は FeedItem のみ
です。
originalFeedElementId String
このフィード要素が共有され 省略可能
ている場合、これは元の
フィード要素の 18 文字の ID
です。
31.0
メモ: このパラメータ
は、他のすべてのパラ
メータよりも優先され
ます。たとえば、投稿
を共有し、さらにファ
イルのアップロードも
試みる場合、生成され
たフィード項目には共
有された投稿のみが含
まれます。1 つの POST
内では、投稿の共有か
ファイルのアップロー
ドのどちらか 1 つのみ
(両方ではなく) を行う
必要があります。
originalFeedItemId String
このフィード項目が共有され 省略可能
ている場合、これは元の
フィード項目の 18 文字の ID
です。
重要: API バージョン
32.0 以降は、
317
24.0 ～
31.0
Chatter REST API リソース
名前
Record Feed リソース
型
説明
必須項目/省略可能 使用可能
なバー
ジョン
originalFeedElementId
プロパティを使用しま
す。
subjectId
String
このフィード要素が投稿され 必須項目
た親の ID。この値は、ユー
ザ、グループ、レコードの
ID、またはコンテキストユー
ザを示す文字列 me になりま
す。
31.0
visibility
String
投稿を表示できるユーザ。有 省略可能
効な値は、次のとおりです。
26.0
• InternalUsers — コ
ミュニティが有効な場合
は、デフォルトの内部コ
ミュニティのメンバーに
対してのみフィード項目
を表示できます。
• AllUsers — コミュニ
ティが有効な場合は、コ
ミュニティのすべてのメ
ンバーに対してフィード
項目を表示できます。
デフォルト値は、次のとおり
です。
• 外部ユーザの場合、デ
フォルト値は AllUsers
です。外部ユーザが投稿
を表示するには、この値
を使用する必要がありま
す。
• 内部ユーザの場合、デ
フォルト値は
InternalUsers です。
内部ユーザは、この値を
受け入れるか、値
AllUsers を使用して外
部ユーザに投稿の表示を
許可します。
318
Chatter REST API リソース
名前
Record Feed リソース
型
説明
必須項目/省略可能 使用可能
なバー
ジョン
フィード項目の親が User また
は Group の場合、フィード項
目の visibility は
AllUsers である必要があり
ます。
POST の要求パラメータ
次のいずれかのパラメータセットを使用します。たとえば、リンクの post 送信とファイルの添付を同じ要
求で行うことはできません。
既存のファイルを添付するためのパラメータ
パラメータ名
型
説明
必須項
目/省略
可能
attachmentType
String
添付ファイルの種別。値 ExistingContent
を含める必要があります。
必須項目 27.0 ～
31.0
contentDocumentId
String
既存のファイルの 18 文字の ID。
必須項目 23.0 ～
31.0
isBookmarked
ByCurrentUser
Boolean 新しいフィード項目をユーザのためにブック 省略可能 26.0 ～
31.0
マークするか (true)、否か (false) を指定し
ます。デフォルト値は、false です。
text
String
フィード項目のテキスト。
visibility
String
投稿を表示できるユーザ。有効な値は、次の 省略可能 26.0 ～
31.0
とおりです。
• InternalUsers — コミュニティが有効な
場合は、デフォルトの内部コミュニティの
メンバーに対してのみフィード項目を表示
できます。
• AllUsers — コミュニティが有効な場合
は、コミュニティのすべてのメンバーに対
してフィード項目を表示できます。
デフォルト値は、次のとおりです。
• 外部ユーザの場合、デフォルト値は
AllUsers です。外部ユーザが投稿を表示
319
使用可
能な
バー
ジョン
省略可能 23.0 ～
31.0
Chatter REST API リソース
パラメータ名
Record Feed リソース
型
説明
必須項
目/省略
可能
使用可
能な
バー
ジョン
必須項
目/省略
可能
使用可
能な
バー
ジョン
するには、この値を使用する必要がありま
す。
• 内部ユーザの場合、デフォルト値は
InternalUsers です。内部ユーザは、こ
の値を受け入れるか、値 AllUsers を使用
して外部ユーザに投稿の表示を許可しま
す。
フィード項目の親が User または Group の場合、
フィード項目の visibility は AllUsers で
ある必要があります。
新規のファイルを添付するためのパラメータ
パラメータ名
型
説明
attachmentType
String
添付ファイルの種別。値 NewFile を含める必 必須項目 27.0 ～
31.0
要があります。
desc
String
post 送信するファイルの説明。
注意: このパラメータは、バージョン 27.0
以降では使用しないでください。代わり
に description を使用します。
省略可能 23.0 ～
26.0
description
String
post 送信するファイルの説明。
省略可能 27.0 ～
31.0
fileName
String
post 送信するファイルのファイル名。
必須項目 23.0 ～
24.0
注意: このパラメータは、バージョン 24.0
以降では使用しないでください。代わり
に title を使用します。
isBookmarked
ByCurrentUser
Boolean 新しいフィード項目をユーザのためにブック 省略可能 26.0 ～
31.0
マークするか (true)、否か (false) を指定し
ます。デフォルト値は、false です。
text
String
フィード項目のテキスト。
320
省略可能 23.0 ～
31.0
Chatter REST API リソース
Record Feed リソース
パラメータ名
型
説明
必須項
目/省略
可能
使用可
能な
バー
ジョン
title
String
アップロードまたは post 送信するファイルの 必須項目 24.0 ～
31.0
ファイル名。
visibility
String
投稿を表示できるユーザ。有効な値は、次の 省略可能 26.0 ～
31.0
とおりです。
• InternalUsers — コミュニティが有効な
場合は、デフォルトの内部コミュニティの
メンバーに対してのみフィード項目を表示
できます。
• AllUsers — コミュニティが有効な場合
は、コミュニティのすべてのメンバーに対
してフィード項目を表示できます。
デフォルト値は、次のとおりです。
• 外部ユーザの場合、デフォルト値は
AllUsers です。外部ユーザが投稿を表示
するには、この値を使用する必要がありま
す。
• 内部ユーザの場合、デフォルト値は
InternalUsers です。内部ユーザは、こ
の値を受け入れるか、値 AllUsers を使用
して外部ユーザに投稿の表示を許可しま
す。
フィード項目の親が User または Group の場合、
フィード項目の visibility は AllUsers で
ある必要があります。
リンクを post 送信するためのパラメータ
パラメータ名
型
説明
必須項目/ 使用可
省略可能 能な
バー
ジョン
attachmentType
String
添付ファイルの種別。値 Link を含める 必須項目
必要があります。
321
27.0 ～
31.0
Chatter REST API リソース
Record Feed リソース
パラメータ名
型
説明
必須項目/ 使用可
省略可能 能な
バー
ジョン
isBookmarked
ByCurrentUser
Boolean
新しいフィード項目をユーザのために
省略可能
ブックマークするか (true)、否か (false)
を指定します。デフォルト値は、false
です。
26.0 ～
31.0
text
String
フィード項目のテキスト。
省略可能
23.0 ～
31.0
url
String
リンクの URL。
必須項目
23.0 ～
31.0
urlName
String
URL の名前。
省略可能
23.0 ～
31.0
visibility
String
投稿を表示できるユーザ。有効な値は、 省略可能
次のとおりです。
26.0 ～
31.0
• InternalUsers — コミュニティが有
効な場合は、デフォルトの内部コミュ
ニティのメンバーに対してのみフィー
ド項目を表示できます。
• AllUsers — コミュニティが有効な
場合は、コミュニティのすべてのメン
バーに対してフィード項目を表示でき
ます。
デフォルト値は、次のとおりです。
• 外部ユーザの場合、デフォルト値は
AllUsers です。外部ユーザが投稿を
表示するには、この値を使用する必要
があります。
• 内部ユーザの場合、デフォルト値は
InternalUsers です。内部ユーザ
は、この値を受け入れるか、値
AllUsers を使用して外部ユーザに投
稿の表示を許可します。
フィード項目の親が User または Group の
場合、フィード項目の visibility は
AllUsers である必要があります。
アンケートを post 送信するためのパラメータ
322
Chatter REST API リソース
Record Feed リソース
パラメータ名
型
説明
必須項目/ 使用可
省略可能 能な
バー
ジョン
attachmentType
String
添付ファイルの種別。値 Poll を含める 必須項目 27.0 ～
31.0
必要があります。
isBookmarked
ByCurrentUser
Boolean
新しいフィード項目をユーザのために
省略可能 26.0 ～
31.0
ブックマークするか (true)、否か (false)
を指定します。デフォルト値は、false
です。
pollChoice1 ～
pollChoice10
String
この選択肢を使用して、アンケートを含 必須項目 26.0 ～
31.0
むフィード項目を作成します。アンケー
トには 2 個から 10 個のアンケート選択肢
を指定します。
text
String
フィード項目のテキスト。
visibility
String
投稿を表示できるユーザ。有効な値は、 省略可能 26.0 ～
31.0
次のとおりです。
• InternalUsers — コミュニティが有
効な場合は、デフォルトの内部コミュ
ニティのメンバーに対してのみフィー
ド項目を表示できます。
• AllUsers — コミュニティが有効な場
合は、コミュニティのすべてのメン
バーに対してフィード項目を表示でき
ます。
デフォルト値は、次のとおりです。
• 外部ユーザの場合、デフォルト値は
AllUsers です。外部ユーザが投稿を
表示するには、この値を使用する必要
があります。
• 内部ユーザの場合、デフォルト値は
InternalUsers です。内部ユーザ
は、この値を受け入れるか、値
AllUsers を使用して外部ユーザに投
稿の表示を許可します。
フィード項目の親が User または Group の
場合、フィード項目の visibility は
AllUsers である必要があります。
323
必須項目 23.0 ～
31.0
Chatter REST API リソース
Record Feed リソース
投稿を共有するためのパラメータ
パラメータ名
型
説明
必須項目/ 使用可
省略可能 能な
バー
ジョン
isBookmarked
ByCurrentUser
Boolean
新しいフィード項目をユーザのためにブッ 省略可能
クマークするか (true)、否か (false) を
指定します。デフォルト値は、false で
す。
26.0 ～
31.0
originalFeedItemId
String
共有するフィード項目の 18 文字の ID。
必須項目
24.0 ～
31.0
メモ: 投稿の共有は、ファイルの
アップロードよりも優先されます。
1 つの POST 内では、投稿の共有と
ファイルのアップロードの両方は行
わないでください。
text
String
共有されるフィード項目に対するコメン 省略可能
ト。
28.0 ～
31.0
visibility
String
投稿を表示できるユーザ。有効な値は、 省略可能
次のとおりです。
26.0 ～
31.0
• InternalUsers — コミュニティが有
効な場合は、デフォルトの内部コミュ
ニティのメンバーに対してのみフィー
ド項目を表示できます。
• AllUsers — コミュニティが有効な場
合は、コミュニティのすべてのメン
バーに対してフィード項目を表示でき
ます。
デフォルト値は、次のとおりです。
• 外部ユーザの場合、デフォルト値は
AllUsers です。外部ユーザが投稿を
表示するには、この値を使用する必要
があります。
• 内部ユーザの場合、デフォルト値は
InternalUsers です。内部ユーザ
は、この値を受け入れるか、値
AllUsers を使用して外部ユーザに投
稿の表示を許可します。
324
Chatter REST API リソース
パラメータ名
Record Feed リソース
型
説明
必須項目/ 使用可
省略可能 能な
バー
ジョン
フィード項目の親が User または Group の
場合、フィード項目の visibility は
AllUsers である必要があります。
テキストのみを post 送信するためのパラメータ
パラメータ名
型
説明
必須項目/ 使用可
省略可能 能な
バー
ジョン
isBookmarked
ByCurrentUser
Boolean
新しいフィード項目をユーザのためにブッ 省略可能
クマークするか (true)、否か (false) を
指定します。デフォルト値は、false で
す。
26.0 ～
31.0
text
String
フィード項目のテキスト。最大文字数は 必須項目
1000 文字です。
23.0 ～
31.0
visibility
String
投稿を表示できるユーザ。有効な値は、 省略可能
次のとおりです。
26.0 ～
31.0
• InternalUsers — コミュニティが有
効な場合は、デフォルトの内部コミュ
ニティのメンバーに対してのみフィー
ド項目を表示できます。
• AllUsers — コミュニティが有効な場
合は、コミュニティのすべてのメン
バーに対してフィード項目を表示でき
ます。
デフォルト値は、次のとおりです。
• 外部ユーザの場合、デフォルト値は
AllUsers です。外部ユーザが投稿を
表示するには、この値を使用する必要
があります。
• 内部ユーザの場合、デフォルト値は
InternalUsers です。内部ユーザ
は、この値を受け入れるか、値
AllUsers を使用して外部ユーザに投
稿の表示を許可します。
325
Chatter REST API リソース
パラメータ名
Record Feed リソース
型
説明
必須項目/ 使用可
省略可能 能な
バー
ジョン
フィード項目の親が User または Group の
場合、フィード項目の visibility は
AllUsers である必要があります。
キャンバスアプリケーションを post 送信するためのパラメータ
パラメータ名
型
説明
必須項目/ 使用可
省略可能 能な
バー
ジョン
attachmentType
String
添付ファイルの種別。値 Canvas を含める必 必須項目
要があります。
29.0 ～
31.0
description
String
キャンバスアプリケーションの説明
省略可能
29.0 ～
31.0
developerName
String
キャンバスアプリケーションの開発者名 (API
名)
必須項目
29.0 ～
31.0
height
String
キャンバスアプリケーションの高さ (ピクセル 省略可能
単位)。デフォルトの高さは 200 ピクセルです。
29.0 ～
31.0
isBookmarked
ByCurrentUser
Boolean 新しいフィード項目をユーザのためにブック 省略可能
マークするか (true)、否か (false) を指定し
ます。デフォルト値は、false です。
29.0 ～
31.0
namespacePrefix
String
キャンバスアプリケーションが作成された
Developer Edition 組織の名前空間プレフィック
ス。
省略可能
29.0 ～
31.0
parameters
String
キャンバスアプリケーションに渡される JSON 省略可能
形式のパラメータ。JSON は URL でエンコード
されている必要があります。
29.0 ～
31.0
parameters={'isUpdated'='true';}"
text
String
フィード項目のテキスト
省略可能
29.0 ～
31.0
thumbnailUrl
String
キャンバスアプリケーションのサムネイル画 省略可能
像の URL。最大サイズは 120x120 ピクセルです。
29.0 ～
31.0
326
Chatter REST API リソース
Record Feed リソース
パラメータ名
型
説明
必須項目/ 使用可
省略可能 能な
バー
ジョン
title
String
キャンバスアプリケーションへのリンクのタ 省略可能
イトル
29.0 ～
31.0
visibility
String
投稿を表示できるユーザ。有効な値は、次の 省略可能
とおりです。
29.0 ～
31.0
• InternalUsers — コミュニティが有効な
場合は、デフォルトの内部コミュニティの
メンバーに対してのみフィード項目を表示
できます。
• AllUsers — コミュニティが有効な場合
は、コミュニティのすべてのメンバーに対
してフィード項目を表示できます。
デフォルト値は、次のとおりです。
• 外部ユーザの場合、デフォルト値は
AllUsers です。外部ユーザが投稿を表示
するには、この値を使用する必要がありま
す。
• 内部ユーザの場合、デフォルト値は
InternalUsers です。内部ユーザは、こ
の値を受け入れるか、値 AllUsers を使用
して外部ユーザに投稿の表示を許可しま
す。
フィード項目の親が User または Group の場合、
フィード項目の visibility は AllUsers で
ある必要があります。
GET のレスポンスボディ
Feed Item Page
POST のレスポンスボディ
Feed Item
GET の例
次の要求は、文字列 track を含むフィード項目を検索します。
/chatter/feeds/record/me/feed-items?q=track
Feed Item Page レスポンスボディの feed-items/items/body/text プロパティで、文字列 track が検索
されます。
327
Chatter REST API リソース
Record Feed リソース
Record Feed Items Flat
このリソースは、バージョン 26.0 で廃止されました。
フラットフィードを返します。つまり、フィード項目とコメントの間に階層がなく、フィード項目とコメント
はすべて同じレベルに配置されます。すべての項目は、時系列に返されます。
リソース
/chatter/feeds/record/me/feed-items/flat
または
/chatter/feeds/record/userId/feed-items/flat
メモ: userId は、コンテキストユーザの ID または別名 me である必要があります。
適用開始バージョン
25.0 ～ 26.0
Chatter が必要かどうか
はい
HTTP メソッド
GET または HEAD
要求パラメータ
パラメータ名
型
説明
numFeedItems
Integer
返されるフィード項目数を指定し
ます。有効な値は 0 ～ 100 です。
デフォルト値は 25 です。フィード
項目にはコメントが含まれる場合
があるため、25 個のフラット
フィード項目を指定しても、実際
に返される数がそれより多くなる
ことがあります。たとえば、各
フィード項目に 1 つのコメントが
あり、recentCommentCount が
1 よりも大きい場合、50 個のフラッ
トフィード項目が返されます。
page
String
生成されたトークン。フィード内
のフィード項目のビューを示しま
す。ページトークンは、レスポン
スボディの一部として、
nextPageURL など、いずれかの
URL パラメータで返されます。
328
Chatter REST API リソース
To Feed リソース
パラメータ名
型
説明
recentCommentCount
Integer
返される最近のコメントの数を指
定します。有効な値は 0 ～ 25 で
す。デフォルト値は 3 です。
sort
String。次のいずれかになります。 返されたフィードを、作成日の昇
順、または最終更新日の昇順で並
• CreatedDateDesc
び替えます。デフォルトは
• LastModifiedDateDesc
LastModifiedDateDesc です。
レスポンスボディ
Flat Feed
関連トピック:
Records リソース
フィードおよびフィード要素の使用
レコードフィードを取得する
To Feed リソース
コンテキストユーザのすべての @メンションと、コンテキストユーザのフィードに対して行われたすべての投
稿を含むフィード。
次のリソースを使用できます。
リソース
説明
/chatter/feeds/to/me
コンテキストユーザのフィードのフィード要素への
URL を返します。
/chatter/feeds/to/me/feed-elements
コンテキストユーザのすべての @メンションのフィー
ド要素と、ユーザのフィードに対して行われたすべて
の投稿のフィード要素を返します。
To Feed URL
コンテキストユーザのフィードのフィード要素への URL を返します。
リソース
/chatter/feeds/to/userId
/connect/communities/communityId/chatter/feeds/to/userId
メモ: userId は、コンテキストユーザの ID または別名 me である必要があります。
329
Chatter REST API リソース
To Feed リソース
適用開始バージョン
23.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、HEAD
要求パラメータ
パラメータ名
型
説明
sort
String
作成日や最終更新日などで並び替
えて返される順序を指定します。
• CreatedDateDesc — 作成日
の新しい順に並び替えます。
• LastModifiedDateDesc — 活
動の新しい順に並び替えられま
す。
デフォルト値は、
CreatedDescDate です。
レスポンスボディ
Feed
To Feed Elements
コンテキストユーザのすべての @メンションのフィード要素と、ユーザのフィードに対して行われたすべての
投稿のフィード要素を返します。To Feed には、ユーザにメンションしている投稿と、他のユーザがユーザの
ウォールに対して行った投稿が含まれます。ユーザ自身の投稿は、コメントがある場合にのみ含まれます。こ
の場合、自分からのコメントと別のユーザからのコメントの両方が対象となります。
リソース
/chatter/feeds/to/userId/feed-elements
/connect/communities/communityId/chatter/feeds/to/userId/feed-elements
メモ: userId は、コンテキストユーザの ID または別名 me である必要があります。
適用開始バージョン
31.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、HEAD
330
Chatter REST API リソース
To Feed リソース
要求パラメータ
パラメータ名
型
説明
必須項 使用可能
目/省略 なバー
可能
ジョン
density
String
フィードの密度。次のいずれかの値にしま
す。
省略可
能
31.0
バンドルに含める最大フィード要素数。値は 省略可
0 ～ 10 の整数である必要があります。デフォ 能
ルト値は 3 です。
31.0
• AllUpdates — ユーザがフォローする人
とレコード、およびユーザがメンバーと
なっているグループからのすべての更新
が表示されます。
• FewerUpdates — ユーザがフォローする
人とレコード、およびユーザがメンバー
となっているグループからのすべての更
新が表示されますが、レコードからのシ
ステム生成された更新は非表示になりま
す。
デフォルト値は、AllUpdates です。
elementsPerBundle Integer
メモ: バンドル投稿にはフィード追跡
変更が含まれます。Salesforce1 ダウン
ロード可能アプリケーションでは、バ
ンドル投稿がレコードフィードのみに
あります。
page
String
生成されたトークン。フィード内のフィード 省略可
要素のビューを示します。ページトークン 能
は、レスポンスボディの一部として、
nextPageURL など、いずれかの URL パラメー
タで返されます。たとえば、次のようになり
ます。
"nextPageUrl":
"/services/data/v34.0/
chatter/feeds/news/
005D0000001GLowIAN
/feed-elements
331
31.0
Chatter REST API リソース
パラメータ名
To Feed リソース
型
説明
必須項 使用可能
目/省略 なバー
可能
ジョン
?page=2011-03-30T17:34:50Z,
0D5D0000000DSv4KAG"
pageSize
Integer
ページあたりのフィード要素数。有効な値は 省略可
1 ～ 100 です。デフォルトサイズは 25 です。 能
31.0
q
String
このフィード内のフィード要素の本文とコメ 省略可
ントに含まれる 1 つ以上の検索キーワード。 能
31.0
検索文字列にはワイルドカード文字を含める
ことができ、ワイルドカード文字を除く 2 文
字以上が含まれている必要があります。「ワ
イルドカード」を参照してください。
recentComment Integer
Count
sort
String
フィード要素ごとに含めるコメントの最大 省略可
数。デフォルト値は 3 です。最大値は、25 で 能
す。
31.0
作成日や最終更新日などで並び替えて返され 省略可
る順序を指定します。
能
31.0
• CreatedDateDesc — 作成日の新しい順
に並び替えます。
• LastModifiedDateDesc — 活動の新し
い順に並び替えられます。
デフォルト値は、CreatedDescDate です。
GET のレスポンスボディ
Feed Element Page
To Feed Items
コンテキストユーザのすべての @メンションのフィード項目と、ユーザのフィードに対して行われたすべての
投稿のフィード項目を返します。To Feed には、ユーザにメンションしている投稿と、他のユーザがユーザの
ウォールに対して行った投稿が含まれます。ユーザ自身の投稿は、コメントがある場合にのみ含まれます。こ
の場合、自分からのコメントと別のユーザからのコメントの両方が対象となります。
リソース
/chatter/feeds/to/me/feed-items
または
/chatter/feeds/to/userId/feed-items
332
Chatter REST API リソース
To Feed リソース
メモ: userId は、コンテキストユーザの ID または別名 me である必要があります。
使用可能なバージョン
23.0 ～ 31.0
重要: バージョン 32.0 以降では、To Feed Elements を使用します。
Chatter が必要かどうか
はい
HTTP メソッド
GET、HEAD
要求パラメータ
パラメータ名
型
説明
必須項 使用可能
目/省略 なバー
可能
ジョン
density
String
フィードの密度。次のいずれかの値にしま
す。
省略可
能
29.0 ～ 31.0
生成されたトークン。フィード内のフィード 省略可
項目のビューを示します。ページトークン 能
は、レスポンスボディの一部として、
nextPageURL など、いずれかの URL パラメー
タで返されます。たとえば、次のようになり
ます。
23.0 ～ 31.0
• AllUpdates — ユーザがフォローする人
とレコード、およびユーザがメンバーと
なっているグループからのすべての更新
が表示されます。
• FewerUpdates — ユーザがフォローする
人とレコード、およびユーザがメンバー
となっているグループからのすべての更
新が表示されますが、レコードからのシ
ステム生成された更新は非表示になりま
す。
デフォルト値は、AllUpdates です。
page
String
"nextPageUrl":
"/services/data/v34.0/
chatter/feeds/news/
005D0000001GLowIAN
/feed-items
333
Chatter REST API リソース
パラメータ名
To Feed リソース
型
説明
必須項 使用可能
目/省略 なバー
可能
ジョン
?page=2011-03-30T17:34:50Z,
0D5D0000000DSv4KAG"
pageSize
Integer
ページあたりの項目数を指定します。有効な 省略可
値は 1 ～ 100 です。サイズを指定しない場
能
合、デフォルトは 25 です。
23.0 ～ 31.0
q
String
このフィード内のフィード項目の本文とコメ 省略可
ントに含まれる 1 つ以上の検索キーワード。 能
28.0 ～ 31.0
検索文字列にはワイルドカード文字を含める
ことができ、ワイルドカード文字を除く 2 文
字以上が含まれている必要があります。「ワ
イルドカード」を参照してください。
recentComment Integer
Count
sort
String
フィード項目ごとに含めるコメントの最大 省略可
数。デフォルト値は 3 です。最大値は、25 で 能
す。
29.0 ～ 31.0
作成日や最終更新日などで並び替えて返され 省略可
る順序を指定します。
能
23.0 ～ 31.0
• CreatedDateDesc — 作成日の新しい順
に並び替えます。
• LastModifiedDateDesc — 活動の新し
い順に並び替えられます。
デフォルト値は、CreatedDescDate です。
GET のレスポンスボディ
Feed Item Page
To Feed Items Flat
このリソースは、バージョン 26.0 で廃止されました。
フラットフィードを返します。つまり、フィード項目とコメントの間に階層がなく、フィード項目とコメント
はすべて同じレベルに配置されます。すべての項目は、時系列に返されます。
リソース
/chatter/feeds/to/me/feed-items/flat
334
Chatter REST API リソース
To Feed リソース
または
/chatter/feeds/to/userId/feed-items/flat
メモ: userId は、コンテキストユーザの ID または別名 me である必要があります。
適用開始バージョン
25.0 ～ 26.0
Chatter が必要かどうか
はい
HTTP メソッド
GET または HEAD
要求パラメータ
パラメータ名
型
説明
numFeedItems
Integer
返されるフィード項目数を指定し
ます。有効な値は 0 ～ 100 です。
デフォルト値は 25 です。フィード
項目にはコメントが含まれる場合
があるため、25 個のフラット
フィード項目を指定しても、実際
に返される数がそれより多くなる
ことがあります。たとえば、各
フィード項目に 1 つのコメントが
あり、recentCommentCount が
1 よりも大きい場合、50 個のフラッ
トフィード項目が返されます。
page
String
生成されたトークン。フィード内
のフィード項目のビューを示しま
す。ページトークンは、レスポン
スボディの一部として、
nextPageURL など、いずれかの
URL パラメータで返されます。
recentCommentCount
Integer
返される最近のコメントの数を指
定します。有効な値は 0 ～ 25 で
す。デフォルト値は 3 です。
sort
String。次のいずれかになります。 返されたフィードを、作成日の昇
順、または最終更新日の昇順で並
• CreatedDateDesc
び替えます。デフォルトは
• LastModifiedDateDesc
LastModifiedDateDesc です。
335
Chatter REST API リソース
Topics Feed リソース
レスポンスボディ
Flat Feed
関連トピック:
フィードおよびフィード要素の使用
Topics Feed リソース
特定のトピックのフィード。
次のリソースを使用できます。
リソース
説明
/chatter/feeds/topics/topicId
特定のトピックのフィード項目への URL を返します。
/chatter/feeds/topics/topicId/feed-elements コンテキストユーザのすべての @メンションのフィー
ド要素と、ユーザのフィードに対して行われたすべて
の投稿のフィード要素を返します。
Topics Feed URL
特定のトピックのフィード項目への URL を返します。
リソース
/chatter/feeds/topics/topicId
/connect/communities/communityId/chatter/feeds/topics/topicId
適用開始バージョン
28.0
Chatter が必要かどうか
はい
HTTP メソッド
GET または HEAD
要求パラメータ
パラメータ名
型
説明
sort
String
作成日や最終更新日などで並び替
えて返される順序を指定します。
• CreatedDateDesc — 作成日
の新しい順に並び替えます。
336
Chatter REST API リソース
Topics Feed リソース
パラメータ名
型
説明
• LastModifiedDateDesc — 活
動の新しい順に並び替えられま
す。
デフォルト値は、
CreatedDescDate です。
レスポンスボディ
Feed
Topics Feed Elements
指定されたトピックのフィード要素をすべて返します。
リソース
/chatter/feeds/topics/topicId/feed-elements
/connect/communities/communityId/chatter/feeds/topics/topicId/feed-elements
適用開始バージョン
31.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、HEAD
要求パラメータ
パラメータ名
型
説明
必須項 使用可能
目/省略 なバー
可能
ジョン
filter
String
フィードに適用可能な検索条件値を指定しま 省略可
す。
能
• AllQuestions — 質問であるフィード要
素のみ。
• CommunityScoped — 今後の使用のため
に予約されています。
• SolvedQuestions — 質問で最良の回答
があるフィード要素のみ。
• UnansweredQuestions — 質問で回答が
ないフィード要素のみ。
• UnsolvedQuestions — 質問で最良の回
答がないフィード要素のみ。
337
32.0
Chatter REST API リソース
Topics Feed リソース
パラメータ名
型
説明
必須項 使用可能
目/省略 なバー
可能
ジョン
page
String
生成されたトークン。フィード内のフィード 省略可
要素のビューを示します。ページトークン 能
は、レスポンスボディの一部として、
nextPageURL など、いずれかの URL パラメー
タで返されます。
31.0
pageSize
Integer
ページあたりのフィード要素数を指定しま 省略可
す。有効な値は 1 ～ 100 です。デフォルト値 能
は 25 です。
31.0
sort
String
作成日や最終更新日などで並び替えて返され 省略可
る順序を指定します。
能
31.0
• CreatedDateDesc — 作成日の新しい順
に並び替えます。
• LastModifiedDateDesc — 活動の新し
い順に並び替えられます。
デフォルト値は、CreatedDescDate です。
レスポンスボディ
Feed Element Page
Topics Feed Items
指定されたトピックのフィード項目をすべて返します。トピックを投稿するには、Feed-Items Topicsリソースを
使用します。
リソース
/chatter/feeds/topics/topicId/feed-items
使用可能なバージョン
28.0 ～ 31.0
重要: バージョン 32.0 以降では、Topics Feed Elements を使用します。
Chatter が必要かどうか
はい
HTTP メソッド
GET または HEAD
338
Chatter REST API リソース
User Profile Feed リソース
要求パラメータ
パラメータ名
型
説明
必須項 使用可能
目/省略 なバー
可能
ジョン
page
String
生成されたトークン。フィード内のフィード 省略可
項目のビューを示します。ページトークン 能
は、レスポンスボディの一部として、
nextPageURL など、いずれかの URL パラメー
タで返されます。
28.0 ～ 31.0
pageSize
Integer
ページあたりの項目数を指定します。有効な 省略可
値は 1 ～ 100 です。サイズを指定しない場
能
合、デフォルトは 25 です。
28.0 ～ 31.0
sort
String
作成日や最終更新日などで並び替えて返され 省略可
る順序を指定します。
能
28.0 ～ 31.0
• CreatedDateDesc — 作成日の新しい順
に並び替えます。
• LastModifiedDateDesc — 活動の新し
い順に並び替えられます。
デフォルト値は、CreatedDescDate です。
レスポンスボディ
Feed Item Page
関連トピック:
フィードおよびフィード要素の使用
User Profile Feed リソース
フィードで追跡可能なレコードに対して現在のユーザが行ったアクションを含むフィード。このフィードは、
投稿、グループ更新、レコード更新などのより多くの要素を返す /chatter/feeds/news とは異なります。
User-Profile Feed へのフィード項目の post 送信に使用できます。
メモ: このフィードの構成は、Chatter Web UI に表示されているフィードと一致させるために、リリースに
よって異なる場合があります。
次のリソースを使用できます。
リソース
説明
/chatter/feeds/user-profile/me
ユーザプロファイルフィードのフィード要素への URL
を返します。
339
Chatter REST API リソース
User Profile Feed リソース
リソース
説明
/chatter/feeds/user-profile/me/feed-elements フィードで追跡可能なすべてのレコードに対するすべ
てのアクションのフィード要素を返します。
User Profile Feed URL
ユーザプロファイルフィードのフィード要素への URL を返します。
リソース
/chatter/feeds/user-profile/userId
/connect/communities/communityId/chatter/feeds/user-profile/userId
レスポンスボディ
Feed
User Profile Feed Elements
フィードで追跡可能なすべてのレコードに対するすべてのアクションのフィード要素を返します。
リソース
/chatter/feeds/user-profile/userId/feed-elements
/connect/communities/communityId/chatter/feeds/user-profile/userId/feed-elements
適用開始バージョン
31.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、HEAD
GET の要求パラメータ
パラメータ名
型
説明
必須項 使用可能
目/省略 なバー
可能
ジョン
density
String
フィードの密度。次のいずれかの値にしま
す。
省略可
能
• AllUpdates — ユーザがフォローする人
とレコード、およびユーザがメンバーと
なっているグループからのすべての更新
が表示されます。
• FewerUpdates — ユーザがフォローする
人とレコード、およびユーザがメンバー
340
31.0
Chatter REST API リソース
パラメータ名
User Profile Feed リソース
型
説明
必須項 使用可能
目/省略 なバー
可能
ジョン
となっているグループからのすべての更
新が表示されますが、レコードからのシ
ステム生成された更新は非表示になりま
す。
デフォルト値は、AllUpdates です。
elementsPerBundle Integer
バンドルに含める最大フィード要素数。値は 省略可
0 ～ 10 の整数である必要があります。デフォ 能
ルト値は 3 です。
31.0
メモ: バンドル投稿にはフィード追跡
変更が含まれます。Salesforce1 ダウン
ロード可能アプリケーションでは、バ
ンドル投稿がレコードフィードのみに
あります。
filter
String
値は、CommunityScoped のみです。コミュ
ニティを範囲とするフィード要素のみが含ま
れるようにフィードを絞り込みます。すべて
のコミュニティで常に表示されるフィード要
素は除外されます。現在、コミュニティを範
囲とするフィード要素には、User または Group
親レコードがあります。ただし、今後、他の
親レコードタイプがコミュニティを範囲とす
る可能性があります。
page
String
生成されたトークン。フィード内のフィード 省略可
要素のビューを示します。ページトークン 能
は、レスポンスボディの一部として、
nextPageURL など、いずれかの URL パラメー
タで返されます。
"nextPageUrl":
"/services/data/v34.0/
chatter/feeds/news/
005D0000001GLowIAN
/feed-elements
?page=2011-03-30T17:34:50Z,
0D5D0000000DSv4KAG"
341
31.0
Chatter REST API リソース
User Profile Feed リソース
パラメータ名
型
説明
必須項 使用可能
目/省略 なバー
可能
ジョン
pageSize
Integer
ページあたりのフィード要素数を指定しま 省略可
す。有効な値は 1 ～ 100 です。デフォルト値 能
は 25 です。
31.0
q
String
このフィード内のフィード要素の本文とコメ 省略可
ントに含まれる 1 つ以上の検索キーワード。 能
31.0
検索文字列にはワイルドカード文字を含める
ことができ、ワイルドカード文字を除く 2 文
字以上が含まれている必要があります。「ワ
イルドカード」を参照してください。
recentComment Integer
Count
sort
String
フィード要素ごとに含めるコメントの最大 省略可
数。デフォルト値は 3 です。最大値は、25 で 能
す。
31.0
作成日や最終更新日などで並び替えて返され 省略可
る順序を指定します。
能
31.0
• CreatedDateDesc — 作成日の新しい順
に並び替えます。
• LastModifiedDateDesc — 活動の新し
い順に並び替えられます。
デフォルト値は、CreatedDescDate です。
GET のレスポンスボディ
Feed Element Page
User Profile Feed Items
フィードで追跡可能なすべてのレコードに対するすべてのアクションのフィード項目を返します。このリソー
スは、新しいフィード項目の post 送信にも使用できます。
フィード項目の post 送信についての詳細は、「入力での POST、PATCH、または PUT の使用」を参照してくださ
い。
バイナリファイルをアップロードするには、マルチパート/フォームデータ要求のボディパートとして送信す
る必要があります。投稿またはコメントのテキストのような情報を、同じマルチパート/フォームデータ要求
の JSON または XML リッチ入力ボディパートとして送信できます。または、その情報を要求パラメータで送信
するように選択することもできます。リッチ入力リクエストボディと要求パラメータの両方を渡すと、要求パ
ラメータは無視されます。マルチパート/フォームデータメッセージを作成する方法についての詳細は、「バ
イナリファイルのアップロード」を参照してください。
API バージョン 29.0 では、フィード項目に 5000 文字まで含めることができます。この変更には後方互換性があ
り、以前のすべての API バージョンで 5000 文字の制限がサポートされています。API バージョン 23.0 および 24.0
342
Chatter REST API リソース
User Profile Feed リソース
では、User Profile Feed Items リソースへの投稿でユーザ状況更新が作成されますが、フィード項目は作成されま
せん。このため、これらの API バージョンでは、User Profile Feed Items リソースの文字制限は引き続き 1000 文字
になります。
リソース
/chatter/feeds/user-profile/me/feed-items
または
/chatter/feeds/user-profile/userId/feed-items
使用可能なバージョン
23.0 ～ 31.0
重要: バージョン 32.0 以降では、User Profile Feed Elements を使用します。
Chatter が必要かどうか
はい
HTTP メソッド
GET、POST、または HEAD
POST のリクエストボディ
ルート XML タグ
<feedItem>
JSON
次の例では、フィード項目にアンケートを添付します。
{
"body":{
"messageSegments":[
{
"type":"Text",
"text":"When should we meet for release planning?"
}
]
},
"capabilities":{
"poll":{
"choices":[
"Monday",
343
Chatter REST API リソース
User Profile Feed リソース
"Tuesday"
]
}
},
"feedElementType":"FeedItem",
"subjectId":"me"
}
フィード項目は複数の機能をサポートします。次の例では、ファイルをフィード項目に添付し、ブック
マークします。
{
"body":{
"messageSegments":[
{
"type":"Text",
"text":"Check out the latest marketing collateral."
}
]
},
"capabilities":{
"bookmarks":{
"isBookmarkedByCurrentUser": true
},
"content":{
"contentDocumentId": "069D00000001uQO"
}
},
"feedElementType":"FeedItem",
"subjectId":"me"
344
Chatter REST API リソース
User Profile Feed リソース
}
プロパティ
名前
型
説明
必須項目/省略可能 使用可能
なバー
ジョン
attachment
種別によって異な
る。
attachment パラメータには、 省略可能
次のいずれか 1 つの値のみを
指定できます。値は次のとお
りです。
• Attachment Input: Canvas App
(v29.0 ～ 31.0)
• Attachment Input: Existing
Content (v23.0 ～ 31.0)
• Attachment Input: Feed Poll
(v26.0 ～ 31.0)
• Attachment Input: Link (v23.0
～ 31.0)
• Attachment Input: New File
Upload (v23.0 ～ 31.0)
重要: API バージョン
32.0 以降では、
capabilities プロパ
ティを使用します。
body
Message Body Input
メッセージ本文の説明。本文 フィード項目にコ
には 25 文字まで使用できま ンテンツ機能また
す。
はリンク機能があ
フィード項目を共有するため る場合を除き、必
の originalFeedItemId を 須
23.0
指定する場合、body プロパ
ティを使用してコメントを
フィード項目に追加します。
このフィード項目が共有され
ている場合、この値は最初の
コメントの本文です。
capabilities
Feed Element
Capabilities Input
このフィード要素の動作を定 省略可能
義する機能。
345
31.0
Chatter REST API リソース
User Profile Feed リソース
名前
型
説明
必須項目/省略可能 使用可能
なバー
ジョン
isBookmarked
ByCurrentUser
Boolean
新しいフィード項目をユーザ 省略可能
のためにブックマークするか
(true)、否か (false) を指定
します。デフォルト値は、
false です。
24.0 ～
31.0
重要: API バージョン
32.0 以降では、
capabilities.bookmarks.
isBookmarkedByCurrentUser
プロパティを使用しま
す。
feedElementType String
この入力が表すフィード要素 必須項目
の種別。
31.0
有効な値は FeedItem のみ
です。
originalFeedElementId String
このフィード要素が共有され 省略可能
ている場合、これは元の
フィード要素の 18 文字の ID
です。
メモ: このパラメータ
は、他のすべてのパラ
メータよりも優先され
ます。たとえば、投稿
を共有し、さらにファ
イルのアップロードも
試みる場合、生成され
たフィード項目には共
有された投稿のみが含
まれます。1 つの POST
内では、投稿の共有か
ファイルのアップロー
ドのどちらか 1 つのみ
(両方ではなく) を行う
必要があります。
346
31.0
Chatter REST API リソース
名前
User Profile Feed リソース
型
originalFeedItemId String
説明
必須項目/省略可能 使用可能
なバー
ジョン
このフィード項目が共有され 省略可能
ている場合、これは元の
フィード項目の 18 文字の ID
です。
24.0 ～
31.0
重要: API バージョン
32.0 以降は、
originalFeedElementId
プロパティを使用しま
す。
subjectId
String
このフィード要素が投稿され 必須項目
た親の ID。この値は、ユー
ザ、グループ、レコードの
ID、またはコンテキストユー
ザを示す文字列 me になりま
す。
31.0
visibility
String
投稿を表示できるユーザ。有 省略可能
効な値は、次のとおりです。
26.0
• InternalUsers — コ
ミュニティが有効な場合
は、デフォルトの内部コ
ミュニティのメンバーに
対してのみフィード項目
を表示できます。
• AllUsers — コミュニ
ティが有効な場合は、コ
ミュニティのすべてのメ
ンバーに対してフィード
項目を表示できます。
デフォルト値は、次のとおり
です。
• 外部ユーザの場合、デ
フォルト値は AllUsers
です。外部ユーザが投稿
を表示するには、この値
を使用する必要がありま
す。
• 内部ユーザの場合、デ
フォルト値は
347
Chatter REST API リソース
名前
User Profile Feed リソース
型
説明
必須項目/省略可能 使用可能
なバー
ジョン
InternalUsers です。
内部ユーザは、この値を
受け入れるか、値
AllUsers を使用して外
部ユーザに投稿の表示を
許可します。
フィード項目の親が User また
は Group の場合、フィード項
目の visibility は
AllUsers である必要があり
ます。
POST の要求パラメータ
次のいずれかのパラメータセットを使用します。たとえば、リンクの post 送信とファイルの添付を同じ要
求で行うことはできません。
既存のファイルを添付するためのパラメータ
パラメータ名
型
説明
必須項
目/省略
可能
attachmentType
String
添付ファイルの種別。値 ExistingContent
を含める必要があります。
必須項目 27.0 ～
31.0
contentDocumentId
String
既存のファイルの 18 文字の ID。
必須項目 23.0 ～
31.0
isBookmarked
ByCurrentUser
Boolean 新しいフィード項目をユーザのためにブック 省略可能 26.0 ～
31.0
マークするか (true)、否か (false) を指定し
ます。デフォルト値は、false です。
text
String
フィード項目のテキスト。
visibility
String
投稿を表示できるユーザ。有効な値は、次の 省略可能 26.0 ～
31.0
とおりです。
• InternalUsers — コミュニティが有効な
場合は、デフォルトの内部コミュニティの
メンバーに対してのみフィード項目を表示
できます。
348
使用可
能な
バー
ジョン
省略可能 23.0 ～
31.0
Chatter REST API リソース
パラメータ名
User Profile Feed リソース
型
説明
必須項
目/省略
可能
使用可
能な
バー
ジョン
必須項
目/省略
可能
使用可
能な
バー
ジョン
• AllUsers — コミュニティが有効な場合
は、コミュニティのすべてのメンバーに対
してフィード項目を表示できます。
デフォルト値は、次のとおりです。
• 外部ユーザの場合、デフォルト値は
AllUsers です。外部ユーザが投稿を表示
するには、この値を使用する必要がありま
す。
• 内部ユーザの場合、デフォルト値は
InternalUsers です。内部ユーザは、こ
の値を受け入れるか、値 AllUsers を使用
して外部ユーザに投稿の表示を許可しま
す。
フィード項目の親が User または Group の場合、
フィード項目の visibility は AllUsers で
ある必要があります。
新規のファイルを添付するためのパラメータ
パラメータ名
型
説明
attachmentType
String
添付ファイルの種別。値 NewFile を含める必 必須項目 27.0 ～
31.0
要があります。
desc
String
post 送信するファイルの説明。
注意: このパラメータは、バージョン 27.0
以降では使用しないでください。代わり
に description を使用します。
省略可能 23.0 ～
26.0
description
String
post 送信するファイルの説明。
省略可能 27.0 ～
31.0
fileName
String
post 送信するファイルのファイル名。
必須項目 23.0 ～
24.0
注意: このパラメータは、バージョン 24.0
以降では使用しないでください。代わり
に title を使用します。
349
Chatter REST API リソース
User Profile Feed リソース
パラメータ名
型
説明
必須項
目/省略
可能
isBookmarked
ByCurrentUser
Boolean 新しいフィード項目をユーザのためにブック 省略可能 26.0 ～
31.0
マークするか (true)、否か (false) を指定し
ます。デフォルト値は、false です。
text
String
フィード項目のテキスト。
title
String
アップロードまたは post 送信するファイルの 必須項目 24.0 ～
31.0
ファイル名。
visibility
String
投稿を表示できるユーザ。有効な値は、次の 省略可能 26.0 ～
31.0
とおりです。
• InternalUsers — コミュニティが有効な
場合は、デフォルトの内部コミュニティの
メンバーに対してのみフィード項目を表示
できます。
• AllUsers — コミュニティが有効な場合
は、コミュニティのすべてのメンバーに対
してフィード項目を表示できます。
デフォルト値は、次のとおりです。
• 外部ユーザの場合、デフォルト値は
AllUsers です。外部ユーザが投稿を表示
するには、この値を使用する必要がありま
す。
• 内部ユーザの場合、デフォルト値は
InternalUsers です。内部ユーザは、こ
の値を受け入れるか、値 AllUsers を使用
して外部ユーザに投稿の表示を許可しま
す。
フィード項目の親が User または Group の場合、
フィード項目の visibility は AllUsers で
ある必要があります。
リンクを post 送信するためのパラメータ
350
使用可
能な
バー
ジョン
省略可能 23.0 ～
31.0
Chatter REST API リソース
User Profile Feed リソース
パラメータ名
型
説明
必須項目/ 使用可
省略可能 能な
バー
ジョン
attachmentType
String
添付ファイルの種別。値 Link を含める 必須項目
必要があります。
27.0 ～
31.0
isBookmarked
ByCurrentUser
Boolean
新しいフィード項目をユーザのために
省略可能
ブックマークするか (true)、否か (false)
を指定します。デフォルト値は、false
です。
26.0 ～
31.0
text
String
フィード項目のテキスト。
省略可能
23.0 ～
31.0
url
String
リンクの URL。
必須項目
23.0 ～
31.0
urlName
String
URL の名前。
省略可能
23.0 ～
31.0
visibility
String
投稿を表示できるユーザ。有効な値は、 省略可能
次のとおりです。
26.0 ～
31.0
• InternalUsers — コミュニティが有
効な場合は、デフォルトの内部コミュ
ニティのメンバーに対してのみフィー
ド項目を表示できます。
• AllUsers — コミュニティが有効な
場合は、コミュニティのすべてのメン
バーに対してフィード項目を表示でき
ます。
デフォルト値は、次のとおりです。
• 外部ユーザの場合、デフォルト値は
AllUsers です。外部ユーザが投稿を
表示するには、この値を使用する必要
があります。
• 内部ユーザの場合、デフォルト値は
InternalUsers です。内部ユーザ
は、この値を受け入れるか、値
AllUsers を使用して外部ユーザに投
稿の表示を許可します。
フィード項目の親が User または Group の
場合、フィード項目の visibility は
AllUsers である必要があります。
351
Chatter REST API リソース
User Profile Feed リソース
アンケートを post 送信するためのパラメータ
パラメータ名
型
説明
必須項目/ 使用可
省略可能 能な
バー
ジョン
attachmentType
String
添付ファイルの種別。値 Poll を含める 必須項目 27.0 ～
31.0
必要があります。
isBookmarked
ByCurrentUser
Boolean
新しいフィード項目をユーザのために
省略可能 26.0 ～
31.0
ブックマークするか (true)、否か (false)
を指定します。デフォルト値は、false
です。
pollChoice1 ～
pollChoice10
String
この選択肢を使用して、アンケートを含 必須項目 26.0 ～
31.0
むフィード項目を作成します。アンケー
トには 2 個から 10 個のアンケート選択肢
を指定します。
text
String
フィード項目のテキスト。
visibility
String
投稿を表示できるユーザ。有効な値は、 省略可能 26.0 ～
31.0
次のとおりです。
• InternalUsers — コミュニティが有
効な場合は、デフォルトの内部コミュ
ニティのメンバーに対してのみフィー
ド項目を表示できます。
• AllUsers — コミュニティが有効な場
合は、コミュニティのすべてのメン
バーに対してフィード項目を表示でき
ます。
デフォルト値は、次のとおりです。
• 外部ユーザの場合、デフォルト値は
AllUsers です。外部ユーザが投稿を
表示するには、この値を使用する必要
があります。
• 内部ユーザの場合、デフォルト値は
InternalUsers です。内部ユーザ
は、この値を受け入れるか、値
AllUsers を使用して外部ユーザに投
稿の表示を許可します。
フィード項目の親が User または Group の
場合、フィード項目の visibility は
AllUsers である必要があります。
352
必須項目 23.0 ～
31.0
Chatter REST API リソース
User Profile Feed リソース
投稿を共有するためのパラメータ
パラメータ名
型
説明
必須項目/ 使用可
省略可能 能な
バー
ジョン
isBookmarked
ByCurrentUser
Boolean
新しいフィード項目をユーザのためにブッ 省略可能
クマークするか (true)、否か (false) を
指定します。デフォルト値は、false で
す。
26.0 ～
31.0
originalFeedItemId
String
共有するフィード項目の 18 文字の ID。
必須項目
24.0 ～
31.0
メモ: 投稿の共有は、ファイルの
アップロードよりも優先されます。
1 つの POST 内では、投稿の共有と
ファイルのアップロードの両方は行
わないでください。
text
String
共有されるフィード項目に対するコメン 省略可能
ト。
28.0 ～
31.0
visibility
String
投稿を表示できるユーザ。有効な値は、 省略可能
次のとおりです。
26.0 ～
31.0
• InternalUsers — コミュニティが有
効な場合は、デフォルトの内部コミュ
ニティのメンバーに対してのみフィー
ド項目を表示できます。
• AllUsers — コミュニティが有効な場
合は、コミュニティのすべてのメン
バーに対してフィード項目を表示でき
ます。
デフォルト値は、次のとおりです。
• 外部ユーザの場合、デフォルト値は
AllUsers です。外部ユーザが投稿を
表示するには、この値を使用する必要
があります。
• 内部ユーザの場合、デフォルト値は
InternalUsers です。内部ユーザ
は、この値を受け入れるか、値
AllUsers を使用して外部ユーザに投
稿の表示を許可します。
353
Chatter REST API リソース
パラメータ名
User Profile Feed リソース
型
説明
必須項目/ 使用可
省略可能 能な
バー
ジョン
フィード項目の親が User または Group の
場合、フィード項目の visibility は
AllUsers である必要があります。
テキストのみを post 送信するためのパラメータ
パラメータ名
型
説明
必須項目/ 使用可
省略可能 能な
バー
ジョン
isBookmarked
ByCurrentUser
Boolean
新しいフィード項目をユーザのためにブッ 省略可能
クマークするか (true)、否か (false) を
指定します。デフォルト値は、false で
す。
26.0 ～
31.0
text
String
フィード項目のテキスト。最大文字数は 必須項目
1000 文字です。
23.0 ～
31.0
visibility
String
投稿を表示できるユーザ。有効な値は、 省略可能
次のとおりです。
26.0 ～
31.0
• InternalUsers — コミュニティが有
効な場合は、デフォルトの内部コミュ
ニティのメンバーに対してのみフィー
ド項目を表示できます。
• AllUsers — コミュニティが有効な場
合は、コミュニティのすべてのメン
バーに対してフィード項目を表示でき
ます。
デフォルト値は、次のとおりです。
• 外部ユーザの場合、デフォルト値は
AllUsers です。外部ユーザが投稿を
表示するには、この値を使用する必要
があります。
• 内部ユーザの場合、デフォルト値は
InternalUsers です。内部ユーザ
は、この値を受け入れるか、値
AllUsers を使用して外部ユーザに投
稿の表示を許可します。
354
Chatter REST API リソース
パラメータ名
User Profile Feed リソース
型
説明
必須項目/ 使用可
省略可能 能な
バー
ジョン
フィード項目の親が User または Group の
場合、フィード項目の visibility は
AllUsers である必要があります。
キャンバスアプリケーションを post 送信するためのパラメータ
パラメータ名
型
説明
必須項目/ 使用可
省略可能 能な
バー
ジョン
attachmentType
String
添付ファイルの種別。値 Canvas を含める必 必須項目
要があります。
29.0 ～
31.0
description
String
キャンバスアプリケーションの説明
省略可能
29.0 ～
31.0
developerName
String
キャンバスアプリケーションの開発者名 (API
名)
必須項目
29.0 ～
31.0
height
String
キャンバスアプリケーションの高さ (ピクセル 省略可能
単位)。デフォルトの高さは 200 ピクセルです。
29.0 ～
31.0
isBookmarked
ByCurrentUser
Boolean 新しいフィード項目をユーザのためにブック 省略可能
マークするか (true)、否か (false) を指定し
ます。デフォルト値は、false です。
29.0 ～
31.0
namespacePrefix
String
キャンバスアプリケーションが作成された
Developer Edition 組織の名前空間プレフィック
ス。
省略可能
29.0 ～
31.0
parameters
String
キャンバスアプリケーションに渡される JSON 省略可能
形式のパラメータ。JSON は URL でエンコード
されている必要があります。
29.0 ～
31.0
parameters={'isUpdated'='true';}"
text
String
フィード項目のテキスト
省略可能
29.0 ～
31.0
thumbnailUrl
String
キャンバスアプリケーションのサムネイル画 省略可能
像の URL。最大サイズは 120x120 ピクセルです。
29.0 ～
31.0
355
Chatter REST API リソース
User Profile Feed リソース
パラメータ名
型
説明
必須項目/ 使用可
省略可能 能な
バー
ジョン
title
String
キャンバスアプリケーションへのリンクのタ 省略可能
イトル
29.0 ～
31.0
visibility
String
投稿を表示できるユーザ。有効な値は、次の 省略可能
とおりです。
29.0 ～
31.0
• InternalUsers — コミュニティが有効な
場合は、デフォルトの内部コミュニティの
メンバーに対してのみフィード項目を表示
できます。
• AllUsers — コミュニティが有効な場合
は、コミュニティのすべてのメンバーに対
してフィード項目を表示できます。
デフォルト値は、次のとおりです。
• 外部ユーザの場合、デフォルト値は
AllUsers です。外部ユーザが投稿を表示
するには、この値を使用する必要がありま
す。
• 内部ユーザの場合、デフォルト値は
InternalUsers です。内部ユーザは、こ
の値を受け入れるか、値 AllUsers を使用
して外部ユーザに投稿の表示を許可しま
す。
フィード項目の親が User または Group の場合、
フィード項目の visibility は AllUsers で
ある必要があります。
GET または HEAD の要求パラメータ
パラメータ名
型
説明
必須項 使用可能
目/省略 なバー
可能
ジョン
density
String
フィードの密度。次のいずれかの値にしま
す。
省略可
能
• AllUpdates — ユーザがフォローする人
とレコード、およびユーザがメンバーと
なっているグループからのすべての更新
が表示されます。
356
29.0 ～ 31.0
Chatter REST API リソース
パラメータ名
User Profile Feed リソース
型
説明
必須項 使用可能
目/省略 なバー
可能
ジョン
• FewerUpdates — ユーザがフォローする
人とレコード、およびユーザがメンバー
となっているグループからのすべての更
新が表示されますが、レコードからのシ
ステム生成された更新は非表示になりま
す。
デフォルト値は、AllUpdates です。
page
String
生成されたトークン。フィード内のフィード 省略可
項目のビューを示します。ページトークン 能
は、レスポンスボディの一部として、
nextPageURL など、いずれかの URL パラメー
タで返されます。たとえば、次のようになり
ます。
23.0 ～ 31.0
"nextPageUrl":
"/services/data/v34.0/
chatter/feeds/news/
005D0000001GLowIAN
/feed-items
?page=2011-03-30T17:34:50Z,
0D5D0000000DSv4KAG"
pageSize
Integer
ページあたりの項目数を指定します。有効な 省略可
値は 1 ～ 100 です。サイズを指定しない場
能
合、デフォルトは 25 です。
23.0 ～ 31.0
q
String
このフィード内のフィード項目の本文とコメ 省略可
ントに含まれる 1 つ以上の検索キーワード。 能
28.0 ～ 31.0
検索文字列にはワイルドカード文字を含める
ことができ、ワイルドカード文字を除く 2 文
字以上が含まれている必要があります。「ワ
イルドカード」を参照してください。
recentComment Integer
Count
フィード項目ごとに含めるコメントの最大 省略可
数。デフォルト値は 3 です。最大値は、25 で 能
す。
357
29.0 ～ 31.0
Chatter REST API リソース
User Profile Feed リソース
パラメータ名
型
説明
必須項 使用可能
目/省略 なバー
可能
ジョン
sort
String
作成日や最終更新日などで並び替えて返され 省略可
る順序を指定します。
能
23.0 ～ 31.0
• CreatedDateDesc — 作成日の新しい順
に並び替えます。
• LastModifiedDateDesc — 活動の新し
い順に並び替えられます。
デフォルト値は、CreatedDescDate です。
GET のレスポンスボディ
Feed Item Page
POST のレスポンスボディ
Feed Item
User-Profile Feed Items Flat
このリソースは、バージョン 26.0 で廃止されました。
フラットフィードを返します。つまり、フィード項目とコメントの間に階層がなく、フィード項目とコメント
はすべて同じレベルに配置されます。すべての項目は、時系列に返されます。
リソース
/chatter/feeds/user-profile/me/feed-items/flat
または
/chatter/feeds/user-profile/userId/feed-items/flat
適用開始バージョン
25.0 ～ 26.0
Chatter が必要かどうか
はい
HTTP メソッド
GET または HEAD
要求パラメータ
パラメータ名
型
説明
numFeedItems
Integer
返されるフィード項目数を指定し
ます。有効な値は 0 ～ 100 です。
デフォルト値は 25 です。フィード
項目にはコメントが含まれる場合
358
Chatter REST API リソース
パラメータ名
Files Connect Repository リソース
型
説明
があるため、25 個のフラット
フィード項目を指定しても、実際
に返される数がそれより多くなる
ことがあります。たとえば、各
フィード項目に 1 つのコメントが
あり、recentCommentCount が
1 よりも大きい場合、50 個のフラッ
トフィード項目が返されます。
page
String
生成されたトークン。フィード内
のフィード項目のビューを示しま
す。ページトークンは、レスポン
スボディの一部として、
nextPageURL など、いずれかの
URL パラメータで返されます。
recentCommentCount
Integer
返される最近のコメントの数を指
定します。有効な値は 0 ～ 25 で
す。デフォルト値は 3 です。
sort
String。次のいずれかになります。 返されたフィードを、作成日の昇
順、または最終更新日の昇順で並
• CreatedDateDesc
び替えます。デフォルトは
• LastModifiedDateDesc
LastModifiedDateDesc です。
レスポンスボディ
Flat Feed
関連トピック:
フィードおよびフィード要素の使用
Files Connect Repository リソース
Files Connect リポジトリは、Salesforceに接続している外部コンテンツリポジトリです。これらのリソースを使用
して、リポジトリのリストの取得、リポジトリまたはリポジトリファイルに関する情報の取得、リポジトリ
ファイルのコンテンツの取得を行います。また、リポジトリフォルダ内のファイルとフォルダに関する情報の
取得にもこれらのリソースを使用します。
使用可能なリソース:
リソース
説明
/connect/content-hub/repositories
Files Connect リポジトリのリストを取得します。
359
Chatter REST API リソース
Files Connect Repository List
リソース
説明
/connect/content-hub/repositories/repositoryId Files Connect リポジトリに関する情報を取得します。
/connect/content-hub/repositories/repositoryId Files Connect リポジトリファイルに関する情報を取得し
/files/repositoryFileId
ます。
/connect/content-hub/repositories/repositoryId 外部システムからリポジトリファイルのコンテンツを
/files/repositoryFileId/content
取得します。コンテンツは、レスポンスボディとして
ストリーミングされます。
/connect/content-hub/repositories/repositoryId リポジトリフォルダ内のファイルとフォルダに関する
/folders/repositoryFolderId/items
情報を取得します。
リポジトリファイルへの参照を処理するには、次のファイルリソースを使用します。
リソース
説明
/chatter/files/fileId
既存の参照のバージョンの情報取得や更新を行いま
す。
/chatter/files/fileId/content
参照の内容を取得します。コンテンツは、レスポンス
ボディとしてストリーミングされます。
/chatter/users/me/files/
参照を作成します。
Files Connect Repository List
Files Connect リポジトリのリストを取得します。
リソース
/connect/content-hub/repositories
使用可能なバージョン
32.0
Chatter が必要かどうか
いいえ
HTTP メソッド
GET
GET の要求パラメータ
パラメータ名
型
canBrowseOnly Boolean
説明
必須項目/省略可 使用可能なバー
能
ジョン
参照をサポートするリポジトリの 省略可能
みを取得します。
360
32.0
Chatter REST API リソース
パラメータ名
Files Connect リポジトリ
型
canSearchOnly Boolean
説明
必須項目/省略可 使用可能なバー
能
ジョン
検索をサポートするリポジトリの 省略可能
みを取得します。
32.0
page
Integer
情報ページの表示に使用される
省略可能
ページトークンを指定します。
ページトークンは、
currentPageToken または
nextPageToken のように、応答
クラスの一部として返されます。
null を渡すと、最初のページが
返されます。
32.0
pageSize
Integer
ページあたりの項目数を指定しま 省略可能
す。有効な値は 1 ～ 100 です。
null を渡すと、デフォルトの 25
に設定されます。
32.0
GET のレスポンスボディ
Files Connect Repository Collection
Files Connect リポジトリ
Files Connect リポジトリに関する情報を取得します。
リソース
/connect/content-hub/repositories/repositoryId
使用可能なバージョン
32.0
Chatter が必要かどうか
いいえ
HTTP メソッド
GET、HEAD
レスポンスボディ
Files Connect Repository
Files Connect Repository File
Files Connect リポジトリファイルに関する情報を取得します。
リソース
/connect/content-hub/repositories/repositoryId/files/repositoryFileId
361
Chatter REST API リソース
Files Connect Repository File Content
使用可能なバージョン
32.0
Chatter が必要かどうか
いいえ
HTTP メソッド
GET、HEAD
レスポンスボディ
Repository File Detail
Files Connect Repository File Content
外部システムからリポジトリファイルのコンテンツを取得します。コンテンツは、レスポンスボディとしてス
トリーミングされます。
リソース
/connect/content-hub/repositories/repositoryId/files/repositoryFileId/content
使用可能なバージョン
32.0
Chatter が必要かどうか
いいえ
HTTP メソッド
GET、HEAD
レスポンスボディ
ファイルのコンテンツのバイナリストリーム。
Files Connect Repository Folder Items
リポジトリフォルダ内のファイルとフォルダに関する情報を取得します。
リソース
/connect/content-hub/repositories/repositoryId/folders/repositoryFolderId/items
使用可能なバージョン
32.0
Chatter が必要かどうか
いいえ
HTTP メソッド
GET、HEAD
362
Chatter REST API リソース
Files リソース
GET の要求パラメータ
パラメータ名
型
説明
必須項目/省略可 使用可能なバー
能
ジョン
page
Integer
情報ページの表示に使用される
省略可能
ページトークンを指定します。
ページトークンは、
currentPageToken または
nextPageToken のように、応答
クラスの一部として返されます。
null を渡すと、最初のページが
返されます。
32.0
pageSize
Integer
ページあたりの項目数を指定しま 省略可能
す。有効な値は 1 ～ 100 です。
null を渡すと、デフォルトの 25
に設定されます。
32.0
GET のレスポンスボディ
Repository Folder Items Collection
Files リソース
コンテンツ、表示されているバージョン、共有など、ファイルに関する情報。
次のリソースを使用できます。
リソース
説明
/chatter/files/fileId
外部ファイルへの参照を含む、指定されたファイルに
関する情報を取得します。外部ファイルへの参照を含
む、既存のファイルの新バージョンをアップロードし
ます。ファイルの名称変更、別のフォルダへの移動、
ファイルの削除を行います。
/chatter/files/fileId/content
外部ファイルへの参照を含む、ファイルのコンテンツ
を返します。コンテンツは、レスポンスボディとして
ストリーミングされます。
/chatter/files/fileId/file-shares
指定されたファイルの共有先であるオブジェクトに関
する情報を返します。オブジェクトはユーザ、グルー
プ、またはレコードの場合があります。指定された
ファイルをユーザと共有する場合にも使用できます。
363
Chatter REST API リソース
File Information
リソース
説明
/chatter/files/fileId/file-shares/link
リンクとして共有されるファイルの説明。ファイルの
共有リンクの作成、アクセス、または削除を行いま
す。
/chatter/files/fileId/rendition
ファイルの変換。変換とは、ファイルのバイナリプレ
ビューです。バイナリの形式は、要求で指定された形
式によって異なります。
/chatter/files/batch/fileIds
ファイル ID によって指定されたファイルのリストに
関する情報。ファイルのリストに関する情報の取得
や、ファイルのリストの削除を行います。
File Information
外部ファイルへの参照を含む、指定されたファイルに関する情報を取得します。外部ファイルへの参照を含
む、既存のファイルの新バージョンをアップロードします。ファイルの名称変更、別のフォルダへの移動、
ファイルの削除を行います。
既存のファイルの新しいバージョンをアップロードするには、POST 要求を実行します。新しいバージョンは、
マルチパート/フォームデータ要求のバイナリパートとしてアップロードする必要があります。「バイナリファ
イルのアップロード」 (ページ 13)を参照してください。新しいファイルを [ファイル] タブにアップロードする
には、/chatter/users/me/files (ページ 473)を使用します。
リソース
/chatter/files/fileId
/connect/communities/communityId/chatter/files/fileId
適用開始バージョン
24.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、POST、PATCH、DELETE、または HEAD
メモ: POST、PATCH、および DELETE は、バージョン 26.0 以降で使用できます。
POST のリクエストボディ
SharePoint 2010 へのアップロードは、最大 3 MB です。
ルート XML タグ
<fileInput>
JSON
{
364
Chatter REST API リソース
File Information
"desc" : "Employee Survey Results",
"title" : "emp_surv_results"
}
プロパティ
名前
型
説明
必須項目/省略
可能
使用可能なバー
ジョン
ファイル固有の最終更新日。クラ 省略可能
イアント側の更新日を設定するた
めに使用できます。
32.0
アップロードするファイルの説
明。
省略可能
24.0
isInMyFileSync Boolean
ファイルが Salesforce Files Sync と同 省略可能
期されている場合は true、同期
されていない場合は false。
31.0
isMajorVersion Boolean
ファイルがメジャーバージョンの 省略可能
場合は true、ファイルがマイ
ナーバージョンの場合は false。
メジャーバージョンを置き換える
ことはできません。
31.0
parentFolderId String
収容フォルダの ID。
省略可能
31.0
String
外部ファイルの ID。
省略可能
32.0
外部データソースの ID。
省略可能
32.0
ファイルのタイトル。
省略可能
24.0
content
Date
ModifiedDate
desc
repository
FileId
String
repositoryId String
title
String
POST の要求パラメータ
SharePoint 2010 へのアップロードは、最大 3 MB です。
名前
型
説明
使用可能な
バージョン
desc
String
アップロードするファイルの説明。
26.0
isDataSync
Boolean
要求は自動クライアントによって自動生成されます。 31.0
isInMyFileSync
Boolean
ファイルが Salesforce Files Sync と同期されている場合は 31.0
true、同期されていない場合は false。
365
Chatter REST API リソース
File Information
名前
型
説明
使用可能な
バージョン
isMajorVersion
Boolean
ファイルがメジャーバージョンの場合は true、ファ 31.0
イルがマイナーバージョンの場合は false。メジャー
バージョンを置き換えることはできません。
title
String
ファイルのタイトル。
26.0
GET の要求パラメータ
指定されたファイルに関する情報を取得します。
名前
型
説明
使用可能な
バージョン
versionNumber
Integer
ファイルの既存のバージョン番号を指定します。指 23.0
定されていない場合、最新のバージョンが返されま
す。
PATCH の要求パラメータ
ファイルのタイトルまたは同期状態の更新や、別のフォルダへのファイルの移動を行います。
名前
型
説明
使用可能な
バージョン
desc
String
ファイルの新しい説明
32.0
title
String
ファイルの新しいタイトル
26.0
isInMyFileSync
Boolean
ファイルが Salesforce Files Sync と同期されている場合 31.0
は true、同期されていない場合は false。
parentFolderId
String
収容フォルダの ID
GET、POST、PATCH、および HEAD のレスポンスボディ
File Detail
DELETE のレスポンスボディ
状況コード 204 を返します。
例
この PATCH 要求は、ファイルのタイトルを更新します。
/chatter/files/069D00000001FHF?title=A+New+Title
366
31.0
Chatter REST API リソース
File Content
File Content
外部ファイルへの参照を含む、ファイルのコンテンツを返します。コンテンツは、レスポンスボディとしてス
トリーミングされます。
リソース
/chatter/files/fileId/content
/connect/communities/communityId/chatter/files/fileId/content
適用開始バージョン
24.0
Chatter が必要かどうか
はい
HTTP メソッド
GET
GET の要求パラメータ
パラメータ名
型
説明
isDataSync
Boolean
要求は自動クライアントによって 省略可能
自動生成されます。
31.0
ファイルの既存のバージョン番号 省略可能
を指定します。指定されていない
場合、最新のバージョンが返され
ます。
24.0
versionNumber Integer
必須項目/省略可 使用可能なバー
能
ジョン
レスポンスボディ
ファイルのコンテンツのバイナリストリーム。
File Shares
指定されたファイルの共有先であるオブジェクトに関する情報を返します。オブジェクトはユーザ、グルー
プ、またはレコードの場合があります。指定されたファイルをユーザと共有する場合にも使用できます。
リソース
/chatter/files/fileId/file-shares
/connect/communities/communityId/chatter/files/fileId/file-shares
適用開始バージョン
24.0
Chatter が必要かどうか
はい
367
Chatter REST API リソース
File Shares
HTTP メソッド
GET、HEAD、POST
POST は、バージョン 30.0 以降で使用できます。
GET の要求パラメータ
バージョン 30.0 以降の場合、GET 要求で最初に返される共有は組織のレコード共有です。コミュニティの場
合、最初に返される共有はネットワークレコード共有です。
名前
型
説明
必須項目/省略可能
適用開始バージョン
page
Integer
トピックのページを指定する 0 省略可能
より大きい整数。デフォルト
値は、0 です。
24.0
pageSize
Integer
ページあたりの項目数を指定 省略可能
します。有効な値は 1 ～ 100 で
す。デフォルト値は 25 です。
24.0
POST のリクエストボディ
ルート XML タグ
<fileShares>
JSON の例
{
"message": "I shared a document with you.",
"shares": [
{ "id": "005D0000001Az4l", "sharingType": "V" },
{ "id": "005D0000001B2ny", "sharingType": "C" }
]
}
プロパティ
名前
型
説明
message
String
受信者に送信される非公開のメッセージ本 30.0
文。Salesforce Communities が有効な場合、非
公開メッセージではなくメールが送信され
ます。
368
使用可能なバー
ジョン
Chatter REST API リソース
File Shares
名前
型
説明
使用可能なバー
ジョン
shares
Share Input[]
Share Input リクエストボディのコレクショ
ン。
30.0
POST の要求パラメータ
ファイルをユーザと共有するためのパラメータ
名前
型
説明
id(1–9)
String
このファイルの共有先である 必須項目
最大 9 個のユーザ ID のリスト。
このリストは、共有種別のリ
ストと一致する必要がありま
す。
30.0
message
String
受信者に送信される非公開の
メッセージ本文。Salesforce
Communities が有効な場合、非
公開メッセージではなくメー
ルが送信されます。
省略可能
30.0
共有種別のリスト。コラボレー 必須項目
タの場合は C、閲覧者の場合は
V です。このリストは、ユー
ザ ID のリストと一致する必要
があります。
30.0
sharingType(1–9) String
必須項目/省略可能
適用開始バージョン
GET および POST のレスポンスボディ
File Shares Page
POST の例
次の例では、要求パラメータを使用してファイルを 2 人のユーザと共有します。
POST /chatter/files/069D00000001JDU/file-shares?
id1=005D0000001LL8O&id2=005D0000001QdEL&sharingType1=C&sharingType2=V
次の例では、リクエストボディを使用して同じファイルを同じユーザと共有します。
POST /chatter/files/069D00000001JDU/file-shares
{
"shares": [
{ "id": "005D0000001LL8O", "sharingType": "C" },
369
Chatter REST API リソース
Files Shares Link
{ "id": "005D0000001QdEL", "sharingType": "V" }
]
}
Files Shares Link
リンクとして共有されるファイルの説明。ファイルの共有リンクの作成、アクセス、または削除を行います。
リソース
/chatter/files/fileId/file-shares/link
/connect/communities/communityId/chatter/files/fileId/file-shares/link
適用開始バージョン
30.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、HEAD、PUT、DELETE
GET または PUT のレスポンスボディ
File Share Link
DELETE のレスポンスボディ
状況コード 204 を返します。
File Rendition
ファイルの変換。変換とは、ファイルのバイナリプレビューです。バイナリの形式は、要求で指定された形式
によって異なります。
メモ: 共有ファイルの場合、変換はアップロード後に非同期で処理されます。非公開ファイルの場合、変
換は最初にファイルプレビューが要求されたときに処理されるため、ファイルのアップロード直後は使
用できません。
リソース
/chatter/files/fileId/rendition
/connect/communities/communityId/chatter/files/fileId/rendition
適用開始バージョン
24.0
Chatter が必要かどうか
はい
370
Chatter REST API リソース
File Information, Batch
HTTP メソッド
GET
要求パラメータ
名前
型
説明
page
Integer
特定のページの変換を指定しま
す。最初のページは 0 です。特定
のページを指定しない場合、最初
のページの変換が返されます。
PDF ファイルの変換の場合、ドキュ
メント全体の変換になります。有
効な値は 0 のみです。単一ページ
の変換は取得できません。
type
返される変換の種別を指定しま
す。デフォルト値は
THUMB120BY90 です。有効な値
は、次のとおりです。
String
• FLASH
• PDF
• THUMB120BY90
• THUMB240BY180
• THUMB720BY480
レスポンスボディ
変換のバイナリストリーム。
File Information, Batch
ファイル ID によって指定されたファイルのリストに関する情報。ファイルのリストに関する情報の取得や、
ファイルのリストの削除を行います。
指定できるファイル ID 数は、URL の長さによって制限されます。通常、カンマ区切りのリストに最大 100 個の
ファイル ID を指定できます。
リソース
/chatter/files/batch/fileIds
/connect/communities/communityId/chatter/files/batch/fileIds
適用開始バージョン
26.0
371
Chatter REST API リソース
Folders リソース
Chatter が必要かどうか
はい
HTTP メソッド
GET、DELETE
レスポンスボディ
Batch Result Item
Folders リソース
フォルダまたはフォルダの内容に関する情報。フォルダの変更と削除、フォルダへの項目の追加、およびルー
トフォルダの同期を行います。
使用可能なリソース:
リソース
説明
/chatter/folders/folderId
指定されたフォルダに関する情報を取得します。フォ
ルダの移動、名前の変更、および削除を行います。
ルートフォルダを同期します。
/chatter/folders/folderId/items
フォルダの内容に関する情報を取得します。フォルダ
へのファイルの追加や、フォルダの作成を行います。
ルートフォルダを同期します。
Folder Information
指定されたフォルダに関する情報を取得します。フォルダの移動、名前の変更、および削除を行います。ルー
トフォルダを同期します。フォルダを削除すると、そのフォルダ内のフォルダはすべて削除され、削除された
フォルダからすべてのファイルが削除されるため、同期されなくなります。
リソース
/chatter/folders/folderId
メモ: root を folderId として使用できます。
適用開始バージョン
30.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、HEAD、PATCH、DELETE
PATCH のリクエストボディ
Folder Input
372
Chatter REST API リソース
Folders リソース
PATCH の要求パラメータ
フォルダの移動
パラメータ 型
isInMy
FileSync
Boolean
説明
必須項目/省略可能
フォルダおよびこのフォルダ内のすべての 省略可能
フォルダが Salesforce Files Sync と同期されてい
る場合は true、同期されていない場合は
false。
使用可能な
バージョン
33.0
isInMyFileSync 設定は、ルートフォルダ
でのみ有効です。一度 true に設定すると、
isInMyFileSync を false に設定すること
はできません。
parent
FolderId
String
新しい親フォルダの ID。null の場合、フォ 必須項目
ルダは現在のフォルダから削除されます。
指定された ID が root の場合、フォルダは
ユーザのフォルダ階層のルートに移動しま
す。
30.0
説明
使用可能な
バージョン
フォルダ名の変更
パラメータ 型
isInMy
FileSync
Boolean
必須項目/省略可能
フォルダおよびこのフォルダ内のすべての 省略可能
フォルダが Salesforce Files Sync と同期されてい
る場合は true、同期されていない場合は
false。
33.0
isInMyFileSync 設定は、ルートフォルダ
でのみ有効です。一度 true に設定すると、
isInMyFileSync を false に設定すること
はできません。
name
String
フォルダの新しい名前
必須項目
30.0
GET および PATCH のレスポンスボディ
Folder
Folder Contents
フォルダの内容に関する情報を取得します。フォルダへのファイルの追加や、フォルダの作成を行います。
ルートフォルダを同期します。
373
Chatter REST API リソース
Folders リソース
フォルダを作成するには、POST 要求でリクエストボディまたは要求パラメータを使用できます。
ファイルを作成するには、マルチパート/フォームデータの POST 要求のボディパートとして送信する必要があ
ります。説明とタイトル情報を送信するには、マルチパート/フォームデータ要求の一部として JSON または
XML リッチ入力ボディに含めます。または、説明、タイトル、および種別を要求パラメータで送信できます。
「バイナリファイルのアップロード」 (ページ 13)を参照してください。ファイルを [ファイル] タブに追加する
には、/chatter/users/me/filesを使用します。
リソース
/chatter/folders/folderId/items
メモ: root を folderId として使用できます。
適用開始バージョン
30.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、HEAD、POST
GET の要求パラメータ
パラメータ 型
説明
必須項目/省略可能
使用可能な
バージョン
filter
String
フォルダ内の項目の検索条件を指定します。 省略可能
値 IsInMyFileSync は、フォルダで同期さ
れていない項目を除外します。
33.0
page
Integer
項目のページを指定する整数。デフォルト
値は 0 で、最初のページを返します。
省略可能
30.0
pageSize
Integer
ページあたりの項目数を指定します。有効 省略可能
な値は 1 ～ 100 です。サイズを指定しない場
合、デフォルトは 25 です。
30.0
GET のレスポンスボディ
Folder Item Page
POST のリクエストボディ
Folder Item Input
POST の要求パラメータ
フォルダへのファイルの追加
パラメータ 型
desc
String
説明
必須項目/省略可能
使用可能な
バージョン
ファイルの説明
省略可能
30.0
374
Chatter REST API リソース
パラメータ 型
isInMy
FileSync
Boolean
Folders リソース
説明
必須項目/省略可能
フォルダおよびこのフォルダ内のすべての 省略可能
フォルダが Salesforce Files Sync と同期されてい
る場合は true、同期されていない場合は
false。
使用可能な
バージョン
33.0
isInMyFileSync 設定は、ルートフォルダ
でのみ有効です。一度 true に設定すると、
isInMyFileSync を false に設定すること
はできません。
title
String
ファイルのタイトル
省略可能
30.0
type
String
項目の種別。ファイルをフォルダに追加す 必須項目
るには、値を File にする必要があります。
30.0
パラメータ 型
説明
必須項目/省略可能
使用可能な
バージョン
folderPath String
フォルダへのパス
必須項目
30.0
フォルダおよびこのフォルダ内のすべての 省略可能
フォルダが Salesforce Files Sync と同期されてい
る場合は true、同期されていない場合は
false。
33.0
フォルダの作成
isInMy
FileSync
Boolean
isInMyFileSync 設定は、ルートフォルダ
でのみ有効です。一度 true に設定すると、
isInMyFileSync を false に設定すること
はできません。
String
type
項目の種別。フォルダを作成するには、値
を Folder にする必要があります。
POST のレスポンスボディ
Folder Item
ファイルをフォルダに追加する例
{
"file" :
{
375
必須項目
30.0
Chatter REST API リソース
Groups リソース
"description" : "Yearly Report for Universal Containers Box Division",
"title" : "Yearly.txt"
},
"type" : "File"
}
フォルダを作成する例
{
"folder" :
{
"path" : "my_documents/my_folder"
},
"type" : "Folder"
}
Groups リソース
グループのメンバー、写真、および組織内のグループなど、グループに関する情報。グループの作成および削
除、グループへのメンバーの追加、グループの写真の変更を行います。
メモ: groups リソースはフィードではありません。グループのフィードの表示や、グループのフィードへ
の投稿を行うには、groupId を含む Record Feed リソースを使用してください。
使用可能なリソース:
リソース
説明
/chatter/group-membership-requests/requestId 非公開グループに参加するユーザによって要求の状況
を更新するか、非公開グループへの参加要求に関する
情報を取得します。
/chatter/group-memberships/membershipId
グループのメンバーに関する情報へのアクセス、グ
ループからのメンバーの削除、およびグループメン
バーのロールの更新に使用されます。
/chatter/group-memberships/batch/membershipIds グループメンバーのリストに関する情報へのアクセス
に使用されます。
/chatter/group-records/groupRecordId
グループレコードに関する情報の取得、またはレコー
ドとグループ間の関連付けの削除を行います。
376
Chatter REST API リソース
List of Groups
リソース
説明
/chatter/groups/
組織内のすべてのグループのリスト。グループに関す
る情報を取得するか、グループを作成します。
/chatter/groups/batch/group_list
一度に複数のグループに関する情報を返します。
/chatter/groups/groupId
グループに関する情報。
/chatter/groups/groupId/announcements
指定されたグループに投稿されたお知らせに関する情
報。グループへのお知らせの情報取得や投稿を行いま
す。
/chatter/groups/groupID/files
指定されたグループに投稿されたファイルに関する情
報を返します。
/chatter/groups/groupId/members
指定されたグループのメンバー。メンバーを取得し、
グループにメンバーを追加します。メンバーを追加す
るには、コンテキストユーザがグループ所有者または
モデレータである必要があります。
/chatter/groups/groupId/members/requests
非公開グループのメンバーシップを要求するか、非公
開グループへの参加要求の状況を取得します。
/chatter/groups/groupId/my-settings
指定されたグループのコンテキストユーザの Chatter
設定に関する情報です。
/chatter/groups/groupId/photo
指定されたグループの写真。写真を取得、投稿、トリ
ミング、削除します。
/chatter/groups/groupId/records
指定されたグループに関連付けられたレコードのリス
トを返します。レコードをグループに関連付けるため
にも使用されます。
/chatter/groups/groupId/topics
指定されたグループで最近使用されたトピックを最大
5 個返します。
関連トピック:
Groups Feed リソース
List of Groups
組織内のすべてのグループのリスト。グループに関する情報を取得するか、グループを作成します。
リソース
/chatter/groups/
/connect/communities/communityId/chatter/groups/
377
Chatter REST API リソース
List of Groups
使用可能なバージョン
23.0
POST は 29.0 で使用可能
Chatter が必要かどうか
はい
HTTP メソッド
GET、HEAD、POST
GET の要求パラメータ
パラメータ名
型
説明
使用可能
archiveStatus
String
指定のアーカイブ状況で絞り込まれ 29.0
たグループのリストを返します。
• All — アーカイブ対象かどうか
に関係なく、すべてのグルー
プ。
• Archived — アーカイブ対象の
グループのみ。
• NotArchived — アーカイブ対
象外のグループのみ。
デフォルト値は、NotArchived で
す。
page
Integer
項目のページを指定する整数。デ 23.0
フォルト値は 0 で、最初のページを
返します。
pageSize
Integer
ページあたりの項目数を指定しま
す。有効な値は 1 ～ 250 です。デ
フォルト値は 25 です。
q
String
検索する文字列を指定します。検索 23.0
文字列にはワイルドカード文字を除
いて 2 文字以上が含まれている必要
があります。ワイルドカードについ
ての詳細は、「ワイルドカード」を
参照してください。
POST のリクエストボディ
ルート XML タグ
<group>
378
23.0
Chatter REST API リソース
List of Groups
JSON
{
"announcement" : "0D5D0000000K4XT",
"canHaveChatterGuests" : "true",
"description" : "This group is building a powerful API.",
"information" : {
"text" : "Read this section before you post to the group.",
"title" : "Information"
},
"isArchived" : "false",
"isAutoArchiveDisabled" : "false",
"name" : "Chatter API",
"owner" : "00590000000DmPw",
"visibility" : "PublicAccess"
}
プロパティ
名前
型
説明
使用可能な
バージョン
announcement
String
お知らせ ID。
31.0
お知らせは、削除されるか、別の
お知らせで置き換えられない限
り、その表示期限の 11:59 p.m. まで
Salesforce UI の指定の場所に表示さ
れます。
canHaveChatterGuests Boolean
このグループで Chatter 顧客を許可 29.0
している場合は true、それ以外
の場合は false。このプロパティ
を true に設定した後で、false
に設定することはできません。
description
String
グループの [説明] セクション
information
Group Information Input
グループの [情報] セクション Web 28.0
UI では、[情報] セクションは [説明]
379
29.0
Chatter REST API リソース
List of Groups
名前
型
説明
使用可能な
バージョン
セクションの上にあります。グ
ループが非公開の場合は、[情報]
セクションはメンバーにのみ表示
されます。[説明] セクションは全
員に表示されます。
Boolean
グループがアーカイブ済みの場合 29.0
は true、それ以外の場合は
false。デフォルトは false で
す。
isAutoArchiveDisabled Boolean
グループの自動アーカイブが無効 29.0
の場合は true、それ以外の場合
は false。デフォルトは false
です。
isArchived
name
String
グループの名前
29.0
owner
String
グループ所有者の ID。このプロパ 29.0
ティは、PATCH 要求でのみ使用で
きます。
visibility
String
グループの表示種別を指定しま
す。次のいずれかの値になりま
す。
29.0
• PrivateAccess — グループの
メンバーのみが、このグループ
への投稿を参照できます。
• PublicAccess — コミュニ
ティのすべてのユーザが、この
グループへの投稿を参照できま
す。
• Unlisted — 今後の使用のため
に予約されています。
POST の要求パラメータ
パラメータ名
型
説明
必須項目/省略可 使用可能
能
canHaveChatterGuests Boolean このグループで Chatter 顧客を許可している場 省略可能
合は true、それ以外の場合は false。このプ
380
29.0
Chatter REST API リソース
パラメータ名
Group Information
型
説明
必須項目/省略可 使用可能
能
ロパティを true に設定した後で、false に
設定することはできません。
グループの [説明] セクション
省略可能
29.0
informationText String
グループの [情報] セクション内のテキスト
省略可能
29.0
informationTitle String
グループの [情報] セクションのタイトル
省略可能
29.0
description
String
name
String
グループの名前
必須項目
29.0
visibility
String
グループの表示種別を指定します。次のいず 必須項目
れかになります。
29.0
• PrivateAccess — グループのメンバーの
みが、このグループへの投稿を参照できま
す。
• PublicAccess — コミュニティのすべて
のユーザが、このグループへの投稿を参照
できます。
• Unlisted — 今後の使用のために予約され
ています。
GET のレスポンスボディ
Group Page
POST のレスポンスボディ
Group Detail
POST の例
次の要求で公開グループが作成されます。
POST /chatter/groups?name=New+Group&visibility=PublicAccess
関連トピック:
グループを作成する
Group Information
グループに関する情報。
リソース
/chatter/groups/groupId
/connect/communities/communityId/chatter/groups/groupId
381
Chatter REST API リソース
Group Information
使用可能なバージョン
23.0
PATCH は 28.0 で使用可能
Chatter が必要かどうか
はい
HTTP メソッド
GET、DELETE、HEAD、PATCH
DELETE は 29.0 でサポート
PATCH は 28.0 でサポート
PATCH のリクエストボディ
Group Input
ルート XML タグ
<group>
JSON
{
"announcement" : "0D5D0000000K4XT",
"canHaveChatterGuests" : "true",
"description" : "This group is building a powerful API.",
"information" : {
"text" : "Read this section before you post to the group.",
"title" : "Information"
},
"isArchived" : "false",
"isAutoArchiveDisabled" : "false",
"name" : "Chatter API",
"owner" : "00590000000DmPw",
"visibility" : "PublicAccess"
}
382
Chatter REST API リソース
Group Information
プロパティ
名前
型
説明
使用可能な
バージョン
announcement
String
お知らせ ID。
31.0
お知らせは、削除されるか、別の
お知らせで置き換えられない限
り、その表示期限の 11:59 p.m. まで
Salesforce UI の指定の場所に表示さ
れます。
canHaveChatterGuests Boolean
このグループで Chatter 顧客を許可 29.0
している場合は true、それ以外
の場合は false。このプロパティ
を true に設定した後で、false
に設定することはできません。
description
String
グループの [説明] セクション
29.0
information
Group Information Input
グループの [情報] セクション Web 28.0
UI では、[情報] セクションは [説明]
セクションの上にあります。グ
ループが非公開の場合は、[情報]
セクションはメンバーにのみ表示
されます。[説明] セクションは全
員に表示されます。
isArchived
Boolean
グループがアーカイブ済みの場合 29.0
は true、それ以外の場合は
false。デフォルトは false で
す。
isAutoArchiveDisabled Boolean
グループの自動アーカイブが無効 29.0
の場合は true、それ以外の場合
は false。デフォルトは false
です。
name
String
グループの名前
owner
String
グループ所有者の ID。このプロパ 29.0
ティは、PATCH 要求でのみ使用で
きます。
383
29.0
Chatter REST API リソース
Group Information
名前
型
説明
使用可能な
バージョン
visibility
String
グループの表示種別を指定しま
す。次のいずれかの値になりま
す。
29.0
• PrivateAccess — グループの
メンバーのみが、このグループ
への投稿を参照できます。
• PublicAccess — コミュニ
ティのすべてのユーザが、この
グループへの投稿を参照できま
す。
• Unlisted — 今後の使用のため
に予約されています。
Group Information Input
JSON
{
"text" : "Post questions about the API.",
"title" : "API Questions"
}
プロパティ
名前
型
説明
text
String
グループの [情報] セクション内の 28.0
テキスト。HTML はサポートされて
いません。最大文字数は 4000 文字
(バイト) です。
title
String
グループの [情報] セクションのタ 28.0
イトル。最大文字数は 240 文字 (バ
イト) です。
384
使用可能な
バージョン
Chatter REST API リソース
Group Information
PATCH の要求パラメータ
プロパティ
型
説明
必須項目/
省略可能
使用可能
なバー
ジョン
announcement
String お知らせとして使用するフィード項目の ID。
省略可能
31.0
省略可能
29.0
String グループの [説明] セクション
省略可能
29.0
informationText String グループの [情報] セクション。Web UI では、[情報]
省略可能
28.0
省略可能
28.0
String グループがアーカイブ済みの場合は true、それ以 省略可能
外の場合は false。デフォルトは false です。
29.0
isAutoArchiveDisabled Boolean グループの自動アーカイブが無効の場合は true、 省略可能
29.0
お知らせは、削除されるか、別のお知らせで置き換
えられない限り、その表示期限の 11:59 p.m. まで
Salesforce UI の指定の場所に表示されます。
canHaveChatterGuests Boolean このグループで Chatter 顧客を許可している場合は
true、それ以外の場合は false。このプロパティ
を true に設定した後で、false に設定することは
できません。
description
セクションは [説明] セクションの上にあります。グ
ループが非公開の場合は、[情報] セクションはメン
バーにのみ表示されます。[説明] セクションは全員
に表示されます。
informationTitle String グループの [情報] セクションのタイトル
isArchived
それ以外の場合は false。デフォルトは false で
す。
name
String グループの名前
省略可能
29.0
owner
String グループ所有者の ID。このプロパティは、PATCH 要 省略可能
求でのみ使用できます。
29.0
visibility
String グループの表示種別を指定します。次のいずれかの 省略可能
値になります。
29.0
• PrivateAccess — グループのメンバーのみが、
このグループへの投稿を参照できます。
• PublicAccess — コミュニティのすべてのユー
ザが、このグループへの投稿を参照できます。
• Unlisted — 今後の使用のために予約されてい
ます。
385
Chatter REST API リソース
Batch Group Information
GET および PATCH のレスポンスボディ
Group Detail
PATCH の例
このリクエストボディは、グループの [情報] セクションのテキストとタイトルを更新します。
{
"information" : {
"text" : "Post questions about the API to this group. If you have the answer to
a question, please post it. This is a private R&D group.",
"title" : "API Questions Group"
}
}
次は、同じ例に要求パラメータを使用しています。
https://instance_name/services/data/34.0/chatter/groups/groupId
?informationText=Post+questions+about+the+API+to+this+group.+If+you+have+the+answer+to+a+question%2C%20
+please+post+it.+This+is+a+private+R%26amp%3Bamp%3BD+group.&informationTitle=API+Questions+Group
応答は Group Detail レスポンスボディです。
Batch Group Information
一度に複数のグループに関する情報を返します。
リソース
/chatter/groups/batch/group_list
/connect/communities/communityId/chatter/groups/batch/group_list
group_list は、最大 500 個のグループ ID から成るカンマ区切りのリストです。
適用開始バージョン
23.0
Chatter が必要かどうか
はい
HTTP メソッド
GET または HEAD
レスポンスボディ
Batch Results
386
Chatter REST API リソース
Group Announcements
Group Announcements
指定されたグループに投稿されたお知らせに関する情報。グループへのお知らせの情報取得や投稿を行いま
す。
お知らせは、情報を強調表示するために使用します。ユーザは、グループフィードのお知らせに対するディス
カッション、いいね!、コメントの投稿ができます。他の投稿と同様に、お知らせが投稿されると、グループ
メンバーは選択したグループメール通知頻度に応じてメール通知を受信します。フィード投稿を削除するとお
知らせが削除されます。
特定のお知らせに関する情報の取得、お知らせの表示期限の更新、またはお知らせの削除を行うには、
Announcements リソース (/chatter/announcements/announcementId) を使用します。
リソース
/chatter/groups/groupID/announcements
/connect/communities/communityId/chatter/groups/groupID/announcements
適用開始バージョン
31.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、POST、HEAD
GET の要求パラメータ
パラメータ名
型
説明
page
Integer
項目のページを指定する 31.0
整数。デフォルト値は 0
で、最初のページを返し
ます。
pageSize
Integer
ページあたりの項目数を 31.0
指定します。有効な値は
1 ～ 100 です。サイズを指
定しない場合、デフォル
トは 25 です。
POST のリクエストボディ
ルート XML タグ
<announcement>
JSON の例
{
"body":
{
387
適用開始バージョン
Chatter REST API リソース
Group Announcements
"messageSegments": [
{
"text": "Please install the updates for all iOS devices.",
"type": "Text"
}
]
}
"expirationDate": "2014-02-22T00:00:00.000Z",
}
プロパティ
名前
型
説明
必須項目/省略
可能
使用可能なバー
ジョン
body
Message Body
Input
お知らせのテキスト。
必須項目
31.0
別のお知らせが最初に投稿されて 必須項目
いない限り、この日付の 11:59 p.m.
まで Salesforce UI にお知らせが表示
されます。Salesforce UI では、
expirationDate の時間値は無
視されます。ただし、時間値を使
用して各自の UI で独自の表示ロ
ジックを作成することはできま
す。
31.0
expirationDate Date
POST の要求パラメータ
パラメータ名
型
説明
expirationDate
Date
別のお知らせが最初に投 31.0
稿されていない限り、こ
の日付の 11:59 p.m. まで
Salesforce UI にお知らせが
表示されます。Salesforce
UI では、
expirationDate の時間
値は無視されます。ただ
388
適用開始バージョン
Chatter REST API リソース
Group Files
パラメータ名
型
説明
適用開始バージョン
し、時間値を使用して各
自の UI で独自の表示ロ
ジックを作成することは
できます。
GET のレスポンスボディ
Announcement Page
POST のレスポンスボディ
Announcement
POST の例
次の要求は、グループへのお知らせを投稿します。
POST /chatter/groups/0F9D00000000I1d/announcements
レスポンスボディは次のようになります。
{
"body":
{
"messageSegments": [
{
"text": "Please install the updates for all iOS devices.",
"type": "Text"
}
]
}
"expirationDate": "2014-02-22T00:00:00.000Z",
}
Group Files
指定されたグループに投稿されたファイルに関する情報を返します。
リソース
/chatter/groups/groupID/files
/connect/communities/communityId/chatter/groups/groupID/files
389
Chatter REST API リソース
Group Members
適用開始バージョン
24.0
Chatter が必要かどうか
はい
HTTP メソッド
GET または HEAD
要求パラメータ
パラメータ名
型
説明
適用開始バージョン
page
Integer
項目のページを指定する 24.0
整数。デフォルト値は 0
で、最初のページを返し
ます。
pageSize
Integer
ページあたりの項目数を 24.0
指定します。有効な値は
1 ～ 100 です。サイズを指
定しない場合、デフォル
トは 25 です。
q
String
結果を絞り込むクエリ文 27.0
字列。文字列にはワイル
ドカード文字を除いて 2
文字以上が含まれている
必要があります。ワイル
ドカードについての詳細
は、「ワイルドカード」
を参照してください。
レスポンスボディ
File Summary Page
Group Members
指定されたグループのメンバー。メンバーを取得し、グループにメンバーを追加します。メンバーを追加する
には、コンテキストユーザがグループ所有者またはモデレータである必要があります。
リソース
/chatter/groups/groupId/members
/connect/communities/communityId/chatter/groups/groupId/members
適用開始バージョン
23.0
390
Chatter REST API リソース
Group Members
Chatter が必要かどうか
はい
HTTP メソッド
GET、POST、または HEAD
POST のリクエストボディ
ルート XML タグ
<member>
プロパティ
名前
型
説明
使用可能なバージョン
role
String
メンバーのロール。次の 29.0
いずれかの値にします。
• GroupManager
• StandardMember
String
userId
グループに追加するメン 23.0
バーのユーザ ID。
POST の要求パラメータ
パラメータ名
型
説明
使用可能なバージョン
role
String
メンバーのロール。次のいずれかの値 29.0
にします。
• GroupManager
• StandardMember
userId
String
グループに追加するユーザの ID。
23.0
GET または HEAD の要求パラメータ
パラメータ名
型
説明
page
Integer
項目のページを指定する 23.0
整数。デフォルト値は 0
で、最初のページを返し
ます。
pageSize
Integer
ページあたりの項目数を 23.0
指定します。有効な値は
1 ～ 1000 です。サイズを
391
使用可能なバージョン
Chatter REST API リソース
パラメータ名
Group Members
型
説明
使用可能なバージョン
指定しない場合、デフォ
ルトは 25 です。
GET または HEAD のレスポンスボディ
Group Member Page
POST のレスポンスボディ
グループメンバー
例: グループへのメンバーの追加
この POST 要求は、グループにメンバーを追加します。
/chatter/groups/0F9D00000000I4O/members?userId=005D0000001LLO1
応答は Group Member レスポンスボディです。
{
"id": "0FBD00000003LRxOAM",
"role": "StandardMember",
"url": "/services/data/v34.0/chatter/group-memberships/0FBD00000003LRxOAM",
"user": {
"companyName": "Universal Containers",
"firstName": "Gordon",
"id": "005D0000001LLO1IAO",
"isActive": true,
"isInThisCommunity": true,
"lastName": "Johnson",
"motif": {
"color": "1797C0",
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png"
},
"mySubscription": {
392
Chatter REST API リソース
Group Members—Private
"id": "0E8D0000000T5ZUKA0",
"url": "/services/data/v34.0/chatter/subscriptions/0E8D0000000T5ZUKA0"
},
"name": "Gordon Johnson",
"photo": {
"fullEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cPhKrC7plNhUw5eOz7Aj1u-oFL0K-ff2oe04ZAmT2MqC",
"largePhotoUrl": "https://instance_name/profilephoto/729D00000000LJL/F",
"photoVersionId": "729D00000000LJLIA2",
"smallPhotoUrl": "https://instance_name/profilephoto/729D00000000LJL/T",
"standardEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cPhKrC7plNhUw5eOz7Aj1u-6d5rE2mNaMaBZfGnFX65O",
"url": "/services/data/v34.0/chatter/users/005D0000001LLO1IAO/photo"
},
"title": "VP Sales",
"type": "User",
"url": "/services/data/v34.0/chatter/users/005D0000001LLO1IAO",
"userType": "Internal"
}
}
メモ: グループが非公開の場合、応答は 403 です。グループへの参加を要求するには、Group
Members—Private リソース (/chatter/groups/groupId/members/requests) に POST 要求を送信しま
す。
関連トピック:
グループに参加する
Group Members—Private
非公開グループのメンバーシップを要求するか、非公開グループへの参加要求の状況を取得します。
393
Chatter REST API リソース
Group Members—Private
メモ: 非公開グループのメンバーシップを要求するには、Group Members リソースを使用します。
リソース
/chatter/groups/groupId/members/requests
/connect/communities/communityId/chatter/groups/groupId/members/requests
適用開始バージョン
27.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、HEAD、および POST
GET の要求パラメータ
パラメータ名
型
説明
適用開始バージョン
status
String
省略可能。このパラメー 27.0
タを含めると、指定した
状況と一致するものを含
むように結果が絞り込ま
れます。有効な値は次の
とおりです。
• Accepted
• Declined
• Pending
GET または HEAD のレスポンスボディ
Group Membership Request Collection
POST のレスポンスボディ
Group Membership Request
次の表に、このリソースに固有の HTTP 応答コードの説明を示します。他の HTTP 応答コードの説明は、「状
況コードとエラー応答」を参照してください。
HTTP 応答コード
説明
201
次のいずれかになります。
• 成功
• ユーザは、このグループに対してメンバーシップを要求済みです。
204
ユーザは、すでにこのグループのメンバーです。
394
Chatter REST API リソース
Group Members—Private
HTTP 応答コード
説明
403
次のいずれかになります。
• 非公開のグループ: INSUFFICIENT_ACCESS_OR_READONLY
• 外部ユーザ: INSUFFICIENT_ACCESS
GET の例
次の例は、この非公開グループに対して承認されたすべての参加要求に関する情報を取得します。
/chatter/groups/0F9D00000000izfKAA/members/requests?status=Accepted
JSON Group Membership Request Collection レスポンスボディには、ユーザ Gordon Johnson からの 1 つの要求が含
まれます。
{
"requests": [{
"createdDate": "2012-10-19T00:23:23.000Z",
"id": "0I5D000000002fmKAA",
"lastUpdateDate": "2012-10-19T00:24:06.000Z",
"requestedGroup": {
"id": "0F9D00000000izfKAA",
"url": "/services/data/v34.0/chatter/groups/0F9D00000000izfKAA"
},
"responseMessage": null,
"status": "Accepted",
"url": "/services/data/v34.0/chatter/group-membership-requests/0I5D000000002fmKAA",
"user": {
"companyName": "Universal Containers",
"firstName": "Gordon",
"id": "005D0000001LLO1IAO",
"isActive": true,
"lastName": "Johnson",
"motif": {
395
Chatter REST API リソース
Group Members—Private
"color": "1797C0",
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png"
},
"mySubscription": {
"id": "0E8D0000000T5ZUKA0",
"url": "/services/data/v34.0/chatter/subscriptions/0E8D0000000T5ZUKA0"
},
"name": "Gordon Johnson",
"photo": {
"fullEmailPhotoUrl": "https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cPhK
rC7plNhUw5eOz7Aj1u-zWLMxsSybO7lwUPg5_Xne",
"largePhotoUrl": "https://instance_name/profilephoto/729D00000000LJL/F",
"photoVersionId": "729D00000000LJLIA2",
"smallPhotoUrl": "https://instance_name/profilephoto/729D00000000LJL/T",
"standardEmailPhotoUrl": "https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0
cPhKrC7plNhUw5eOz7Aj1u_2Vnyzx4jZ2zFiKBz_sTt2",
"url": "/services/data/v34.0/chatter/users/005D0000001LLO1IAO/photo"
},
"title": "VP Sales",
"type": "User",
"url": "/services/data/v34.0/chatter/users/005D0000001LLO1IAO",
"userType": "Internal"
}
}],
"total": 1
396
Chatter REST API リソース
Group Members—Private
}
POST の例
次の例は、ID が 0F9D00000000lpK である非公開グループのメンバーシップを要求します。
/chatter/groups/0F9D00000000lpK/members/requests
JSON 形式の Group Membership Request レスポンスボディです。
{
"createdDate": "2013-04-02T23:44:25.000Z",
"id": "0I5D000000002kOKAQ",
"lastUpdateDate": "2013-04-02T23:44:25.000Z",
"requestedGroup": {
"id": "0F9D00000000lpKKAQ",
"url": "/services/data/v34.0/chatter/groups/0F9D00000000lpKKAQ"
},
"responseMessage": null,
"status": "Pending",
"url": "/services/data/v34.0/chatter/group-membership-requests/0I5D000000002kOKAQ",
"user": {
"companyName": "Universal Containers",
"firstName": "Gordon",
"id": "005D0000001LLO1IAO",
"isActive": true,
"isInThisCommunity": true,
"lastName": "Johnson",
"motif": {
"color": "1797C0",
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png"
397
Chatter REST API リソース
Group Membership Requests—Private
},
"mySubscription": null,
"name": "Gordon Johnson",
"photo": {
"fullEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cPhKrC7plNhUw5eOz7Aj1u-oFL0K-ff2oe04ZAmT2MqC",
"largePhotoUrl": "https://instance_name/profilephoto/729D00000000LJL/F",
"photoVersionId": "729D00000000LJLIA2",
"smallPhotoUrl": "https://instance_name/profilephoto/729D00000000LJL/T",
"standardEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cPhKrC7plNhUw5eOz7Aj1u-6d5rE2mNaMaBZfGnFX65O",
"url": "/services/data/v34.0/chatter/users/005D0000001LLO1IAO/photo"
},
"title": "VP Sales",
"type": "User",
"url": "/services/data/v34.0/chatter/users/005D0000001LLO1IAO",
"userType": "Internal"
}
}
関連トピック:
非公開グループへの参加を要求する
Group Membership Requests—Private
非公開グループに参加するユーザによって要求の状況を更新するか、非公開グループへの参加要求に関する情
報を取得します。/chatter/groups/groupId/members/requests への POST 要求の Group Membership Request
応答から、requestId の値を取得します。
398
Chatter REST API リソース
Group Membership Requests—Private
リソース
/chatter/group-membership-requests/requestId
/connect/communities/communityId/chatter/group-membership-requests/requestId
適用開始バージョン
27.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、HEAD、および PATCH
PATCH のリクエストボディ
Group Membership Request Update
PATCH の要求パラメータ
パラメータ名
型
説明
適用開始バージョン
responseMessage
String
このプロパティを使用して、メンバー 27.0
シップ要求が却下された場合にユーザ
に表示するメッセージを指定します。
このプロパティの値は、status プロパ
ティの値が Declined の場合にのみ使
用されます。
最大文字数は 756 文字です。
status
String
有効な値は次のとおりです。
• Accepted
• Declined
PATCH のレスポンスボディ
Group Membership Request
GET または HEAD のレスポンスボディ
Group Membership Request
PATCH の例
次の例は、非公開グループへの参加要求を Pending から Accepted に更新します。
/chatter/group-membership-requests/0I5D000000002fwKAA?status=Accepted
この要求は、Group Membership Request レスポンスボディを返します。
関連トピック:
非公開グループへの参加要求を承認または却下する
399
27.0
Chatter REST API リソース
Group Memberships リソース
Group Memberships リソース
Chatter グループのメンバーシップに関する情報。
次のリソースを使用できます。
リソース
説明
/chatter/group-memberships/membershipId
グループのメンバーに関する情報へのアクセス、グ
ループからのメンバーの削除、およびグループメン
バーのロールの更新に使用されます。
/chatter/group-memberships/batch/membershipIds グループメンバーのリストに関する情報へのアクセス
に使用されます。
Group Memberships Information
グループのメンバーに関する情報へのアクセス、グループからのメンバーの削除、およびグループメンバーの
ロールの更新に使用されます。
メンバーシップ ID は /chatter/groups/groupId/memberships リソースから返されます。
リソース
/chatter/group-memberships/membershipId
/connect/communities/communityId/chatter/group-memberships/membershipId
適用開始バージョン
23.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、DELETE、HEAD、PATCH
PATCH は 29.0 でサポート
PATCH のリクエストボディ
ルート XML タグ
<member>
JSON の例
{
"role" : "GroupManager",
"userId" : "005B0000000Ge16"
}
400
Chatter REST API リソース
Group Memberships リソース
プロパティ
名前
型
説明
使用可能なバージョン
role
String
メンバーのロール。次の 29.0
いずれかの値にします。
• GroupManager
• StandardMember
String
userId
グループに追加するメン 23.0
バーのユーザ ID。
メモ: PATCH 要求でグループメンバーのロールを更新するには、userId プロパティは渡さずに role
プロパティのみを渡します。
PATCH の要求パラメータ
名前
型
説明
使用可能なバージョン
role
String
メンバーのロール。次の 29.0
いずれかの値にします。
• GroupManager
• StandardMember
GET または PATCH のレスポンスボディ
グループメンバー
Batch Group Memberships
グループメンバーのリストに関する情報へのアクセスに使用されます。メンバーは同じグループに属す必要は
ありません。各メンバーシップ ID は、特定のグループに関連付けられています。
メンバーシップ ID は、複数の groups リソースのレスポンスボディで返されます。
次の groups リソースでは、グループ内のすべてのメンバーがその Group Member レスポンスボディにリストされ
ます。すべての Group Member レスポンスボディの id プロパティには、メンバーシップ ID が含まれます。
/chatter/groups/groupId/members
リソース
/chatter/group-memberships/batch/membershipIds
/connect/communities/communityId/chatter/group-memberships/batch/membershipIds
membershipIds は、最大 500 個のメンバーシップ ID から成るカンマ区切りのリストです。
401
Chatter REST API リソース
Group Memberships リソース
適用開始バージョン
27.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、HEAD
GET または HEAD のレスポンスボディ
Batch Results
GET の例
次の要求は、2 人のユーザのグループメンバーシップ情報を取得します。
/chatter/group-memberships/batch/0FBD00000003GAPOA2,0FBD00000003GAKOA
これは、ネストされた User Summary レスポンスボディを含む Batch Results レスポンスボディです。
{
"hasErrors": true,
"results": [
{
"result": {
"id": "0FBD00000003GAPOA2",
"role": "StandardMember",
"url": "/services/data/v34.0/chatter/group-memberships/0FBD00000003GAPOA2",
"user": {
"companyName": "Universal Containers",
"firstName": "Gordon",
"id": "005D0000001LLO1IAO",
"isActive": true,
"isInThisCommunity": true,
"lastName": "Johnson",
"motif": {
"color": "1797C0",
"largeIconUrl": "/img/icon/profile64.png",
402
Chatter REST API リソース
Group Memberships リソース
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png"
},
"mySubscription": {
"id": "0E8D0000000T5ZUKA0",
"url": "/services/data/v34.0/chatter/subscriptions/0E8D0000000T5ZUKA0"
},
"name": "Gordon Johnson",
"photo": {
"fullEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cPhKrC7plNhUw5eOz7Aj1u-oFL0K-ff2oe04ZAmT2MqC",
"largePhotoUrl": "https:/instance_name/profilephoto/729D00000000LJL/F",
"photoVersionId": "729D00000000LJLIA2",
"smallPhotoUrl":
"https://instance_name/profilephoto/729D00000000LJL/T",
"standardEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cPhKrC7plNhUw5eOz7Aj1u-6d5rE2mNaMaBZfGnFX65O",
"url": "/services/data/v34.0/chatter/users/005D0000001LLO1IAO/photo"
},
"title": "VP Sales",
"type": "User",
"url": "/services/data/v34.0/chatter/users/005D0000001LLO1IAO",
"userType": "Internal"
}
},
"statusCode": 200
403
Chatter REST API リソース
Group Photo
},
{
"result": [{
"errorCode": "NOT_FOUND",
"message": "The requested resource does not exist"
}],
"statusCode": 404
}
]
}
2 つ目のグループメンバーシップが見つかっていません。バッチ要求は、サブ要求ごとの状況コードを返し
ます。
Group Photo
指定されたグループの写真。写真を取得、投稿、トリミング、削除します。
[ファイル] ページからの画像をグループの写真 (既存のコンテンツ) として使用するには、リクエストボディの
fileId プロパティまたは fileId 要求パラメータでファイル ID を渡します。[グループ] ページでアップロー
ドした画像にはファイル ID は含まれず、fileId としては使用できません。
バイナリファイルをグループの写真としてアップロードするには、マルチパート/フォームデータメッセージ
でそのファイルを送信する必要があります。マルチパート/フォームデータメッセージを作成する方法につい
ての詳細は、「バイナリファイルのアップロード」を参照してください。
リソース
/chatter/groups/groupId/photo
/connect/communities/communityId/chatter/groups/groupId/photo
適用開始バージョン
23.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、POST、DELETE、または HEAD
POST のリクエストボディ
ルート XML タグ
<photo>
404
Chatter REST API リソース
Group Photo
JSON の例
{
"cropSize" : "120",
"cropX" : "0",
"cropY" : "0",
"fileId" : "069D00000001IOh"
}
プロパティ
名前
型
説明
必須項目/省略可能
使用可能な
バージョン
cropSize
Integer
トリミングする正方形の任意 アップロードされたファイ 29.0
の境界の長さ (ピクセル単
ルまたは既存のファイルを
位)。
トリミングする必要があり
ます。
cropX
Integer
画像の左端を起点とした、ト
リミングする正方形の開始位
置 X (ピクセル単位)。左上の位
置は (0,0) です。
アップロードされたファイ 29.0
ルまたは既存のファイルを
トリミングする必要があり
ます。
cropY
Integer
画像の上端を起点とした、ト
リミングする正方形の開始位
置 Y (ピクセル単位)。左上の位
置は (0,0) です。
アップロードされたファイ 29.0
ルまたは既存のファイルを
トリミングする必要があり
ます。
fileId
String
既存のファイルの 18 文字の 既存のファイルを選択する 25.0
ID。キープレフィックスは
必要があります。
069、ファイルサイズは 2 MB
未満にする必要があります。
メモ: グループページお
よびユーザページにアッ
プロードされた画像には
ファイル ID がないた
め、使用できません。
versionNumber
Integer
既存のファイルのバージョン 省略可能
番号。指定されていない場
合、最新のバージョンが使用
されます。
405
25.0
Chatter REST API リソース
Group Photo
POST の要求パラメータ
パラメータ名
型
説明
必須項目/省略可能
cropSize
Integer
トリミングする正方 アップロードされた 29.0
形の任意の境界の長 ファイルまたは既存
さ (ピクセル単位)。 のファイルをトリミ
ングする必要があり
ます。
cropX
Integer
画像の左端を起点と
した、トリミングす
る正方形の開始位置
X (ピクセル単位)。
左上の位置は (0,0) で
す。
アップロードされた 29.0
ファイルまたは既存
のファイルをトリミ
ングする必要があり
ます。
cropY
Integer
画像の上端を起点と
した、トリミングす
る正方形の開始位置
Y (ピクセル単位)。
左上の位置は (0,0) で
す。
アップロードされた 29.0
ファイルまたは既存
のファイルをトリミ
ングする必要があり
ます。
fileId
String
既存のファイルの 18 既存のファイルを選 25.0
文字の ID。キープレ 択する必要がありま
フィックスは 069、 す。
ファイルサイズは 2
MB 未満にする必要
があります。
メモ: [グルー
プ] ページおよ
び [ユーザプロ
ファイル] ペー
ジでアップ
ロードした
ファイルには
ファイル ID は
含まれず、投
稿やトリミン
グはできませ
ん。[ファイ
ル] ページで
アップロード
したファイル
406
使用可能なバージョ
ン
Chatter REST API リソース
パラメータ名
Group Records
型
説明
必須項目/省略可能
使用可能なバージョ
ン
にはファイル
ID は含まれ
ず、投稿やト
リミングはで
きません。
versionNumber
Integer
既存のコンテンツの 省略可能
バージョン番号。指
定されていない場
合、最新のバージョ
ンが使用されます。
25.0
メモ: 写真は非同期に処理され、すぐには表示されない場合があります。
GET または HEAD のレスポンスボディ
Photo
POST のレスポンスボディ
Photo
関連トピック:
グループの写真を更新およびトリミングする
Group Records
指定されたグループに関連付けられたレコードのリストを返します。レコードをグループに関連付けるために
も使用されます。
リソース
/chatter/groups/groupID/records
/connect/communities/communityId/chatter/groups/groupID/records
適用開始バージョン
33.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、HEAD、POST
407
Chatter REST API リソース
Group Record
GET の要求パラメータ
パラメータ名
型
説明
適用開始バージョン
page
Integer
項目のページを指定する整数。デフォル 33.0
ト値は 0 で、最初のページを返します。
pageSize
Integer
ページあたりの項目数を指定します。有 33.0
効な値は 1 ～ 100 です。サイズを指定し
ない場合、デフォルトは 25 です。
POST のリクエストボディ
ルート XML タグ
<groupRecord>
JSON の例
{"recordId" : "001D000000Io9cD"}
プロパティ
名前
型
説明
必須項目/省略
可能
使用可能なバー
ジョン
recordId
String
レコードの ID。
必須項目
34.0
POST の要求パラメータ
パラメータ名
型
説明
適用開始バージョン
recordId
String
レコードの ID。
34.0
GET のレスポンスボディ
Group Record Page
POST のレスポンスボディ
Group Record
Group Record
グループレコードに関する情報の取得、またはレコードとグループ間の関連付けの削除を行います。
408
Chatter REST API リソース
Group Settings
リソース
/chatter/group-records/groupRecordId
/connect/communities/communityId/chatter/group-records/groupRecordId
使用可能なバージョン
34.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、DELETE、HEAD
GET のレスポンスボディ
Group Record
DELETE のレスポンスボディ
204: DELETE が成功しました
Group Settings
指定されたグループのコンテキストユーザの Chatter 設定に関する情報です。
リソース
/chatter/groups/groupId/my-settings
/connect/communities/communityId/chatter/groups/groupId/my-settings
適用開始バージョン
27.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、HEAD、または PATCH
PATCH のリクエストボディ
ルート XML タグ
<groupChatterSettings>
プロパティ
ユーザの Chatter 設定。
409
Chatter REST API リソース
Group Topics
名前
型
説明
使用可能な
バージョン
emailFrequency
String
グループメンバーがグループから 27.0
メールを受信する頻度。有効な値
は、次のとおりです。
• EachPost
• DailyDigest
• WeeklyDigest
• Never
コミュニティでは、グループメン
バーが 10,000 人を超えると [各投稿
のメール] オプションが無効になり
ます。このオプションを選択した
すべてのメンバーは、自動的に [毎
日のダイジェスト] に切り替わりま
す。
PATCH の要求パラメータ
パラメータ名
型
説明
emailFrequency
String
27.0
グループメンバーがグ
ループからメールを受信
する頻度。有効な値は、
次のとおりです。
• EachPost
• DailyDigest
• WeeklyDigest
• Never
GET、HEAD、または PATCH のレスポンスボディ
Group Chatter Settings
Group Topics
指定されたグループで最近使用されたトピックを最大 5 個返します。
リソース
/chatter/groups/groupID/topics
/connect/communities/communityId/chatter/groups/groupID/topics
410
適用開始バージョン
Chatter REST API リソース
Influence リソース
適用開始バージョン
28.0
Chatter が必要かどうか
はい
HTTP メソッド
GET または HEAD
レスポンスボディ
Topic Collection
Influence リソース
組織のユーザを Chatter での影響度によって分類するために使用するパーセントしきい値のリスト。
ユーザは、自分が行った投稿とコメントの数、および受け取ったコメントといいね! の数に基づいてランク付
けされます。カテゴリに関連付けられたパーセントは、そのインフルエンサーカテゴリの下限しきい値を表し
ます。たとえば、0.25 は、Active Influencer カテゴリの下限値です。つまり、影響度ランクが 25% 以上
で次に高いカテゴリしきい値未満のユーザがこのカテゴリに含まれます。
Influence Thresholds
リソース
/chatter/influence/thresholds
/connect/communities/communityId/chatter/influence/thresholds
適用開始バージョン
24.0
Chatter が必要かどうか
はい
HTTP メソッド
GET または HEAD
レスポンスボディ
Influence Thresholds
レスポンスボディの例
{"thresholds": [
{
"name": "Top Influencer",
"threshold": "0.8",
}
411
Chatter REST API リソース
Likes リソース
{
"name": "Active Influencer",
"threshold": "0.25",
}
{
"name": "Observer",
"threshold": "0.0",
}
]}
Likes リソース
指定されたいいね! に関する情報。いいね! の削除にも使用されます。
ニュースフィードやレコードフィードなど、任意のフィードから特定のいいね! の ID を検索できます。
Like
リソース
/chatter/likes/likeId
/connect/communities/communityId/chatter/likes/likeId
適用開始バージョン
23.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、DELETE、または HEAD
GET または HEAD のレスポンスボディ
Like
Managed Topics リソース
コミュニティの管理トピック。管理トピックのリストを取得します。コミュニティの管理トピックの作成、削
除、または並び替えを行います。
使用可能なリソース:
412
Chatter REST API リソース
Managed Topics
リソース
説明
/connect/communities/communityId/
managed-topics
コミュニティのすべての管理トピックを取得します。
管理トピックを作成します。管理トピックを並び替え
ます。
/connect/communities/communityId/
managed-topics/managedTopicId
コミュニティの管理トピックの情報取得または削除を
行います。
Managed Topics
コミュニティのすべての管理トピックを取得します。管理トピックを作成します。管理トピックを並び替えま
す。
コミュニティマネージャ (「コミュニティの作成および設定」または「コミュニティの管理」権限を持つユー
ザ) のみが、管理トピックの作成または並び替えを行うことができます。
リソース
/connect/communities/communityId/managed-topics
使用可能なバージョン
32.0
Chatter が必要かどうか
いいえ
HTTP メソッド
GET、POST、PATCH、HEAD
GET の要求パラメータ
パラメータ名
型
説明
必須項目/省略可 使用可能なバー
能
ジョン
managedTopic
Type
String
管理トピックの種別。
省略可能
• Featured — コミュニティホー
ムページなどの主要トピック。
ただし、全体的なナビゲーショ
ンは提供しません。
• Navigational — コミュニ
ティのナビゲーションメニュー
に表示されるトピック。
1 つのトピックは最大 2 つの種別の
管理トピックに関連付けることが
できるため、1 つのトピックを
Featured トピックと
Navigational トピックの両方に
することができます。
413
32.0
Chatter REST API リソース
Managed Topics
GET のレスポンスボディ
Managed Topic Collection
POST のリクエストボディ
ルート XML タグ
<managedTopic>
JSON の例
{
"managedTopicType" :"Featured",
"recordId" :"0TOD00000000cwk"
}
プロパティ
名前
型
managedTopic String
Type
説明
必須項目/省略
可能
使用可能なバー
ジョン
管理トピックの種別。
必須項目
32.0
• Featured — コミュニティ
ホームページなどの主要ト
ピック。ただし、全体的なナ
ビゲーションは提供しませ
ん。
• Navigational — コミュニ
ティのナビゲーションメ
ニューに表示されるトピッ
ク。
1 つのトピックは最大 2 つの種別
の管理トピックに関連付けること
ができるため、1 つのトピックを
Featured トピックと
Navigational トピックの両方
にすることができます。
managedTopicType につき、最
大 25 個の管理トピックを作成で
きます。
name
String
管理トピックの名前。
新規トピックで 32.0
は必須
name または
recordId を指
定する必要があ
414
Chatter REST API リソース
Managed Topics
名前
型
説明
必須項目/省略
可能
使用可能なバー
ジョン
ります。両方を
指定することは
できません。
String
recordId
管理トピックになるレコードの
ID。
Name プロパ
32.0
ティが使用され
バージョン 32.0 では、recordId ていない場合、
はトピック ID である必要があり 既存のトピック
に必要です。
ます。
name または
recordId を指
定する必要があ
ります。両方を
指定することは
できません。
POST の要求パラメータ
パラメータ名
型
説明
必須項目/省略可 使用可能なバー
能
ジョン
managedTopic
Type
String
管理トピックの種別。
必須項目
• Featured — コミュニティホー
ムページなどの主要トピック。
ただし、全体的なナビゲーショ
ンは提供しません。
• Navigational — コミュニ
ティのナビゲーションメニュー
に表示されるトピック。
1 つのトピックは最大 2 つの種別の
管理トピックに関連付けることが
できるため、1 つのトピックを
Featured トピックと
Navigational トピックの両方に
することができます。
managedTopicType につき、最大
25 個の管理トピックを作成できま
す。
415
32.0
Chatter REST API リソース
Managed Topics
パラメータ名
型
説明
必須項目/省略可 使用可能なバー
能
ジョン
name
String
管理トピックの名前。
新規トピックで 32.0
は必須
name または
recordId を指
定する必要があ
ります。両方を
指定することは
できません。
recordId
String
管理トピックになるレコードの
ID。
Name プロパ
ティが使用され
バージョン 32.0 では、recordId ていない場合は
はトピック ID である必要がありま 必須
す。
name または
recordId を指
定する必要があ
ります。両方を
指定することは
できません。
POST のレスポンスボディ
Managed Topic
PATCH のリクエストボディ
ルート XML タグ
<managedTopicPositionCollection>
JSON の例
{
"managedTopicPositions" : [
{
"managedTopicId" :"0mtD0000000001aIAA",
"position" :"0"
},
{
"managedTopicId" :"0mtD0000000002qIAA",
416
32.0
Chatter REST API リソース
Managed Topics
"position" :"2"
}
]
}
プロパティ
名前
型
managedTopic Managed Topic
Position Input[]
Positions
説明
必須項目/省略
可能
Managed Topic Position リクエストボ 必須項目
ディのコレクション。このコレク
ションには、Featured および
Navigational 管理トピックを
含めることができます。また、す
べての管理トピックを含める必要
はありません。
managedTopicPositions にす
べての管理トピックを含めない場
合、管理トピックは
managedTopicPositions で指
示された位置に従って並び替えら
れ、managedTopicPositions
に含まれない管理トピックは次に
空いている位置まで順序を下げら
れます。「管理トピックの並び替
えの例」を参照してください。
管理トピックの並び替えの例
次の管理トピックがあるとします。
管理トピック
位置
ManagedTopicA
0
ManagedTopicB
1
ManagedTopicC
2
ManagedTopicD
3
ManagedTopicE
4
Managed Topic Position Collection Input に次の情報を含めて管理トピックを並び替えます。
417
使用可能なバー
ジョン
32.0
Chatter REST API リソース
Managed Topic
管理トピック
位置
ManagedTopicD
0
ManagedTopicE
2
結果は次のとおりです。
管理トピック
位置
ManagedTopicD
0
ManagedTopicA
1
ManagedTopicE
2
ManagedTopicB
3
ManagedTopicC
4
PATCH のレスポンスボディ
Managed Topic Collection
Managed Topic
コミュニティの管理トピックの情報取得または削除を行います。
コミュニティマネージャ (「コミュニティの作成および設定」または「コミュニティの管理」権限を持つユー
ザ) のみが、管理トピックを削除できます。
リソース
/connect/communities/communityId/managed-topics/managedTopicId
使用可能なバージョン
32.0
Chatter が必要かどうか
いいえ
HTTP メソッド
GET、DELETE、HEAD
GET のレスポンスボディ
Managed Topic
DELETE のレスポンスボディ
204: DELETE が成功しました
418
Chatter REST API リソース
Mentions リソース
Mentions リソース
フィード項目またはコメントの本文でメンション可能なユーザおよびグループに関する情報。ユーザまたはグ
ループは、メンションされると通知を受け取ります。
メンション提案のリストを取得するには、Mentions Completions リソースを使用します。コンテキストユーザに
対して有効な提案を判定するには、Mentions Validations リソースを使用します。
このセクションの内容:
Mentions Completions
フィード項目またはコメントの本文でメンションするユーザおよびグループに関する情報。ユーザが選択
できる提案メンションのリストを生成するには、このリソースを使用します。メンションは、ユーザ名ま
たはグループ名の前にある「@」文字で示されます。ユーザまたはグループは、メンションされると通知
を受け取ります。
Mentions Validations
指定されたメンションがコンテキストユーザに対して有効であるかどうかを示す情報。たとえば、コンテ
キストユーザは自分が属していない非公開グループにメンションできません。そのようなグループがメン
ションの検証のリストに含まれていると、Mention Validations レスポンスボディの hasErrors プロパティは
true になり、そのメンションの検証で Disallowed の validationStatus がグループに設定されます。
Mentions Completions
フィード項目またはコメントの本文でメンションするユーザおよびグループに関する情報。ユーザが選択でき
る提案メンションのリストを生成するには、このリソースを使用します。メンションは、ユーザ名またはグ
ループ名の前にある「@」文字で示されます。ユーザまたはグループは、メンションされると通知を受け取り
ます。
リソース
/chatter/mentions/completions
/connect/communities/communityId/chatter/mentions/completions
適用開始バージョン
29.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、HEAD
419
Chatter REST API リソース
Mentions Completions
GET の要求パラメータ
パラメータ名
型
説明
必須項目/省略可能
適用開始
バージョ
ン
contextId
String
検索結果を絞り込むフィード項目 ID (コ 省略可能
メント内のメンションの場合) または
フィード件名 ID (フィード項目内のメン
ションの場合) であり、最も的確な結果
が最初に表示されます。
29.0
page
Integer
返すページの数。番号付けは 0 から開始 省略可能
します。0 を渡すか、このプロパティを
省略すると、最初のページが返されま
す。
29.0
結果が 500 件を超えるページを試行する
と、空の応答が返されます。
pageSize
Integer
ページあたりの項目数。有効な値は 1 ～ 省略可能
100 です。デフォルトサイズは 25 です。
29.0
500 件を超える結果を取得しようとする
と、空の応答が返されます。
q
String
検索語。一致するユーザおよびグループ 必須項目
の名前を検索します。ユーザを検索する
場合、1 文字以上を指定する必要があり
ます。グループを検索する場合、2 文字
以上を指定する必要があります。このパ
ラメータではワイルドカードは使用でき
ません。
29.0
type
String
メンションの補完の種類。次のいずれか 省略可能
の値にします。
29.0
• All — メンションで参照するレコー
ドタイプに無関係の、すべてのメン
ションの補完。
• Group — グループのメンションの補
完。
• User — ユーザのメンションの補完。
デフォルト値は、All です。
GET のレスポンスボディ
Mention Completion Page
420
Chatter REST API リソース
Mentions Completions
GET の例
この例では、contextId パラメータでフィード項目 ID を指定し、フィード項目のコメントのメンションの
補完を要求します。
GET /chatter/mentions/completions?contextId=0D5D0000000Hwky&q=g
これは、レスポンスボディです。
{
"currentPageUrl":
"/services/data/v34.0/chatter/mentions/completions?contextId=0D5D0000000Hwky&q=g",
"mentionCompletions": [
{
"additionalLabel": null,
"description": "VP Sales",
"name": "Gordon Johnson",
"photoUrl": "https://instance_name/profilephoto/729D00000000LJL/T",
"recordId": "005D0000001LLO1IAO"
},
{
"additionalLabel": null,
"description": "A place for constructive cr...",
"name": "Airing of Grievances",
"photoUrl": "https://instance_name/profilephoto/0F9/T",
"recordId": "0F9D00000000izfKAA"
}
],
"nextPageUrl": null,
"previousPageUrl": null
}
関連トピック:
@メンション提案のリストを取得する
421
Chatter REST API リソース
Mentions Validations
Mentions Validations
指定されたメンションがコンテキストユーザに対して有効であるかどうかを示す情報。たとえば、コンテキス
トユーザは自分が属していない非公開グループにメンションできません。そのようなグループがメンションの
検証のリストに含まれていると、Mention Validations レスポンスボディの hasErrors プロパティは true にな
り、そのメンションの検証で Disallowed の validationStatus がグループに設定されます。
リソース
/chatter/mentions/validations
/connect/communities/communityId/chatter/mentions/validations
適用開始バージョン
29.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、HEAD
GET の要求パラメータ
パラメータ名
型
説明
必須項目/省略可能
parentId
String
フィード項目の親 ID (新しいフィード項 必須項目
目の場合) またはフィード項目 ID (コメン
トの場合)。
29.0
recordIds
String[]
メンションする ID のカンマ区切りのリ
スト。最大値は、25 です。
必須項目
29.0
visibility
String
フィード項目を表示できるユーザの種別 必須項目
を指定します。
29.0
• AllUsers — 表示は内部ユーザに限
定されません。
• InternalUsers — 表示は内部ユー
ザに限定されます。
GET のレスポンスボディ
Mention Validation
422
適用開始
バージョ
ン
Chatter REST API リソース
Motifs リソース
使用方法
まず、Mentions Completionsを要求し、提案メンションのリストを取得します。これらの提案メンションを Mentions
Validations リソースに渡し、メンションがコンテキストユーザに対して有効であるかどうかを判定します。
関連トピック:
@メンション提案のリストを取得する
Motifs リソース
小、中、大の一連の motif アイコンの URL を返します。レコードの一連の motif アイコンは、レコードタイプに
よって異なります。motif にはレコードタイプのベース色を含めることもできます。
次のリソースを使用できます。
リソース
説明
/connect/motifs/idOrPrefix
指定したレコードの小、中、大の一連の motif アイコ
ンを返します。指定されたレコードのベース色を返す
こともできます。
/connect/motifs/batch/idOrPrefixList
指定した複数のレコードの小、中、大の一連の motif
アイコンを返します。指定された各レコードのベース
色を含めることもできます。
Motifs リソース
指定したレコードの小、中、大の一連の motif アイコンを返します。指定されたレコードのベース色を返すこ
ともできます。
idOrPrefix の ID またはキープレフィックスのいずれかを指定します。
リソース
/connect/motifs/idOrPrefix
/connect/communities/communityId/motifs/idOrPrefix
適用開始バージョン
27.0
Chatter が必要かどうか
いいえ
HTTP メソッド
GET または HEAD
レスポンスボディ
Motif
423
Chatter REST API リソース
Motifs リソース
GET の例
ユーザの motifs の要求: /connect/motifs/005D0000001LLO1
応答:
{
"color": "1797C0",
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png"
}
Batch Motifs リソース
指定した複数のレコードの小、中、大の一連の motif アイコンを返します。指定された各レコードのベース色
を含めることもできます。
idOrPrefixList の ID とキープレフィックスのカンマ区切りのリストを指定します。ID とキープレフィック
スは、同じ要求に混在できます。
リソース
/connect/motifs/batch/idOrPrefixList
/connect/communities/communityId/motifs/batch/idOrPrefixList
適用開始バージョン
27.0
Chatter が必要かどうか
いいえ
HTTP メソッド
GET または HEAD
レスポンスボディ
Batch Results
GET の例
ユーザおよびファイルの motifs の要求: /connect/motifs/batch/005D0000001LLO1,069D00000001FHF
応答:
{"results": [
{
"result": {
"color": "1797C0",
424
Chatter REST API リソース
Push Notifications リソース
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png"
},
"statusCode": 200
},
{
"result": {
"color": "993333",
"largeIconUrl": "/img/content/content64.png",
"mediumIconUrl": "/img/content/content32.png",
"smallIconUrl": "/img/icon/files16.png"
},
"statusCode": 200
}
]}
Push Notifications リソース
モバイル転送通知をユーザのデバイスの接続アプリケーションに送信します。受信者の接続アプリケーション
と同じ組織で開発された、または同じパッケージにインストールされた接続アプリケーションでセッションが
確立されている場合にのみこのリソースにアクセスできます。
リソース
/connect/notifications/push
使用可能なバージョン
31.0
Chatter が必要かどうか
いいえ
HTTP メソッド
POST
425
Chatter REST API リソース
Push Notifications リソース
POST のリクエストボディ
ルート XML タグ
<pushNotification>
JSON の例
{
"appName" : "TestApp",
"namespace" : "abc",
"userIds" : ["005x00000013dPK", "005x00000013dPL"],
"payload" : "{'aps':{'alert':'test', 'badge':0, 'sound':'default'}}"
}
プロパティ
名前
型
説明
必須項目/省略
可能
使用可能なバー
ジョン
appName
String
転送通知の送信先の接続アプリ
ケーションの API 名。
必須項目
31.0
namespace
String
転送通知の送信先の接続アプリ
ケーションの名前空間。
必須項目 (名前 31.0
空間が設定され
ている場合)
payload
String
JSON 形式の転送通知ペイロード。 必須項目
31.0
userIds
String []
転送通知受信者のユーザ ID。
31.0
必須項目
POST の要求パラメータ
パラメータ名
型
説明
必須項目/省略可 使用可能なバー
能
ジョン
appName
String
転送通知の送信先の接続アプリ
ケーションの API 名。
必須項目
namespace
String
転送通知の送信先の接続アプリ
ケーションの名前空間。
必須項目 (名前空 31.0
間が設定されて
いる場合)
payload
String
JSON 形式の転送通知ペイロード。 必須項目
31.0
userIds
String []
転送通知受信者のユーザ ID。
31.0
426
必須項目
31.0
Chatter REST API リソース
Question and Answers Suggestions リソース
Question and Answers Suggestions リソース
質問および回答の提案を取得します。
リソース
/connect/question-and-answers/suggestions
/connect/communities/communityId/question-and-answers/suggestions
使用可能なバージョン
32.0
Chatter が必要かどうか
いいえ
HTTP メソッド
GET
GET の要求パラメータ
パラメータ名
型
includeArticles Boolean
説明
必須項目/省略可 使用可能なバー
能
ジョン
検索結果にナレッジ記事を含める 省略可能
場合は、true を指定します。質
問のみを返す場合は、false を指
定します。
32.0
maxResults
Integer
項目種別ごとに返す結果の最大
数。有効な値は 1 ～ 10 です。デ
フォルト値は 5 です。
省略可能
32.0
q
String
検索する文字列を指定します。検 必須項目
索文字列にはワイルドカード文字
を除いて 2 文字以上が含まれてい
る必要があります。「ワイルド
カード」を参照してください。最
大文字数は 255 文字です。
32.0
subjectId
String
そのオブジェクトに関する質問の 省略可能
みを検索するには、件名 ID を指定
します。ID がトピックまたはユー
ザの場合、ID は無視されます。
32.0
GET のレスポンスボディ
Question and Answers Suggestion Collection
427
Chatter REST API リソース
おすすめ定義リソース
おすすめ定義リソース
おすすめ定義を使用すると、コミュニティに表示されるカスタムおすすめを作成して、ユーザに動画の閲覧や
トレーニングの受講などを促すことができます。これらのリソースは、おすすめ定義の情報取得、作成、変
更、削除に使用します。また、おすすめ定義の写真の情報取得、アップロード、変更、および削除にも使用し
ます。
コミュニティマネージャ (「コミュニティの作成および設定」または「コミュニティの管理」権限を持つユー
ザ) および「すべてのデータの編集」権限を持つユーザのみが、おすすめ定義とスケジュール済みおすすめの
アクセス、作成、および削除を行うことができます。これらのおすすめは、Salesforce1 モバイルブラウザアプ
リケーションのコミュニティのフィードに直接表示されます。また、Summer '15 以降のバージョンの Napili テン
プレートを使用すると、コミュニティのホームページの右側にもデフォルトで表示されます。
使用可能なリソース:
リソース
説明
/connect/recommendation-definitions
おすすめ定義のリストの取得、おすすめ定義の作成を
行います。
/connect/recommendation-definitions/
recommendationDefinitionId
おすすめ定義に関する情報の取得、おすすめ定義の変
更または削除を行います。
/connect/recommendation-definitions/
recommendationDefinitionId/photo
おすすめ定義の写真に情報取得、アップロード、変更
または削除を行います。
Recommendation Definitions
おすすめ定義のリストの取得、おすすめ定義の作成を行います。
コミュニティマネージャ (「コミュニティの作成および設定」または「コミュニティの管理」権限を持つユー
ザ) および「すべてのデータの編集」権限を持つユーザのみが、おすすめ定義とスケジュール済みおすすめの
アクセス、作成、および削除を行うことができます。これらのおすすめは、Salesforce1 モバイルブラウザアプ
リケーションのコミュニティのフィードに直接表示されます。また、Summer '15 以降のバージョンの Napili テン
プレートを使用すると、コミュニティのホームページの右側にもデフォルトで表示されます。
リソース
/connect/recommendation-definitions
/connect/communities/communityId/recommendation-definitions
使用可能なバージョン
33.0
Chatter が必要かどうか
いいえ
HTTP メソッド
GET、HEAD、POST
428
Chatter REST API リソース
Recommendation Definitions
POST のリクエストボディ
JSON の例
{
"actionUrl" : "https://www.example.com",
"actionUrlName" : "Launch",
"explanation" : "Click this link to learn more!",
"name" : "Corporate Training Project",
"title" : "Want to learn more about Corporate Training Project?"}
プロパティ
名前
型
説明
actionUrl
String
おすすめに基づいて行動するため 必須項目
の URL （グループに参加するため
の URL など）。
33.0
ユーザインターフェースのアク
ション URL のテキストラベル
("Launch" など)。
必須項目
34.0
actionUrlName String
必須項目/省略
可能
使用可能なバー
ジョン
explanation
String
おすすめの説明 (本文)。
必須項目
33.0
name
String
おすすめ定義の名前。この名前が 必須項目
[設定] に表示されます。
33.0
title
String
おすすめ定義のタイトル。
33.0
省略可能
POST の要求パラメータ
パラメータ名
型
説明
actionUrl
String
おすすめに基づいて行動するため 必須項目
の URL （グループに参加するため
の URL など）。
33.0
ユーザインターフェースのアク
ション URL のテキストラベル
("Launch" など)。
必須項目
34.0
おすすめの説明 (本文)。
必須項目
33.0
actionUrlName String
explanation
String
必須項目/省略可 使用可能なバー
能
ジョン
429
Chatter REST API リソース
Recommendation Definition
パラメータ名
型
説明
必須項目/省略可 使用可能なバー
能
ジョン
name
String
おすすめ定義の名前。この名前が 必須項目
[設定] に表示されます。
33.0
title
String
おすすめ定義のタイトル。
33.0
省略可能
POST のレスポンスボディ
Recommendation Definition
GET のレスポンスボディ
Recommendation Definition Collection
Recommendation Definition
おすすめ定義に関する情報の取得、おすすめ定義の変更または削除を行います。
コミュニティマネージャ (「コミュニティの作成および設定」または「コミュニティの管理」権限を持つユー
ザ) および「すべてのデータの編集」権限を持つユーザのみが、おすすめ定義とスケジュール済みおすすめの
アクセス、作成、および削除を行うことができます。これらのおすすめは、Salesforce1 モバイルブラウザアプ
リケーションのコミュニティのフィードに直接表示されます。また、Summer '15 以降のバージョンの Napili テン
プレートを使用すると、コミュニティのホームページの右側にもデフォルトで表示されます。
リソース
/connect/recommendation-definitions/recommendationDefinitionId
/connect/communities/communityId/recommendation-definitions/recommendationDefinitionId
使用可能なバージョン
33.0
Chatter が必要かどうか
いいえ
HTTP メソッド
GET、HEAD、PATCH、DELETE
PATCH のリクエストボディ
JSON の例
{
"actionUrl" : "https://www.example.com",
"actionUrlName" : "Launch",
"explanation" : "Click this link to learn more!",
"name" : "Corporate Training Project",
430
Chatter REST API リソース
Recommendation Definition
"title" : "Want to learn more about Corporate Training Project?"}
プロパティ
名前
型
説明
actionUrl
String
おすすめに基づいて行動するため 省略可能
の URL （グループに参加するため
の URL など）。
33.0
ユーザインターフェースのアク
ション URL のテキストラベル
("Launch" など)。
省略可能
34.0
actionUrlName String
必須項目/省略
可能
使用可能なバー
ジョン
explanation
String
おすすめの説明 (本文)。
省略可能
33.0
name
String
おすすめ定義の名前。この名前が 省略可能
[設定] に表示されます。
33.0
title
String
おすすめ定義のタイトル。
33.0
省略可能
PATCH の要求パラメータ
パラメータ名
型
説明
actionUrl
String
おすすめに基づいて行動するため 省略可能
の URL （グループに参加するため
の URL など）。
33.0
ユーザインターフェースのアク
ション URL のテキストラベル
("Launch" など)。
省略可能
34.0
actionUrlName String
必須項目/省略可 使用可能なバー
能
ジョン
explanation
String
おすすめの説明 (本文)。
省略可能
33.0
name
String
おすすめ定義の名前。この名前が 省略可能
[設定] に表示されます。
33.0
title
String
おすすめ定義のタイトル。
33.0
GET および PATCH のレスポンスボディ
Recommendation Definition
DELETE のレスポンスボディ
204: DELETE が成功しました
431
省略可能
Chatter REST API リソース
Recommendation Definition Photo
Recommendation Definition Photo
おすすめ定義の写真に情報取得、アップロード、変更または削除を行います。
コミュニティマネージャ (「コミュニティの作成および設定」または「コミュニティの管理」権限を持つユー
ザ) および「すべてのデータの編集」権限を持つユーザのみが、おすすめ定義とスケジュール済みおすすめの
アクセス、作成、および削除を行うことができます。これらのおすすめは、Salesforce1 モバイルブラウザアプ
リケーションのコミュニティのフィードに直接表示されます。また、Summer '15 以降のバージョンの Napili テン
プレートを使用すると、コミュニティのホームページの右側にもデフォルトで表示されます。
[ファイル] ページからの画像をおすすめ定義の写真 (既存のコンテンツ) として使用するには、リクエストボ
ディの fileId プロパティまたは fileId 要求パラメータでファイル ID を渡します。
バイナリファイルをおすすめ定義の写真としてアップロードするには、マルチパート/フォームデータメッセー
ジでそのファイルを送信する必要があります。マルチパート/フォームデータメッセージを作成する方法につ
いての詳細は、「バイナリファイルのアップロード」を参照してください。
リソース
/connect/recommendation-definitions/recommendationDefinitionId/photo
使用可能なバージョン
33.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、HEAD、PUT、DELETE
PUT のリクエストボディ
ルート XML タグ
<photo>
JSON の例
{
"cropSize" : "120",
"cropX" : "0",
"cropY" : "0",
"fileId" : "069D00000001IOh"
}
プロパティ
名前
型
説明
必須項目/省略可能
cropSize
Integer
トリミングする正方形の任意 アップロードされたファイ 29.0
の境界の長さ (ピクセル単
ルまたは既存のファイルを
位)。
432
使用可能な
バージョン
Chatter REST API リソース
Recommendation Definition Photo
名前
型
説明
必須項目/省略可能
使用可能な
バージョン
トリミングする必要があり
ます。
cropX
Integer
画像の左端を起点とした、ト
リミングする正方形の開始位
置 X (ピクセル単位)。左上の位
置は (0,0) です。
アップロードされたファイ 29.0
ルまたは既存のファイルを
トリミングする必要があり
ます。
cropY
Integer
画像の上端を起点とした、ト
リミングする正方形の開始位
置 Y (ピクセル単位)。左上の位
置は (0,0) です。
アップロードされたファイ 29.0
ルまたは既存のファイルを
トリミングする必要があり
ます。
fileId
String
既存のファイルの 18 文字の 既存のファイルを選択する 25.0
ID。キープレフィックスは
必要があります。
069、ファイルサイズは 2 MB
未満にする必要があります。
メモ: グループページお
よびユーザページにアッ
プロードされた画像には
ファイル ID がないた
め、使用できません。
Integer
versionNumber
既存のファイルのバージョン 省略可能
番号。指定されていない場
合、最新のバージョンが使用
されます。
25.0
PUT の要求パラメータ
パラメータ名
型
説明
必須項目/省略可能
cropSize
Integer
トリミングする正方 アップロードされた 29.0
形の任意の境界の長 ファイルまたは既存
さ (ピクセル単位)。 のファイルをトリミ
ングする必要があり
ます。
cropX
Integer
画像の左端を起点と アップロードされた 29.0
した、トリミングす ファイルまたは既存
る正方形の開始位置 のファイルをトリミ
433
使用可能なバージョ
ン
Chatter REST API リソース
パラメータ名
Recommendation Definition Photo
型
説明
必須項目/省略可能
使用可能なバージョ
ン
X (ピクセル単位)。 ングする必要があり
左上の位置は (0,0) で ます。
す。
cropY
Integer
画像の上端を起点と
した、トリミングす
る正方形の開始位置
Y (ピクセル単位)。
左上の位置は (0,0) で
す。
アップロードされた 29.0
ファイルまたは既存
のファイルをトリミ
ングする必要があり
ます。
fileId
String
既存のファイルの 18 既存のファイルを選 25.0
文字の ID。キープレ 択する必要がありま
フィックスは 069、 す。
ファイルサイズは 2
MB 未満にする必要
があります。
メモ: [グルー
プ] ページおよ
び [ユーザプロ
ファイル] ペー
ジでアップ
ロードした
ファイルには
ファイル ID は
含まれず、投
稿やトリミン
グはできませ
ん。[ファイ
ル] ページで
アップロード
したファイル
にはファイル
ID は含まれ
ず、投稿やト
リミングはで
きません。
versionNumber
Integer
既存のコンテンツの 省略可能
バージョン番号。指
定されていない場
合、最新のバージョ
ンが使用されます。
434
25.0
Chatter REST API リソース
Records リソース
メモ: 写真は非同期に処理され、すぐには表示されない場合があります。
GET および PUT のレスポンスボディ
Photo
Records リソース
レコードをフォローしている人に関する情報を取得します。レコードに対するトピックの追加や削除を行いま
す。
次のリソースを使用できます。
このセクションの内容:
Followers on Records リソース
指定されたレコードをフォローしている人に関する情報を取得します。
Topics on Records リソース
指定されたレコードに割り当てられているトピック。指定されたレコードに割り当てられているトピック
に関する情報の取得、および指定されたレコードに対するトピックの追加や削除を行います。ユーザがオ
ブジェクト種別のレコードにトピックを追加できるようにするには、事前にシステム管理者がそのオブジェ
クトでトピックを有効化しておく必要があります。
関連トピック:
Record Feed リソース
Followers on Records リソース
指定されたレコードをフォローしている人に関する情報を取得します。
リソース
/chatter/records/recordId/followers
/connect/communities/communityId/chatter/records/recordId/followers
バージョン 29.0 では、recordId にトピック ID を使用できます。
適用開始バージョン
23.0
Chatter が必要かどうか
はい
HTTP メソッド
GET または HEAD
435
Chatter REST API リソース
Topics on Records リソース
要求パラメータ
パラメータ名
型
説明
page
Integer
項目のページを指定する整数。デ
フォルト値は 0 で、最初のページ
を返します。
pageSize
Integer
ページあたりの項目数を指定しま
す。有効な値は 1 ～ 1000 です。サ
イズを指定しない場合、デフォル
トは 25 です。
レスポンスボディ
Subscription Page
Topics on Records リソース
指定されたレコードに割り当てられているトピック。指定されたレコードに割り当てられているトピックに関
する情報の取得、および指定されたレコードに対するトピックの追加や削除を行います。ユーザがオブジェク
ト種別のレコードにトピックを追加できるようにするには、事前にシステム管理者がそのオブジェクトでト
ピックを有効化しておく必要があります。
リソース
/connect/records/recordId/topics
/connect/communities/communityId/records/recordId/topics
適用開始バージョン
30.0
Chatter が必要かどうか
いいえ
HTTP メソッド
GET、DELETE、POST
DELETE の要求パラメータ
パラメータ名
型
説明
必須項目/省略可能
topicId
String
既存のトピックの ID 必須項目
DELETE のレスポンスボディ
204: DELETE が成功しました
436
使用可能なバージョ
ン
30.0
Chatter REST API リソース
Topics on Records リソース
POST のリクエストボディ
ルート XML タグ
<topicAssignment>
JSON
次の例では、トピックをレコードに割り当てます。
{ "topicId": "0TOD0000000090r"
}
プロパティ
名前
型
説明
必須項目/省略可能
使用可
能な
バー
ジョン
topicId
String
既存のトピックの ID。
topicName プロパティが 30.0
使用されていない場合、既
存のトピックに必要です。
topicName
String
新規または既存のトピック 新規のトピック、および 30.0
の名前。
topicId プロパティが使
用されていない場合の既存
のトピックに必要です。
POST の要求パラメータ
パラメータ名
型
説明
必須項目/省略可能
topicId
String
30.0
既存のトピックの ID topicName パラ
メータが使用されて
いない場合、既存の
トピックに必要で
す。
topicName
String
新規または既存のト 新規のトピック、お 30.0
ピックの名前
よび topicId パラ
メータが使用されて
いない場合の既存の
トピックに必要で
す。
437
使用可能なバージョ
ン
Chatter REST API リソース
スケジュール済みおすすめリソース
POST のレスポンスボディ
Topic
POST の例
この例では、既存のトピックの ID を topidId パラメータで渡して商談レコードに関連付けます。
POST /connect/records/006D000000CtYBc/topics?topicId=0TOD0000000090r
スケジュール済みおすすめリソース
スケジュール済みおすすめに関する情報の取得、スケジュール済みおすすめの作成、変更、削除を行います。
コミュニティマネージャ (「コミュニティの作成および設定」または「コミュニティの管理」権限を持つユー
ザ) および「すべてのデータの編集」権限を持つユーザのみが、おすすめ定義とスケジュール済みおすすめの
アクセス、作成、および削除を行うことができます。これらのおすすめは、Salesforce1 モバイルブラウザアプ
リケーションのコミュニティのフィードに直接表示されます。また、Summer '15 以降のバージョンの Napili テン
プレートを使用すると、コミュニティのホームページの右側にもデフォルトで表示されます。
使用可能なリソース:
リソース
説明
/connect/scheduled-recommendations
スケジュール済みおすすめのリストの取得、スケ
ジュール済みおすすめの作成を行います。
/connect/scheduled-recommendations/
scheduledRecommendationId
スケジュール済みおすすめに関する情報の取得、スケ
ジュール済みおすすめの更新または削除を行います。
スケジュール済みおすすめ
スケジュール済みおすすめのリストの取得、スケジュール済みおすすめの作成を行います。
コミュニティマネージャ (「コミュニティの作成および設定」または「コミュニティの管理」権限を持つユー
ザ) および「すべてのデータの編集」権限を持つユーザのみが、おすすめ定義とスケジュール済みおすすめの
アクセス、作成、および削除を行うことができます。これらのおすすめは、Salesforce1 モバイルブラウザアプ
リケーションのコミュニティのフィードに直接表示されます。また、Summer '15 以降のバージョンの Napili テン
プレートを使用すると、コミュニティのホームページの右側にもデフォルトで表示されます。
リソース
/connect/scheduled-recommendations
/connect/communities/communityId/scheduled-recommendations
使用可能なバージョン
33.0
Chatter が必要かどうか
いいえ
438
Chatter REST API リソース
スケジュール済みおすすめ
HTTP メソッド
GET、HEAD、POST
POST のリクエストボディ
新しいスケジュール済みおすすめを作成する JSON の例
{
"rank" : "2",
"recommendationDefinitionId" : "0RDD00000004CEhOAM"}
既存のスケジュール済みおすすめを更新する JSON の例
{
"rank" : "2"}
プロパティ
名前
型
説明
必須項目/省略
可能
enabled
Boolean
スケジュールが有効になっている 省略可能
かどうかを示します。true の場
合、おすすめが有効になり、コ
ミュニティに表示されます。
false の場合、Salesforce1 モバイ
ルブラウザアプリケーションでの
フィードのおすすめは削除されま
せんが、新しいおすすめは表示さ
れなくなります。Summer '15 以降
のバージョンの Napili テンプレー
トを使用したコミュニティでは、
無効にしたおすすめは表示されな
くなります。
34.0
rank
Integer
スケジュール済みおすすめの相対 省略可能
的なランク。1 から開始する昇順
の整数で示されます。
33.0
ランクを設定することと、順序付
きリストに挿入することは同じで
す。スケジュール済みおすすめ
は、rank で指定された位置に挿
入されます。それ以降のすべての
スケジュール済みおすすめの
rank が 1 つずつ下がります。
「スケジュール済みおすすめにラ
ンクを付ける場合の例」を参照し
てください。
439
使用可能なバー
ジョン
Chatter REST API リソース
スケジュール済みおすすめ
名前
型
説明
必須項目/省略
可能
使用可能なバー
ジョン
指定された rank がリストのサイ
ズよりも大きい場合は、スケ
ジュール済みおすすめがリストの
末尾に配置されます。スケジュー
ル済みおすすめの rank には、指
定された値の代わりにリストのサ
イズが指定されます。
rank が指定されていない場合
は、スケジュール済みおすすめが
リストの末尾に配置されます。
recommendation String
DefinitionId
このスケジュール済みおすすめに スケジュール済 33.0
よってスケジュールされたおすす みおすすめを作
め定義の ID。
成する場合は必
須です。
既存のスケ
ジュール済みお
すすめを更新す
る場合は、
recommendation
DefinitionId
を指定できませ
ん。
POST の要求パラメータ
パラメータ名
型
説明
必須項目/省略可 使用可能なバー
能
ジョン
enabled
Boolean
スケジュールが有効になっている 省略可能
かどうかを示します。true の場
合、おすすめが有効になり、コ
ミュニティに表示されます。
false の場合、Salesforce1 モバイル
ブラウザアプリケーションでの
フィードのおすすめは削除されま
せんが、新しいおすすめは表示さ
れなくなります。Summer '15 以降
のバージョンの Napili テンプレート
を使用したコミュニティでは、無
440
34.0
Chatter REST API リソース
パラメータ名
スケジュール済みおすすめ
型
説明
必須項目/省略可 使用可能なバー
能
ジョン
効にしたおすすめは表示されなく
なります。
rank
Integer
スケジュール済みおすすめの相対 省略可能
的なランク。1 から開始する昇順
の整数で示されます。
33.0
ランクを設定することと、順序付
きリストに挿入することは同じで
す。スケジュール済みおすすめ
は、rank で指定された位置に挿
入されます。それ以降のすべての
スケジュール済みおすすめの rank
が 1 つずつ下がります。「スケ
ジュール済みおすすめにランクを
付ける場合の例」を参照してくだ
さい。
指定された rank がリストのサイ
ズよりも大きい場合は、スケ
ジュール済みおすすめがリストの
末尾に配置されます。スケジュー
ル済みおすすめの rank には、指
定された値の代わりにリストのサ
イズが指定されます。
rank が指定されていない場合は、
スケジュール済みおすすめがリス
トの末尾に配置されます。
recommendation String
DefinitionId
このスケジュール済みおすすめに 必須項目
よってスケジュールされたおすす
め定義の ID。
33.0
POST のレスポンスボディ
スケジュール済みおすすめ
GET のレスポンスボディ
Scheduled Recommendation Collection
スケジュール済みおすすめ
スケジュール済みおすすめに関する情報の取得、スケジュール済みおすすめの更新または削除を行います。
441
Chatter REST API リソース
スケジュール済みおすすめ
コミュニティマネージャ (「コミュニティの作成および設定」または「コミュニティの管理」権限を持つユー
ザ) および「すべてのデータの編集」権限を持つユーザのみが、おすすめ定義とスケジュール済みおすすめの
アクセス、作成、および削除を行うことができます。これらのおすすめは、Salesforce1 モバイルブラウザアプ
リケーションのコミュニティのフィードに直接表示されます。また、Summer '15 以降のバージョンの Napili テン
プレートを使用すると、コミュニティのホームページの右側にもデフォルトで表示されます。
リソース
/connect/scheduled-recommendations/scheduledRecommendationId
/connect/communities/communityId/scheduled-recommendations/scheduledRecommendationId
使用可能なバージョン
33.0
Chatter が必要かどうか
いいえ
HTTP メソッド
GET、HEAD、PATCH、DELETE
PATCH のリクエストボディ
新しいスケジュール済みおすすめを作成する JSON の例
{
"rank" : "2",
"recommendationDefinitionId" : "0RDD00000004CEhOAM"}
既存のスケジュール済みおすすめを更新する JSON の例
{
"rank" : "2"}
プロパティ
名前
型
説明
必須項目/省略
可能
enabled
Boolean
スケジュールが有効になっている 省略可能
かどうかを示します。true の場
合、おすすめが有効になり、コ
ミュニティに表示されます。
false の場合、Salesforce1 モバイ
ルブラウザアプリケーションでの
フィードのおすすめは削除されま
せんが、新しいおすすめは表示さ
れなくなります。Summer '15 以降
のバージョンの Napili テンプレー
トを使用したコミュニティでは、
無効にしたおすすめは表示されな
くなります。
442
使用可能なバー
ジョン
34.0
Chatter REST API リソース
スケジュール済みおすすめ
名前
型
説明
必須項目/省略
可能
rank
Integer
スケジュール済みおすすめの相対 省略可能
的なランク。1 から開始する昇順
の整数で示されます。
使用可能なバー
ジョン
33.0
ランクを設定することと、順序付
きリストに挿入することは同じで
す。スケジュール済みおすすめ
は、rank で指定された位置に挿
入されます。それ以降のすべての
スケジュール済みおすすめの
rank が 1 つずつ下がります。
「スケジュール済みおすすめにラ
ンクを付ける場合の例」を参照し
てください。
指定された rank がリストのサイ
ズよりも大きい場合は、スケ
ジュール済みおすすめがリストの
末尾に配置されます。スケジュー
ル済みおすすめの rank には、指
定された値の代わりにリストのサ
イズが指定されます。
rank が指定されていない場合
は、スケジュール済みおすすめが
リストの末尾に配置されます。
recommendation String
DefinitionId
このスケジュール済みおすすめに スケジュール済 33.0
よってスケジュールされたおすす みおすすめを作
め定義の ID。
成する場合は必
須です。
既存のスケ
ジュール済みお
すすめを更新す
る場合は、
recommendation
DefinitionId
を指定できませ
ん。
443
Chatter REST API リソース
スケジュール済みおすすめ
PATCH の要求パラメータ
パラメータ名
型
説明
必須項目/省略可 使用可能なバー
能
ジョン
enabled
Boolean
スケジュールが有効になっている 省略可能
かどうかを示します。true の場
合、おすすめが有効になり、コ
ミュニティに表示されます。
false の場合、Salesforce1 モバイル
ブラウザアプリケーションでの
フィードのおすすめは削除されま
せんが、新しいおすすめは表示さ
れなくなります。Summer '15 以降
のバージョンの Napili テンプレート
を使用したコミュニティでは、無
効にしたおすすめは表示されなく
なります。
34.0
rank
Integer
スケジュール済みおすすめの相対 省略可能
的なランク。1 から開始する昇順
の整数で示されます。
33.0
ランクを設定することと、順序付
きリストに挿入することは同じで
す。スケジュール済みおすすめ
は、rank で指定された位置に挿
入されます。それ以降のすべての
スケジュール済みおすすめの rank
が 1 つずつ下がります。「スケ
ジュール済みおすすめにランクを
付ける場合の例」を参照してくだ
さい。
指定された rank がリストのサイ
ズよりも大きい場合は、スケ
ジュール済みおすすめがリストの
末尾に配置されます。スケジュー
ル済みおすすめの rank には、指
定された値の代わりにリストのサ
イズが指定されます。
rank が指定されていない場合は、
スケジュール済みおすすめがリス
トの末尾に配置されます。
444
Chatter REST API リソース
Subscriptions リソース
PATCH のレスポンスボディ
スケジュール済みおすすめ
DELETE のレスポンスボディ
204: DELETE が成功しました
スケジュール済みおすすめの削除は、順序付きリストでの削除に相当します。スケジュール済みおすすめ
を削除すると、削除されたものの後にあるすべてのスケジュール済みおすすめが自動的に上位に順位付け
されます。
Subscriptions リソース
指定された登録に関する情報。登録の削除 (レコードまたはトピックのフォロー解除など) にも使用されます。
登録 ID は、follower リソースと following リソースのレスポンスボディの一部として返されます。たとえ
ば、/records/recordId/followers のようになります。さらに、登録 ID は、グループサマリーやユーザサ
マリーなど、多くのサマリーレスポンスボディでも返されます。
リソース
/chatter/subscriptions/subscriptionId
/connect/communities/communityId/chatter/subscriptions/subscriptionId
適用開始バージョン
23.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、DELETE、または HEAD
GET のレスポンスボディ
Subscription
関連トピック:
レコードのフォローを停止する
Topics リソース
組織のトピックのリスト、指定されたテキスト文字列、フィード項目、またはレコードの推奨トピックのリス
ト、組織のトピックのトレンドのリスト、指定されたトピックに関する情報、指定されたトピックの支持、指
定されたトピックに最近投稿されたファイルに関する情報、指定されたトピックに最近投稿したグループに関
する情報、指定されたトピックに関する知識のあるユーザ、および指定されたトピックに関連するトピックの
リスト。
使用可能なリソース:
445
Chatter REST API リソース
List of Topics
リソース
説明
/connect/topics
組織のトピックのリスト。
/connect/topics/topicId
指定されたトピックに関する情報。トピックに関する
情報の取得、トピックの名前または説明の更新、ト
ピックのマージおよび削除を行います。
/connect/topics/suggestions
指定されたテキスト文字列、フィード項目、またはレ
コードの推奨トピックのリスト。
/connect/topics/trending
組織のトピックのトレンド上位 5 つのリスト。
/connect/topics/topicId/endorsements
指定されたトピックに関する知識のあるユーザへの支
持。指定されたトピックに関する支持の取得、および
指定されたトピックに関するユーザへの支持を行いま
す。
/connect/topic-endorsements/endorsementId 支持。支持に関する情報の取得と、支持の削除を行い
ます。
/connect/topics/topicId/files
指定されたトピックに最近投稿された 5 つのファイル
に関する情報を返します。
/connect/topics/topicId/groups
指定されたトピックに最近投稿した 5 つのグループに
関する情報を返します。
/connect/topics/topicId/knowledgeable-users トピックに関する知識のあるユーザ。指定されたト
ピックに関する知識のあるユーザのリストを取得しま
す。
/connect/topics/topicId/related-topics
指定されたトピックへの関連性が最も強い 5 つのト
ピックのリスト。
/connect/topics/topicId/topic-opt-outs
トピックからの除外。指定されたトピックについてト
ピックからの除外のリストを取得します。指定された
トピックの [知識のあるユーザ] リストで自分を非表示
にします。
/connect/topic-opt-outs/topicOptOutId
トピックからの除外。[知識のあるユーザ] リストで自
分を非表示にした後、再度表示します。
List of Topics
組織のトピックのリスト。
リソース
/connect/topics
/connect/communities/communityId/topics
446
Chatter REST API リソース
List of Topics
適用開始バージョン
29.0
バージョン 28.0 では、/chatter/topics を使用します。
Chatter が必要かどうか
いいえ
HTTP メソッド
GET または HEAD
要求パラメータ
パラメータ名
値
説明
必須項目/省略可能
exactMatch
Boolean
大文字と小文字を含 省略可能
め、完全一致する名
前でトピックを検索
する場合は、true
を指定し、q パラ
メータと一緒に使用
します。デフォルト
値は false です。
28.0
page
Integer
トピックのページを 省略可能
指定する 0 より大き
い整数。デフォルト
値は、0 です。
28.0
pageSize
Integer
ページあたりの項目 省略可能
数を指定します。有
効な値は 1 ～ 100 で
す。デフォルト値は
25 です。
28.0
q
String
結果を絞り込むクエ 省略可能
リ文字列。文字列に
はワイルドカード文
字を除いて 2 文字以
上が含まれている必
要があります。
28.0
sort
String
次のいずれかの値に 省略可能
なります。
28.0
• popularDesc:
トピックを人気
順に並び替えま
す。この値がデ
フォルトです。
447
使用可能なバージョ
ン
Chatter REST API リソース
パラメータ名
Topics Suggestions
値
説明
必須項目/省略可能
使用可能なバージョ
ン
• alphaAsc: ト
ピックをアル
ファベット順に
並び替えます。
レスポンスボディ
Topic Collection
GET の例
この例では、アルファベット順に並び替えられたトピックのリストを要求します。
/connect/topics?sort=alphaAsc
Topics Suggestions
指定されたテキスト文字列、フィード項目、またはレコードの推奨トピックのリスト。
リソース
/connect/topics/suggestions
/connect/communities/communityId/topics/suggestions
適用開始バージョン
29.0
バージョン 28.0 では、/chatter/topics/suggestions を使用します。
Chatter が必要かどうか
いいえ
HTTP メソッド
GET または HEAD
要求パラメータ
パラメータ名
値
説明
maxResults
Integer
返される推奨トピックの 省略可能
最大数。デフォルト値は
5 です。値は 1 以上 25 以
下で指定する必要があり
ます。
recordId
String
トピックの抽出元になる text パラメータが使用
フィード項目またはレ
されていない場合に必要
コードの 18 文字の ID。オ です。
ブジェクト種別のレコー
448
必須項目/省略可能
Chatter REST API リソース
パラメータ名
Trending Topics
値
説明
必須項目/省略可能
ドについてトピックの提
案を表示するには、シス
テム管理者がそのオブ
ジェクトでトピックを有
効化しておく必要があり
ます。オブジェクトのト
ピックは、バージョン
30.0 で使用できます。
text
トピックの抽出元のテキ recordId パラメータが
スト。
使用されていない場合に
必要です。
String
レスポンスボディ
Topic Suggestion Collection
GET の例
この例では、テキスト “Working on the planning meeting for our new initiative.” について推奨トピックを取得しま
す。
/connect/topics/suggestions?text=Working+on+the+planning+meeting+for+our+new+initiative.
Trending Topics
組織のトピックのトレンド上位 5 つのリスト。
ユーザが投稿やコメントの中で特定のトピックを追加したり、同じトピックの投稿にコメントしたりいいね!
と言う頻度が短時間で高くなるほど、トレンドトピックになる可能性が高まります。たとえば、同僚が近々
Dreamforce の会議に出席することになっており、Chatter でそれについての議論を開始すると、「Dreamforce」が
トピックのトレンドとして表示されます。トピックのトレンドは、人気度のみに基づくのではなく、通常は、
会議やプロジェクトの期限など、活動の急な増加を伴う、頻繁には行われない 1 回限りの行動に関連するト
ピックが表示されます。
メモ: API バージョン 28.0 以前では、トピックはハッシュタグ (#) で開始していました。
リソース
/connect/topics/trending
/connect/communities/communityId/topics/trending
適用開始バージョン
29.0
バージョン 24.0 ～ 28.0 では、/chatter/topics/trending および
/connect/communities/communityId/chatter/topics/trending を使用します。
449
Chatter REST API リソース
Trending Topics
Chatter が必要かどうか
いいえ
HTTP メソッド
GET または HEAD
要求パラメータ
パラメータ名
値
説明
maxResults
Integer
返されるトピックのトレンドの最
大数。デフォルト値は 5 です。値
は 1 以上 100 未満で指定する必要
があります。
レスポンスボディ
Topic Collection
レスポンスボディの例 (バージョン 28.0 以降)。
{"currentPageUrl" : "/services/data/v34.0/connect/topics/trending?maxResults=5",
"nextPageUrl" : null,
"topics" : [
{
"createdDate": "2013-01-01T20:43:31.000Z",
"id" : "0TOD0000000090qOAA",
"description" : "Application Programming Interface",
"talkingAbout" : 527,
"name" : "API",
"url": "/services/data/v34.0/connect/topics/0TOD0000000090qOAA"
},
{
"createdDate": "2012-11-14T05:24:23.000Z",
"id" : "0TOD000000006RxOAI",
"description" : "The cloud computing event of the year.",
"talkingAbout" : 424,
"name" : "Dreamforce",
450
Chatter REST API リソース
Topic
"url": "/services/data/v34.0/connect/topics/0TOD000000006RxOAI"
},
{
"createdDate": "2013-02-25T10:47:51.000Z",
"id" : "0TOD0000000090rOAA",
"description" : "All things related to mobile.",
"talkingAbout" : 87,
"name" : "Mobile",
"url": "/services/data/v34.0/connect/topics/0TOD0000000090rOAA"
}
]}
レスポンスボディの例 (バージョン 24.0 ～ 27.0)
{"topics" : [
{
"name" : "#API"
},
{
"name" : "#Dreamforce"
},
{
"name" : "#Mobile"
}
]}
Topic
指定されたトピックに関する情報。トピックに関する情報の取得、トピックの名前または説明の更新、トピッ
クのマージおよび削除を行います。
451
Chatter REST API リソース
Topic
「トピックを編集」または「すべてのデータの編集」権限を持つユーザは、トピックの名前および説明を編集
できます。「トピックの削除」または「すべてのデータの編集」権限を持つユーザは、トピックをマージおよ
び削除できます。
メモ: トピックのマージはベータ版で、既知の制限があります。IdeaExchange でフィードバックをお寄せ
ください。
リソース
/connect/topics/topicId
/connect/communities/communityId/topics/topicId
適用開始バージョン
29.0
バージョン 28.0 では、/chatter/topics/topicId を使用します。
Chatter が必要かどうか
いいえ
HTTP メソッド
GET、PATCH、DELETE、および HEAD
PATCH のリクエストボディ
ルート XML タグ
<topic>
JSON
{
"description" : "World Wide Web Consortium (W3C) is the main international standards
organization for the Web."
"name" : "W3C"}
プロパティ
名前
型
説明
使用可能なバージョン
description
String
トピックのテキストによ 28.0
る説明
idsToMerge
String []
トピックにマージする最 33.0
大 5 個のトピック ID のリ
スト。
メモ: トピックの
マージはベータ版
で、既知の制限が
あります。
IdeaExchange で
452
Chatter REST API リソース
Topic
名前
型
説明
使用可能なバージョン
フィードバックを
お寄せください。
トピックの名前
String
name
28.0
トピック名の大文字、小
文字、スペースのみを変
更するには、このプロパ
ティを使用します。
PATCH の要求パラメータ
パラメータ名
型
説明
適用開始バージョン
description
String
トピックのテキストによる説明
28.0
idsToMerge
String []
トピックにマージする最大 5 個のトピッ 33.0
ク ID のリスト。
メモ: トピックのマージはベータ
版で、既知の制限があります。
IdeaExchangeでフィードバックをお
寄せください。
name
String
トピックの名前
28.0
トピック名の大文字、小文字、スペー
スのみを変更するには、このプロパティ
を使用します。
GET、HEAD、または PATCH のレスポンスボディ
Topic
DELETE のレスポンスボディ
204: DELETE が成功しました
トピックの削除は非同期です。削除の完了前にトピックを要求した場合、応答は200: Successfulになり、バー
ジョン 33.0 以降では Topic 出力の isBeingDeleted プロパティが true になります。削除の完了後にトピッ
クを要求した場合、応答は 404: Not found になります。
PATCH の例
この例では、要求パラメータを使用してトピックの説明を更新します。
/connect/topics/0TOD000000006RxOAI?description=Edit+requests
453
Chatter REST API リソース
Topics, Endorse People
これは、同じ要求に JSON リクエストボディを使用しています。
/connect/topics/0TOD000000006RxOAI
{
"description" : "Edit requests"
}
Topics, Endorse People
指定されたトピックに関する知識のあるユーザへの支持。指定されたトピックに関する支持の取得、および指
定されたトピックに関するユーザへの支持を行います。
リソース
/connect/topics/topicId/endorsements
/connect/communities/communityId/topics/topicId/endorsements
適用開始バージョン
30.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、HEAD、POST
GET の要求パラメータ
パラメータ名
型
説明
必須項目/省略可能
適用開始バージョン
endorseeId
String
支持を受け取った
ユーザの ID を指定
します。
省略可能
31.0
endorserId
String
他のユーザを支持し 省略可能
たユーザの ID を指
定します。
31.0
page
Integer
支持のページを指定 省略可能
する 0 より大きい整
数。デフォルト値
は、0 です。
30.0
pageSize
Integer
ページあたりの項目 省略可能
数を指定します。有
効な値は 1 ～ 100 で
30.0
454
Chatter REST API リソース
パラメータ名
Topic Endorsements
型
説明
必須項目/省略可能
適用開始バージョン
す。デフォルト値は
25 です。
POST のリクエストボディ
ルート XML タグ
<topicEndorsement>
JSON
{
"userId" : "005B0000000Ge16"
}
プロパティ
名前
型
説明
必須項目/省略可能 使用可能なバー
ジョン
userId
String
指定したトピック
について支持され
るユーザの ID。
必須項目
30.0
POST の要求パラメータ
パラメータ名
型
説明
適用開始バージョン
userId
String
支持するユーザの ID
30.0
GET のレスポンスボディ
Topic Endorsement Collection
POST のレスポンスボディ
Topic Endorsement
Topic Endorsements
支持。支持に関する情報の取得と、支持の削除を行います。
リソース
/connect/topic-endorsements/endorsementId
/connect/communities/communityId/topic-endorsements/endorsementId
455
Chatter REST API リソース
Topic Files
適用開始バージョン
30.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、HEAD、DELETE
GET のレスポンスボディ
Topic Endorsement
DELETE のレスポンスボディ
204: DELETE が成功しました
DELETE の例
トピックについて他のユーザを支持すると、キープレフィックス 0en の支持レコードが作成されます。支
持を削除するには、この支持レコードを削除します。
DELETE /connect/topic-endorsements/0enD0000000003UIAQ
次にレスポンスボディを示します。
HTTP 204
Topic Files
指定されたトピックに最近投稿された 5 つのファイルに関する情報を返します。
リソース
/connect/topics/topicId/files
/connect/communities/communityId/topics/topicId/files
適用開始バージョン
29.0
バージョン 28.0 では、/chatter/topics/topicId/files を使用します。
Chatter が必要かどうか
いいえ
HTTP メソッド
GET または HEAD
レスポンスボディ
File Summary Page
レスポンスボディの例
この GET 要求は、指定されたトピックのすべてのファイルに関する情報を返します。
/connect/topics/0TOD000000009Q2/files
456
Chatter REST API リソース
Topic Files
応答は次のようになります。
{
"currentPageUrl": null,
"files": [{
"checksum": "a65b71bc6a31fa95dd0a9232c9f58c86",
"contentSize": 100377,
"contentUrl": null,
"description": null,
"downloadUrl":
"/services/data/v34.0/chatter/files/069D00000001E32IAE/content?versionNumber=1",
"fileExtension": "png",
"fileType": "Png",
"flashRenditionStatus": "Na",
"id": "069D00000001E32IAE",
"isInMyFileSync": false,
"mimeType": "image/png",
"modifiedDate": "2012-07-17T21:47:27.000Z",
"motif": {
"color": "993333",
"largeIconUrl": "/img/content/content64.png",
"mediumIconUrl": "/img/content/content32.png",
"smallIconUrl": "/img/icon/files16.png"
},
"mySubscription": {
"id": "0E8D0000000T5JrKAK",
"url": "/services/data/v34.0/chatter/subscriptions/0E8D0000000T5JrKAK"
},
"name": "Recruitment Poster",
457
Chatter REST API リソース
Topic Files
"origin": "Chatter",
"owner": {
"companyName": "SeattleApps",
"firstName": "Rene",
"id": "005D0000001LFNnIAO",
"isActive": true,
"lastName": "Holmes",
"motif": {
"color": "1797C0",
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile.png",
"smallIconUrl": "/img/icon/profile.png"
},
"mySubscription": null,
"name": "Rene Holmes",
"photo": {
"fullEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sZVyX4qlsJTXfOWM77RW7yt",
"largePhotoUrl": "https://instance_name/profilephoto/729D00000000BDV/F",
"photoVersionId": "729D00000000BDV",
"smallPhotoUrl": "https://instance_name/profilephoto/729D00000000BDV/T",
"standardEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sbktFTIf9vWhFTTALJiaFz_",
"url": "/services/data/v34.0/chatter/users/005D0000001LL8OIAW/photo"
},
"title": null,
"type": "User",
458
Chatter REST API リソース
Topic Groups
"url": "/services/data/v34.0/chatter/users/005D0000001LFNnIAO",
"userType": "Internal"
},
"parentFolder" : "null",
"pdfRenditionStatus": "Na",
"renditionUrl": "/services/data/v34.0/chatter/files/069D00000001E32IAE/rendition",
"thumb120By90RenditionStatus": "Success",
"thumb240By180RenditionStatus": "Success",
"thumb720By480RenditionStatus": "Success",
"title": "Recruitment Poster",
"type": "ContentDocument",
"url": "/services/data/v34.0/chatter/files/069D00000001E32IAE?versionNumber=1",
"versionNumber": "1"
}],
"nextPageUrl": null,
"previousPageUrl": null
}
Topic Groups
指定されたトピックに最近投稿した 5 つのグループに関する情報を返します。
リソース
/connect/topics/topicId/groups
/connect/communities/communityId/topics/topicId/groups
適用開始バージョン
29.0
バージョン 28.0 では、/chatter/topics/topicId/groups を使用します。
Chatter が必要かどうか
はい
HTTP メソッド
GET または HEAD
459
Chatter REST API リソース
Topics, Knowledgeable People List
レスポンスボディ
Group Page
Topics, Knowledgeable People List
トピックに関する知識のあるユーザ。指定されたトピックに関する知識のあるユーザのリストを取得します。
リソース
/connect/topics/topicId/knowledgeable-users
/connect/communities/communityId/topics/topicId/knowledgeable-users
適用開始バージョン
30.0
Chatter が必要かどうか
はい
HTTP メソッド
GET または HEAD
要求パラメータ
パラメータ名
値
説明
必須項目/省略可能
page
Integer
トピックのページを 省略可能
指定する 0 より大き
い整数。デフォルト
値は、0 です。
30.0
pageSize
Integer
ページあたりの項目 省略可能
数を指定します。有
効な値は 1 ～ 100 で
す。デフォルト値は
25 です。
30.0
レスポンスボディ
Knowledgeable People Collection
Related Topics
指定されたトピックへの関連性が最も強い 5 つのトピックのリスト。
リソース
/connect/topics/topicId/related-topics
/connect/communities/communityId/topics/topicId/related-topics
460
使用可能なバージョ
ン
Chatter REST API リソース
Topics, Opt Outs from Knowledgeable People List
適用開始バージョン
29.0
バージョン 28.0 では、/chatter/topics/topicId/relatedtopics を使用します。
Chatter が必要かどうか
いいえ
HTTP メソッド
GET または HEAD
レスポンスボディ
Topic Collection
Topics, Opt Outs from Knowledgeable People List
トピックからの除外。指定されたトピックについてトピックからの除外のリストを取得します。指定されたト
ピックの [知識のあるユーザ] リストで自分を非表示にします。
リソース
/connect/topics/topicId/topic-opt-outs
/connect/communities/communityId/topics/topicId/topic-opt-outs
適用開始バージョン
30.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、HEAD、POST
GET のレスポンスボディ
Topic Opt Out Collection
POST のレスポンスボディ
Topic Opt Out
Topics, Opt Out from Knowledgeable People List
トピックからの除外。[知識のあるユーザ] リストで自分を非表示にした後、再度表示します。
リソース
/connect/topic-opt-outs/topicOptOutId
/connect/communities/communityId/topic-opt-outs/topicOptOutId
適用開始バージョン
30.0
Chatter が必要かどうか
はい
461
Chatter REST API リソース
User Profiles リソース
HTTP メソッド
GET、HEAD、DELETE
GET のレスポンスボディ
Topic Opt Out
DELETE のレスポンスボディ
204: DELETE が成功しました
DELETE の例
トピックの [知識のあるユーザ] リストから自分を除外すると、キープレフィックス 0eb の Topic Opt Out レ
コードが作成されます。[知識のあるユーザ] リストから自分を除外した後に再度表示するには、この Topic
Opt Out レコードを削除します。
DELETE /connect/topic-opt-outs/0ebD0000000003oIAA
次にレスポンスボディを示します。
HTTP 204
User Profiles リソース
ユーザのプロファイルに関する詳細を返します。このユーザプロファイルデータが、プロファイルページ
(Chatterプロファイルページとも呼ばれる) に入力されます。このデータには、ユーザ情報 (住所、マネージャ、
電話番号など)、一部のユーザ機能 (権限)、および一連のサブタブアプリケーション (プロファイルページのカ
スタムタブ) が含まれます。
サブタブアプリケーションについての詳細は、help.salesforce.com で「サブタブアプリケーション」を検索して
ください。
機能情報には、別のユーザ (件名ユーザと呼ばれる) に対するコンテキストユーザの機能に関する情報が含まれ
ます。たとえば、コンテキストユーザが件名ユーザとチャットできるかどうかや、コンテキストユーザが件名
ユーザに直接メッセージを送信できるかどうかが機能情報でわかります。件名ユーザを userID として指定し
ます。
リソース
/connect/user-profiles/userID
/connect/communities/communityId/user-profiles/userID
適用開始バージョン
29.0
Chatter が必要かどうか
はい
HTTP メソッド
GET または HEAD
462
Chatter REST API リソース
Users リソース
パラメータ
パラメータ名
型
説明
適用開始バージョン
userId
String
ユーザの ID
29.0
communityId
String
コミュニティの ID
29.0
GET のレスポンスボディ
User Profile
Users リソース
ユーザをフォローしている人、ユーザのファイルやおすすめなど、ユーザに関する情報。フィード項目の post
送信と会話状況の更新にも使用されます。
次のリソースを使用できます。
リソース
説明
/chatter/users
組織のすべてのユーザに関する情報を返
します。
/chatter/users/me
コンテキストユーザまたは指定された
ユーザの Chatter プロファイルに関する情
報。
/chatter/users/batch/user_list
指定されたユーザのプロファイルに関す
る情報を返します。
/chatter/users/me/conversations
コンテキストユーザの非公開の会話をす
べて返します。すべての会話を対象とし
た検索にも使用されます。
/chatter/users/me/conversations/conversationId
コンテキストユーザの指定された非公開
の会話に関する情報を返します。特定の
会話内の検索にも使用されます。
/chatter/users/me/conversations/conversationId/mark-read 指定された会話の状況を変更します。
/chatter/users/me/conversations/unread-count
コンテキストユーザまたは指定された
ユーザについて未読メッセージがある会
話の数を返します。
/chatter/users/me/files/
外部ファイルへの参照を含む、Salesforce
Files Syncへのファイルの投稿、またはユー
ザが所有するファイルに関する情報の取
得を行います。ユーザと共有されている
ファイル、ユーザがフォローしている
463
Chatter REST API リソース
Users リソース
リソース
説明
ファイル、一般的な組織ファイルは対象
外です。
/chatter/users/me/files/filter/groups
指定されたユーザがメンバーであるグ
ループに投稿されたファイルに関する情
報を返します。
/chatter/users/me/files/filter/sharedwithme
指定されたユーザと共有されているファ
イルに関する情報を返します。
/chatter/users/me/followers
指定されたユーザをフォローしている人
に関する情報を返します。
/chatter/users/me/following
指定されたユーザがフォローしている
人、グループ、レコード、トピック、
ファイルに関するリストを返します。レ
コードのフォローにも使用されます。
/chatter/users/me/groups
指定されたユーザがメンバーであるグ
ループ。
/chatter/users/me/knowledgeable-about-topics
指定されたユーザが知識のあるトピッ
ク。指定されたユーザについてトピック
のリストを取得します。
/chatter/users/me/messages
コンテキストユーザのすべての非公開会
話のすべてのメッセージを返します。す
べてのメッセージを対象とした検索や、
メッセージの投稿にも使用されます。
/chatter/users/me/messages/messageId
指定された Chatter 非公開メッセージを返
します。
/chatter/users/me/photo
ユーザの写真。写真を取得、投稿および
トリミングします。
/chatter/users/me/recommendations
コンテキストユーザへのユーザ、グルー
プ、ファイル、レコード、およびカスタ
ムのおすすめを返します。
/chatter/users/me/recommendations/action
コンテキストユーザへの指定されたアク
ションのおすすめを返します。
/chatter/users/me/recommendations/action/objectCategory コンテキストユーザへの指定されたアク
ションおよびオブジェクトカテゴリのお
すすめを返します。
464
Chatter REST API リソース
User Information
リソース
説明
/chatter/users/me/recommendations/action/idPrefix
コンテキストユーザへの指定されたアク
ションおよびキープレフィックスのおす
すめを返します。
/chatter/users/me/recommendations/action/objectID
コンテキストユーザへの指定されたアク
ションおよびオブジェクト ID のおすすめ
を返します。おすすめの削除にも使用さ
れます。
/chatter/users/userId/recommendations/action/objectEnum コンテキストユーザへの指定されたアク
ションおよびオブジェクト種別の静的な
おすすめを返します。静的なおすすめの
削除にも使用されます。
/connect/communities/communityId
/chatter/users/userId/reputation
指定されたコミュニティユーザの評価を
返します。
/chatter/users/me/settings
コンテキストユーザのグローバル Chatter
設定に関する情報を返します。
/chatter/users/me/status
ユーザの最新の状況フィード項目を返し
ます。ユーザの状況の更新または削除に
も使用されます。
/chatter/users/me/topics
指定されたユーザが最近使用したトピッ
ク。指定されたユーザが最近使用したト
ピックを最大 5 個取得します。
User Information
組織のすべてのユーザに関する情報を返します。
リソース
/chatter/users
/connect/communities/communityId/chatter/users
適用開始バージョン
23.0
Chatter が必要かどうか
はい
HTTP メソッド
GET または HEAD
465
Chatter REST API リソース
User Profile Information
要求パラメータ
パラメータ
型
説明
使用可能
なバー
ジョン
page
Integer
項目のページを指定する整数。デフォルト値は 0 で、最初 23.0
のページを返します。
pageSize
Integer
ページあたりの項目数。有効な値は 1 ～ 250 です。デフォ 23.0
ルト値は 25 です。
q
String
検索する文字列を指定します。検索文字列にはワイルド 23.0
カード文字を除いて 2 文字以上が含まれている必要があり
ます。ワイルドカードについての詳細は、「ワイルドカー
ド」を参照してください。
このパラメータが検索するのはユーザ名で、メールアドレ
ス、役職などは検索しません。
searchContextId
String
検索結果のコンテキストを提供するフィード項目 ID を指定 28.0
します。
このパラメータは、@メンションのコンプリートに使用し
ます。searchContextId にフィード項目 ID を渡すと、返
されたコレクションのスレッドで前にメンションされてい
るユーザが照合されます。
このパラメータを使用する場合、クエリできる結果は 500
以下で、検索語にワイルドカードは使用できません。
レスポンスボディ
User Page
28.0 より前のバージョンでは、User Page レスポンスボディの user プロパティには User Summary または User
Detail レスポンスボディを含めることができます。バージョン 28.0 以降では、常に User Detail が含まれます。
コンテキストユーザへの表示が許可されない項目は、null に設定されます。
User Profile Information
コンテキストユーザまたは指定されたユーザの Chatter プロファイルに関する情報。
リソース
/chatter/users/userId
/connect/communities/communityId/chatter/users/userId
使用可能なバージョン
23.0
466
Chatter REST API リソース
User Profile Information
PATCH は 29.0 で使用可能
Chatter が必要かどうか
はい
HTTP メソッド
GET、HEAD、PATCH
PATCH のリクエストボディ
ルート XML タグ
<user>
プロパティ
名前
型
説明
使用可能なバージョン
aboutMe
String
User Detail レスポンスボ 29.0
ディの aboutMe プロパ
ティ。最大文字数は 1000
文字です。このプロパ
ティが、コミュニティま
たは組織のすべてのメン
バーに表示されるユーザ
プロファイルの [自己紹
介] セクションに入力さ
れます。
JSON の例
{
"aboutMe": "Staff Technical Writer responsible for the Connect API and Connect in
Apex documentation."
}
PATCH の要求パラメータ
名前
型
説明
aboutMe
String
29.0
User Detail レスポンスボ
ディの aboutMe プロパ
ティ。最大文字数は 1000
文字です。このプロパ
ティが、コミュニティま
たは組織のすべてのメン
バーに表示されるユーザ
プロファイルの [自己紹
467
使用可能なバージョン
Chatter REST API リソース
名前
Batch User Information
型
説明
使用可能なバージョン
介] セクションに入力され
ます。
GET のレスポンスボディ
• User Detail — バージョン 26.0 以降。外部ユーザの場合、User Detail レスポンスボディが User Summary レスポ
ンスボディと共有するプロパティに null 以外の値を設定できます。その他のプロパティは常に null で
す。
• User Summary — バージョン 25.0 以前。
PATCH のレスポンスボディ
User Detail
PATCH の要求パラメータの例
この例では、パラメータを使用して aboutMe プロパティを更新します。UI では、このプロパティがユーザ
プロファイルの [自己紹介] セクションに入力されます。
/chatter/users/me?aboutMe=Staff+Technical+Writer+at+Seattle+Apps
PATCH のリクエストボディの例
この例では、リクエストボディを使用して aboutMe プロパティを更新します。
/chatter/users/me
リクエストボディ:
{
"aboutMe": "Staff Technical Writer at Seattle Apps"
}
関連トピック:
ユーザの Chatter 活動の統計情報を取得する
ユーザプロファイルを更新する
Batch User Information
指定されたユーザのプロファイルに関する情報を返します。
リソース
/chatter/users/batch/user_list
/connect/communities/communityId/chatter/users/batch/user_list
user_list は、最大 500 個のユーザ ID から成るカンマ区切りのリストです。
468
Chatter REST API リソース
User Conversations, General
適用開始バージョン
23.0
Chatter が必要かどうか
はい
HTTP メソッド
GET または HEAD
レスポンスボディ
Batch Results
関連トピック:
複数のユーザのユーザ情報を取得する
User Conversations, General
コンテキストユーザの非公開の会話をすべて返します。すべての会話を対象とした検索にも使用されます。
「User Conversations, Specific」 (ページ 470)および「User Messages, General」 (ページ 484)を参照してください。
リソース
/chatter/users/userId/conversations
/connect/communities/communityId/chatter/users/userId/conversations
メモ: userId は、コンテキストユーザの ID または別名 me である必要があります。
適用開始バージョン
23.0
Chatter が必要かどうか
はい
HTTP メソッド
GET または HEAD
GET の要求パラメータ
パラメータ名
型
必須項目/省略可能
説明
page
String
省略可能
取得を開始する場所 23.0
を示すページトーク
ン。レスポンスボ
ディの
NextPageUrl プロ
パティからこのトー
クンを取得します。
pageSize
Integer
省略可能
ページあたりの項目 23.0
数を指定します。有
469
使用可能なバージョ
ン
Chatter REST API リソース
パラメータ名
User Conversations, Specific
型
必須項目/省略可能
説明
使用可能なバージョ
ン
効な値は 1 ～ 100 で
す。サイズを指定し
ない場合、デフォル
トは 25 です。
q
String
省略可能
検索する文字列を指 24.0
定します。検索文字
列にはワイルドカー
ド文字を除いて 2 文
字以上が含まれてい
る必要があります。
ワイルドカードにつ
いての詳細は、「ワ
イルドカード」を参
照してください。こ
のパラメータは省略
可能です。
メモ: クエリ
パラメータが
検索するのは
メッセージテ
キスト本文の
みで、ユーザ
名、役職など
は検索しませ
ん。
レスポンスボディ
Conversation Summary Collection
User Conversations, Specific
コンテキストユーザの指定された非公開の会話に関する情報を返します。特定の会話内の検索にも使用されま
す。
メモ: Conversations リソースを使用して、指定された会話の状況を変更することもできます。「Change Status
of Conversations」 (ページ 472)を参照してください。
リソース
/chatter/users/userId/conversations/conversationId
/connect/communities/communityId/chatter/users/userId/conversations/conversationId
470
Chatter REST API リソース
User Conversations, Specific
メモ: userId は、コンテキストユーザの ID または別名 me である必要があります。
適用開始バージョン
23.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、PATCH、または HEAD
GET の要求パラメータ
パラメータ名
型
必須項目/省略可能
説明
使用可能なバージョ
ン
q
String
省略可能
検索する文字列を指 24.0
定します。検索文字
列にはワイルドカー
ド文字を除いて 2 文
字以上が含まれてい
る必要があります。
ワイルドカードにつ
いての詳細は、「ワ
イルドカード」を参
照してください。こ
のパラメータは省略
可能です。
メモ: クエリ
パラメータが
検索するのは
メッセージテ
キスト本文の
みで、ユーザ
名、役職など
は検索しませ
ん。
PATCH のリクエストボディ
ルート XML タグ
<conversation>
471
Chatter REST API リソース
Change Status of Conversations
プロパティ
名前
型
説明
使用可能なバージョン
read
Boolean
会話状況を未読 (false) 24.0
または既読 (true) に変更
します。
PATCH の要求パラメータ
パラメータ名
型
説明
read
Boolean
会話状況を未読 (false) または既
読 (true) に変更します。
GET または HEAD のレスポンスボディ
Conversation Detail
Change Status of Conversations
指定された会話の状況を変更します。「入力での POST、PATCH、または PUT の使用」も参照してください。
conversations リソースに PATCH を使用しても、指定された会話の状況を変更できます。
リソース
/chatter/users/me/conversations/conversationId/mark-read
使用可能なバージョン
23.0 ～ 29.0
Chatter が必要かどうか
はい
HTTP メソッド
POST または PUT
リクエストボディ
ルート XML タグ
<conversation>
プロパティ
名前
型
説明
read
Boolean
会話状況を未読 (false) 24.0
または既読 (true) に変更
します。
472
使用可能なバージョン
Chatter REST API リソース
Get Unread Count for Conversations
要求パラメータ
パラメータ名
型
説明
read
Boolean
会話状況を未読 (false) または既
読 (true) に変更します。
Get Unread Count for Conversations
コンテキストユーザまたは指定されたユーザについて未読メッセージがある会話の数を返します。
リソース
/chatter/users/userId/conversations/unread-count
/connect/communities/communityId/chatter/users/userId/conversations/unread-count
適用開始バージョン
23.0
HTTP メソッド
GET または HEAD
リクエストボディ
Conversation Unread Count
Users Files, General
外部ファイルへの参照を含む、Salesforce Files Sync へのファイルの投稿、またはユーザが所有するファイルに関
する情報の取得を行います。ユーザと共有されているファイル、ユーザがフォローしているファイル、一般的
な組織ファイルは対象外です。
ファイルを post 送信すると、[ファイル] タブに非公開ファイルとしてアップロードされ、ファイル所有者のみ
が使用できるようになります。
ファイルをアップロードするには、マルチパート/フォームデータ要求で送信する必要があります。ファイル
の説明とタイトルをマルチパート/フォームデータ要求に JSON または XML リクエストボディとして含めること
ができます。情報を要求パラメータとして送信することもできます。マルチパート/フォームデータメッセー
ジを作成する方法についての詳細は、「バイナリファイルのアップロード」を参照してください。
重要: このリソースは、大量のデータを返す場合があり、その場合は処理に時間がかかることがありま
す。
リソース
/chatter/users/userId/files/
/connect/communities/communityId/chatter/users/userId/files/
適用開始バージョン
24.0
473
Chatter REST API リソース
Users Files, General
Chatter が必要かどうか
はい
HTTP メソッド
GET、POST、または HEAD
POST のリクエストボディ
このリクエストボディでは、新しいファイル入力について説明します。ファイルをアップロードするに
は、name="fileData" のマルチパート/フォームデータボディパートにそのバイナリファイルを含める
必要があります。「バイナリファイルのアップロード」を参照してください。
ルート XML タグ
<fileInput>
JSON
{
"desc":"Employee Survey Results",
"title":"emp_surv_results"
}
プロパティ
名前
型
content
Date
ModifiedDate
説明
必須項目/省略
可能
使用可能なバー
ジョン
ファイル固有の最終更新日。クラ 省略可能
イアント側の更新日を設定するた
めに使用できます。
32.0
アップロードするファイルの説
明。
省略可能
24.0
isInMyFileSync Boolean
ファイルが Salesforce Files Sync と同 省略可能
期されている場合は true、同期
されていない場合は false。
31.0
isMajorVersion Boolean
ファイルがメジャーバージョンの 省略可能
場合は true、ファイルがマイ
ナーバージョンの場合は false。
メジャーバージョンを置き換える
ことはできません。
31.0
parentFolderId String
収容フォルダの ID。
省略可能
31.0
String
外部ファイルの ID。
省略可能
32.0
外部データソースの ID。
省略可能
32.0
ファイルのタイトル。
省略可能
24.0
desc
repository
FileId
String
repositoryId String
title
String
474
Chatter REST API リソース
Users Files, General
POST の要求パラメータ
名前
型
説明
必須項目/省略可 使用可能な
能
バージョン
content
ModifiedDate
Date
ファイル固有の最終更新日。クライアント 省略可能
側の更新日を設定するために使用できま
す。
32.0
desc
String
ファイルの説明
省略可能
24.0
isDataSync
Boolean
要求は自動クライアントによって自動生成 省略可能
されます。
31.0
isInMyFileSync Boolean
ファイルが Salesforce Files Sync と同期されて 省略可能
いる場合は true、同期されていない場合
は false。デフォルト値は、false です。
31.0
isMajorVersion Boolean
ファイルがメジャーバージョンの場合は
省略可能
true、ファイルがマイナーバージョンの場
合は false。メジャーバージョンを置き換
えることはできません。デフォルト値は、
false です。
31.0
repository
FileId
String
外部ファイルの ID。
省略可能
32.0
repositoryId
String
外部データソースの ID。
省略可能
32.0
title
String
ファイルのタイトル
省略可能
24.0
GET の要求パラメータ
パラメータ名
型
説明
page
Integer
項目のページを指定する 24.0
整数。デフォルト値は 0
で、最初のページを返し
ます。
pageSize
Integer
ページあたりの項目数を 24.0
指定します。有効な値は
1 ～ 100 です。サイズを指
定しない場合、デフォル
トは 25 です。
q
String
結果を絞り込むクエリ文 27.0
字列。文字列にはワイル
ドカード文字を除いて 2
475
適用開始バージョン
Chatter REST API リソース
パラメータ名
Users Files, General
型
説明
適用開始バージョン
文字以上が含まれている
必要があります。ワイル
ドカードについての詳細
は、「ワイルドカード」
を参照してください。
GET のレスポンスボディ
File Summary Page
POST のレスポンスボディ
File Summary
POST 要求の例
次の例では、新しいファイルを作成し、Salesforce Files Sync にアップロードします。この例は、マルチパー
ト/フォームデータ要求のボディパートを示します。最初のボディパートは File Input リクエストボディです。
2 つ目は、ファイルのコンテンツです。詳細は、「バイナリファイルのアップロード」 を参照してくださ
い。
POST /services/data/v34.0/chatter/users/me/files
Authorization: OAuth
00DD0000000Jhd2!AQIAQC.lh4qTQcBhOPm4TZom5IaOOZLVPVK4wI_rPYJvmE8r2VW8XA.
OZ7S29JEM_7Ctq1lst2dzoV.owisJc0KacUbDxyae
User-Agent: Jakarta Commons-HttpClient/3.0.1
Host: instance_name
Content-Length: 489
Content-Type: multipart/form-data; boundary=a7V4kRcFA8E79pivMuV2tukQ85cmNKeoEgJgq
Accept: application/json
--a7V4kRcFA8E79pivMuV2tukQ85cmNKeoEgJgq
Content-Type: application/json; charset=UTF-8
Content-Disposition: form-data; name="json"
{
"title":"BoatPrices"
476
Chatter REST API リソース
User Files, Filtered by Group
}
--a7V4kRcFA8E79pivMuV2tukQ85cmNKeoEgJgq
Content-Disposition: form-data; name="fileData"; filename="BoatPrices.txt"
Content-Type: application/octet-stream; charset=ISO-8859-1
...contents of BoatPrices.txt...
--a7V4kRcFA8E79pivMuV2tukQ85cmNKeoEgJgq--
User Files, Filtered by Group
指定されたユーザがメンバーであるグループに投稿されたファイルに関する情報を返します。
リソース
/chatter/users/userId/files/filter/groups
/connect/communities/communityId/chatter/users/userId/files/filter/groups
適用開始バージョン
24.0
Chatter が必要かどうか
はい
HTTP メソッド
GET または HEAD
要求パラメータ
パラメータ名
型
説明
page
Integer
項目のページを指定する 24.0
整数。デフォルト値は 0
で、最初のページを返し
ます。
pageSize
Integer
ページあたりの項目数を 24.0
指定します。有効な値は
1 ～ 100 です。サイズを指
定しない場合、デフォル
トは 25 です。
477
適用開始バージョン
Chatter REST API リソース
User Files, Filtered by Sharing
パラメータ名
型
説明
適用開始バージョン
q
String
結果を絞り込むクエリ文 27.0
字列。文字列にはワイル
ドカード文字を除いて 2
文字以上が含まれている
必要があります。ワイル
ドカードについての詳細
は、「ワイルドカード」
を参照してください。
レスポンスボディ
File Summary Page
User Files, Filtered by Sharing
指定されたユーザと共有されているファイルに関する情報を返します。
リソース
/chatter/users/userId/files/filter/shared-with-me
/connect/communities/communityId/chatter/users/userId/files/filter/shared-with-me
メモ: このリソースは、最後のキーワード「shared-with-me」を 1 語にしてもアクセスできます。
/chatter/users/userid/files/filter/sharedwithme
適用開始バージョン
24.0
Chatter が必要かどうか
はい
HTTP メソッド
GET または HEAD
要求パラメータ
パラメータ名
型
説明
page
Integer
項目のページを指定する 24.0
整数。デフォルト値は 0
で、最初のページを返し
ます。
pageSize
Integer
ページあたりの項目数を 24.0
指定します。有効な値は
1 ～ 100 です。サイズを指
478
適用開始バージョン
Chatter REST API リソース
パラメータ名
User Followers
型
説明
適用開始バージョン
定しない場合、デフォル
トは 25 です。
q
結果を絞り込むクエリ文 27.0
字列。文字列にはワイル
ドカード文字を除いて 2
文字以上が含まれている
必要があります。ワイル
ドカードについての詳細
は、「ワイルドカード」
を参照してください。
String
レスポンスボディ
File Summary Page
User Followers
指定されたユーザをフォローしている人に関する情報を返します。
リソース
/chatter/users/userId/followers
/connect/communities/communityId/chatter/users/userId/followers
適用開始バージョン
23.0
Chatter が必要かどうか
はい
HTTP メソッド
GET または HEAD
要求パラメータ
パラメータ名
型
説明
page
Integer
返すページ番号を指定します。デ
フォルト値は 0 で、最初のページ
を返します。
pageSize
Integer
ページあたりの項目数を指定しま
す。有効な値は 1 ～ 1000 です。サ
イズを指定しない場合、デフォル
トは 25 です。
479
Chatter REST API リソース
Following
レスポンスボディ
Follower Page
Following
指定されたユーザがフォローしている人、グループ、レコード、トピック、ファイルに関するリストを返しま
す。レコードのフォローにも使用されます。「入力での POST、PATCH、または PUT の使用」を参照してくださ
い。
メモ: users リソースを使用して、ユーザをグループに追加することはできません。代わりに、groups リ
ソースを使用してください。
リソース
/chatter/users/userId/following
/connect/communities/communityId/chatter/users/userId/following
適用開始バージョン
23.0
トピックのフォローは、バージョン 29.0 以降で使用できます。
Chatter が必要かどうか
はい
HTTP メソッド
GET、POST、または HEAD
POST のリクエストボディ
ルート XML タグ
<following>
プロパティ
名前
型
説明
使用可能なバージョン
subjectId
String
フォローする対象の ID。 23.0
たとえば、ユーザ ID、レ トピック ID は 29.0 で使用
コード ID、ファイル ID、 できます。
トピック ID などがありま
す。
メモ: グループに
メンバーを追加す
る場合には Group
Member Input を使用
します。
480
Chatter REST API リソース
Following
POST の要求パラメータ
パラメータ名
型
説明
使用可能
subjectId
String
23.0
ユーザが指定されたレ
コードをフォローできる トピック ID は 29.0 で使用
ようにします。ユーザ
できます。
ID、ファイル ID、トピッ
ク ID などの場合がありま
す。
GET または HEAD の要求パラメータ
すべてのパラメータは省略可能です。
パラメータ名
型
説明
filterType
String
返されるオブジェクトの種別を絞
り込みするためのキープレフィッ
クスを指定します。キープレ
フィックスは、オブジェクト ID に
含まれる 3 文字のプレフィックス
コードです。オブジェクト ID はオ
ブジェクト型を示す 3 文字のコー
ドが先頭に付けられます。たとえ
ば、User オブジェクトのプレ
フィックスは 005、Group オブジェ
クトのプレフィックスは 0F9 です。
自分でキープレフィックスを生成
する必要はありません。使用可能
なキープレフィックスを確認する
には、List of Filter Feed URLs を使用し
ます。
page
Integer
返すページ番号を指定します。デ
フォルト値は 0 で、最初のページ
を返します。
pageSize
Integer
ページあたりの項目数を指定しま
す。有効な値は 1 ～ 1000 です。サ
イズを指定しない場合、デフォル
トは 25 です。
GET または HEAD のレスポンスボディ
Following Page
481
Chatter REST API リソース
User Groups
POST のレスポンスボディ
Subscription
関連トピック:
レコードをフォローする
ユーザがフォローしているレコードのリストを取得する
User Groups
指定されたユーザがメンバーであるグループ。
リソース
/chatter/users/userId/groups
/connect/communities/communityId/chatter/users/userId/groups
適用開始バージョン
23.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、HEAD
要求パラメータ
パラメータ名
型
説明
必須項目/省略可 使用
能
可能
な
バー
ジョ
ン
page
Token
生成されたトークン。フィード項目のビューを示 省略可能
します。ページトークンは、レスポンスボディの
一部として、nextPageURL など、いずれかの URL
パラメータで返されます。
23.0
pageSize
Integer
ページあたりの項目数を指定します。有効な値は 省略可能
1 ～ 250 です。サイズを指定しない場合、デフォ
ルトは 25 です。
23.0
q
String
検索する文字列を指定します。検索文字列にはワ 省略可能
イルドカード文字を除いて 2 文字以上が含まれて
いる必要があります。「ワイルドカード」を参照
してください。
30.0
482
Chatter REST API リソース
Topics a User is Knowledgeable About
レスポンスボディ
User Group Page
例
次の GET 要求は、コンテキストユーザがメンバーであるグループのうち、その名前または説明に文字 co が
含まれるすべてのグループに関する情報を返します。
/chatter/users/me/groups?q=co
Topics a User is Knowledgeable About
指定されたユーザが知識のあるトピック。指定されたユーザについてトピックのリストを取得します。
リソース
/chatter/users/userId/knowledgeable-about-topics
/connect/communities/communityId/chatter/users/userId/knowledgeable-about-topics
適用開始バージョン
30.0
Chatter が必要かどうか
はい
HTTP メソッド
GET または HEAD
要求パラメータ
パラメータ名
値
説明
必須項目/省略可能
page
Integer
トピックのページを 省略可能
指定する 0 より大き
い整数。デフォルト
値は、0 です。
30.0
pageSize
Integer
ページあたりの項目 省略可能
数を指定します。有
効な値は 1 ～ 100 で
す。デフォルト値は
25 です。
30.0
レスポンスボディ
Topics People Are Knowledgeable About Collection
483
使用可能なバージョ
ン
Chatter REST API リソース
User Messages, General
User Messages, General
コンテキストユーザのすべての非公開会話のすべてのメッセージを返します。すべてのメッセージを対象とし
た検索や、メッセージの投稿にも使用されます。「入力での POST、PATCH、または PUT の使用」を参照してく
ださい。「User Conversations, General」 (ページ 469)も参照してください。
リソース
/chatter/users/userId/messages
/connect/communities/communityId/chatter/users/userId/messages
メモ: userId は、コンテキストユーザの ID または別名 me である必要があります。
適用開始バージョン
23.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、HEAD、POST
POST のリクエストボディ
ルート XML タグ
<message>
プロパティ
名前
型
説明
body
String
メッセージ本文のテキス 23.0
ト
inReplyTo
String
このメッセージが含まれ 23.0
る会話を識別する既存の
メッセージの ID。
recipients または
inReplyTo を指定する
必要があります。両方で
はなく、どちらか一方を
指定する必要がありま
す。
recipients
User Message Recipient List
Input
目的のメッセージ受信者 23.0
であるユーザ (最大 9 人)
のリスト。ユーザ ID のカ
ンマ区切りのリスト。
recipients または
inReplyTo を指定する
必要があります。両方で
484
使用可能なバージョン
Chatter REST API リソース
User Messages, General
名前
型
説明
使用可能なバージョン
はなく、どちらか一方を
指定する必要がありま
す。
XML 形式の例:
<message>
<body>Text of the message</body>
<recipients>
<recipient>userID</recipient>
<recipient>userID</recipient>
</recipients>
<inReplyTo>messageID</inReplyTo>
</message>
JSON 形式の例:
{
"body": "Text of the message",
"recipients": ["userID","userID"],
"inReplyTo": "messageID"
}
POST の要求パラメータ
パラメータ名
型
必須項目/省略可能
説明
使用可能なバージョ
ン
inReplyTo
String
recipients または このメッセージが含 23.0
inReplyTo を指定 まれる会話を識別す
する必要がありま る既存のメッセージ
す。両方を指定する の ID
ことはできません。
recipients
String
recipients または 目的のメッセージ受 23.0
inReplyTo を指定 信者であるユーザ
485
Chatter REST API リソース
パラメータ名
User Messages, General
型
必須項目/省略可能
説明
使用可能なバージョ
ン
する必要がありま (最大 9 人) のリス
す。両方を指定する ト。ユーザ ID のカ
ことはできません。 ンマ区切りのリス
ト。
String
必須項目
メッセージのテキス 23.0
ト (最大 10,000 文字)
パラメータ名
型
必須項目/省略可能
説明
page
String
省略可能
取得を開始する場所 23.0
を示すページトーク
ン。レスポンスボ
ディの
NextPageUrl プロ
パティからこのトー
クンを取得します。
pageSize
Integer
省略可能
ページあたりの項目 23.0
数を指定します。有
効な値は 1 ～ 100 で
す。サイズを指定し
ない場合、デフォル
トは 25 です。
q
String
省略可能
検索する文字列を指 24.0
定します。検索文字
列にはワイルドカー
ド文字を除いて 2 文
字以上が含まれてい
る必要があります。
ワイルドカードにつ
いての詳細は、「ワ
イルドカード」を参
照してください。こ
のパラメータは省略
可能です。
text
GET の要求パラメータ
使用可能なバージョ
ン
メモ: クエリ
パラメータが
検索するのは
486
Chatter REST API リソース
User Messages, General
パラメータ名
型
必須項目/省略可能
説明
使用可能なバージョ
ン
メッセージテ
キスト本文の
みで、ユーザ
名、役職など
は検索しませ
ん。
GET または HEAD のレスポンスボディ
Message Collection
POST のレスポンスボディ
Message
GET または HEAD のレスポンスボディの例
{
"currentPageUrl": "/services/data/v34.0/chatter/users/me/messages",
"messages": [
{
"body": {
"messageSegments": [],
"text": "Will you be able to meet about your Dreamforce presentation this
week?"
},
"conversationId": "03MD000000002LTMAY",
"conversationUrl":
"/services/data/v34.0/chatter/users/me/conversations/03MD000000002LTMAY",
"id": "03JD000000003XGMAY",
"recipients": [
{
"companyName": "SeattleApps",
"firstName": "Rene",
"id": "005D0000001LFNnIAO",
487
Chatter REST API リソース
User Messages, General
"isActive": true,
"lastName": "Holmes",
"motif": {
"color": "1797C0",
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png"
},
"mySubscription": null,
"name": "Rene Holmes",
"photo": {
"fullEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sZVyX4qlsJTXfOWM77RW7yt",
"largePhotoUrl":
"https://instance_name/profilephoto/729D00000000XA5/F",
"photoVersionId": "729D00000000XA5",
"smallPhotoUrl":
"https://instance_name/profilephoto/729D00000000XA5/T",
"standardEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sbktFTIf9vWhFTTALJiaFz_",
"url": "/services/data/v34.0/chatter/users/005D0000001LLO6IAO/photo"
},
"title": "Senior Manager",
"type": "User",
"url": "/services/data/v34.0/chatter/users/005D0000001LFNnIAO",
"userType": "Internal"
},
{
488
Chatter REST API リソース
User Messages, General
"companyName": null,
"firstName": "Desmond",
"id": "005D0000001LJvOIAW",
"isActive": true,
"lastName": "Catillo",
"motif": {
"color": "1797C0",
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png"
},
"mySubscription": null,
"name": "Desmond Catillo",
"photo": {
"fullEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sZVyX4qlsJTXfOWM77RW7yt",
"largePhotoUrl":
"https://instance_name/profilephoto/729D00000000XA5/F",
"photoVersionId": "729D00000000XA5",
"smallPhotoUrl":
"https://instance_name/profilephoto/729D00000000XA5/T",
"standardEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sbktFTIf9vWhFTTALJiaFz_",
"url": "/services/data/v34.0/chatter/users/005D0000001LLO1IAO/photo"
},
"title": "Senior Manager",
"type": "User",
489
Chatter REST API リソース
User Messages, General
"url": "/services/data/v34.0/chatter/users/005D0000001LJvOIAW",
"userType": "Internal"
}
],
"sender": {
"companyName": "SeattleApps",
"firstName": "Rene",
"id": "005D0000001LFNnIAO",
"isActive": true,
"lastName": "Holmes",
"motif": {
"color": "1797C0",
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png"
},
"mySubscription": null,
"name": "Rene Holmes",
"photo": {
"fullEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sZVyX4qlsJTXfOWM77RW7yt",
"largePhotoUrl": "https://instance_name/profilephoto/729D00000000XA5/F",
"photoVersionId": "729D00000000XA5",
"smallPhotoUrl": "https://instance_name/profilephoto/729D00000000XA5/T",
"standardEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sbktFTIf9vWhFTTALJiaFz_",
"url": "/services/data/v34.0/chatter/users/005D0000001LLO6IAO/photo"
490
Chatter REST API リソース
User Messages, General
},
"title": "Senior Manager",
"type": "User",
"url": "/services/data/v34.0/chatter/users/005D0000001LFNnIAO",
"userType": "Internal"
},
"sentDate": "2012-07-20T21:27:07.000Z",
"url": "/services/data/v34.0/chatter/users/me/messages/03JD000000003XGMAY"
},
{
"body": {
"messageSegments": [],
"text": "Rene Holmes has shared Recruitment Poster.png with you on
Chatter.\n\nPlease review.\n\nTo view the file, go to:
https://na1-blitz01.soma.salesforce.com/069D00000001E32"
},
"conversationId": "03MD000000002LTMAY",
"conversationUrl":
"/services/data/v34.0/chatter/users/me/conversations/03MD000000002LTMAY",
"id": "03JD000000003VAMAY",
"recipients": [
{
"companyName": "SeattleApps",
"firstName": "Rene",
"id": "005D0000001LFNnIAO",
"isActive": true,
"lastName": "Holmes",
"motif": {
"color": "1797C0",
491
Chatter REST API リソース
User Messages, General
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png"
},
"mySubscription": null,
"name": "Rene Holmes",
"photo": {
"fullEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sZVyX4qlsJTXfOWM77RW7yt",
"largePhotoUrl":
"https://instance_name/profilephoto/729D00000000XA5/F",
"photoVersionId": "729D00000000XA5",
"smallPhotoUrl":
"https://instance_name/profilephoto/729D00000000XA5/T",
"standardEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sbktFTIf9vWhFTTALJiaFz_",
"url": "/services/data/v34.0/chatter/users/005D0000001LLO6IAO/photo"
},
"title": "Senior Manager",
"type": "User",
"url": "/services/data/v34.0/chatter/users/005D0000001LFNnIAO",
"userType": "Internal"
},
{
"companyName": null,
"firstName": "Desmond",
"id": "005D0000001LJvOIAW",
492
Chatter REST API リソース
User Messages, General
"isActive": true,
"lastName": "Catillo",
"motif": {
"color": "1797C0",
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png"
},
"mySubscription": null,
"name": "Desmond Catillo",
"photo": {
"fullEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sZVyX4qlsJTXfOWM77RW7yt",
"largePhotoUrl":
"https://instance_name/profilephoto/729D00000000XA5/F",
"photoVersionId": "729D00000000XA5",
"smallPhotoUrl":
"https://instance_name/profilephoto/729D00000000XA5/T",
"standardEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sbktFTIf9vWhFTTALJiaFz_",
"url": "/services/data/v34.0/chatter/users/005D0000001LLO1IAO/photo"
},
"title": "Senior Manager",
"type": "User",
"url": "/services/data/v34.0/chatter/users/005D0000001LJvOIAW",
"userType": "Internal"
}
],
493
Chatter REST API リソース
User Messages, General
"sender": {
"companyName": "SeattleApps",
"firstName": "Rene",
"id": "005D0000001LFNnIAO",
"isActive": true,
"lastName": "Holmes",
"motif": {
"color": "1797C0",
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png"
},
"mySubscription": null,
"name": "Rene Holmes",
"photo": {
"fullEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sZVyX4qlsJTXfOWM77RW7yt",
"largePhotoUrl": "https://instance_name/profilephoto/729D00000000XA5/F",
"photoVersionId": "729D00000000XA5",
"smallPhotoUrl": "https://instance_name/profilephoto/729D00000000XA5/T",
"standardEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sbktFTIf9vWhFTTALJiaFz_",
"url": "/services/data/v34.0/chatter/users/005D0000001LLO6IAO/photo"
},
"title": "Senior Manager",
"type": "User",
494
Chatter REST API リソース
User Messages, Specific
"url": "/services/data/v34.0/chatter/users/005D0000001LFNnIAO",
"userType": "Internal"
},
"sentDate": "2012-07-18T19:01:51.000Z",
"url": "/services/data/v34.0/chatter/users/me/messages/03JD000000003VAMAY"
},
"nextPageUrl": null
}
関連トピック:
非公開メッセージを送信する
User Messages, Specific
指定された Chatter 非公開メッセージを返します。
リソース
/chatter/users/userId/messages/messageId
/connect/communities/communityId/chatter/users/userId/messages/messageId
メモ: userId は、コンテキストユーザの ID または別名 me である必要があります。
適用開始バージョン
23.0
Chatter が必要かどうか
はい
HTTP メソッド
GET または HEAD
レスポンスボディ
Message
User Photo
ユーザの写真。写真を取得、投稿およびトリミングします。
[ファイル] ページからの画像をユーザの写真として使用するには、リクエストボディの fileId プロパティま
たは fileId 要求パラメータでファイル ID を渡します。[ユーザ] ページでアップロードした画像にはファイル
ID は含まれず、fileId としては使用できません。
495
Chatter REST API リソース
User Photo
バイナリファイルをユーザの写真としてアップロードするには、マルチパート/フォームデータメッセージで
そのファイルを送信する必要があります。マルチパート/フォームデータメッセージを作成する方法について
の詳細は、「バイナリファイルのアップロード」を参照してください。
ユーザプロファイルの写真をフィードに表示するには、ユーザの写真をキャッシュします。次に、Photo レス
ポンスボディの photoVersionId プロパティを使用して、いつ写真を更新する必要があるかを判断します。
この方法により、制限を超えて実行することを避け、モバイルクライアントのパフォーマンスを改善できる場
合があります。
リソース
/chatter/users/userId/photo
/connect/communities/communityId/chatter/users/userId/photo
適用開始バージョン
23.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、POST、または HEAD
POST のリクエストボディ
ルート XML タグ
<photo>
JSON の例
{
"cropSize" : "120",
"cropX" : "0",
"cropY" : "0",
"fileId" : "069D00000001IOh"
}
プロパティ
名前
型
説明
必須項目/省略可能
cropSize
Integer
トリミングする正方形の任意 アップロードされたファイ 29.0
の境界の長さ (ピクセル単
ルまたは既存のファイルを
位)。
トリミングする必要があり
ます。
cropX
Integer
画像の左端を起点とした、ト
リミングする正方形の開始位
置 X (ピクセル単位)。左上の位
置は (0,0) です。
496
使用可能な
バージョン
アップロードされたファイ 29.0
ルまたは既存のファイルを
トリミングする必要があり
ます。
Chatter REST API リソース
User Photo
名前
型
説明
必須項目/省略可能
使用可能な
バージョン
cropY
Integer
画像の上端を起点とした、ト
リミングする正方形の開始位
置 Y (ピクセル単位)。左上の位
置は (0,0) です。
アップロードされたファイ 29.0
ルまたは既存のファイルを
トリミングする必要があり
ます。
fileId
String
既存のファイルの 18 文字の 既存のファイルを選択する 25.0
ID。キープレフィックスは
必要があります。
069、ファイルサイズは 2 MB
未満にする必要があります。
メモ: グループページお
よびユーザページにアッ
プロードされた画像には
ファイル ID がないた
め、使用できません。
Integer
versionNumber
既存のファイルのバージョン 省略可能
番号。指定されていない場
合、最新のバージョンが使用
されます。
25.0
POST の要求パラメータ
パラメータ名
型
説明
必須項目/省略可能
cropSize
Integer
トリミングする正方 アップロードされた 29.0
形の任意の境界の長 ファイルまたは既存
さ (ピクセル単位)。 のファイルをトリミ
ングする必要があり
ます。
cropX
Integer
画像の左端を起点と
した、トリミングす
る正方形の開始位置
X (ピクセル単位)。
左上の位置は (0,0) で
す。
アップロードされた 29.0
ファイルまたは既存
のファイルをトリミ
ングする必要があり
ます。
cropY
Integer
画像の上端を起点と
した、トリミングす
る正方形の開始位置
Y (ピクセル単位)。
アップロードされた 29.0
ファイルまたは既存
のファイルをトリミ
ングする必要があり
ます。
497
使用可能なバージョ
ン
Chatter REST API リソース
パラメータ名
User Photo
型
説明
必須項目/省略可能
使用可能なバージョ
ン
左上の位置は (0,0) で
す。
fileId
String
既存のファイルの 18 既存のファイルを選 25.0
文字の ID。キープレ 択する必要がありま
フィックスは 069、 す。
ファイルサイズは 2
MB 未満にする必要
があります。
メモ: [グルー
プ] ページおよ
び [ユーザプロ
ファイル] ペー
ジでアップ
ロードした
ファイルには
ファイル ID は
含まれず、投
稿やトリミン
グはできませ
ん。[ファイ
ル] ページで
アップロード
したファイル
にはファイル
ID は含まれ
ず、投稿やト
リミングはで
きません。
versionNumber
Integer
既存のコンテンツの 省略可能
バージョン番号。指
定されていない場
合、最新のバージョ
ンが使用されます。
メモ: 写真は非同期に処理され、すぐには表示されない場合があります。
GET または HEAD のレスポンスボディ
Photo
498
25.0
Chatter REST API リソース
User Recommendations, General
POST のレスポンスボディ
Photo
関連トピック:
ユーザの写真を更新およびトリミングする
User Recommendations, General
コンテキストユーザへのユーザ、グループ、ファイル、レコード、およびカスタムのおすすめを返します。
リソース
/chatter/users/userId/recommendations
/connect/communities/communityId/chatter/users/userId/recommendations
メモ: userId は、コンテキストユーザの ID または別名 me である必要があります。
適用開始バージョン
24.0
Chatter が必要かどうか
はい
HTTP メソッド
GET または HEAD
GET の要求パラメータ
パラメータ名
型
説明
contextAction
String
ユーザが直前に実行した 33.0
アクション。サポートさ
れている値は、次のとお
りです。
• follow
• view
直前に実行されたアク
ションに基づいて新しい
おすすめを取得するに
は、contextAction と
contextObjectId を一
緒に使用します。
499
使用可能なバージョン
Chatter REST API リソース
User Recommendations, General
パラメータ名
型
説明
使用可能なバージョン
contextObjectId
String
ユーザが直前に実行した 33.0
アクションのオブジェク
トの ID。
• contextAction が
follow の場合、
contextObjectId
は、ユーザ ID、ファイ
ル ID、またはレコード
ID になります。
• contextAction が
view の場合、
contextObjectId
は、ユーザ ID、ファイ
ル ID、グループ ID、ま
たはレコード ID にな
ります。
直前に実行されたアク
ションに基づいて新しい
おすすめを取得するに
は、contextAction と
contextObjectId を一
緒に使用します。
followed
String
ユーザの ID。このユーザ 23.0 ～ 32.0
ID のコンテキストに基づ
いて新しいおすすめを提
供します。
重要: バージョン
33.0 以降では、
contextAction お
よび
contextObjectId
を使用します。
maxResults
Integer
23.0
おすすめの結果の最大
数。デフォルトは 10 で
す。値は 0 よりも大きく
する必要があります。
viewed
String
ファイルの ID。このファ 23.0 ～ 33.0
イル ID のコンテキストに
基づいて新しいおすすめ
を提供します。
500
Chatter REST API リソース
パラメータ名
User Recommendations for a Specific Action
型
説明
使用可能なバージョン
重要: バージョン
33.0 以降では、
contextAction お
よび
contextObjectId
を使用します。
レスポンスボディ
Recommendations
User Recommendations for a Specific Action
コンテキストユーザへの指定されたアクションのおすすめを返します。
リソース
/chatter/users/userId/recommendations/action
/connect/communities/communityId/chatter/users/userId/recommendations/action
メモ: userId は、コンテキストユーザの ID または別名 me である必要があります。
action の有効値と、その結果返されるおすすめは次のようになります。
• follow は、フォローするユーザ、ファイル、およびレコードのおすすめを返します。
• join は、参加するグループのおすすめを返します。
• view は、表示するユーザ、ファイル、グループ、およびレコードのおすすめを返します (バージョン
25.0 以降)。バージョン 34.0 以降、view はカスタムのおすすめも返します。
適用開始バージョン
24.0
Chatter が必要かどうか
はい
HTTP メソッド
GET または HEAD
GET の要求パラメータ
パラメータ名
型
説明
contextAction
String
ユーザが直前に実行した 33.0
アクション。サポートさ
れている値は、次のとお
りです。
• follow
501
使用可能なバージョン
Chatter REST API リソース
パラメータ名
User Recommendations for a Specific Action
型
説明
使用可能なバージョン
• view
直前に実行されたアク
ションに基づいて新しい
おすすめを取得するに
は、contextAction と
contextObjectId を一
緒に使用します。
contextObjectId
String
ユーザが直前に実行した 33.0
アクションのオブジェク
トの ID。
• contextAction が
follow の場合、
contextObjectId
は、ユーザ ID、ファイ
ル ID、またはレコード
ID になります。
• contextAction が
view の場合、
contextObjectId
は、ユーザ ID、ファイ
ル ID、グループ ID、ま
たはレコード ID にな
ります。
直前に実行されたアク
ションに基づいて新しい
おすすめを取得するに
は、contextAction と
contextObjectId を一
緒に使用します。
followed
String
ユーザの ID。このユーザ 23.0 ～ 32.0
ID のコンテキストに基づ
いて新しいおすすめを提
供します。
重要: バージョン
33.0 以降では、
contextAction お
よび
contextObjectId
を使用します。
502
Chatter REST API リソース
User Recommendations for a Specific Action and Object
Category
パラメータ名
型
説明
使用可能なバージョン
maxResults
Integer
23.0
おすすめの結果の最大
数。デフォルトは 10 で
す。値は 0 よりも大きく
する必要があります。
viewed
String
ファイルの ID。このファ 23.0 ～ 33.0
イル ID のコンテキストに
基づいて新しいおすすめ
を提供します。
重要: バージョン
33.0 以降では、
contextAction お
よび
contextObjectId
を使用します。
レスポンスボディ
Recommendations
User Recommendations for a Specific Action and Object Category
コンテキストユーザへの指定されたアクションおよびオブジェクトカテゴリのおすすめを返します。
リソース
/chatter/users/userId/recommendations/action/objectCategory
/connect/communities/communityId/chatter/users/userId/recommendations/action/objectCategory
メモ: userId は、コンテキストユーザの ID または別名 me である必要があります。
• action の有効値は次のとおりです。
– follow
– join
– view (バージョン 25.0 以降)
• objectCategory の有効値は次のとおりです。
– action が follow の場合、objectCategory は users、files、または records になります。
– action が join の場合、objectCategory は groups になります。
– action が view の場合、objectCategory は users、files、groups、records、または custom
になります (バージョン 34.0 以降)。
適用開始バージョン
23.0
503
Chatter REST API リソース
User Recommendations for a Specific Action and Object
Category
Chatter が必要かどうか
はい
HTTP メソッド
GET、HEAD
GET の要求パラメータ
パラメータ名
型
説明
使用可能なバージョン
contextAction
String
ユーザが直前に実行した 33.0
アクション。サポートさ
れている値は、次のとお
りです。
• follow
• view
直前に実行されたアク
ションに基づいて新しい
おすすめを取得するに
は、contextAction と
contextObjectId を一
緒に使用します。
contextObjectId
String
ユーザが直前に実行した 33.0
アクションのオブジェク
トの ID。
• contextAction が
follow の場合、
contextObjectId
は、ユーザ ID、ファイ
ル ID、またはレコード
ID になります。
• contextAction が
view の場合、
contextObjectId
は、ユーザ ID、ファイ
ル ID、グループ ID、ま
たはレコード ID にな
ります。
直前に実行されたアク
ションに基づいて新しい
おすすめを取得するに
は、contextAction と
contextObjectId を一
緒に使用します。
504
Chatter REST API リソース
User Recommendations for a Specific Action and Object
Category
パラメータ名
型
説明
使用可能なバージョン
followed
String
ユーザの ID。このユーザ 23.0 ～ 32.0
ID のコンテキストに基づ
いて新しいおすすめを提
供します。
重要: バージョン
33.0 以降では、
contextAction お
よび
contextObjectId
を使用します。
maxResults
Integer
23.0
おすすめの結果の最大
数。デフォルトは 10 で
す。値は 0 よりも大きく
する必要があります。
viewed
String
ファイルの ID。このファ 23.0 ～ 33.0
イル ID のコンテキストに
基づいて新しいおすすめ
を提供します。
重要: バージョン
33.0 以降では、
contextAction お
よび
contextObjectId
を使用します。
GET のレスポンスボディ
Recommendations
直前に実行されたアクションに基づいて新しいおすすめを取得するための要求 URL の例
ユーザ ID が 005D0000001GLowIAB である Pam を直前にフォローした場合、次の URL を使用します。
/chatter/users/me/recommendations/follow/users?contextAction=follow&contextObjectId=005D0000001GLowIAB
これにより、Pam をフォローするユーザがフォローしているユーザのおすすめのみが取得されます。この
例では、John が Pam をフォローしており、John は Suzanne もフォローしているため、Suzanne をフォローす
るためのおすすめが取得されます。
505
Chatter REST API リソース
User Recommendations for a Specific Action and Key Prefix
自分が参照中のファイルを参照したユーザが参照したファイルのリストを取得するための要求 URL の例
次の URL では、所定のファイル ID のファイル詳細ページの [ユーザがその他に参照しているもの] 領域に表
示されるリストが表示されます。
/chatter/users/me/recommendations/view/files?contextAction=view&contextObjectId=069D00000000xNXIAY
関連トピック:
フォローするユーザのおすすめを取得する
User Recommendations for a Specific Action and Key Prefix
コンテキストユーザへの指定されたアクションおよびキープレフィックスのおすすめを返します。
リソース
/chatter/users/userId/recommendations/action/idPrefix
/connect/communities/communityId/chatter/users/userId/recommendations/action/idPrefix
メモ: userId は、コンテキストユーザの ID または別名 me である必要があります。
• action の有効値は次のとおりです。
– follow
– join
– view
• キープレフィックス、つまりリソース URL 内の idPrefix はオブジェクト ID の最初の 3 文字であり、オ
ブジェクト種別を示します。この URL の idPrefix の有効値は次のとおりです。
– action が follow の場合、idPrefix はユーザ (005)、ファイル (069)、またはレコード (001 や 003 な
ど) のキープレフィックスです。
506
Chatter REST API リソース
User Recommendations for a Specific Action and Key Prefix
– action が join の場合、idPrefix はグループ (0F9) のキープレフィックスです。
– バージョン 34.0 以降では、action が view の場合、idPrefix はユーザ (005)、ファイル (069)、グ
ループ (0F9)、レコード (001 や 003 など)、またはカスタムのおすすめ (0RD) のキープレフィックスで
す。
適用開始バージョン
26.0
Chatter が必要かどうか
はい
HTTP メソッド
GET または HEAD
GET の要求パラメータ
パラメータ名
型
説明
使用可能なバージョン
contextAction
String
ユーザが直前に実行した 33.0
アクション。サポートさ
れている値は、次のとお
りです。
• follow
• view
直前に実行されたアク
ションに基づいて新しい
おすすめを取得するに
は、contextAction と
contextObjectId を一
緒に使用します。
contextObjectId
String
ユーザが直前に実行した 33.0
アクションのオブジェク
トの ID。
• contextAction が
follow の場合、
contextObjectId
は、ユーザ ID、ファイ
ル ID、またはレコード
ID になります。
• contextAction が
view の場合、
contextObjectId
は、ユーザ ID、ファイ
ル ID、グループ ID、ま
たはレコード ID にな
ります。
507
Chatter REST API リソース
パラメータ名
User Recommendations for a Specific Action and Key Prefix
型
説明
使用可能なバージョン
直前に実行されたアク
ションに基づいて新しい
おすすめを取得するに
は、contextAction と
contextObjectId を一
緒に使用します。
followed
String
ユーザの ID。このユーザ 23.0 ～ 32.0
ID のコンテキストに基づ
いて新しいおすすめを提
供します。
重要: バージョン
33.0 以降では、
contextAction お
よび
contextObjectId
を使用します。
maxResults
Integer
23.0
おすすめの結果の最大
数。デフォルトは 10 で
す。値は 0 よりも大きく
する必要があります。
viewed
String
ファイルの ID。このファ 23.0 ～ 33.0
イル ID のコンテキストに
基づいて新しいおすすめ
を提供します。
重要: バージョン
33.0 以降では、
contextAction お
よび
contextObjectId
を使用します。
リクエスト URL の例
/chatter/users/me/recommendations/view/001
GET のレスポンスボディ
Recommendations
508
Chatter REST API リソース
User Recommendations for a Specific Action and Object ID
User Recommendations for a Specific Action and Object ID
コンテキストユーザへの指定されたアクションおよびオブジェクト ID のおすすめを返します。おすすめの削
除にも使用されます。
リソース
/chatter/users/userId/recommendations/action/objectId
/connect/communities/communityId/chatter/users/userId/recommendations/action/objectId
メモ: userId は、コンテキストユーザの ID または別名 me である必要があります。
• action の有効値は次のとおりです。
– follow
– join
– view (バージョン 25.0 以降)
• objectId の有効値は次のとおりです。
– action が follow の場合、objectId は、ユーザ ID、ファイル ID、またはレコード ID です。
– action が join の場合、objectId はグループ ID です。
– action が view の場合、objectId は、ユーザ ID、ファイル ID、グループ ID、レコード ID、または
カスタムのおすすめ ID です (バージョン 34.0 以降)。
適用開始バージョン
24.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、DELETE、または HEAD
DELETE は、おすすめの削除に使用され、次のリソースでのみ有効です。
• /chatter/users/userId/recommendations/follow/recommendedUserId
• /chatter/users/userId/recommendations/follow/recommendedFileId
• /chatter/users/userId/recommendations/follow/recommendedRecordId
• /chatter/users/userId/recommendations/join/recommendedGroupId
• /chatter/users/userId/recommendations/view/customRecommendationId
メモ: userId は、コンテキストユーザの ID または別名 me である必要があります。
GET のレスポンスボディ
Recommendations
DELETE のレスポンスボディ
204: DELETE が成功しました
509
Chatter REST API リソース
User Recommendations for a Specific Action and Object Type
User Recommendations for a Specific Action and Object Type
コンテキストユーザへの指定されたアクションおよびオブジェクト種別の静的なおすすめを返します。静的な
おすすめの削除にも使用されます。
リソース
/chatter/users/userId/recommendations/action/objectEnum
/connect/communities/communityId/chatter/users/userId/recommendations/action/objectEnum
メモ: userId は、コンテキストユーザの ID または別名 me である必要があります。
• action の有効値は次のとおりです。
– view
• objectEnum の有効値は次のとおりです。
– Today — ID のない静的なおすすめ (Today アプリケーションのおすすめなど)。
使用可能なバージョン
34.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、DELETE、HEAD
GET のレスポンスボディ
Recommendations
DELETE のレスポンスボディ
204: DELETE が成功しました
User Reputation
指定されたコミュニティユーザの評価を返します。
リソース
/connect/communities/communityId/chatter/users/userId/reputation
使用可能なバージョン
32.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、HEAD
レスポンスボディ
Reputation
510
Chatter REST API リソース
User Settings
User Settings
コンテキストユーザのグローバル Chatter 設定に関する情報を返します。
リソース
/chatter/users/userId/settings
/connect/communities/communityId/chatter/users/userId/settings
メモ: userId は、コンテキストユーザの ID または別名 me である必要があります。
適用開始バージョン
27.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、HEAD、または PATCH
PATCH のリクエストボディ
ルート XML タグ
<userChatterSettings>
プロパティ
名前
型
説明
defaultGroup
EmailFrequency
String
ユーザが参加するグループからメー 27.0
ルを受信するデフォルトの頻度。有
効な値は、次のとおりです。
• EachPost
• DailyDigest
• WeeklyDigest
• Never
コミュニティでは、グループメンバー
が 10,000 人を超えると [各投稿のメー
ル] オプションが無効になります。こ
のオプションを選択したすべてのメ
ンバーは、自動的に [毎日のダイジェ
スト] に切り替わります。
511
使用可能な
バージョン
Chatter REST API リソース
User Status
PATCH の要求パラメータ
パラメータ名
型
説明
適用開始バージョン
defaultGroup
EmailFrequency
String
ユーザが参加するグルー 27.0
プからメールを受信する
デフォルトの頻度。この
設定は、ユーザがすでに
メンバーであるグループ
には影響しません。有効
な値は、次のとおりで
す。
• EachPost
• DailyDigest
• WeeklyDigest
• Never
GET、HEAD、または PATCH のレスポンスボディ
User Chatter Settings
GET のレスポンスボディの例
{"defaultGroupEmailFrequency": "Never"}
User Status
メモ: このリソースは、バージョン 25.0 以降、使用できなくなります。代わり
に、/chatter/feeds/news/me/feed-items など、フィード項目 (feed-items) を指定した Feeds リソース
を使用してください。
ユーザの最新の状況フィード項目を返します。ユーザの状況の更新または削除にも使用されます。「入力での
POST、PATCH、または PUT の使用」を参照してください。
リソース
/chatter/users/me/status
または
/chatter/users/userId/status
使用可能なバージョン
23.0 ～ 24.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、DELETE、POST、または HEAD
512
Chatter REST API リソース
Topics Recently Used
POST のリクエストボディ
ルート XML タグ
<userStatus>
プロパティ
名前
型
説明
使用可能なバージョン
body
Message Body Input
メッセージ本文の説明。 23.0 ～ 24.0
POST の要求パラメータ
名前
型
説明
text
String 投稿するテキスト
ユーザの状況に post 送信する項目
のテキスト
GET または POST のレスポンスボディ
User Status
Topics Recently Used
指定されたユーザが最近使用したトピック。指定されたユーザが最近使用したトピックを最大 5 個取得しま
す。
リソース
/chatter/users/userId/topics
/connect/communities/communityId/chatter/users/userId/topics
適用開始バージョン
28.0
Chatter が必要かどうか
はい
HTTP メソッド
GET または HEAD
レスポンスボディ
Topic Collection
Zones リソース
Chatter アンサーゾーンに関する情報。
使用可能なリソース:
513
Chatter REST API リソース
List of Zones
リソース
説明
/connect/zones
組織の Chatter アンサーゾーンのリスト。コンテキス
トユーザが使用できるゾーンに関する情報を取得しま
す。
/connect/zones/zoneId
指定された Chatter アンサーゾーンに関する情報。
/connect/zones/zoneId/searchResults
Chatter アンサーゾーン内の検索の検索結果。
List of Zones
組織のChatter アンサーゾーンのリスト。コンテキストユーザが使用できるゾーンに関する情報を取得します。
リソース
/connect/zones/
/connect/communities/communityId/zones/
使用可能なバージョン
29.0
Chatter が必要かどうか
いいえ
HTTP メソッド
GET
GET の要求パラメータ
パラメータ名
型
説明
使用可能なバー
ジョン
page
Integer
項目のページを指定する整数。デフォルト値
は 0 で、最初のページを返します。
29.0
pageSize
Integer
ページあたりの項目数を指定します。有効な
値は 1 ～ 250 です。デフォルト値は 25 です。
29.0
GET のレスポンスボディ
Zone Page
Zone Information
指定された Chatter アンサーゾーンに関する情報。
514
Chatter REST API リソース
Zone Search Results
リソース
/connect/zones/zoneId
/connect/communities/communityId/zones/zoneId
使用可能なバージョン
29.0
Chatter が必要かどうか
いいえ
HTTP メソッド
GET
GET のレスポンスボディ
Zone
Zone Search Results
Chatter アンサーゾーン内の検索の検索結果。
リソース
/connect/zones/zoneId/search-results
/connect/communities/communityId/zones/zoneId/search-results
使用可能なバージョン
29.0
Chatter が必要かどうか
いいえ
HTTP メソッド
GET
GET の要求パラメータ
パラメータ名
型
説明
使用可能なバー
ジョン
page
Integer
項目のページを指定する整数。デフォルト値
は 0 で、最初のページを返します。
29.0
pageSize
Integer
ページあたりの項目数を指定します。有効な
値は 1 ～ 100 です。デフォルト値は 20 です。
29.0
GET のレスポンスボディ
Zone Search Result
515
第6章
Chatter REST API リクエストボディ
POST、PATCH、または PUT 要求を実行するには、クエリパラメータを渡すか、XML または JSON 形式のリクエス
トボディを作成します。この章には、リクエストボディのリストが記載されています。クエリパラメータは、
各リソースと一緒にリストに含まれています。
JSON リクエストボディを作成するには、JSON 形式でリクエストボディのプロパティを指定します。
Comment リクエストボディの例を次に示します。
{
"body" : "Let's look for a new solution."
}
最上位レベルのリクエストボディの場合は、ルート XML タグが表示されます。XML リクエストボディを作成す
るには、プロパティをルート XML タグの内部に XML タグとしてネストします。
同じ Connect リクエストボディに XML 形式を使用すると次のようになります。
<comment>
<body>Let's look for a new solution.</body>
</comment>
Action Link Definition Input
アクションリンクの定義。アクションリンクは、フィード要素上のボタンです。アクションリンクをクリック
すると、ユーザを特定の Web ページに移動したり、ファイルダウンロードを開始したり、Salesforceまたは外部
サーバへの API コールを呼び出したりできます。アクションリンクには、URL と HTTP メソッドが含まれ、リク
エストボディとヘッダー情報 (認証用の OAuth トークンなど) を含めることができます。アクションリンクを使
用してSalesforceおよびサードパーティサービスをフィードに統合することで、ユーザはアクションを実行して
生産性を高め、イノベーションを促進できます。
使用方法
コンテキスト変数は、actionUrl、headers、および requestBody プロパティで使用できます。コンテキス
ト変数を使用して、アクションリンクを実行したユーザに関する情報をサーバ側のコードに渡すことができま
す。アクションリンクが実行されたときに、Salesforce によって値が代入されます。
使用可能なコンテキスト変数は次のとおりです。
コンテキスト変数
説明
{!actionLinkId}
ユーザが実行したアクションリンクの ID。
516
Chatter REST API リクエストボディ
Action Link Definition Input
コンテキスト変数
説明
{!actionLinkGroupId}
ユーザが実行したアクションリンクが含まれるアク
ションリンクグループの ID。
{!communityId}
ユーザがアクションリンクを実行したコミュニティの
ID。内部組織の場合、値は空のキー
"000000000000000000" になります。
{!communityUrl}
ユーザがアクションリンクを実行したコミュニティの
URL。内部組織の場合、値は空の文字列 "" になりま
す。
{!orgId}
ユーザがアクションリンクを実行した組織の ID。
{!userId}
アクションリンクを実行したユーザの ID。
ルート XML タグ
<actionLinkDefinition>
JSON の例
次の例ではテンプレートを使用していません。
{
"actionType":"Api",
"actionUrl":"/services/data/v34.0/chatter/feed-elements",
"groupDefault":"true",
"labelKey":"Post",
"method":"Post",
"requiresConfirmation":"true",
"requestBody":"{\"subjectId\": \"me\",\"feedElementType\": \"FeedItem\",\"body\":
{\"messageSegments\": [{\"type\": \"Text\",\"text\": \"Testing a post created via an
API action link.\"}]}}",
"headers":[
{
"name":"Content-Type", "value":"application/json"
}]
}
517
Chatter REST API リクエストボディ
Action Link Definition Input
次の例ではテンプレートを使用しています。
{
"templateId":"07gD00000004C9r",
"templateBindings":[
{
"key":"Bindings.version",
"value":"v33.0"
}
]
}
プロパティ
名前
型
説明
必須項目/省略可 使用可能なバー
能
ジョン
actionType
String
33.0
アクションリンクの種別を定義し 必須項目
ます。値は次のとおりです。
アクションリン
• Api — アクションリンクは、 クテンプレート
に定義できま
アクション URL で同期 API を
コールします。Salesforce は、 す。
サーバから返された HTTP 状況
コードに基づいて状況を
SuccessfulStatus または
FailedStatus に設定しま
す。
• ApiAsync — アクションリン
クは、アクション URL で非同期
API をコールします。アクショ
ンは、非同期操作の完了時に
サードパーティが
/connect/action-links/actionLinkId
への要求を行って状況を
SuccessfulStatus または
FailedStatus に設定するま
で、PendingStatus 状態のま
まになります。
518
Chatter REST API リクエストボディ
名前
型
Action Link Definition Input
説明
必須項目/省略可 使用可能なバー
能
ジョン
• Download — アクションリン
クは、アクション URL からファ
イルをダウンロードします。
• Ui — アクションリンクは、ア
クション URL で Web ページを
ユーザに表示します。
ユーザがアクションを実行する前
にページを読み込む必要がある場
合、Ui を使用します。たとえば、
アクションの実行前にユーザが入
力を行う場合やユーザに情報を表
示したりする場合などです。
actionUrl
String
アクションリンクの URL。たとえ
ば、Ui アクションリンク URL は
Web ページになります。Download
アクションリンク URL は、ダウン
ロードするファイルへのリンクに
なります。Ui および Download
アクションリンク URL がクライア
ントに提供されます。Api または
ApiAsync アクションリンク URL
は REST リソースになります。Api
および ApiAsync アクションリン
ク URL はクライアントに提供され
ません。Salesforce へのリンクは、
相対リンクにすることができま
す。他のすべてのリンクは、
https:// で始まる絶対リンクに
する必要があります。
ヒント: API のアップグレー
ドや機能変更が原因の問題
を回避するために、
actionUrl にはバージョン
管理された API を使用するこ
とをお勧めします
(https://www.example.com/
api/v1/exampleResource
など)。API がバージョン管理
されていない場合、Action Link
Group Definition Input の
519
必須項目
アクションリン
クテンプレート
に定義できま
す。
33.0
Chatter REST API リクエストボディ
名前
型
Action Link Definition Input
説明
必須項目/省略可 使用可能なバー
能
ジョン
expirationDate プロパ
ティを使用して API のアップ
グレードや機能変更による
問題を避けることができま
す。
excludedUserId String
アクションの実行から除外する単 省略可能
一ユーザの ID。excludedUserId [ユーザ表示設
を指定した場合、userId を指定
定] および [カ
できません。
33.0
スタムユーザ(別
名)] 項目を使
用してアクショ
ンリンクテンプ
レートに定義で
きます。
groupDefault
headers
Boolean
Request Header
Input[]
このアクションがアクションリン
クグループのデフォルトアクショ
ンリンクである場合は true、そ
れ以外の場合は false。各アク
ションリンクグループに含めるこ
とができるデフォルトアクション
リンクは 1 つだけです。Salesforce
UI では、デフォルトアクションリ
ンクには区別しやすいスタイルが
適用されます。
リンク種別の要求ヘッダー。
String
ユーザインターフェースに表示さ
れる表示ラベルのセットのキー。
セットには、NewStatus、
PendingStatus、SuccessStatus、
FailedStatus の状態の表示ラベルが
含まれます。たとえば、Approve
キーを使用する場合、[承認]、[待
機中]、[承認済み]、[失敗] の表示
ラベルが含まれます。
520
33.0
アクションリン
クテンプレート
に定義できま
す。
Api および ApiAsync アクション 省略可能
「認証」を参照してください。
labelKey
省略可能
33.0
アクションリン
クテンプレート
に定義できま
す。
必須項目
アクションリン
クテンプレート
に定義できま
す。
33.0
Chatter REST API リクエストボディ
名前
型
Action Link Definition Input
説明
必須項目/省略可 使用可能なバー
能
ジョン
キーおよび表示ラベルの完全なリ
ストについては、「アクションリ
ンクの表示ラベル」を参照してく
ださい。
アクションリンクに適した定義済
み表示ラベルがない場合は、カス
タム表示ラベルを使用します。カ
スタム表示ラベルを使用するに
は、アクションリンクテンプレー
トを作成します。「アクションリ
ンクテンプレートの作成」を参照
してください。
method
String
次のいずれかの HTTP メソッド。
必須項目
• HttpDelete — 成功した場合
は HTTP 204 を返します。レスポ
ンスボディまたは出力クラスは
空です。
アクションリン
クテンプレート
に定義できま
す。
• HttpGet — 成功した場合は
HTTP 200 を返します。
• HttpHead — 成功した場合は
HTTP 200 を返します。レスポン
スボディまたは出力クラスは空
です。
• HttpPatch — 成功した場合は
HTTP 200 を返し、レスポンスボ
ディまたは出力クラスが空の場
合は HTTP 204 を返します。
• HttpPost — 成功した場合は
HTTP 201 を返し、レスポンスボ
ディまたは出力クラスが空の場
合は HTTP 204 を返します。例外
は、成功時に HTTP 200 を返す
バッチ投稿リソースおよびメ
ソッドです。
• HttpPut — 成功した場合は
HTTP 200 を返し、レスポンスボ
ディまたは出力クラスが空の場
合は HTTP 204 を返します。
521
33.0
Chatter REST API リクエストボディ
Action Link Group Definition Input
名前
型
説明
必須項目/省略可 使用可能なバー
能
ジョン
requestBody
String
Api および ApiAsync アクション 省略可能
33.0
リンク種別のリクエストボディ。 アクションリン
メモ: requestBody 値の疑 クテンプレート
に定義できま
問符文字をエスケープしま
す。
す。
requires
Confirmation
Boolean
33.0
ユーザにアクションを確認するよ 必須項目
うに要求する場合は true、それ アクションリン
以外の場合は false。
クテンプレート
に定義できま
す。
userId
String
アクションを実行できるユーザの
ID。指定しない場合や null の場
合、すべてのユーザがアクション
を実行できます。userId を指定
した場合、excludedUserId を指
定できません。
省略可能
33.0
[ユーザ表示設
定] および [カ
スタムユーザ(別
名)] 項目を使
用してアクショ
ンリンクテンプ
レートに定義で
きます。
関連トピック:
アクションリンクを定義し、フィード要素を使用して投稿する
Action Link Group Definition Input
アクションリンクグループの定義。すべてのアクションリンクはグループに属している必要があります。1 つ
のグループ内のアクションリンクは、相互排他的で、同じプロパティを共有します。各自のアクショングルー
プでスタンドアロンアクションを定義します。
アクションリンク定義の情報はサードパーティの機密情報 (OAuth ベアラトークンヘッダーなど) である可能性
があります。そのため、アクションリンク定義を作成した接続アプリケーション経由で実行された要求のみが
定義を参照、変更、または削除できます。さらに、要求を実行するユーザは、定義を作成したユーザか、「す
べてのデータの参照」権限を持つユーザである必要があります。
ルート XML タグ
<actionLinkGroup>
522
Chatter REST API リクエストボディ
Action Link Group Definition Input
JSON の例
次の例では、テンプレートを使用せずにアクションリンクグループ定義をインスタンス化しています。
{
"actionLinks": [
{
"actionType": "Api",
"labelKey": "Like",
"groupDefault": "true",
"actionUrl": "https://test.com/this",
"method": "HttpPost",
"requiresConfirmation": "false"
},
{
"actionType": "Api",
"labelKey": "Unlike",
"groupDefault": "false",
"actionUrl": "https://test.com/that",
"method": "HttpPost",
"requiresConfirmation": "false"
}
],
"executionsAllowed": "OncePerUser",
"expirationDate": "2014-07-07T23:59:11.168Z",
"category": "Primary"
}
次の例では、テンプレートからアクションリンクグループ定義をインスタンス化しています。
{
"templateId":"07gD00000004C9r",
523
Chatter REST API リクエストボディ
Action Link Group Definition Input
"templateBindings":[
{
"key":"Bindings.version",
"value":"v33.0"
}
]
}
プロパティ
名前
型
説明
必須項目/省略
可能
actionLinks
Action Link
Definition Input[]
グループ内の各アクションリン
ク。
category
String
関連付けられたフィード項目内
でのアクションリンクの優先度
および相対位置を示します。値
は次のとおりです。
使用可能なバー
ジョン
テンプレートを 33.0
使用せずにアク
アクションリンクグループ内で ションリンクグ
は、アクションリンクは、Action ループをインス
Link Group Definition Input リクエス タンス化する場
トボディの actionLinks プロ 合は必須。
パティにリストされる順序で表 テンプレートか
示されます。フィード項目内で らインスタンス
は、アクションリンクグループ 化する場合は、
は、Associated Actions Capability Input 値を指定しない
でください。
リクエストボディの
actionLinkGroupIds プロパ
ティに指定された順序で表示さ
れます。
テンプレートを 33.0
使用せずにアク
ションリンクグ
ループをインス
• Primary — アクションリン タンス化する場
クグループは、フィード要素 合は必須。
テンプレートか
の本文に表示されます。
• Overflow — アクションリン らインスタンス
クグループは、フィード要素 化する場合は、
のオーバーフローメニューに 値を指定しない
でください。
表示されます。
524
Chatter REST API リクエストボディ
名前
型
Action Link Group Definition Input
説明
必須項目/省略
可能
使用可能なバー
ジョン
Primary グループには最大 3
個、Overflow グループには最大
4 個のアクションリンクを作成で
きます。
executionsAllowed String
テンプレートを 33.0
使用せずにアク
ションリンクグ
ループをインス
• Once — アクションリンク
は、すべてのユーザで 1 回の タンス化する場
合は必須。
み実行できます。
アクションリンクを実行できる
回数を定義します。値は次のと
おりです。
• OncePerUser — アクション テンプレートか
リンクは、各ユーザで 1 回の らインスタンス
化する場合は、
み実行できます。
値を指定しない
• Unlimited — アクションリ
でください。
ンクは、各ユーザで無制限に
実行できます。アクションリ
ンクの actionType が Api
または ApiAsync の場合、こ
の値を使用できません。
expirationDate Date
このアクションリンクグループ
が関連付けられたフィード項目
から削除され、実行できなくな
る日時を表す ISO 8601 日付文字列
(例: 2011-02-25T18:24:31.000Z)。
expirationDate は、作成日か
ら 1 年以内の日時である必要があ
ります。
アクションリンクグループ定義
に OAuth トークンが含まれる場
合、アクションリンクグループ
の有効期限を OAuth トークンの有
効期限と同じ値に設定すること
をお勧めします。そうすれば、
ユーザがアクションリンクを実
行できず、OAuth エラーは発生し
ません。
テンプレートからインスタンス
化するときに日付を設定する場
合は、「アクションリンクグルー
525
テンプレートを 33.0
使用せずにアク
ションリンクグ
ループをインス
タンス化する場
合は必須。
テンプレートか
らインスタンス
化する場合は省
略可能。
Chatter REST API リクエストボディ
名前
型
Action Link Input
説明
必須項目/省略
可能
使用可能なバー
ジョン
プの有効期限の設定」を参照し
てください。
templateBindings Action Link
Template Binding
Input[]
templateId
String
アクションリンクテンプレート
からバインド変数値またはカス
タムユーザ別名に入力されるキー
- 値のペアのコレクション。バイ
ンド変数を使用するアクション
リンクテンプレートからこのア
クションリンクグループをイン
スタンス化するには、すべての
変数の値を指定する必要があり
ます。「バインド変数の定義」
を参照してください。
テンプレートを 33.0
使用せずにイン
スタンス化する
場合は、値を指
定しないでくだ
さい。
このアクションリンクグループ
のインスタンス化に使用された
アクションリンクグループテン
プレートの ID。
テンプレートを 33.0
使用せずにイン
スタンス化する
場合は、値を指
定しないでくだ
さい。
バインド変数を
使用するテンプ
レートからこの
アクションリン
クグループをイ
ンスタンス化す
る場合は必須。
テンプレートか
らこのアクショ
ンリンクグルー
プをインスタン
ス化する場合は
必須。
関連トピック:
アクションリンクを定義し、フィード要素を使用して投稿する
アクションリンクを定義し、フィード要素を使用して投稿する
テンプレートのアクションリンクを定義し、フィード要素を使用して投稿する
Action Link Input
アクションリンクの想定される実行状況。
526
Chatter REST API リクエストボディ
Action Link Template Binding Input
ルート XML タグ
<actionLink>
JSON の例
{
"status" : "SuccessfulStatus"
}
プロパティ
名前
型
説明
必須項目/省略可 使用可能なバー
能
ジョン
status
String
アクションの現在の実行状況。値 必須項目
は次のとおりです。
• FailedStatus — アクション
リンクの実行に失敗しました。
• NewStatus — アクションリン
クの実行の準備が整っていま
す。Download および Ui アク
ションリンクでのみ使用できま
す。
• PendingStatus — アクション
リンクが実行されています。こ
の値を選択すると、Api および
ApiAsync アクションリンクの
API コールがトリガされます。
• SuccessfulStatus — アク
ションリンクが正常に実行され
ました。
関連トピック:
アクションリンクの状況を更新するかアクションリンクを呼び出す
Action Link Template Binding Input
アクションリンクテンプレートのバインド変数値に入力されるキー - 値ペア。
JSON の例
{
"key":"version",
"value":"33.0"
527
33.0
Chatter REST API リクエストボディ
Announcement Input
}
プロパティ
名前
型
説明
必須項目/省略可 使用可能なバー
能
ジョン
key
String
[設定] でアクションリンクテンプ 必須項目
レートに指定されたバインド変数
キーの名前。たとえば、テンプ
レートのバインド変数が
{!Binding.firstName} の場
合、キーは firstName です。
33.0
value
String
バインド変数キーの値。たとえ
必須項目
ば、キーが firstName の場合、
この値は Joan などになります。
33.0
Announcement Input
お知らせは、削除されるか、別のお知らせで置き換えられない限り、その表示期限の 11:59 p.m. まで Salesforce UI
の指定の場所に表示されます。
ルート XML タグ
<announcement>
JSON の例
{
"body":
{
"messageSegments": [
{
"text": "Please install the updates for all iOS devices.",
"type": "Text"
}
]
}
"expirationDate": "2014-02-22T00:00:00.000Z",
}
528
Chatter REST API リクエストボディ
Associated Actions Capability Input
プロパティ
名前
型
body
Message Body Input お知らせのテキスト。
expirationDate Date
説明
必須項目/省略可 使用可能なバー
能
ジョン
必須項目
31.0
別のお知らせが最初に投稿されて 必須項目
いない限り、この日付の 11:59 p.m.
まで Salesforce UI にお知らせが表示
されます。Salesforce UI では、
expirationDate の時間値は無視
されます。ただし、時間値を使用
して各自の UI で独自の表示ロジッ
クを作成することはできます。
31.0
Associated Actions Capability Input
フィード要素で作成または更新できるアクションリンクを記述します。アクションリンクグループをフィード
要素に関連付けるには、クライアントがアクションリンクグループ定義を作成したものと同じ接続アプリケー
ションで、ユーザが定義を作成したユーザまたは「すべてのデータの参照」権限を持つユーザである必要があ
ります。
アクションリンクは、フィード要素上のボタンです。アクションリンクをクリックすると、ユーザを特定の
Web ページに移動したり、ファイルダウンロードを開始したり、Salesforce または外部サーバへの API コールを
呼び出したりできます。アクションリンクには、URL と HTTP メソッドが含まれ、リクエストボディとヘッダー
情報 (認証用の OAuth トークンなど) を含めることができます。アクションリンクを使用して Salesforce および
サードパーティサービスをフィードに統合することで、ユーザはアクションを実行して生産性を高め、イノ
ベーションを促進できます。
JSON の例
"associatedActions": {
"actionLinkGroupIds":["0Agxx00000000d1CAA", "0Agxx00000000d2DFY"]
}
プロパティ
名前
型
説明
必須項目/省略可 使用可能なバー
能
ジョン
actionLink
GroupIds
String []
フィード要素に関連付けるアク
必須項目
ションリンクグループ ID。1 つの
Primary アクションリンクグルー
プを含め、合計で最大 10 個のアク
ションリンクグループをフィード
529
33.0
Chatter REST API リクエストボディ
名前
型
Attachment Input: Canvas App
説明
必須項目/省略可 使用可能なバー
能
ジョン
項目に関連付けます。アクション
リンクグループは、このプロパ
ティに指定された順序で返されま
す。
/connect/action-link-group-definitions へ
の要求の応答からアクションリン
クグループ ID を取得します。
Attachment Input: Canvas App
重要: このリクエストボディは、バージョン 32.0 以降では使用できません。バージョン 32.0 以降では、
Canvas Capability Input を使用してください。
XML
XML リクエストボディでは、attachmentType は <attachment> 要素の属性です。
<attachment attachmentType="Canvas">
<developerName>TravelApp</developerName>
</attachment>
JSON
{"attachment" :
{
"attachmentType" : "Canvas",
"developerName" : "TravelApp",
"namespacePrefix" : "dev_org",
"parameters" : "{&quot;itinerary&quot;:&quot;123&quot;}",
"height" : "250px",
"title" : "TravelItinerary",
}
}
530
Chatter REST API リクエストボディ
Attachment Input: Existing Content
プロパティ
名前
型
説明
使用可能なバー
ジョン
attachmentType
String
添付ファイルの種別。値 Canvas を含める必要があり 29.0 ～ 31.0
ます。
description
String
省略可能。キャンバスアプリケーションの説明。
29.0 ～ 31.0
developerName
String
キャンバスアプリケーションの開発者名 (API 名)
29.0 ～ 31.0
height
String
省略可能。キャンバスアプリケーションの高さ (ピク
セル単位)。デフォルトの高さは 200 ピクセルです。
29.0 ～ 31.0
namespacePrefix
String
省略可能。キャンバスアプリケーションが作成された 29.0 ～ 31.0
Developer Edition 組織の名前空間プレフィックス。
parameters
String
省略可能。キャンバスアプリケーションに渡される
29.0 ～ 31.0
JSON 形式のパラメータ。JSON はエスケープする必要が
あります。
thumbnailUrl
String
省略可能。キャンバスアプリケーションのサムネイル 29.0 ～ 31.0
画像の URL。最大サイズは 120x120 ピクセルです。
title
String
省略可能。キャンバスアプリケーションのコールに使 29.0 ～ 31.0
用されるリンクのタイトル。
Attachment Input: Existing Content
重要: このリクエストボディは、バージョン 32.0 以降では使用できません。バージョン 32.0 以降では、
Content Capability Input を使用してください。
XML
XML リクエストボディでは、attachmentType は <attachment> 要素の属性です。
<attachment attachmentType="ExistingContent">
<contentDocumentId>069...</contentDocumentId>
</attachment>
JSON
{ "attachment":
{
"attachmentType":"ExistingContent",
531
Chatter REST API リクエストボディ
Attachment Input: Feed Poll
"contentDocumentId": "069D00000001FHF"
}
}
プロパティ
名前
型
説明
使用可能なバージョン
attachmentType
String
添付ファイルの種別。値 27.0 ～ 31.0
ExistingContent を含
める必要があります。
contentDocumentId
String
既存のコンテンツの ID
23.0 ～ 31.0
Attachment Input: Feed Poll
重要: このリクエストボディは、バージョン 32.0 以降では使用できません。バージョン 32.0 以降では、Poll
Capability Input を使用してください。
XML
XML では、アンケートの選択肢はそれぞれ <choice> 要素にラップされ、attachmentType は
<attachment> 要素の属性です。例:
<attachment attachmentType="Poll">
<pollChoices>
<choice>One</choice>
<choice>Two</choice>
</pollChoices>
</attachment>
JSON
{ "attachment":
{
"attachmentType":"Poll",
"pollChoices": [
"Monday",
"Tuesday"
532
Chatter REST API リクエストボディ
Attachment Input: Link
]
}
}
プロパティ
名前
型
説明
使用可能なバージョン
attachmentType
String
添付ファイルの種別。値 27.0 ～ 31.0
Poll を含める必要があ
ります。
pollChoices
String[]
フィードアンケートに使 26.0 ～ 31.0
用される選択肢のリス
ト。
Attachment Input: Link
重要: このリクエストボディは、バージョン 32.0 以降では使用できません。バージョン 32.0 以降では、Link
Capability Input を使用してください。
XML
attachmentType プロパティは、<attachment> 要素の属性です。たとえば、次のように使用します。
<attachment attachmentType="Link">
<url>http://www.google.com</url>
<urlName>A search engine</urlName>
</attachment>
JSON
{ "attachment":
{
"attachmentType":"Link",
"url": "http://www.salesforce.com",
"urlName": "Salesforce"
}
}
533
Chatter REST API リクエストボディ
Attachment Input: New File Upload
プロパティ
名前
型
説明
使用可能なバージョン
attachmentType
String
添付ファイルの種別。値 27.0 ～ 31.0
Link を含める必要があ
ります。
url
String
添付ファイルに含まれる 23.0 ～ 31.0
URL。
urlName
String
省略可能。URL の名前。 23.0 ～ 31.0
指定されない場合、名前
は URL のドメイン名から
生成されます。
Attachment Input: New File Upload
重要: このリクエストボディは、バージョン 32.0 以降では使用できません。バージョン 32.0 以降では、
Content Capability Input を使用してください。
新しいファイルをアップロードするには、name="feedItemFileUpload" のマルチパート/フォームデー
タボディパートにそのバイナリファイルを含める必要があります。「バイナリファイルのアップロード」
を参照してください。
XML
attachmentType プロパティは、<attachment> 要素の属性です。たとえば、次のように使用します。
<attachment attachmentType="NewFile">
<description>TPS Report (with cover)</description>
<title>TPS.txt</title>
</attachment>
JSON
{ "attachment":
{
"attachmentType":"NewFile",
"description":"TPS Report (with cover)",
"title":"TPS.txt"
}
534
Chatter REST API リクエストボディ
Batch Collection Input
}
プロパティ
名前
型
説明
使用可能なバー
ジョン
attachmentType
String
添付ファイルの種別。値 NewFile 27.0 ～ 31.0
を含める必要があります。
desc
String
ファイルの説明。
23.0 ～ 26.0
注意: このパラメータは、
バージョン 27.0 以降では使用
しないでください。代わり
に、description を使用し
てください。
description
String
省略可能。ファイルの説明。
27.0 ～ 31.0
title
String
ファイルのタイトル。
24.0 ～ 31.0
Batch Collection Input
バッチ要求用の入力のコレクションを記述します。
JSON の例
{
"inputs": [
{
"richInput": {
"subjectId": "me",
"body": {
"messageSegments": [
{
"type": "Text",
"text": "Post Number 1"
}]
535
Chatter REST API リクエストボディ
Batch Input
},
"feedElementType": "FeedItem"
}
}, {
"richInput": {
"subjectId": "me",
"body": {
"messageSegments": [
{
"type": "Text",
"text": "Post Number 2"
}]
},
"feedElementType": "FeedItem"
}
}]
}
プロパティ
名前
型
説明
必須項目/省略 使用可能な
可能
バージョン
inputs
Batch Input[]
一緒に処理される入力 (リクエ 必須項目
ストボディ) のコレクション。
すべての Batch Input リクエスト
ボディの richInput プロパ
ティには、同じ種別のリクエ
ストボディが含まれている必
要があります。
Batch Input
Batch Collection Input 内にネストされる個別のバッチ入力。
536
32.0
Chatter REST API リクエストボディ
Batch Input
JSON の例
バイナリパートのない例:
{
"richInput": {
"subjectId": "me",
"body": {
"messageSegments": [
{
"type": "Text",
"text": "Post Number 1"
}]
},
"feedElementType": "FeedItem"
}
}
バイナリパートのある例:
{
"binaryPartNames": [
"bin1"
],
"richInput": {
"subjectId": "me",
"body": {
"messageSegments": [
{
"type": "Text",
"text": "Please accept this receipt"
}
537
Chatter REST API リクエストボディ
Batch Input
]
},
"capabilities": {
"content": {
"description": "Receipt for expenses",
"title": "receipt.pdf"
}
},
"feedElementType": "FeedItem"
}
}
この例では、バイナリボディパートの Content-Disposition ヘッダー内の name パラメータの値が bin1
である必要があります。
プロパティ
名前
型
binaryPartNames String []
説明
必須項目/省略
可能
この入力で含めるバイナリボディパートの 省略可能
Content-Disposition ヘッダー内の name
パラメータのリスト。この値が存在する場
合、対応するバイナリパートが要求に含ま
れている必要があります。
使用可能なバー
ジョン
32.0
メモ:
/chatter/feed-elements/batch リ
ソースとともに使用する場合、このプ
ロパティに設定できる値は 1 つのみ
で、値のリストではありません。
richInput
要求の入力ボディ (リクエストボディ)。
必須項目
richInput プロパティには、リソースが想
定するリクエストボディが含まれている必
要があります。
/chatter/feed-elements/batch リソー
スでは、Feed Item Input リクエストボディを
想定します。
538
32.0
Chatter REST API リクエストボディ
Bookmarks Capability Input
Bookmarks Capability Input
フィード要素のブックマークを作成または更新します。
ルート XML タグ
<bookmarksCapability>
<isBookmarkedByCurrentUser>true</isBookmarkedByCurrentUser>
</bookmarksCapability>
JSON の例
{
"isBookmarkedByCurrentUser": true
}
プロパティ
名前
型
isBookmarked Boolean
ByCurrentUser
説明
必須項目/省略可 使用可能なバー
能
ジョン
フィード要素をユーザのために
ブックマークする必要があるか
(true)、否か (false) を指定しま
す。
必須項目
Canvas Capability Input
フィード要素に関連付けられたキャンバスアプリケーションを作成または更新します。
ルート XML タグ
<canvasCapability>
<developerName>true</developerName>
<title>true</title>
</canvasCapability>
JSON の例
{
"developerName": "myNewApp",
539
32.0
Chatter REST API リクエストボディ
Comment Input
"title": "My New App"
}
プロパティ
名前
型
説明
description
String
キャンバスアプリケーションの説 省略可能
明。最大サイズは 255 文字です。
32.0
developerName String
接続アプリケーションの API 名 (開 必須項目
発者名)。
32.0
String
キャンバスアプリケーションの高 省略可能
さ (ピクセル単位)。
32.0
namespacePrefix String
キャンバスアプリケーションの一 省略可能
意の名前空間プレフィックス。
32.0
parameters
String
キャンバスアプリケーションに渡 省略可能
される JSON パラメータ。
32.0
thumbnailUrl
String
プレビュー画像へのサムネイル
URL。最大サムネイルサイズは、
120 × 120 ピクセルです。
省略可能
32.0
title
String
キャンバスリンクのタイトル。
必須項目
32.0
height
必須項目/省略可 使用可能なバー
能
ジョン
Comment Input
ルート XML タグ
<comment>
JSON
次の例では、コメントに既存のファイルを添付します。
{
"body" : {
"messageSegments" : [
{
"text" : "FY14 Sales Projections",
"type" : "Text"
}
540
Chatter REST API リクエストボディ
Comment Capabilities Input
]
},
"capabilities": {
"contentDocumentId":"069D00000001FHF"
}
}
プロパティ
名前
型
説明
使用可能な
バージョン
attachment
種別によって異なる。
省略可能。値は次のとおりです。
24.0 ～ 31.0
• Attachment Input: Existing Content
• Attachment Input: New File Upload
重要: バージョン 32.0 以降は、
capabilities プロパティを使
用します。
body
Message Body Input
メッセージ本文の説明
23.0
capabilities
Comment Capabilities Input
添付ファイルなど、コメントの機能。 32.0
関連トピック:
コメントを投稿する
コメントを投稿し、Salesforce のファイルを含める
@メンションを投稿する
複数の @メンションを投稿する
Comment Capabilities Input
ルート XML タグ
<commentCapabilities>
プロパティ
名前
型
説明
使用可能な
バージョン
content
Content Capability Input
添付ファイル。
32.0
541
Chatter REST API リクエストボディ
Content Capability Input
Content Capability Input
フィード要素に関連付けられたファイルを作成または更新します。
ルート XML タグ
<contentCapability>
<contentDocumentId>069D00000001pyS</contentDocumentId>
</contentCapability>
JSON の例
{
"contentDocumentId": "069D00000001pyS"
}
プロパティ
名前
型
contentDocumentId String
説明
必須項目/省略可 使用可能なバー
能
ジョン
既存のコンテンツの ID。
既存のコンテン 32.0
ツでは必須
新規コンテンツ
ではサポート対
象外
description
String
アップロードするファイルの説
明。
新規コンテンツ 32.0
では省略可能
既存のコンテン
ツではサポート
対象外
title
String
ファイルのタイトル。この値は、
新しいコンテンツのファイル名と
して使用されます。たとえば、タ
イトルが「My Title」で、ファイル
が .txt ファイルの場合、ファイル
名は My Title.txt になります。
新規コンテンツ 32.0
では必須
既存のコンテン
ツではサポート
対象外
Datacloud Order Input
特定の userType によって取引先責任者または会社の購入に使用される Data.com 識別番号のリスト。
542
Chatter REST API リクエストボディ
Datacloud Order Input
ルート XML タグ
<DatacloudOrder>
JSON の例
{
"companyIds":[
"23456",
"24548"
],
"userType":"Monthly"
}
プロパティ
名前
型
説明
必須項目/省
略可能
使用可能な
バージョン
companyIds String
購入する会社のリスト。contactIds と
必須項目
companyIds が共に含まれていると、購入は
失敗します。
32.0
contactIds String
購入する取引先責任者のリスト。リストには 必須項目
取引先責任者のみを含めることをお勧めしま
す。companyIds と contactIds が共に含ま
れていると、購入は失敗します。
32.0
userType
String
Data.com ユーザ種別。
• Monthy — Data.com レコードの購入の毎月
のポイント制限が割り当てられるユーザ種
別。毎月のポイントを使用できるのは、割
り当てられたユーザのみです。ポイント
は、月末に期限切れになります。Monthly
は、DatacloudUserType のデフォルト設
定です。
• Listpool — Data.com レコードを購入する
ためのポイントをユーザがプールから引き
出すことを許可するユーザ種別。
543
省略可能 — 32.0
ユーザ種別が
指定されてい
ない場合、デ
フォルトは
Monthly で
す。
Chatter REST API リクエストボディ
Dashboard Component Snapshot Input
Dashboard Component Snapshot Input
ルート XML タグ
<dashboardComponentSnapshot>
JSON
{
"parentId" : "0F9D00000000I4O",
"feedItemBody" : {
"messageSegments" : [
{
"text" : "Sales Heat",
"type" : "Text"
}
]
}
}
プロパティ
名前
型
説明
使用可能なバージョン
parentId
String
スナップショットの post 送信 25.0
先となるユーザ、グループ、
または ダッシュボードの ID。
filterId1
String
省略可能。ダッシュボード絞 25.0
り込み項目の ID。
filterId2
String
省略可能。2 つ目のダッシュ
ボード絞り込み項目の ID。
25.0
filterId3
String
省略可能。3 つ目のダッシュ
ボード絞り込み項目の ID。
25.0
feedItemBody
Message Body Input ダッシュボードコンポーネン 25.0
トスナップショットに関連付
けられたフィード項目に付随
するテキストが含まれます。
544
Chatter REST API リクエストボディ
Feed Element Capabilities Input
名前
型
説明
使用可能なバージョン
runningUserId
String
省略可能。ダッシュボードの 25.0
ビューの作成元となるユーザ
ID (作成者以外の場合)。
Feed Element Capabilities Input
新しいフィード要素を作成するときに含めることができるすべての機能のコンテナ。
API バージョン 30.0 以前では、各フィード項目にコメント、いいね!、トピックなどを含めることができました。
バージョン 31.0 以降では、各フィード項目 (およびフィード要素) に一意の機能セットを含めることができま
す。フィード要素に機能プロパティが存在する場合、機能プロパティに値がなくてもその機能を使用できま
す。たとえば、ChatterLikes 機能プロパティがフィード要素に存在している場合、(値の有無に関係なく) コ
ンテキストユーザはそのフィード要素にいいね! と言うことができます。機能プロパティが存在しない場合、
そのフィード要素にいいね! と言うことはできません。機能には、関連データを含めることもできます。たと
えば、Moderation 機能には、モデレーションフラグに関するデータが含まれます。
XML の例
<capabilities>
<associatedActions>
<actionLinkGroupIds>
<actionLinkGroupId/>0Agxx00000000d1CAA<actionLinkGroupId/>
<actionLinkGroupId/>0Agxx00000000d2DFY<actionLinkGroupId/>
</actionLinkGroupIds>
</associatedActions>
<bookmarksCapability>
<isBookmarkedByCurrentUser>false</isBookmarkedByCurrentUser>
</bookmarksCapability>
<contentCapability>
<contentDocumentId>069D00000001pyS</contentDocumentId>
</contentCapability>
</capabilities>
545
Chatter REST API リクエストボディ
Feed Element Capabilities Input
JSON の例
"capabilities": {
"associatedActions": {
"actionLinkGroupIds":["0Agxx00000000d1CAA", "0Agxx00000000d2DFY"]
},
"bookmarks": {
"isBookmarkedByCurrentUser": false
},
"content": {
"contentDocumentId": "069D00000001pyS"
}
}
プロパティ
名前
型
説明
必須項目/省略可 使用可能なバー
能
ジョン
associated
Actions
Associated Actions
Capability Input
フィード要素で作成または更新で 省略可能
きるアクションリンクを記述しま
す。アクションリンクグループを
フィード要素に関連付けるには、
クライアントがアクションリンク
グループ定義を作成したものと同
じ接続アプリケーションで、ユー
ザが定義を作成したユーザまたは
「すべてのデータの参照」権限を
持つユーザである必要がありま
す。
31.0
bookmarks
Bookmarks
Capability Input
フィード要素のブックマークを作 省略可能
成または更新します。
32.0
canvas
Canvas Capability
Input
フィード要素に関連付けられた
省略可能
キャンバスアプリケーションを作
成または更新します。
32.0
content
Content Capability
Input
フィード要素を使用してファイル 省略可能
を添付または更新します。このク
ラスを使用して、新しいファイル
32.0
546
Chatter REST API リクエストボディ
名前
Feed Favorite Input
型
説明
必須項目/省略可 使用可能なバー
能
ジョン
を添付したり、すでに Salesforce に
アップロードされているファイル
を更新したりします。
link
Link Capability Input フィード要素に添付されたリンク 省略可能
を作成または更新します。
32.0
poll
Poll Capability Input フィード要素に添付されたアン
省略可能
ケートの作成、更新、または投票
を行います。
32.0
questionAnd
Answers
Question and
質問フィード要素を作成するか、 省略可能
Answers Capability 既存の質問フィード要素の最良の
Input
回答を設定します。
32.0
Feed Favorite Input
ルート XML タグ
<favorite>
POST の JSON
{
"searchText" : "release",
"targetId" : "0TOD0000000099d"
}
POST のプロパティ
名前
型
説明
searchText
String
24.0
フィード検索のテキス
ト。このパラメータは、
フィード検索にのみ使用
します。
targetId
String
トピックの ID。このパラ 28.0
メータは、トピックにの
み使用します。
547
使用可能なバージョン
Chatter REST API リクエストボディ
Feed Item Input
PATCH の JSON
{
"updateLastViewDate" : "true"
}
PATCH のプロパティ
名前
型
説明
updateLastViewDate
Boolean
指定されたフィードのお 24.0
気に入りの最終参照日を
現在のシステム時刻に設
定します。デフォルト値
は false です。
Feed Item Input
ルート XML タグ
<feedItem>
JSON
次の例では、フィード項目にアンケートを添付します。
{
"body":{
"messageSegments":[
{
"type":"Text",
"text":"When should we meet for release planning?"
}
]
},
"capabilities":{
"poll":{
"choices":[
"Monday",
548
使用可能なバージョン
Chatter REST API リクエストボディ
Feed Item Input
"Tuesday"
]
}
},
"feedElementType":"FeedItem",
"subjectId":"me"
}
フィード項目は複数の機能をサポートします。次の例では、ファイルをフィード項目に添付し、ブックマー
クします。
{
"body":{
"messageSegments":[
{
"type":"Text",
"text":"Check out the latest marketing collateral."
}
]
},
"capabilities":{
"bookmarks":{
"isBookmarkedByCurrentUser": true
},
"content":{
"contentDocumentId": "069D00000001uQO"
}
},
"feedElementType":"FeedItem",
"subjectId":"me"
549
Chatter REST API リクエストボディ
Feed Item Input
}
プロパティ
名前
型
説明
必須項目/省略可能
attachment
種別によって異な
る。
attachment パラメータには、次 省略可能
のいずれか 1 つの値のみを指
定できます。値は次のとおり
です。
使用可能
なバー
ジョン
• Attachment Input: Canvas App
(v29.0 ～ 31.0)
• Attachment Input: Existing
Content (v23.0 ～ 31.0)
• Attachment Input: Feed Poll
(v26.0 ～ 31.0)
• Attachment Input: Link (v23.0 ～
31.0)
• Attachment Input: New File
Upload (v23.0 ～ 31.0)
重要: API バージョン 32.0
以降では、
capabilities プロパ
ティを使用します。
body
Message Body Input
メッセージ本文の説明。本文 フィード項目にコン 23.0
には 25 文字まで使用できま テンツ機能またはリ
す。
ンク機能がある場合
フィード項目を共有するため を除き、必須
の originalFeedItemId を
指定する場合、body プロパ
ティを使用してコメントを
フィード項目に追加します。
このフィード項目が共有され
ている場合、この値は最初の
コメントの本文です。
capabilities
Feed Element
Capabilities Input
このフィード要素の動作を定 省略可能
義する機能。
31.0
isBookmarked
ByCurrentUser
Boolean
新しいフィード項目をユーザ 省略可能
のためにブックマークするか
24.0 ～ 31.0
550
Chatter REST API リクエストボディ
名前
型
Feed Item Input
説明
必須項目/省略可能
使用可能
なバー
ジョン
(true)、否か (false) を指定
します。デフォルト値は、
false です。
重要: API バージョン 32.0
以降では、
capabilities.bookmarks.
isBookmarkedByCurrentUser
プロパティを使用しま
す。
feedElementType String
この入力が表すフィード要素 必須項目
の種別。
31.0
有効な値は FeedItem のみで
す。
originalFeedElementId String
このフィード要素が共有され 省略可能
ている場合、これは元の
フィード要素の18 文字の IDで
す。
31.0
メモ: このパラメータ
は、他のすべてのパラ
メータよりも優先されま
す。たとえば、投稿を共
有し、さらにファイルの
アップロードも試みる場
合、生成されたフィード
項目には共有された投稿
のみが含まれます。1 つ
の POST 内では、投稿の
共有かファイルのアップ
ロードのどちらか 1 つの
み (両方ではなく) を行う
必要があります。
originalFeedItemId String
このフィード項目が共有され 省略可能
ている場合、これは元の
フィード項目の18 文字の IDで
す。
重要: API バージョン 32.0
以降では、
551
24.0 ～ 31.0
Chatter REST API リクエストボディ
名前
型
Feed Item Input
説明
必須項目/省略可能
使用可能
なバー
ジョン
originalFeedElementId
プロパティを使用しま
す。
subjectId
String
このフィード要素が投稿され 必須項目
た親の ID。この値は、ユー
ザ、グループ、レコードの
ID、またはコンテキストユー
ザを示す文字列 me になりま
す。
552
31.0
Chatter REST API リクエストボディ
Feed Item Input
名前
型
説明
必須項目/省略可能
visibility
String
投稿を表示できるユーザ。有 省略可能
効な値は、次のとおりです。
• InternalUsers — コミュ
ニティが有効な場合は、デ
フォルトの内部コミュニ
ティのメンバーに対しての
みフィード項目を表示でき
ます。
• AllUsers — コミュニティ
が有効な場合は、コミュニ
ティのすべてのメンバーに
対してフィード項目を表示
できます。
デフォルト値は、次のとおり
です。
• 外部ユーザの場合、デフォ
ルト値は AllUsers で
す。外部ユーザが投稿を表
示するには、この値を使用
する必要があります。
• 内部ユーザの場合、デフォ
ルト値は InternalUsers
です。内部ユーザは、この
値を受け入れるか、値
AllUsers を使用して外部
ユーザに投稿の表示を許可
します。
フィード項目の親が User また
は Group の場合、フィード項
目の visibility は
AllUsers である必要があり
ます。
553
使用可能
なバー
ジョン
26.0
Chatter REST API リクエストボディ
Feed Item Topic Input
関連トピック:
フィード項目を投稿する
フィード要素を投稿し、Salesforce のファイルを含める
@メンションを投稿する
複数の @メンションを投稿する
アクションリンクを定義し、フィード要素を使用して投稿する
テンプレートのアクションリンクを定義し、フィード要素を使用して投稿する
フィード項目を共有する
グループに投稿する
Feed Item Topic Input
ルート XML タグ
<feedItemTopic>
JSON
次の例では、フィード項目に新規のトピックを添付します。
{ "topicName": "W3C"
}
プロパティ
名前
型
説明
必須項目/省略可能
使用可能
なバー
ジョン
topicId
String
既存のトピックの ID
topicName プロパティが
29.0
使用されていない場合、既
存のトピックに必要です。
topicName
String
29.0
新規または既存のトピック 新規のトピック、および
の名前 (最大 150 文字)
topicId プロパティが使
用されていない場合の既存
のトピックに必要です。
Feed Poll Input
重要: このリクエストボディは、バージョン 32.0 以降では使用できません。バージョン 32.0 以降では、Poll
Capability Input を使用してください。
ルート XML タグ
<feedPoll>
554
Chatter REST API リクエストボディ
File Input
プロパティ
名前
型
説明
使用可能なバージョン
myChoiceId
String
フィードアンケートの既 26.0 ～ 31.0
存の選択肢の ID。現在の
ユーザが投票するアン
ケート選択肢の ID を指定
するために使用されま
す。
File Input
このリクエストボディでは、新しいファイル入力について説明します。ファイルをアップロードするには、
name="fileData" のマルチパート/フォームデータボディパートにそのバイナリファイルを含める必要が
あります。「バイナリファイルのアップロード」を参照してください。
ルート XML タグ
<fileInput>
JSON
{
"desc":"Employee Survey Results",
"title":"emp_surv_results"
}
プロパティ
名前
型
説明
必須項目/省略可 使用可能なバー
能
ジョン
content
ModifiedDate
Date
ファイル固有の最終更新日。クラ 省略可能
イアント側の更新日を設定するた
めに使用できます。
32.0
desc
String
アップロードするファイルの説
明。
省略可能
24.0
isInMyFileSync Boolean
ファイルが Salesforce Files Sync と同 省略可能
期されている場合は true、同期
されていない場合は false。
31.0
isMajorVersion Boolean
ファイルがメジャーバージョンの 省略可能
場合は true、ファイルがマイナー
バージョンの場合は false。メ
31.0
555
Chatter REST API リクエストボディ
名前
File Shares Input
型
説明
必須項目/省略可 使用可能なバー
能
ジョン
ジャーバージョンを置き換えるこ
とはできません。
parentFolderId String
収容フォルダの ID。
省略可能
31.0
repository
FileId
String
外部ファイルの ID。
省略可能
32.0
repositoryId
String
外部データソースの ID。
省略可能
32.0
title
String
ファイルのタイトル。
省略可能
24.0
File Shares Input
ルート XML タグ
<fileShares>
JSON の例
{
"message": "I shared a document with you.",
"shares": [
{ "id": "005D0000001Az4l", "sharingType": "V" },
{ "id": "005D0000001B2ny", "sharingType": "C" }
]
}
プロパティ
名前
型
説明
使用可能なバー
ジョン
message
String
受信者に送信される非公開のメッセージ本 30.0
文。Salesforce Communities が有効な場合、非公
開メッセージではなくメールが送信されま
す。
shares
Share Input[]
Share Input リクエストボディのコレクション。 30.0
556
Chatter REST API リクエストボディ
Folder Input
Folder Input
ルート XML タグ
<folderInput>
JSON の例
{
"path" : "my_documents/my_folder"
}
プロパティ
名前
型
説明
使用可能なバー
ジョン
isInMyFileSync
Boolean
フォルダおよびこのフォルダ内のすべての 33.0
フォルダが Salesforce Files Sync と同期されてい
る場合は true、同期されていない場合は
false。
isInMyFileSync 設定は、ルートフォルダ
でのみ有効です。一度 true に設定すると、
isInMyFileSync を false に設定すること
はできません。
name
String
フォルダの名前。
30.0
path または name のいずれかが必要です。
両方を指定すると、path が使用され、name
が無視されます。
parentFolderId
String
親フォルダの ID。
30.0
parentFolderId または path のいずれか
が必要です。両方を含めることはできませ
ん。
path
String
フォルダのパス。たとえば、my
documents/folder です。
Folder Item Input
ルート XML タグ
<folderItem>
557
30.0
Chatter REST API リクエストボディ
Following Input
JSON の例
{
"file" :
{
"desc" : "Yearly Report for Universal Containers Box Division",
"title" : "Yearly.txt"
},
"type" : "File"
}
プロパティ
名前
型
説明
必須項目/省略可能
使用可能な
バージョン
file
File Input
フォルダ内のファイ
ル。
File の POST では必須項目。
30.0
folder
Folder Input
フォルダ内フォルダ。 Folder の POST では必須項目。 30.0
type
String
項目の種別。次のいず 必須項目
れかの値にします。
• File
• Folder
Following Input
ルート XML タグ
<following>
558
30.0
Chatter REST API リクエストボディ
Generic Batch Collection Input
プロパティ
名前
型
説明
使用可能なバージョン
subjectId
String
フォローする対象の ID。 23.0
たとえば、ユーザ ID、レ トピック ID は 29.0 で使用
コード ID、ファイル ID、 できます。
トピック ID などがありま
す。
メモ: グループにメ
ンバーを追加する
場合には Group
Member Input を使用
します。
関連トピック:
レコードをフォローする
Generic Batch Collection Input
ルート XML タグ
<batch>
JSON
{
"batchRequests" : [
{
"method" : "Get",
"url" : "/v34.0/chatter/feeds/news/me"
},
{
"method" : "Get",
"url" : "/v34.0/chatter/feeds/user-profile/me"
}
]
}
559
Chatter REST API リクエストボディ
Generic Batch Input
プロパティ
名前
型
説明
batchRequests
Generic Batch Input[]
実行するサブ要求の URL を含む、Batch 28.0
Request Input リクエストボディのコレク
ション。
haltOnError
Boolean
デフォルト値は、false です。
値が false で、バッチ内のサブ要求が
完了しない場合、Salesforce は、バッチ
内の後続のサブ要求を実行しようと試
みます。
値が true で、HTTP 応答 400 番台また
は 500 番台のエラーが含まれるために
バッチ内のサブ要求が完了しない場
合、Salesforceは実行を停止します。バッ
チ内にある後続のサブ要求の実行は試
みず、後続のサブ要求ごとに HTTP 412
状況コードと前の要求が失敗したこと
を示す BATCH_PROCESSING_HALTED
エラーメッセージを返しま
す。/connect/batch への最上位要求
は、HTTP 200 を返し、応答内の
hasErrors プロパティが true に設定
されます。
関連トピック:
フィード項目にいいね! と言い、いいね! の総数を返す
Generic Batch Input
ルート XML タグ
<request>
JSON
{
"method" : "Get",
"url" : "/v28.0/chatter/feeds/news/me"
}
560
使用可能な
バージョン
28.0
Chatter REST API リクエストボディ
Generic Batch Input
プロパティ
名前
型
説明
使用可能な
バージョン
binaryPartName
String
マルチパート要求のバイナリパートの 28.0
名前。
1 つのバッチ要求で複数のバイナリパー
トがアップロードされると、この値が
要求とバイナリパートの対応付けに使
用されます。名前の競合を防止するた
めに、バッチ要求内の各
binaryPartName プロパティには一意
の値を使用します。
このプロパティは省略可能です。この
値が存在する場合、
binaryPartNameAlias 値も存在する
必要があります。
binaryPartNameAlias
String
28.0
バイナリボディパートの
Content-Disposition ヘッダーの name パラ
メータ。リソースごとに異なる値を使
用します。「バイナリファイルのアッ
プロード」を参照してください。
このプロパティは省略可能です。この
値が存在する場合、binaryPartName
値も存在する必要があります。
method
String
次のいずれかの HTTP メソッド。
• HttpDelete — 成功した場合は HTTP
204 を返します。レスポンスボディ
または出力クラスは空です。
• HttpGet — 成功した場合は HTTP 200
を返します。
• HttpHead — 成功した場合は HTTP
200 を返します。レスポンスボディ
または出力クラスは空です。
• HttpPatch — 成功した場合は HTTP
200 を返し、レスポンスボディまた
は出力クラスが空の場合は HTTP 204
を返します。
• HttpPost — 成功した場合は HTTP
201 を返し、レスポンスボディまた
561
28.0
Chatter REST API リクエストボディ
名前
Generic Batch Input
型
説明
使用可能な
バージョン
は出力クラスが空の場合は HTTP 204
を返します。例外は、成功時に HTTP
200 を返すバッチ投稿リソースおよ
びメソッドです。
• HttpPut — 成功した場合は HTTP 200
を返し、レスポンスボディまたは出
力クラスが空の場合は HTTP 204 を返
します。
要求の入力ボディ。
richInput
28.0
型は url プロパティに指定された要求
に応じて異なります。
このプロパティは省略可能です。
url
要求する Chatter API リソース。この値は 28.0
サブ要求と呼ばれます。
String
サブ要求 URL は次のように開始できま
す。
• /services/data/version (例:
/services/data/v34.0
/chatter/users/me)。
• /version (例: /v34.0/chatter
/users/me)。バージョン番号
は、/connect/batch 要求 URL に指
定された要求のバージョン以下にす
る必要があります。
サブ要求に関する追加情報は、次のと
おりです。
• URL には、サブ要求がサポートする
クエリ文字列パラメータを含めるこ
とができます。クエリ文字列は、
URL 符号化されている必要がありま
す。
• パラメータを使用して、レスポンス
ボディの絞り込みを行うことができ
ます。
• サブ要求レベルでヘッダーを適用す
ることはできません。
562
Chatter REST API リクエストボディ
Group Chatter Settings Input
Group Chatter Settings Input
ルート XML タグ
<groupChatterSettings>
プロパティ
ユーザの Chatter 設定。
名前
型
説明
使用可能な
バージョン
emailFrequency
String
グループメンバーがグループから
メールを受信する頻度。有効な値
は、次のとおりです。
27.0
• EachPost
• DailyDigest
• WeeklyDigest
• Never
コミュニティでは、グループメン
バーが 10,000 人を超えると [各投稿
のメール] オプションが無効になり
ます。このオプションを選択したす
べてのメンバーは、自動的に [毎日
のダイジェスト] に切り替わりま
す。
Group Information Input
JSON
{
"text" : "Post questions about the API.",
"title" : "API Questions"
}
プロパティ
名前
型
説明
text
String
グループの [情報] セクション内のテ 28.0
キスト。HTML はサポートされてい
563
使用可能な
バージョン
Chatter REST API リクエストボディ
名前
Group Input
型
説明
使用可能な
バージョン
ません。最大文字数は 4000 文字 (バ
イト) です。
String
title
グループの [情報] セクションのタイ 28.0
トル。最大文字数は 240 文字 (バイ
ト) です。
Group Input
ルート XML タグ
<group>
JSON
{
"announcement" : "0D5D0000000K4XT",
"canHaveChatterGuests" : "true",
"description" : "This group is building a powerful API.",
"information" : {
"text" : "Read this section before you post to the group.",
"title" : "Information"
},
"isArchived" : "false",
"isAutoArchiveDisabled" : "false",
"name" : "Chatter API",
"owner" : "00590000000DmPw",
"visibility" : "PublicAccess"
}
564
Chatter REST API リクエストボディ
Group Input
プロパティ
名前
型
説明
使用可能な
バージョン
announcement
String
お知らせ ID。
31.0
お知らせは、削除されるか、別のお
知らせで置き換えられない限り、そ
の表示期限の 11:59 p.m. まで Salesforce
UI の指定の場所に表示されます。
このグループで Chatter 顧客を許可 29.0
している場合は true、それ以外の
場合は false。このプロパティを
true に設定した後で、false に設
定することはできません。
canHaveChatterGuests Boolean
description
String
グループの [説明] セクション
29.0
information
Group Information Input
グループの [情報] セクション Web UI 28.0
では、[情報] セクションは [説明] セ
クションの上にあります。グループ
が非公開の場合は、[情報] セクショ
ンはメンバーにのみ表示されます。
[説明] セクションは全員に表示され
ます。
isArchived
Boolean
グループがアーカイブ済みの場合は 29.0
true、それ以外の場合は false。
デフォルトは false です。
isAutoArchiveDisabled Boolean
グループの自動アーカイブが無効の 29.0
場合は true、それ以外の場合は
false。デフォルトは false で
す。
name
String
グループの名前
owner
String
グループ所有者の ID。このプロパ 29.0
ティは、PATCH 要求でのみ使用でき
ます。
565
29.0
Chatter REST API リクエストボディ
Group Member Input
名前
型
説明
使用可能な
バージョン
visibility
String
グループの表示種別を指定します。 29.0
次のいずれかの値になります。
• PrivateAccess — グループの
メンバーのみが、このグループ
への投稿を参照できます。
• PublicAccess — コミュニティ
のすべてのユーザが、このグ
ループへの投稿を参照できま
す。
• Unlisted — 今後の使用のため
に予約されています。
関連トピック:
グループを作成する
Group Member Input
ルート XML タグ
<member>
JSON の例
{
"role" : "GroupManager",
"userId" : "005B0000000Ge16"
}
プロパティ
名前
型
説明
role
String
メンバーのロール。次の 29.0
いずれかの値にします。
• GroupManager
• StandardMember
566
使用可能なバージョン
Chatter REST API リクエストボディ
Group Membership Request Update
名前
型
説明
使用可能なバージョン
userId
String
グループに追加するメン 23.0
バーのユーザ ID。
関連トピック:
グループに参加する
Group Membership Request Update
ルート XML タグ
<groupMembershipRequestUpdate>
プロパティ
名前
型
説明
使用可能なバージョン
responseMessage
String
このプロパティを使用して、メンバー 27.0
シップ要求が却下された場合にユーザ
に表示するメッセージを指定します。
このプロパティの値は、status プロパ
ティの値が Declined の場合にのみ使
用されます。
最大文字数は 756 文字です。
status
String
有効な値は次のとおりです。
• Accepted
• Declined
関連トピック:
非公開グループへの参加要求を承認または却下する
Group Record Input
Chatter グループに追加するレコード。
ルート XML タグ
<groupRecord>
JSON の例
{"recordId" : "001D000000Io9cD"}
567
27.0
Chatter REST API リクエストボディ
Link Capability Input
プロパティ
名前
型
説明
必須項目/省略可 使用可能なバー
能
ジョン
recordId
String
レコードの ID。
必須項目
34.0
Link Capability Input
フィード要素に添付されたリンクを作成または更新します。
ルート XML タグ
<linkCapability>
<url>http://www.example.com</url>
<urlName>Example</urlName>
</linkCapability>
JSON の例
{
"url": "http://www.example.com",
"urlName": "Example"
}
プロパティ
名前
型
説明
必須項目/省略可 使用可能なバー
能
ジョン
url
String
リンクの URL。
必須項目
32.0
urlName
String
リンクの名前。
省略可能
32.0
Managed Topic Input
管理トピック。
ルート XML タグ
<managedTopic>
568
Chatter REST API リクエストボディ
Managed Topic Input
JSON の例
{
"managedTopicType" :"Featured",
"recordId" :"0TOD00000000cwk"
}
プロパティ
名前
型
説明
必須項目/省略可 使用可能なバー
能
ジョン
managedTopic
Type
String
管理トピックの種別。
必須項目
32.0
• Featured — コミュニティホー
ムページなどの主要トピック。
ただし、全体的なナビゲーショ
ンは提供しません。
• Navigational — コミュニ
ティのナビゲーションメニュー
に表示されるトピック。
1 つのトピックは最大 2 つの種別の
管理トピックに関連付けることが
できるため、1 つのトピックを
Featured トピックと
Navigational トピックの両方に
することができます。
managedTopicType につき、最大
25 個の管理トピックを作成できま
す。
name
String
管理トピックの名前。
新規トピックで 32.0
は必須
name または
recordId を指
定する必要があ
ります。両方を
指定することは
できません。
569
Chatter REST API リクエストボディ
Managed Topic Position Collection Input
名前
型
説明
必須項目/省略可 使用可能なバー
能
ジョン
recordId
String
管理トピックになるレコードの
ID。
Name プロパ
ティが使用され
バージョン 32.0 では、recordId ていない場合、
はトピック ID である必要がありま 既存のトピック
に必要です。
す。
name または
recordId を指
定する必要があ
ります。両方を
指定することは
できません。
Managed Topic Position Collection Input
管理トピックの相対位置のコレクション。
ルート XML タグ
<managedTopicPositionCollection>
JSON の例
{
"managedTopicPositions" : [
{
"managedTopicId" :"0mtD0000000001aIAA",
"position" :"0"
},
{
"managedTopicId" :"0mtD0000000002qIAA",
"position" :"2"
}
]
}
570
32.0
Chatter REST API リクエストボディ
Managed Topic Position Collection Input
プロパティ
名前
型
説明
必須項目/省略可 使用可能なバー
能
ジョン
managedTopic
Positions
Managed Topic
Position Input[]
Managed Topic Position リクエストボ 必須項目
ディのコレクション。このコレク
ションには、Featured および
Navigational 管理トピックを含
めることができます。また、すべ
ての管理トピックを含める必要は
ありません。
managedTopicPositions にすべ
ての管理トピックを含めない場
合、管理トピックは
managedTopicPositions で指示
された位置に従って並び替えら
れ、managedTopicPositions に
含まれない管理トピックは次に空
いている位置まで順序を下げられ
ます。「管理トピックの並び替え
の例」を参照してください。
管理トピックの並び替えの例
次の管理トピックがあるとします。
Managed Topic
位置
ManagedTopicA
0
ManagedTopicB
1
ManagedTopicC
2
ManagedTopicD
3
ManagedTopicE
4
Managed Topic Position Collection Input に次の情報を含めて管理トピックを並び替えます。
管理トピック
位置
ManagedTopicD
0
ManagedTopicE
2
571
32.0
Chatter REST API リクエストボディ
Managed Topic Position Input
結果は次のとおりです。
管理トピック
位置
ManagedTopicD
0
ManagedTopicA
1
ManagedTopicE
2
ManagedTopicB
3
ManagedTopicC
4
Managed Topic Position Input
管理トピックの相対位置。
ルート XML タグ
<managedTopicPosition>
JSON の例
{
"managedTopicId" :"0mtD0000000001aIAA",
"position" :"0"
}
プロパティ
名前
型
managedTopicId String
position
Integer
説明
必須項目/省略可 使用可能なバー
能
ジョン
既存の管理トピックの ID。
必須項目
32.0
管理トピックの相対的位置。ゼロ 必須項目
から開始する昇順の整数でイン
デックスが付けられます。
32.0
Message Body Input
名前
型
説明
使用可能なバージョン
messageSegments
Segments[]
種別に基づくメッセージ
セグメントのコレクショ
ン。セグメントは次のい
ずれかになります。
23.0
572
Chatter REST API リクエストボディ
名前
Message Segment Input: Hash Tag
型
説明
使用可能なバージョン
• Message Segment Input:
Hash Tag
• Message Segment Input:
Link
• Message Segment Input:
Mention
• Message Segment Input:
Text
Message Segment Input: Hash Tag
インラインハッシュタグを表します。ハッシュタグもテキストセグメントから解析されるため、このセグメン
トの使用は省略可能です。
名前
型
説明
使用可能なバージョン
tag
String
ハッシュタグを除いたハッ 23.0
シュタグのテキスト。
複数語のハッシュタグは、
メモ: ハッシュタグ バージョン 28.0 で使用でき
テキストでは、閉じ ます。
る角括弧 ( ] ) はサ
ポートされていませ
ん。テキストに閉じ
る角括弧 ( ] ) が含ま
れていると、ハッ
シュタグはその括弧
で終了します。
type
String
値は Hashtag です。
23.0
Message Segment Input: Link
URL へのインラインリンクを表します。先頭に空白テキストのないリンクが入力として指定された場合、空白
が挿入されます。末尾に空白テキストのないリンクが入力として指定された場合も、空白が挿入されます。リ
ンクもテキストセグメントから解析されるため、このセグメントの使用は省略可能です。
名前
型
説明
使用可能なバージョン
type
String
値は Link です。
23.0
url
URL
リンクに使用する URL。
23.0
573
Chatter REST API リクエストボディ
Message Segment Input: Mention
Message Segment Input: Mention
ユーザまたはグループのインラインメンションを表します。ユーザまたはグループの ID を指定する必要があ
ります。空白は追加されません。フィード項目またはコメントを作成する場合、最大 25 個のメンションを含
めることができます。
名前
型
説明
使用可能なバージョン
id
String
メンションされるユーザ
またはグループの ID。
23.0
値は Mention
23.0
String
type
グループは 29.0 で使用でき
ます。
Message Segment Input: Text
プレーンインラインテキストを表します。リンクのような外見で、前後に空白のあるテキストは、リンクセグ
メントに変換されます。プレフィックスとしてハッシュが付加され、前後が角括弧 ([]) で囲まれたテキストは、
ハッシュタグセグメントに変換されます。複数語のハッシュタグは、バージョン 28.0 以上で使用できます。
名前
型
説明
使用可能なバージョン
text
String
このセグメントのプレー
ンテキスト。
23.0
type
String
値は Text のみ。
23.0
Moderation Flag Input
ルート XML タグ
<moderationFlag>
JSON
{
"visibility" : "ModeratorsOnly"
}
574
Chatter REST API リクエストボディ
Photo Input
プロパティ
名前
型
説明
使用可能なバー
ジョン
visibility
String
さまざまなユーザ種別でのフラグの表示動 30.0
作を指定します。
• ModeratorsOnly — フラグは、フラグ
が付けられた要素または項目に対するモ
デレーション権限を持つユーザにのみ表
示されます。
• SelfAndModerators — フラグは、フラ
グの作成者とフラグが付けられた要素ま
たは項目に対するモデレーション権限を
持つユーザに表示されます。
Photo Input
写真入力について説明します。
ルート XML タグ
<photo>
JSON の例
{
"cropSize" : "120",
"cropX" : "0",
"cropY" : "0",
"fileId" : "069D00000001IOh"
}
プロパティ
名前
型
説明
必須項目/省略可能
cropSize
Integer
トリミングする四角形の任意 アップロードされたファイ 29.0
の境界の長さ (ピクセル単位)。 ルまたは既存のファイルを
トリミングする必要があり
ます。
cropX
Integer
画像の左端を起点とした、ト
リミングする四角形の開始位
575
使用可能な
バージョン
アップロードされたファイ 29.0
ルまたは既存のファイルを
Chatter REST API リクエストボディ
名前
型
Poll Capability Input
説明
必須項目/省略可能
使用可能な
バージョン
置 X (ピクセル単位)。左上の位 トリミングする必要があり
置は (0,0) です。
ます。
cropY
Integer
画像の上端を起点とした、ト
リミングする四角形の開始位
置 Y (ピクセル単位)。左上の位
置は (0,0) です。
アップロードされたファイ 29.0
ルまたは既存のファイルを
トリミングする必要があり
ます。
fileId
String
既存のファイルの 18 文字の
既存のファイルを選択する 25.0
ID。キープレフィックスは
必要があります。
069、ファイルサイズは 2 MB 未
満にする必要があります。
メモ: グループページお
よびユーザページにアッ
プロードされた画像には
ファイル ID がないため、
使用できません。
versionNumber
Integer
既存のファイルのバージョン 省略可能
番号。指定されていない場合、
最新のバージョンが使用され
ます。
関連トピック:
グループの写真を更新およびトリミングする
ユーザの写真を更新およびトリミングする
Poll Capability Input
フィード要素に添付されたアンケートの作成、更新、または投票を行います。
XML の例
<pollCapability>
<pollChoices>
<choice>Monday</choice>
<choice>Tuesday</choice>
</pollChoices>
576
25.0
Chatter REST API リクエストボディ
Push Notification Input
</pollCapability>
JSON の例
{
"choices" : [
"Monday", "Tuesday"
]
}
プロパティ
名前
型
説明
必須項目/省略可 使用可能なバー
能
ジョン
choices
String []
新しいアンケートの作成に使用す アンケートの作 32.0
る選択肢。アンケートには 2 個か 成では必須
ら 10 個のアンケート選択肢を指定
する必要があります。
myChoiceId
String
フィードアンケートの既存の選択 アンケートへの 32.0
肢の ID。既存のアンケートに投票 投票では必須
するために使用されます。
Push Notification Input
転送通知。
ルート XML タグ
<pushNotification>
JSON の例
{
"appName" : "TestApp",
"namespace" : "abc",
"userIds" : ["005x00000013dPK", "005x00000013dPL"],
"payload" : "{'aps':{'alert':'test', 'badge':0, 'sound':'default'}}"
}
577
Chatter REST API リクエストボディ
Question and Answers Capability Input
プロパティ
名前
型
説明
必須項目/省略可 使用可能なバー
能
ジョン
appName
String
転送通知の送信先の接続アプリ
ケーションの API 名。
必須項目
namespace
String
転送通知の送信先の接続アプリ
ケーションの名前空間。
必須項目 (名前空 31.0
間が設定されて
いる場合)
payload
String
JSON 形式の転送通知ペイロード。 必須項目
31.0
userIds
String []
転送通知受信者のユーザ ID。
31.0
必須項目
31.0
Question and Answers Capability Input
質問フィード要素を作成するか、既存の質問フィード要素の最良の回答を設定します。
ルート XML タグ
<questionAndAnswersCapability>
<bestAnswerId>0D7D00000000lMAKAY</bestAnswerId>
</questionAndAnswersCapability>
JSON の例
{
"bestAnswerId": "0D7D00000000lMAKAY"
}
プロパティ
名前
型
説明
必須項目/省略可 使用可能なバー
能
ジョン
bestAnswerId
String
質問フィード要素の最良の回答と
して使用するコメント ID。最良の
回答コメントは、質問フィード要
素にすでに存在する必要がありま
す。
フィード要素の 32.0
PATCH では必須
です。
578
POST 要求ではサ
ポートされてい
ません。
Chatter REST API リクエストボディ
名前
型
questionTitle String
Recommendation Definition Input
説明
必須項目/省略可 使用可能なバー
能
ジョン
質問フィード要素のタイトル。
フィード要素の 32.0
POST では必須で
す。
PATCH 要求では
サポートされて
いません。
Recommendation Definition Input
おすすめ定義。
JSON の例
{
"actionUrl" : "https://www.example.com",
"actionUrlName" : "Launch",
"explanation" : "Click this link to learn more!",
"name" : "Corporate Training Project",
"title" : "Want to learn more about Corporate Training Project?"}
プロパティ
名前
型
説明
必須項目/省略可 使用可能なバー
能
ジョン
actionUrl
String
おすすめに基づいて行動するため おすすめ定義を 33.0
の URL （グループに参加するため 作成する場合は
の URL など）。
必須です。
既存のおすすめ
定義を更新する
場合は省略可能
です。
actionUrlName String
ユーザインターフェースのアク
ション URL のテキストラベル
("Launch" など)。
おすすめ定義を 34.0
作成する場合は
必須です。
既存のおすすめ
定義を更新する
579
Chatter REST API リクエストボディ
名前
型
Request Header Input
説明
必須項目/省略可 使用可能なバー
能
ジョン
場合は省略可能
です。
explanation
String
おすすめの説明 (本文)。
おすすめ定義を 33.0
作成する場合は
必須です。
既存のおすすめ
定義を更新する
場合は省略可能
です。
name
String
おすすめ定義の名前。この名前が おすすめ定義を 33.0
[設定] に表示されます。
作成する場合は
必須です。
既存のおすすめ
定義を更新する
場合は省略可能
です。
title
String
おすすめ定義のタイトル。
省略可能
33.0
Request Header Input
HTTP 要求ヘッダー名と値のペア。
JSON の例
{
"name": "Content-Type",
"value": "application/json"
}
プロパティ
名前
型
説明
必須項目/省略可 使用可能なバー
能
ジョン
name
String
要求ヘッダーの名前。
必須項目
33.0
value
String
要求ヘッダーの値。
必須項目
33.0
580
Chatter REST API リクエストボディ
Scheduled Recommendation Input
Scheduled Recommendation Input
スケジュール済みおすすめ。
新しいスケジュール済みおすすめを作成する JSON の例
{
"rank" : "2",
"recommendationDefinitionId" : "0RDD00000004CEhOAM"}
既存のスケジュール済みおすすめを更新する JSON の例
{
"rank" : "2"}
プロパティ
名前
型
説明
必須項目/省略可 使用可能なバー
能
ジョン
enabled
Boolean
スケジュールが有効になっている 省略可能
かどうかを示します。true の場
合、おすすめが有効になり、コ
ミュニティに表示されます。
false の場合、Salesforce1 モバイル
ブラウザアプリケーションでの
フィードのおすすめは削除されま
せんが、新しいおすすめは表示さ
れなくなります。Summer '15 以降
のバージョンの Napili テンプレート
を使用したコミュニティでは、無
効にしたおすすめは表示されなく
なります。
34.0
rank
Integer
スケジュール済みおすすめの相対 省略可能
的なランク。1 から開始する昇順
の整数で示されます。
33.0
ランクを設定することと、順序付
きリストに挿入することは同じで
す。スケジュール済みおすすめ
は、rank で指定された位置に挿
入されます。それ以降のすべての
スケジュール済みおすすめの rank
が 1 つずつ下がります。「スケ
ジュール済みおすすめにランクを
付ける場合の例」を参照してくだ
さい。
581
Chatter REST API リクエストボディ
名前
型
Scheduled Recommendation Input
説明
必須項目/省略可 使用可能なバー
能
ジョン
指定された rank がリストのサイ
ズよりも大きい場合は、スケ
ジュール済みおすすめがリストの
末尾に配置されます。スケジュー
ル済みおすすめの rank には、指
定された値の代わりにリストのサ
イズが指定されます。
rank が指定されていない場合は、
スケジュール済みおすすめがリス
トの末尾に配置されます。
recommendation String
DefinitionId
このスケジュール済みおすすめに スケジュール済 33.0
よってスケジュールされたおすす みおすすめを作
め定義の ID。
成する場合は必
須です。
既存のスケ
ジュール済みお
すすめを更新す
る場合は、
recommendation
DefinitionId
を指定できませ
ん。
スケジュール済みおすすめにランクを付ける場合の例
次のようなスケジュール済みおすすめがあり、
スケジュール済みおすすめ
ランク
ScheduledRecommendationA
1
ScheduledRecommendationB
2
ScheduledRecommendationC
3
Scheduled Recommendation Input に次の情報を含めるとします。
スケジュール済みおすすめ
ランク
ScheduledRecommendationD
2
582
Chatter REST API リクエストボディ
Share Input
結果は次のとおりです。
スケジュール済みおすすめ
ランク
ScheduledRecommendationA
1
ScheduledRecommendationD
2
ScheduledRecommendationB
3
ScheduledRecommendationC
4
Share Input
JSON の例
{
"id": "005D0000001Az4l",
"sharingType": "V"
}
プロパティ
名前
型
説明
使用可能なバー
ジョン
id
String
ファイルの共有先のユーザ ID
30.0
sharingType
String
コラボレータの場合は C、閲覧者の場合は V 30.0
Topic Assignment Input
フィード項目またはレコードに割り当てるトピックを表します。ユーザがオブジェクト種別のレコードにト
ピックを追加できるようにするには、事前にシステム管理者がそのオブジェクトでトピックを有効化しておく
必要があります。
ルート XML タグ
<topicAssignment>
JSON
次の例では、トピックをレコードに割り当てます。
{ "topicId": "0TOD0000000090r"
}
583
Chatter REST API リクエストボディ
Topic Endorsement Input
プロパティ
名前
型
説明
必須項目/省略可能
使用可能
なバー
ジョン
topicId
String
既存のトピックの ID。
topicName プロパティが
30.0
使用されていない場合、既
存のトピックに必要です。
topicName
String
30.0
新規または既存のトピック 新規のトピック、および
の名前。
topicId プロパティが使
用されていない場合の既存
のトピックに必要です。
Topic Endorsement Input
トピックに関する知識のあるユーザを支持します。
ルート XML タグ
<topicEndorsement>
JSON
{
"userId" : "005B0000000Ge16"
}
プロパティ
名前
型
説明
必須項目/省略可能
userId
String
指定したトピックに 必須項目
ついて支持される
ユーザの ID。
使用可能なバージョ
ン
30.0
Topic Input
ルート XML タグ
<topic>
JSON
{
"description" : "World Wide Web Consortium (W3C) is the main international standards
584
Chatter REST API リクエストボディ
User Chatter Settings Input
organization for the Web."
"name" : "W3C"}
プロパティ
名前
型
説明
使用可能なバージョン
description
String
トピックのテキストによ 28.0
る説明
idsToMerge
String []
トピックにマージする最 33.0
大 5 個のトピック ID のリ
スト。
メモ: トピックの
マージはベータ版
で、既知の制限が
あります。
IdeaExchange で
フィードバックを
お寄せください。
name
String
トピックの名前
28.0
トピック名の大文字、小
文字、スペースのみを変
更するには、このプロパ
ティを使用します。
User Chatter Settings Input
ユーザのグローバル Chatter 設定。
ルート XML タグ
<userChatterSettings>
プロパティ
名前
型
説明
defaultGroup
EmailFrequency
String
ユーザが参加するグループからメール 27.0
を受信するデフォルトの頻度。有効な
値は、次のとおりです。
• EachPost
• DailyDigest
• WeeklyDigest
585
使用可能な
バージョン
Chatter REST API リクエストボディ
名前
User Input
型
説明
使用可能な
バージョン
• Never
コミュニティでは、グループメンバー
が 10,000 人を超えると [各投稿のメー
ル] オプションが無効になります。こ
のオプションを選択したすべてのメン
バーは、自動的に [毎日のダイジェス
ト] に切り替わります。
User Input
ルート XML タグ
<user>
プロパティ
名前
型
説明
使用可能なバージョン
aboutMe
String
29.0
User Detail レスポンスボ
ディの aboutMe プロパ
ティ。最大文字数は 1000
文字です。このプロパ
ティが、コミュニティま
たは組織のすべてのメン
バーに表示されるユーザ
プロファイルの [自己紹
介] セクションに入力され
ます。
JSON の例
{
"aboutMe": "Staff Technical Writer responsible for the Connect API and Connect in
Apex documentation."
}
関連トピック:
ユーザプロファイルを更新する
586
Chatter REST API リクエストボディ
User Message
User Message
ルート XML タグ
<message>
プロパティ
名前
型
説明
body
String
メッセージ本文のテキス 23.0
ト
inReplyTo
String
このメッセージが含まれ 23.0
る会話を識別する既存の
メッセージの ID。
recipients または
inReplyTo を指定する
必要があります。両方で
はなく、どちらか一方を
指定する必要がありま
す。
recipients
User Message Recipient List
Input
目的のメッセージ受信者 23.0
であるユーザ (最大 9 人)
のリスト。ユーザ ID のカ
ンマ区切りのリスト。
recipients または
inReplyTo を指定する
必要があります。両方で
はなく、どちらか一方を
指定する必要がありま
す。
XML 形式の例:
<message>
<body>Text of the message</body>
<recipients>
<recipient>userID</recipient>
<recipient>userID</recipient>
</recipients>
<inReplyTo>messageID</inReplyTo>
587
使用可能なバージョン
Chatter REST API リクエストボディ
User Message Recipient Input
</message>
JSON 形式の例:
{
"body": "Text of the message",
"recipients": ["userID","userID"],
"inReplyTo": "messageID"
}
関連トピック:
非公開メッセージを送信する
User Message Recipient Input
ルート XML タグ
<recipient>
プロパティ
名前
型
説明
使用可能なバージョン
recipient
String
メッセージを受信する
ユーザの 18 文字の ID。
23.0
説明
使用可能なバージョン
User Message Recipient List Input
ルート XML タグ
<message>
プロパティ
名前
型
recipients
User Message Recipient Input[] メッセージを受信する受 23.0
信者のコレクション。
588
Chatter REST API リクエストボディ
User Status Input
User Status Input
メモ: User Status Input を使用したユーザ状況の設定は、バージョン 25.0 以降使用できなくなります。代わ
りに、Feed Item Input を使用してフィードにフィード項目を post 送信してください。
ルート XML タグ
<userStatus>
プロパティ
名前
型
説明
使用可能なバージョン
body
Message Body Input
メッセージ本文の説明。 23.0 ～ 24.0
User Stream (Conversation) Input
ルート XML タグ
<conversation>
プロパティ
名前
型
説明
read
Boolean
会話状況を未読 (false) 24.0
または既読 (true) に変更
します。
589
使用可能なバージョン
第7章
Chatter REST API レスポンスボディ
Chatter REST API リソースへの要求の実行が成功すると、JSON または XML 形式でレスポンスボディが返される場
合があります。
Chatter REST API リソースへの要求では、要求が成功したかどうかに関係なく、常に HTTP 応答コードが返されま
す。
Action Link Definition
アクションリンクの定義。この情報を参照するには、アクションリンク定義の作成時に使用した接続アプリ
ケーションを要求で使用する必要があります。
プロパティ名
型
説明
actionUrl
String
アクションリンクの URL。たとえ
Small、33.0
ば、Ui アクションリンク URL は Web
ページになります。Download アク
ションリンク URL は、ダウンロード
するファイルへのリンクになりま
す。Ui および Download アクショ
ンリンク URL がクライアントに提供
されます。Api または ApiAsync
アクションリンク URL は REST リソー
スになります。Api および
ApiAsync アクションリンク URL は
クライアントに提供されません。
Salesforceへのリンクは、相対リンク
にすることができます。他のすべ
てのリンクは、https:// で始まる
絶対リンクにする必要があります。
33.0
createdDate
Date
ISO 8601 形式の日付文字列 (例:
2011-02-25T18:24:31.000Z)。
Small、33.0
33.0
アクションの実行から除外する単 Small、33.0
一ユーザの ID。excludedUserId
を指定した場合、userId を指定で
きません。
33.0
このアクションがアクションリン Small、33.0
クグループのデフォルトアクショ
ンリンクである場合は true、それ
33.0
excludedUserId String
groupDefault
Boolean
検索条件グルー
プとバージョン
590
使用可能なバー
ジョン
Chatter REST API レスポンスボディ
プロパティ名
型
Action Link Definition
説明
検索条件グルー
プとバージョン
使用可能なバー
ジョン
Big、33.0
33.0
以外の場合は false。各アクショ
ンリンクグループに含めることが
できるデフォルトアクションリン
クは 1 つだけです。Salesforce UI で
は、デフォルトアクションリンク
には区別しやすいスタイルが適用
されます。
headers
Request Header[]
Api および ApiAsync アクション
リンク種別の要求ヘッダー。
id
String
アクションリンク定義の 18 文字の Small、33.0
ID。
33.0
label
String
アクションリンクボタンに表示す Small、34.0
るカスタムの表示ラベル。label
値は、アクションリンクテンプレー
トでのみ設定できます。
34.0
アクションリンクには、NewStatus、
PendingStatus、SuccessStatus、
FailedStatus の 4 つの状況がありま
す。次の文字列が、各状況の表示
ラベルに追加されます。
• 表示ラベル
• 表示ラベル待機中
• 表示ラベル成功
• 表示ラベル失敗
たとえば、label の値が「See
Example」の場合、4 つのアクション
リンクの状態の値は「See
Example」、「See Example 待機中」、
「See Example 成功」、および「See
Example 失敗」になります。
アクションリンクでは、表示ラベ
ル名の生成に label または
labelKey を使用できますが、両
方は使用できません。label に値
がある場合、labelKey の値は
None になります。labelKey に
None 以外の値がある場合、label
の値は null になります。
591
Chatter REST API レスポンスボディ
Action Link Definition
プロパティ名
型
説明
検索条件グルー
プとバージョン
labelKey
String
ユーザインターフェースに表示さ Small、33.0
れる表示ラベルのセットのキー。
セットには、NewStatus、
PendingStatus、SuccessStatus、
FailedStatus の状態の表示ラベルが含
まれます。たとえば、Approve
キーを使用する場合、[承認]、[待機
中]、[承認済み]、[失敗] の表示ラベ
ルが含まれます。
使用可能なバー
ジョン
33.0
「アクションリンクの表示ラベル」
を参照してください。
method
String
HTTP メソッド。次のいずれかの値
にします。
• HttpDelete — 成功した場合は
HTTP 204 を返します。レスポン
スボディまたは出力クラスは空
です。
• HttpGet — 成功した場合は HTTP
200 を返します。
• HttpHead — 成功した場合は
HTTP 200 を返します。レスポン
スボディまたは出力クラスは空
です。
• HttpPatch — 成功した場合は
HTTP 200 を返し、レスポンスボ
ディまたは出力クラスが空の場
合は HTTP 204 を返します。
• HttpPost — 成功した場合は
HTTP 201 を返し、レスポンスボ
ディまたは出力クラスが空の場
合は HTTP 204 を返します。例外
は、成功時に HTTP 200 を返す
バッチ投稿リソースおよびメ
ソッドです。
• HttpPut — 成功した場合は HTTP
200 を返し、レスポンスボディ
または出力クラスが空の場合は
HTTP 204 を返します。
592
Medium、33.0
33.0
Chatter REST API レスポンスボディ
Action Link Definition
プロパティ名
型
説明
検索条件グルー
プとバージョン
使用可能なバー
ジョン
modifiedDate
Date
ISO8601 の日付文字列 (例:
2011—02—25T18:24:31.000Z)。
Small、33.0
33.0
requestBody
String
Api および ApiAsync アクション
Big、33.0
33.0
リンク種別のリクエストボディ。
requires
Confirmation
Boolean
ユーザにアクションを確認するよ Small、33.0
うに要求する場合は true、それ以
外の場合は false。
33.0
templateId
String
このアクションリンクのインスタ Medium、33.0
ンス化に使用されたアクションリ
ンクテンプレートの ID。アクション
リンクがテンプレートに関連付け
られていない場合、値は null で
す。
33.0
type
String
アクションリンクの種別を定義し
ます。値は次のとおりです。
33.0
• Api — アクションリンクは、ア
クション URL で同期 API をコール
します。Salesforce は、サーバか
ら返された HTTP 状況コードに基
づいて状況を
SuccessfulStatus または
FailedStatus に設定します。
• ApiAsync — アクションリンク
は、アクション URL で非同期 API
をコールします。アクション
は、非同期操作の完了時にサー
ドパーティが
/connect/action-links/actionLinkId
への要求を行って状況を
SuccessfulStatus または
FailedStatus に設定するま
で、PendingStatus 状態のま
まになります。
• Download — アクションリンク
は、アクション URL からファイ
ルをダウンロードします。
• Ui — アクションリンクは、ア
クション URL で Web ページを
ユーザに表示します。
593
Small、33.0
Chatter REST API レスポンスボディ
Action Link Diagnostic
プロパティ名
型
説明
検索条件グルー
プとバージョン
userId
String
アクションを実行できるユーザの Small、33.0
ID。指定しない場合や null の場
合、すべてのユーザがアクション
を実行できます。userId を指定し
た場合、excludedUserId を指定
できません。
使用可能なバー
ジョン
33.0
Action Link Diagnostic
アクションリンクが実行されたときに REST エンドポイントから返された診断情報。診断情報は、アクション
リンクにアクセスできるユーザに対してのみ提供されます。
プロパティ名
型
diagnosticInfo String
url
String
説明
検索条件グルー
プとバージョン
使用可能なバー
ジョン
アクションリンクが実行されたと Small、33.0
きに REST エンドポイントから返さ
れた診断情報。診断情報は、アク
ションリンクにアクセスできるユー
ザに対してのみ提供されます。
33.0
このアクションリンク診断情報の
Chatter REST API URL。
33.0
Small、33.0
Action Link Group Definition
アクションリンクグループの定義。すべてのアクションリンクはグループに属している必要があります。1 つ
のグループ内のアクションリンクは、相互排他的で、同じプロパティを共有します。各自のアクショングルー
プでスタンドアロンアクションを定義します。
プロパティ名
型
説明
検索条件グルー
プとバージョン
使用可能なバー
ジョン
actionLinks
Action Link
Definition[]
アクションリンクグループを構成
するアクションリンク定義のコレ
クション。
Medium、33.0
33.0
アクションリンクグループ内では、
アクションリンクは、Action Link
Group Definition Input リクエストボ
ディの actionLinks プロパティに
リストされる順序で表示されます。
594
Chatter REST API レスポンスボディ
プロパティ名
型
Action Link Group Definition
説明
検索条件グルー
プとバージョン
使用可能なバー
ジョン
Medium、33.0
33.0
フィード項目内では、アクション
リンクグループは、Associated Actions
Capability Input リクエストボディの
actionLinkGroupIds プロパティ
に指定された順序で表示されます。
category
String
アクションリンクの優先度および
位置を示します。値は次のとおり
です。
• Primary — アクションリンクグ
ループは、フィード要素の本文
に表示されます。
• Overflow — アクションリンク
グループは、フィード要素の
オーバーフローメニューに表示
されます。
createdDate
Date
ISO8601 の日付文字列 (例:
2011-02-25T18:24:31.000Z)
Small、33.0
33.0
executions
Allowed
String
アクションリンクを実行できる回
数を定義します。値は次のとおり
です。
Medium、33.0
33.0
このアクショングループの有効期 Medium、33.0
限が切れて実行できなくなる日時
を表す ISO 8601 日付文字列 (例:
2011-02-25T18:24:31.000Z)。値が null
の場合、有効期限はありません。
33.0
• Once — アクションリンクは、
すべてのユーザで 1 回のみ実行
できます。
• OncePerUser — アクションリ
ンクは、各ユーザで 1 回のみ実
行できます。
• Unlimited — アクションリン
クは、各ユーザで無制限に実行
できます。アクションリンクの
actionType が Api または
ApiAsync の場合、この値を使
用できません。
expirationDate Date
595
Chatter REST API レスポンスボディ
Address
プロパティ名
型
説明
検索条件グルー
プとバージョン
使用可能なバー
ジョン
id
String
アクションリンクグループ定義の
18 文字の ID
Small、33.0
33.0
modifiedDate
Date
ISO8601 の日付文字列 (例:
2011-02-25T18:24:31.000Z)
Small、33.0
33.0
templateId
String
このアクションリンクグループを Medium、33.0
インスタンス化するアクションリ
ンクグループテンプレートの ID。ま
たは、このグループがテンプレー
トに関連付けられていない場合は
null。
33.0
url
String
このアクションリンクグループ定
義の Chatter REST API URL。
33.0
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
city
String
市区郡の名前
Small、29.0
23.0
country
String
国の名前
Small、29.0
23.0
formatted
Address
String
ロケールに従って書式設定された住所
Small、29.0
25.0
state
String
都道府県などの名前
Small、29.0
23.0
street
String
町名・番地
Small、29.0
23.0
zip
String
郵便番号
Small、29.0
23.0
Small、33.0
Address
Announcement
お知らせは、削除されるか、別のお知らせで置き換えられない限り、その表示期限の 11:59 p.m. まで Salesforce UI
の指定の場所に表示されます。
プロパティ名
型
expirationDate Date
説明
検索条件グルー
プとバージョン
使用可能なバー
ジョン
別のお知らせが最初に投稿されて
いない限り、この日付の 11:59 p.m.
Small、31.0
31.0
596
Chatter REST API レスポンスボディ
プロパティ名
型
Announcement Page
説明
検索条件グルー
プとバージョン
使用可能なバー
ジョン
まで Salesforce UI にお知らせが表示
されます。Salesforce UI では、
expirationDate の時間値は無視
されます。ただし、時間値を使用
して各自の UI で独自の表示ロジッ
クを作成することはできます。
feedElement
Feed Item
お知らせの本文およびそれに関連 Small、31.0
するコメントやいいね! などを含む
フィード要素。
31.0
id
String
お知らせの 18 文字の ID。
Small、31.0
31.0
url
String
お知らせへの URL。
Small、33.0
33.0
検索条件グルー
プとバージョン
使用可能なバー
ジョン
Announcement Page
Announcement レスポンスボディのページ設定されたコレクション。
プロパティ名
型
説明
announcements Announcement[]
Announcement レスポンスボディのコ Small、31.0
レクション。お知らせは、削除さ
れるか、別のお知らせで置き換え
られない限り、その表示期限の 11:59
p.m. まで Salesforce UI の指定の場所に
表示されます。
31.0
currentPageUrl String
現在のページを識別する Chatter REST Medium、31.0
API URL。
31.0
次のページを識別する Chatter REST Small、31.0
API URL。次のページがない場合は
null。別のページを取得する前
に、この値が null であるかどうか
を確認します。ページが存在しな
い場合は、
31.0
nextPageUrl
String
ConnectApi.NotFoundException
エラーが返されます。
previousPageUrl String
前のページを識別する Chatter REST
API URL。前のページがない場合は
null。
597
Medium、31.0
31.0
Chatter REST API レスポンスボディ
Approval Capability
Approval Capability
フィード要素にこの機能がある場合、承認に関する情報が含まれています。
プロパティ名
型
説明
id
String
作業項目 ID。承認レコードに関連付 Small、32.0
けられた保留中の作業項目がない
場合、作業項目 ID は null です。
32.0
postTemplate
Fields
Approval Post
Template Field[]
承認投稿テンプレート項目の詳細。 Small、32.0
32.0
プロセスインスタンスステップ ID。 Small、32.0
関連付けられたレコードが承認プ
ロセスの 1 つのステップを表しま
す。
32.0
承認の状況。次のいずれかの値に
します。
32.0
processInstance String
StepId
status
String
検索条件グルー
プとバージョン
Small、32.0
使用可能なバー
ジョン
• Approved
• Fault
• Held
• NoResponse
• Pending
• Reassigned
• Rejected
• Removed
• Started
Approval Post Template Field
承認投稿テンプレート項目の説明。
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
displayName
String
項目名
Small、29.0
28.0
displayValue
String
項目値。項目が null に設定されている場合 Small、29.0
は null。
28.0
598
Chatter REST API レスポンスボディ
Article Item
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
record
Reference
レコード ID
Small、29.0
28.0
レコードが存在しない場合、または参照が
null の場合、この値は null になります。
Article Item
質問および回答の検索結果に含まれる記事項目。
プロパティ名
型
説明
検索条件グルー
プとバージョン
使用可能なバー
ジョン
id
String
記事 ID。
Small、32.0
32.0
rating
Double
記事の評価。
Small、32.0
32.0
title
String
記事のタイトル。
Small、32.0
32.0
urlLink
String
記事のリンク URL。
Small、32.0
32.0
viewCount
Integer
記事への投票数。
Small、32.0
32.0
Associated Actions Capability
フィード要素にこの機能がある場合、フィード要素にプラットフォームアクションが関連付けられています。
プロパティ名
型
platformAction Platform Action
Group[]
Groups
説明
検索条件グルー
プとバージョン
フィード要素に関連付けられたプ Medium、33.0
ラットフォームアクショングルー
プ。プラットフォームアクション
グループは、Associated Actions
Capability Input リクエストボディに指
定された順序で返されます。
使用可能なバー
ジョン
33.0
Banner Capability
このフィード要素にこの機能がある場合、フィード要素にバナーのモチーフとスタイルが含まれます。
599
Chatter REST API レスポンスボディ
Batch Result Item
プロパティ名
型
説明
検索条件グルー
プとバージョン
使用可能なバー
ジョン
motif
Motif
バナーのモチーフ。
Small、31.0
31.0
style
String
色とアイコンセットでフィード項
目を装飾します。
Small、31.0
31.0
• Announcement — お知らせは、
削除されるか、別のお知らせで
置き換えられない限り、その表
示期限の 11:59 p.m. まで Salesforce
UI の指定の場所に表示されま
す。
Batch Result Item
プロパティ
型
説明
result
種別は、バッチ
のオブジェクト
種別によって異
なります。
バッチの種別によって異なります。値は次の Small、29.0
いずれかになる可能性があります。
重要: 結果
がエラーの
場合、種別
はコレク
ションで
す。
検索条件グ
ループと
バージョン
• /chatter/feed-elements/batch (v32.0)
のフィード項目
• Error Message (v23.0)
• File Summary
/chatter/files/batch/
fileIds
(v26.0)
• Group Member
/chatter/group-memberships/batch/
membershipIds
(v27.0)
• Group
/chatter/groups/batch/
groupIds
(v23.0)
600
使用可能な
バージョン
Chatter REST API レスポンスボディ
プロパティ
型
Batch Results
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
バッチ内のこの個別要求の状況を示す HTTP
状況コード
Small、29.0
23.0
検索条件グ
ループと
バージョン
使用可能な
バージョン
• Motif
/connect/motifs/batch/
idOrPrefixList
(v27.0)
• User Detail
/chatter/users/batch/
userIds
(v23.0)
• /connect/batch の場合、値はバッチ内
のサブ要求に応じて、どのレスポンスボ
ディにもなる可能性があります。(v28.0)
statusCode
Integer
Batch Results
プロパティ
型
説明
hasErrors
Boolean
結果セットに HTTP 状況コードが 400 番台また Small、29.0
は 500 番台の結果が 1 つ以上ある場合は
true、それ以外の場合は false
28.0
results
Batch Result Item[]
バッチの結果項目のコレクション
23.0
Small、29.0
Bookmarks Capability
フィード要素にこの機能がある場合、コンテキストユーザがそのフィード要素をブックマークできます。
プロパティ名
型
isBookmarked Boolean
ByCurrentUser
説明
検索条件グルー
プとバージョン
現在のユーザがフィード要素をブッ Small、32.0
クマークしているか (true )、否か
(false) を示します。
601
使用可能なバー
ジョン
32.0
Chatter REST API レスポンスボディ
Case Comment Capability
Case Comment Capability
フィード要素にこの機能がある場合、ケースフィードにケースコメントが含まれます。
プロパティ名
型
説明
検索条件グルー
プとバージョン
使用可能なバー
ジョン
actorType
String
コメントを行ったユーザの種別を
示します。
Small、32.0
32.0
• Customer — Chatter 顧客がコメ
ントを行った場合
• CustomerService — サービス
担当者がコメントを行った場合
createdBy
User Detail または コメントを作成したユーザに関す
User Summary
る情報。
Small、32.0
32.0
createdDate
Date
ISO8601 の日付文字列 (例:
2011-02-25T18:24:31.000Z)。
Small、32.0
32.0
eventType
String
ケースフィードのコメントのイベ
ントタイプを示します。
Small、32.0
32.0
• NewInternal — 新しく「社内
のみ」とマークされたケースコ
メント。
• NewPublished — 新しく公開さ
れたケースコメント。
• NewPublishedByCustomer —
新しく公開された、顧客による
ケースコメント。
• PublishExisting — 再公開さ
れた既存のケースコメント。
• PublishExistingByCustomer
— 再公開された、顧客による既
存のケースコメント。
• UnpublishExistingByCustomer
— 非公開にされた、顧客による
既存のケースコメント。
• UnpublishExsiting — 非公開
にされた既存のケースコメン
ト。
メモ: この入力ミスは、ド
キュメントではなくコード
に含まれています。コード
602
Chatter REST API レスポンスボディ
プロパティ名
型
Canvas Capability
説明
検索条件グルー
プとバージョン
使用可能なバー
ジョン
でこのスペルを使用してく
ださい。
id
String
ケースコメントの 18 文字の ID。
Small、32.0
32.0
published
Boolean
コメントが公開されたかどうかを
示します。
Small、32.0
32.0
text
String
ケースコメントのテキスト。
Small、32.0
32.0
Canvas Capability
フィード要素にこの機能がある場合、キャンバスアプリケーションが表示されます。
プロパティ名
型
説明
検索条件グルー
プとバージョン
使用可能なバー
ジョン
description
String
キャンバスアプリケーションの説
明。最大サイズは 255 文字です。
Small、32.0
32.0
developerName String
接続アプリケーションの API 名 (開
発者名)。
Small、32.0
32.0
height
String
キャンバスアプリケーションの高
さ (ピクセル単位)。
Small、32.0
32.0
icon
ConnectApi.Icon
キャンバスアプリケーションのア
イコン。
Small、32.0
32.0
namespacePrefix String
キャンバスアプリケーションの一
意の名前空間プレフィックス。
Small、32.0
32.0
parameters
String
キャンバスアプリケーションに渡
される JSON パラメータ。
Small、32.0
32.0
thumbnailUrl
String
プレビュー画像へのサムネイル
Small、32.0
URL。最大サムネイルサイズは、120
× 120 ピクセルです。
32.0
title
String
キャンバスリンクのタイトル。
32.0
603
Small、32.0
Chatter REST API レスポンスボディ
Chatter Activity
Chatter Activity
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
commentCount
Integer
ユーザが行った組織またはコミュニティ内の Small、29.0
コメントの合計数
23.0
commentReceived Integer
Count
ユーザが受け取った組織またはコミュニティ Small、29.0
内のコメントの合計数
23.0
likeReceived
Count
Integer
ユーザが受け取った組織またはコミュニティ Small、29.0
内の投稿とコメントに対するいいね! の合計
数
23.0
postCount
Integer
ユーザが行った組織またはコミュニティ内の Small、29.0
投稿の合計数
23.0
使用可能な
バージョン
Chatter Directory
プロパティ
型
説明
検索条件グ
ループと
バージョン
feeds
String
組織のフィードの一般リソースへの URL を返 Small、29.0
します。
24.0
groups
String
組織のグループの一般リソースへの URL を返 Small、29.0
します。
24.0
organization
String
メモ: このプロパティは、バージョン
26.0 以降、使用できなくなります。代
わりに、Connect Directory で
organization プロパティを使用しま
す。
24.0 ～ 26.0
接続組織の一般リソースへの URL を返しま
す。
users
String
組織のユーザの一般リソースへの URL を返し Small、29.0
ます。
604
24.0
Chatter REST API レスポンスボディ
Chatter Influence
Chatter Influence
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
percentile
String
組織またはコミュニティ内でのユーザの影響 Small、29.0
度ランクを示すパーセント値
24.0
rank
Integer
組織またはコミュニティ内の他の全ユーザに Small、29.0
対するユーザの相対的な影響度ランクを示す
数値
24.0
Chatter Likes Capability
フィード要素にこの機能がある場合、コンテキストユーザがいいね! と言うことができます。既存のいいね! に
関する情報が公開されます。
プロパティ名
型
説明
検索条件グルー
プとバージョン
使用可能なバー
ジョン
isLikedBy
CurrentUser
Boolean
現在のユーザがフィード要素にい Small、32.0
いね! と言っているか (true)、否か
(false) を示します。
32.0
page
Like Page
このフィード要素のいいね! 情報。 Small、32.0
32.0
likesMessage
Like Message Body
フィード要素にいいね! と言った
Small、32.0
ユーザを説明するメッセージ本文。
32.0
myLike
Reference
コンテキストユーザがフィード要 Medium、32.0
素にいいね! と言った場合はこのプ
ロパティがその特定のいいね! への
参照になり、それ以外の場合は
null になります。
32.0
型
説明
ClientInfo
プロパティ
applicationName String
検索条件グ
ループと
バージョン
認証に使用される接続アプリケーションの名 Small、29.0
前 詳細は、「接続アプリケーションについ
て」 を参照してください。
605
使用可能な
バージョン
23.0
Chatter REST API レスポンスボディ
プロパティ
型
applicationUrl String
Comment
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
認証に使用される接続アプリケーションの
[情報 URL] 項目の値
Small、29.0
23.0
検索条件グ
ループと
バージョン
使用可能な
バージョン
Comment
プロパティ
型
説明
attachment
コメントの種別
によって異なる
コメントに添付ファイルが含まれないか、添 Medium、29.0 24.0 ～ 31.0
付ファイルが使用できない場合、null を返
します。それ以外の場合は、Feed Item
Attachment: Content を返します。
重要: バージョン 32.0 以降では、
capabilities プロパティを使用しま
す。
body
Feed Item Body
コメントのメッセージ本文
Small、29.0
capabilities
Comment
Capabilities
コメントに関連付けられた機能。
Medium、32.0 32.0
clientInfo
ClientInfo
接続の認証に使用される接続アプリケーショ Medium、29.0 23.0
ンに関する情報
createdDate
String
ISO8601 の日付文字列 (例:
2011-02-25T18:24:31.000Z)
Small、29.0
feedElement
Reference
コメントが投稿されたフィード要素。
Medium、32.0 32.0
feedItem
Reference
コメントが投稿されたフィード項目。
Medium、29.0 23.0 ～ 31.0
23.0
23.0
重要: バージョン 32.0 以降では、
feedElement プロパティを使用しま
す。
id
String
isDeletable
Boolean
コメントの 18 文字の ID
メモ: このプロパティは、バージョン
25.0 以降、使用できなくなります。代
わりに、isDeleteRestricted プロ
パティを使用してください。
606
Small、29.0
23.0
23.0 ～ 24.0
Chatter REST API レスポンスボディ
プロパティ
型
Comment Capabilities
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
コンテキストユーザがコメントを削除できる
かどうかを示します。
isDelete
Restricted
Boolean
コンテキストユーザがコメントを削除できな Medium、29.0 25.0
い場合は true を返します。false が返さ
れた場合は、コンテキストユーザがコメント
を削除できる可能性があります。
likes
Like Page
コメントに関連付けられたいいね! のページ Medium、29.0 24.0
likesMessage
Like Message Body
コメントにいいね! と言ったユーザを説明す Medium、29.0 27.0
るメッセージ本文
myLike
Reference
コンテキストユーザがコメントにいいね! と Medium、29.0 23.0
言った場合は、そのいいね! への参照を返し
ます。それ以外の場合は null を返します。
parent
Reference
このコメントに関連付けられたフィード項目 Big、29.0
の親に関する情報
relative
CreatedDate
String
相対的なローカライズされた文字列として書 Medium、29.0 28.0
式設定された作成日 (「17 分前」、「昨日」
など)
type
String
コメントの種別を示します。有効な値は、次 Small、29.0
のとおりです。
23.0
24.0
• ContentComment — コメントに添付ファ
イルが含まれる
• TextComment — コメントにテキストの
みが含まれる
url
String
このコメントへの URL
Small、29.0
23.0
user
User Summary
コメント作成者に関する情報
Small、29.0
23.0
Comment Capabilities
コメントに含めることができるすべての機能のコンテナ。
607
Chatter REST API レスポンスボディ
Comment Page
プロパティ名
型
説明
検索条件グルー
プとバージョン
content
Content Capability
このフィード要素に関連付けられ Small、32.0
たコンテンツ (添付ファイルなど)。
使用可能なバー
ジョン
32.0
フィード要素からコンテンツが削
除された場合、またはアクセス権
が非公開に変更された場合、ほと
んどの Content Capability プロパティ
は null になります。
edit
Edit Capability
コメントにこの機能がある場合、
権限を持つユーザはコメントを編
集できます。
Small、34.0
34.0
Comment Page
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
comments
Comment[]
コメントのコレクション
Small、29.0
23.0 ～ 31.0
重要: バージョン 32.0 以降では、
capabilities プロパティを使用しま
す。
currentPageUrl String
コメントの現在のページ、つまり最新のコメ Medium、29.0 23.0
ントの URL。デフォルトの 1 ページあたりの
コメント数は 25 個です。
items
Comment[]
コメントのコレクション
Small、32.0
32.0
nextPageUrl
String
コメントの次のページ、つまり以前のコメン Small、29.0
トへの URL。デフォルトの 1 ページあたりの
コメント数は 25 個です。
23.0
total
Integer
親フィード項目の全ページのコメント合計数 Small、29.0
23.0
Comments Capability
フィード要素にこの機能がある場合、コンテキストユーザはコメントを追加できます。
608
Chatter REST API レスポンスボディ
Community
プロパティ名
型
説明
検索条件グルー
プとバージョン
page
Comment Page
このフィード要素のコメント情報。 Small、32.0
型
説明
使用可能なバー
ジョン
32.0
Community
プロパティ
検索条件グ
ループと
バージョン
使用可能な
バージョン
allowChatter Boolean
AccessWithoutLogin
ゲストユーザがログインせずにコミュニティ Small、31.0
の公開グループにアクセスできるかどうかを
指定します。
31.0
allowMembers
ToFlag
Boolean
コミュニティのメンバーがコンテンツにフラ Small、30.0
グを設定できるかどうかを指定します。
30.0
description
String
コミュニティの説明
Small、29.0
26.0
id
String
コミュニティの 18 文字の ID
Small、29.0
26.0
invitations
Enabled
Boolean
コミュニティのメンバーが他のメンバーをコ Small、29.0
ミュニティに招待できるかどうかを示しま
す。できる場合は true、できない場合は
false となります。
26.0
knowledgeable Boolean
Enabled
トピックについて、知識のあるユーザと支持 Small、30.0
を使用できるか (true)、否か (false) を指定
します。
30.0
コミュニティ名
Small、29.0
26.0
nicknameDisplay Boolean
Enabled
コミュニティでニックネームを表示するかど Small、32.0
うかを指定します。
32.0
privateMessages Boolean
Enabled
同じコミュニティのメンバー同士が互いに非 Small、30.0
公開のメッセージを送受信できるか (true)、
否か (false) を指定します。
30.0
reputationEnabled Boolean
コミュニティのメンバーに対する評価が計算 Small、31.0
および表示されるかどうかを指定します。
31.0
Boolean
お知らせメールが自動的に生成されて、新し Small、29.0
いメンバーに送信されるかどうかを示しま
す。メールが送信される場合は true、送信
されない場合は false となります。
26.0
name
sendWelcome
Email
String
609
Chatter REST API レスポンスボディ
Community Page
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
sendWelcome
Email
Boolean
お知らせメールが自動的に生成されて、新し Small、29.0
いメンバーに送信されるかどうかを示しま
す。メールが送信される場合は true、送信
されない場合は false となります。
26.0
siteUrl
String
コミュニティのサイト URL (カスタムドメイ
ン + URL プレフィックス)。
Small、30.0
30.0
status
String
コミュニティの状況。値は次のとおりです。 Small、29.0
28.0
• Live
• Inactive
• UnderConstruction
urlPathPrefix String
url
String
コミュニティに固有の URL プレフィックス
Small、29.0
26.0
コミュニティへのフル URL
Small、29.0
26.0
検索条件グ
ループと
バージョン
使用可能な
バージョン
Community Page
プロパティ
型
説明
communities
Community[]
現在のユーザが使用できるコミュニティのリ Small、29.0
スト
26.0
total
Integer
コミュニティの合計数
Small、29.0
26.0
Connect Directory
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
communities
Community[]
現在の組織内のコミュニティのリスト
Small、29.0
26.0
organization
String
Chatter 組織への URL
Small、29.0
25.0
610
Chatter REST API レスポンスボディ
Content Capability
Content Capability
フィード要素にこの機能がある場合、添付ファイルがあります。
投稿されたフィード要素からコンテンツが削除された場合、またはコンテンツへのアクセス権が非公開に変更
された場合、Content Capability は存在しますが、そのプロパティのほとんどが null になります。
プロパティ名
型
説明
検索条件グルー
プとバージョン
使用可能なバー
ジョン
checksum
String
ファイルの MD5 チェックサム。
Small、32.0
32.0
contentHub
Repository
Files Connect リポ
ジトリ
このファイルに関連付けられた外 Small、32.0
部データソース、または、外部ファ
イルを指し示していない場合は
null。
32.0
contentUrl
String
リンクおよび Google ドキュメント
のコンテンツの URL。
Small、32.0
32.0
description
String
添付ファイルの説明。
Small、32.0
32.0
downloadUrl
String
コンテンツへの URL。
Small、32.0
32.0
external
DocumentUrl
String
このファイルが指し示す外部 URL、 Small、32.0
または、外部ファイルを指し示し
ていない場合は null。
32.0
ファイルの拡張子。
Small、32.0
32.0
fileExtension String
fileSize
String
ファイルのサイズ (バイト)。サイズ Small、32.0
を判定できない場合は、Unknown
を返します。
32.0
fileType
String
ファイルの種類。
32.0
hasPdfPreview Boolean
id
String
isInMyFileSync Boolean
Small、32.0
ファイルで PDF プレビューを使用で Medium、32.0
きる場合は true。それ以外の場合
は false。
32.0
コンテンツの 18 文字の ID。
Small、32.0
32.0
ファイルが Salesforce Files Sync と同期 Small、32.0
されている場合は true、同期され
ていない場合は false。
32.0
mimeType
String
ファイルの MIME タイプ。
Small、32.0
32.0
renditionUrl
String
ファイルの変換リソースへの URL。 Small、32.0
変換は非同期で処理され、ファイ
ルのアップロード直後は使用でき
ない場合があります。
32.0
611
Chatter REST API レスポンスボディ
Content Capability
プロパティ名
型
説明
検索条件グルー
プとバージョン
使用可能なバー
ジョン
renditionUrl
240By180
String
ファイルの 240×180 サイズの変換リ Small、32.0
ソースへの URL。変換は非同期で処
理され、ファイルのアップロード
直後は使用できない場合がありま
す。
32.0
renditionUrl
720By480
String
ファイルの 720 × 480 サイズの変換 Small、32.0
リソースへの URL。変換は非同期で
処理され、ファイルのアップロー
ド直後は使用できない場合があり
ます。
32.0
repository
FileUrl
String
外部リポジトリファイルのプロパ Small、32.0
ティへのアクセスを提供するChatter
REST APIリソースの URL。このファイ
ルが外部ファイルを参照していな
い場合は null。
32.0
textPreview
String
可能な場合はファイルのテキスト Big、32.0
プレビュー、それ以外の場合は
null です。最大文字数は 200 文字
です。
32.0
thumb120By90 String
RenditionStatus
ファイルの 120×90 ピクセルサイズ Medium、32.0
のプレビュー画像の表示状況。
Processing (処理中)、Failed (失敗)、
Success (成功)、NA (使用不可の場合)
のいずれかになります。
32.0
thumb240By180 String
RenditionStatus
ファイルの 240 × 180 ピクセルサイ Medium、32.0
ズのプレビュー画像の表示状況。
Processing (処理中)、Failed (失敗)、
Success (成功)、NA (使用不可の場合)
のいずれかになります。
32.0
thumb720By480 String
RenditionStatus
ファイルの 720 × 480 ピクセルサイ Medium、32.0
ズのプレビュー画像の表示状況。
Processing (処理中)、Failed (失敗)、
Success (成功)、NA (使用不可の場合)
のいずれかになります。
32.0
title
String
ファイルのタイトル。
Small、32.0
32.0
versionId
String
ファイルのバージョン ID。
Medium、32.0
32.0
612
Chatter REST API レスポンスボディ
Conversation Detail
Conversation Detail
プロパティ
型
説明
検索条件グループと
バージョン
使用可
能な
バー
ジョン
conversationId
String
会話の 18 文字の ID
Medium、29.0
23.0
conversationUrl
String
会話詳細ページへの URL
Small、29.0
23.0
members
User
Summary[]
この会話に参加しているユーザのコレ
クション
Small、29.0
23.0
messages
Message
Collection
この会話に含まれるメッセージ
Small、29.0
23.0
read
Boolean
この会話内にコンテキストユーザが未
読のメッセージがあるかどうか
Small、29.0
23.0
Conversation Summary
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
id
String
会話の 18 文字の ID
Small、29.0
23.0
この会話の最新メッセージ
Small、29.0
23.0
latestMessage メッセージ
members
User Summary[]
会話に参加しているユーザのコレクション
Small、29.0
23.0
read
Boolean
この会話内にコンテキストユーザが未読の
メッセージがあるかどうか
Small、29.0
23.0
url
String
会話詳細ページへの URL
Small、29.0
23.0
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
0 個以上の会話のコレクション
Small、29.0
23.0
会話の現在のページへの URL
Medium、29.0 23.0
Conversation Summary Collection
プロパティ
型
conversations Conversation
Summary[]
currentPageUrl String
613
Chatter REST API レスポンスボディ
Conversation Unread Count
プロパティ
型
説明
検索条件グ
ループと
バージョン
nextPageUrl
String
会話の次のページ、つまり、以前の会話への Small、29.0
URL
使用可能な
バージョン
23.0
Conversation Unread Count
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
hasMore
Boolean
実際の未読会話数が 50 を超えている場合は Small、29.0
true、50 以下の場合は false
23.0
unreadCount
Integer
未読会話、つまり未読メッセージを含む会話 Small、29.0
の数。未読会話数が 50 以下の場合は正確な
値が返され、50 を超えている場合は 50 が返
されます。
23.0
Dashboard Component Snapshot
ダッシュボードコンポーネント値がしきい値を超えたときに受信する、ダッシュボードコンポーネントスナッ
プショットとアラートの両方を表します。
プロパティ名
型
説明
検索条件グルー
プとバージョン
使用可能なバー
ジョン
componentId
String
ダッシュボードコンポーネントの
18 文字の ID。
Small、32.0
32.0
componentName String
ダッシュボードコンポーネント名。 Small、32.0
32.0
dashboardBodyText String
このテキストをフィード要素のア
クターの横に表示します。このテ
キストは、デフォルトの本文テキ
ストの代わりに使用します。
Small、32.0
32.0
ダッシュボードの 18 文字の ID。
Small、32.0
32.0
dashboardName String
ダッシュボード名。
Small、32.0
32.0
fullSizeImageUrl String
スナップショットのフルサイズ画 Small、32.0
像を取得するためのソース URL。こ
32.0
dashboardId
String
614
Chatter REST API レスポンスボディ
プロパティ名
型
Dashboard Component Snapshot Capability
説明
検索条件グルー
プとバージョン
使用可能なバー
ジョン
の URL には、OAuth ログイン情報で
アクセスします。
lastRefreshDate Date
このダッシュボードコンポーネン Small、32.0
トの最終更新日を示す ISO-8601 形式
の日付。
32.0
lastRefreshDate String
DisplayText
最終更新日の表示テキスト (「最終 Small、32.0
更新 2013 年 10 月 31 日」など)。
32.0
runningUser
User Summary
スナップショットが投稿された時 Small、32.0
点のダッシュボードの実行ユーザ。
この値は、null になる場合があり
ます。各ダッシュボードには実行
ユーザがおり、そのユーザのセキュ
リティ設定によってダッシュボー
ドに表示されるデータが決まりま
す。
32.0
thumbnailUrl
String
スナップショットのサムネイル画 Small、32.0
像を取得するためのソース URL。こ
の URL には、OAuth ログイン情報で
アクセスします。
32.0
Dashboard Component Snapshot Capability
フィード要素にこの機能がある場合、ダッシュボードコンポーネントスナップショットがあります。スナップ
ショットとは、特定の時点でのダッシュボードコンポーネントの静的な画像です。
プロパティ名
型
説明
検索条件グルー
プとバージョン
使用可能なバー
ジョン
dashboard
Component
Snapshot
Dashboard
Component
Snapshot
ダッシュボードコンポーネントの
スナップショット。
Small、32.0
32.0
Datacloud Company
Data.com 会社レコード。会社レコードを所有している場合は、すべての項目が表示されます。会社レコードを
所有していない場合は、一部の項目が非表示になりアスタリスク (***) が示されます。
615
Chatter REST API レスポンスボディ
Datacloud Company
プロパティ名 型
説明
activeContacts Integer
会社の有効な取引先責任者の Small、32.0
数。
32.0
会社の住所。
Small、32.0
32.0
会社の 1 年間の売上。
Small、32.0
32.0
会社の一意の数値識別子。
Small、32.0
32.0
会社の説明。
Small、32.0
32.0
address
ConnectApi.Address
annualRevenue Double
companyId
String
description String
検索条件グ
使用可能な
ループとバー バージョン
ジョン
dunsNumber
String
一意の事業所を識別するため Small、32.0
に Dun & Bradstreet (D&B) が割り
当てる、ランダムに生成され
た 9 桁の数値。
32.0
industry
String
会社が事業を行っている重点 Small、32.0
領域の説明。
32.0
isInactive
Boolean
会社情報がもはや正確ではな Small、32.0
いか (true)、最新の情報か
(false)。
32.0
isOwned
Boolean
自分または所属する組織に
よって会社が購入されたか
(true)、否か (false)。
Small、32.0
32.0
naicsCode
String
North American Industry
Small、32.0
Classification System (NAICS) コー
ドは、企業のサービス指向の
詳細を示すために作成されま
した。このコードの説明は、
業務内容に焦点が絞られてい
ます。
32.0
NAICS 分類の説明。
Small、32.0
32.0
会社名。
Small、32.0
32.0
会社の従業員数。
Small、32.0
32.0
会社形態の種別。
Small、32.0
32.0
naicsDescription String
name
String
numberOfEmployees Integer
ownership
String
• 公開
• 非公開
• 政府機関
• その他
616
Chatter REST API レスポンスボディ
Datacloud Company Collection
プロパティ名 型
説明
phoneNumbers ConnectApi.PhoneNumber
会社の代表電話番号を含む数 Small、32.0
値文字列。
32.0
Standard Industrial Codes (SIC) は、 Small、32.0
会社が提供するサービス種別
を示す採番規則。
32.0
SIC 分類の説明。
Small、32.0
32.0
String
会社の所在地の種類 (「本社」 Small、32.0
など)。
32.0
tickerSymbol String
公開証券取引所で取引され
Small、32.0
る、会社を一意に識別する記
号。
32.0
String
公開証券取引所で取引され
Small、32.0
る、会社を一意に識別する記
号。
32.0
この会社の情報の最終更新
日。
Small、32.0
32.0
会社の Web サイトへの URL。
Small、32.0
32.0
会社の創立年。
Small、32.0
32.0
sic
String
sicDescription String
site
tradeStyle
updatedDate Date
website
String
yearStarted String
検索条件グ
使用可能な
ループとバー バージョン
ジョン
Datacloud Company Collection
特定の注文で購入されたすべての会社の購入の詳細。
プロパティ名 型
検索条件グ
使用可能な
ループとバー バージョン
ジョン
特定の注文のすべての会社の Small、32.0
リスト。
32.0
currentPageUrl String
会社の現在のページへの URL。 Medium、32.0
32.0
nextPageUrl String
会社の次のページへの URL。次 Small、32.0
のページがない場合、値は
null です。
32.0
companies
ConnectApi.DatacloudCompany
説明
617
Chatter REST API レスポンスボディ
Datacloud Contact
プロパティ名 型
説明
previousPageUrl String
会社の前のページへの URL。前 Medium、32.0
のページがない場合、値は
null です。
32.0
注文に含まれる会社数。ユー Small、32.0
ザは、1 ページにつき何件の会
社を表示するかを設定できま
す。デフォルトのページサイ
ズは 25 です。
32.0
total
Integer
検索条件グ
使用可能な
ループとバー バージョン
ジョン
Datacloud Contact
Data.com の取引先責任者に関する情報。取引先責任者を所有している場合は、すべての項目が表示されます。
取引先責任者を所有していない場合は、一部の項目が非表示になりアスタリスク (***) が示されます。
プロパティ名 型
説明
検索条件グ
使用可能な
ループとバー バージョン
ジョン
address
ConnectApi.Address[]
この取引先責任者が勤務する Small、32.0
会社の郵送先住所。
32.0
companyId
String
取引先責任が勤務する会社の Small、32.0
一意の数値識別子。
32.0
companyName String
取引先責任者が勤務する会社 Small、32.0
の名前。
32.0
contactId
String
取引先責任者の一意の数値識 Small、32.0
別子。
32.0
department
String
取引先責任者が所属する部門 Small、32.0
の名前。
32.0
email
String
この取引先責任者のメールア Small、32.0
ドレス。
32.0
firstName
String
取引先責任者の名。
Small、32.0
32.0
isInactive
Boolean
true または false の応答。 Small、32.0
32.0
true はレコードがもう有効で
はないことを示します。false
は、取引先責任者がまだ有効
であることを示します。
618
Chatter REST API レスポンスボディ
プロパティ名 型
Datacloud Contact Collection
説明
検索条件グ
使用可能な
ループとバー バージョン
ジョン
isOwned
Boolean
組織がこの取引先責任者を所 Small、32.0
有しているかどうかを示しま
す。
32.0
lastName
String
取引先責任者の姓。
Small、32.0
32.0
level
String
会社での人の役職レベルを指 Small、32.0
定する人事の表示ラベル。
32.0
取引先責任者の直通電話番号 Small、32.0
を含む数値文字列。
32.0
取引先責任者の役職。
Small、32.0
32.0
この取引先責任者の情報の更 Small、32.0
新日。
32.0
phoneNumbers ConnectApi.PhoneNumber[]
title
String
updatedDate Date
Datacloud Contact Collection
特定の注文で購入されたすべての取引先責任者の購入の詳細。
プロパティ名 型
検索条件グ
使用可能な
ループとバー バージョン
ジョン
特定の orderId のすべての取 Small、32.0
引先責任者のリスト。
32.0
currentPageUrl String
取引先責任者の現在のペー
ジ。
32.0
nextPageUrl String
取引先責任者の次のページへ Small、32.0
の URL。取引先責任者に 1 ペー
ジしかない場合、値は null で
す。
32.0
previousPageUrl String
取引先の前のページへの URL。 Medium、32.0
取引先責任者に 1 ページしか
ない場合、値は null です。
32.0
この注文に関連付けられた取 Small、32.0
引先責任者の数。取引先責任
者の総数は、1 ページに表示さ
れる取引先責任者の数よりも
多くなる可能性があります。
32.0
contacts
total
ConnectApi.DatacloudContact[]
説明
Integer
619
Medium、32.0
Chatter REST API レスポンスボディ
Datacloud Order
Datacloud Order
購入した Data.com レコードに関する情報と購入の詳細。
プロパティ名
型
説明
検索条件グルー
プとバージョン
使用可能なバー
ジョン
entityUrl
String
特定の注文で購入されたレコード
のリストへの URL。
Small、32.0
32.0
id
String
特定の注文を識別する orderId。 Small、32.0
32.0
この注文で購入されたレコードの
数。
Small、32.0
32.0
purchaseCount Integer
purchaseDate
Date
レコードが購入された日付。
Small、32.0
32.0
url
String
特定の注文の注文情報への URL。
Small、32.0
32.0
Datacloud Purchase Usage
組織のData.com購入利用状況に関する情報。月次ユーザおよびリストプールユーザの使用済みのクレジットお
よび使用可能なクレジットを示します。
プロパティ名
型
説明
検索条件グルー
プとバージョン
使用可能なバー
ジョン
listpoolCreditsAvailable Integer
リストプールグループのすべての
ユーザが使用できるリストプール
クレジット。
Small、32.0
32.0
listpoolCreditsUsed Integer
リストプールグループのすべての
ユーザによって使用されたリスト
プールクレジット。
Small、32.0
32.0
monthlyCreditsAvailable Integer
特定のユーザに割り当てられた 1 か Small、32.0
月あたりのクレジット。
32.0
monthlyCreditsUsed Integer
特定のユーザによって 1 か月間に使 Small、32.0
用されたクレジット。
32.0
Edit Capability
フィード要素またはコメントにこの機能がある場合、権限を持つユーザはフィード要素またはコメントを編集
できます。
620
Chatter REST API レスポンスボディ
Email Address
プロパティ名
型
説明
isEdit
Restricted
Boolean
このフィード要素またはコメント Small、34.0
の編集が制限されているかどうか
を指定します。true の場合、コン
テキストユーザはこのフィード要
素またはコメントを編集できませ
ん。false の場合、コンテキスト
ユーザにこのフィード要素または
コメントを編集する権限がある場
合とない場合があります。コンテ
キストユーザがフィード要素また
はコメントを編集できるかどうか
を判別するには、Feed Elements,
Editability または Comment Capability,
Editability リソースを使用します。
34.0
isEditable
ByMeUrl
String
コンテキストユーザがこのフィー
ド要素またはコメントを編集でき
るかどうかをチェックするための
URL。
Medium、34.0
34.0
lastEditedBy
User Detail
このフィード要素またはコメント
を最後に編集したユーザ。
Small、34.0
34.0
lastEditedDate Date
このフィード要素またはコメント
の最終編集日。
Small、34.0
34.0
latestRevision Integer
このフィード要素またはコメント
の最新リビジョン。
Small、34.0
34.0
相対的な最終編集日 (「2 時間前」
など)。
Small、34.0
34.0
relativeLast
EditedDate
String
検索条件グルー
プとバージョン
使用可能なバー
ジョン
Email Address
ケースフィードのケースレコードから送信されたメールメッセージのメールアドレス。
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
displayName
String
メールアドレスの表示名
Small、29.0
29.0
emailAddress
String
メールアドレス
Small、29.0
29.0
621
Chatter REST API レスポンスボディ
Email Message Capability
Email Message Capability
フィード要素にこの機能がある場合、ケースからのメールメッセージが含まれます。
プロパティ名
型
説明
検索条件グルー
プとバージョン
使用可能なバー
ジョン
direction
String
メールメッセージの方向。値は次
のとおりです。
Small、32.0
32.0
メールメッセージの ID。
Small、32.0
32.0
• Inbound — インバウンドメッ
セージ (顧客が送信)。
• Outbound — アウトバウンド
メッセージ (サポートエージェン
トが顧客に送信)。
emailMessageId String
subject
String
メールメッセージの件名。
Small、32.0
32.0
textBody
String
メールメッセージの本文。
Big、32.0
32.0
toAddresses
Email Address[]
メールメッセージの宛先アドレス。 Small、32.0
32.0
Enhanced Link Capability
フィード要素にこの機能がある場合、アイコン、タイトル、説明などの補足情報を表示するリンクがありま
す。
プロパティ名
型
説明
検索条件グルー
プとバージョン
使用可能なバー
ジョン
description
String
最大 500 文字の説明。
Small、32.0
32.0
icon
Icon
アイコン。
Small、32.0
32.0
linkRecordId
String
リンク URL が Salesforce レコードを参 Small、32.0
照する場合に、そのリンクに関連
付けられた ID。
32.0
linkUrl
String
使用可能なコンテンツをインライ
ン表示できない場合の詳細ページ
へのリンク URL。
Small、32.0
32.0
title
String
詳細ページのタイトル。
Small、32.0
32.0
622
Chatter REST API レスポンスボディ
Error Message
Error Message
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
errorCode
String
エラーに関する情報を示すエラーコード
(INSUFFICIENT_PRIVILEGES など)
Small、29.0
23.0
message
String
エラーの説明
Small、29.0
23.0
Error with Output
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
message
String
エラーの説明
Small、29.0
27.0
output
任意のレスポン
スボディ
要求されたリソースで記述されるレスポンス Small、29.0
ボディ。たとえば、要求に成功すると Like レ
スポンスボディが返され、エラーが発生する
と Error with Output レスポンスボディが返され
る場合、output プロパティの値は Like レス
ポンスボディになります。
27.0
Explanation Details
一部のおすすめの詳細説明を表します。
プロパティ
型
説明
検索条件グ
ループと
バージョン
data
不特定
おすすめの詳細情報。type プロパティの値 Small、29.0
によって返される内容が異なります。
• UserFollowsSameUsers — ユーザとお
すすめユーザの両方がフォローしている
人。「User Summary」を参照してくださ
い。
• GroupMembersFollowed — おすすめグ
ループのメンバーのうち、ユーザがフォ
ローしている人。「User Summary」を参照
してください。
623
使用可能な
バージョン
24.0
Chatter REST API レスポンスボディ
プロパティ
型
Explanation Details
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
• UserViewingSameRecords — ユーザと
おすすめユーザが最近表示したレコー
ド。「Record Summary」を参照してくださ
い。
• RecordParentOfFollowed — おすすめ
レコードの子レコードのうち、ユーザが
フォローしているレコード。「Record
Summary」を参照してください。
summary
String
おすすめの概要説明。
Small、29.0
24.0
type
String
おすすめの理由を示します。
Small、29.0
24.0
• Custom — カスタムのおすすめ。
• FilePopular — フォロワー数または参
照数の多いファイル
• FileViewedTogether — コンテキスト
ユーザが参照している他のファイルと同
時に参照されることが多いファイル
• FollowedTogetherWithFollowees —
コンテキストユーザがフォローしている
ユーザと共にフォローされることが多い
ユーザ
• GroupMembersFollowed — コンテキス
トユーザがフォローしているメンバーの
グループ
• GroupNew — 最近作成されたグループ
• GroupPopular — 多くの有効なメンバー
がいるグループ
• ItemViewedTogether — コンテキスト
ユーザが参照している他のレコードと同
時に参照されることが多いレコード
• PopularApp — 人気のあるアプリケー
ション
• RecordOwned — コンテキストユーザが
所有するレコード
• RecordParentOfFollowed — コンテキ
ストユーザがフォローしているレコード
の親レコード
624
Chatter REST API レスポンスボディ
プロパティ
型
Explanation Summary
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
検索条件グ
ループと
バージョン
使用可能な
バージョン
• RecordViewed — コンテキストユーザが
最近参照したレコード
• UserDirectReport — コンテキストユー
ザの直属の部下
• UserFollowedTogether — コンテキス
トユーザがフォローしている他のユーザ
と同時にフォローされることが多いユー
ザ
• UserFollowsSameUsers — コンテキス
トユーザと同じユーザをフォローしてい
るユーザ
• UserManager — コンテキストユーザの
マネージャ
• UserNew — 最近作成されたユーザ
• UserPeer — コンテキストユーザと同じ
マネージャに直属するユーザ
• UserPopular — フォロワー数の多いユー
ザ
• UserViewingSameRecords — コンテキ
ストユーザと同じレコードを参照してい
るユーザ
Explanation Summary
おすすめの概要説明を表します。
プロパティ
型
説明
detailsUrl
String
説明の詳細の URL。おすすめに詳細説明がな Small、29.0
い場合は null。
24.0
summary
String
おすすめの概要説明。
Small、29.0
23.0
type
String
おすすめの理由を示します。
Small、29.0
24.0
• Custom — カスタムのおすすめ。
• FilePopular — フォロワー数または参
照数の多いファイル
625
Chatter REST API レスポンスボディ
プロパティ
型
Explanation Summary
説明
検索条件グ
ループと
バージョン
• FileViewedTogether — コンテキスト
ユーザが参照している他のファイルと同
時に参照されることが多いファイル
• FollowedTogetherWithFollowees —
コンテキストユーザがフォローしている
ユーザと共にフォローされることが多い
ユーザ
• GroupMembersFollowed — コンテキス
トユーザがフォローしているメンバーの
グループ
• GroupNew — 最近作成されたグループ
• GroupPopular — 多くの有効なメンバー
がいるグループ
• ItemViewedTogether — コンテキスト
ユーザが参照している他のレコードと同
時に参照されることが多いレコード
• PopularApp — 人気のあるアプリケー
ション
• RecordOwned — コンテキストユーザが
所有するレコード
• RecordParentOfFollowed — コンテキ
ストユーザがフォローしているレコード
の親レコード
• RecordViewed — コンテキストユーザが
最近参照したレコード
• UserDirectReport — コンテキストユー
ザの直属の部下
• UserFollowedTogether — コンテキス
トユーザがフォローしている他のユーザ
と同時にフォローされることが多いユー
ザ
• UserFollowsSameUsers — コンテキス
トユーザと同じユーザをフォローしてい
るユーザ
• UserManager — コンテキストユーザの
マネージャ
• UserNew — 最近作成されたユーザ
626
使用可能な
バージョン
Chatter REST API レスポンスボディ
プロパティ
型
Favorite
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
検索条件グ
ループと
バージョン
使用可能な
バージョン
• UserPeer — コンテキストユーザと同じ
マネージャに直属するユーザ
• UserPopular — フォロワー数の多いユー
ザ
• UserViewingSameRecords — コンテキ
ストユーザと同じレコードを参照してい
るユーザ
Favorite
プロパティ
型
説明
community
Reference
コミュニティに関する情報。デフォルトのコ Medium、29.0 26.0
ミュニティにお気に入りが存在するか、コ
ミュニティが無効である場合は、null が返
されます。
createdBy
User Summary
お気に入りの最初の作成者に関する情報
Medium、29.0 24.0
feedUrl
String
このお気に入りのフィード項目への URL
Small、29.0
24.0
id
String
お気に入りの 18 文字の ID
Small、29.0
24.0
lastViewDate
String
ISO8601 の日付文字列 (例:
2011-02-25T18:24:31.000Z)
Medium、29.0 24.0
name
String
お気に入りの名前
Small、29.0
searchText
String
お気に入りが検索に基づく場合は検索テキス Medium、29.0 24.0
トが含まれ、それ以外の場合は null になり
ます。
target
Reference
該当する場合はトピックへの参照、それ以外 Small、29.0
の場合は null
28.0
type
String
次のいずれかの値になります。
Small、29.0
24.0
Small、29.0
24.0
24.0
• ListView
• Search
• Topic
url
String
このお気に入りへの URL
627
Chatter REST API レスポンスボディ
Favorites Page
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
user
User Summary
このお気に入りを保存したユーザに関する情 Medium、29.0 24.0
報
Favorites Page
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
favorites
Favorite[]
1 つ以上のお気に入りのコレクション
Small、29.0
24.0
total
Integer
お気に入りの合計数
Small、29.0
24.0
Features
コンテキストユーザが使用できる機能。機能が無効な場合は、その機能に関連付けられたリソースを使用でき
ず、オブジェクトの機能に関連する一部のプロパティが null に設定されます。
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
chatter
Boolean
組織で Chatter が有効になっているかどうか
を指定します。
Small、29.0
27.0
chatterActivity Boolean
ユーザの詳細に Chatter 活動に関する情報が
含まれるかどうかを示します。
Small、29.0
24.0
chatterAnswers Boolean
Chatter アンサーが有効になっているかどうか Small、29.0
を示します。
29.0
chatter
Boolean
GlobalInfluence
ユーザの詳細にグローバル Chatter 活動が含
まれるかどうかを示します。
Small、29.0
24.0
chatter
GroupRecords
Boolean
Chatter グループにレコードを関連付けられる Small、33.0
かどうかを指定します。
33.0
chatter
GroupRecord
Sharing
Boolean
Chatter レコードがグループに追加されたと Small、33.0
き、そのレコードがグループメンバー間で暗
黙的に共有されるかどうかを指定します。
33.0
chatter
Messages
Boolean
Chatterメッセージが組織で有効になっている Small、29.0
かどうかを示します。
24.0
628
Chatter REST API レスポンスボディ
プロパティ
型
Features
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
chatterTopics Boolean
Chatterトピックが有効かどうかを示します。 Small、29.0
28.0
communities
Enabled
Boolean
Salesforce Communities が有効になっているかど Small、31.0
うかを示します。
31.0
community
Moderation
Boolean
この組織でコミュニティモデレーションが有 Small、29.0
効になっているかどうかを示します。
29.0
community
Reputation
Boolean
この組織のコミュニティで評価が有効になっ Small、32.0
ているかどうかを示します。
32.0
dashboard
Component
Snapshots
Boolean
ユーザがダッシュボードコンポーネントス Small、29.0
ナップショットを投稿できるかどうかを示し
ます。
24.0
デフォルト通貨の ISO コード。
multiCurrency が false に設定されてい
る場合のみ有効です。
Small、29.0
28.0
defaultCurrency String
IsoCode
feedPolling
Boolean
is-modified リソースが Chatter REST API で有効か Small、29.0
どうかを示します。
24.0
files
Boolean
ファイルが Chatter REST API のリソースとして Small、29.0
機能できるかどうかを示します。
24.0
filesOnComments Boolean
ファイルをコメントに添付できるかどうかを Small、29.0
示します。
24.0
groupsCanFollow Boolean
将来の使用のために予約されています。
28.0 ～ 29.0
Small、29.0
Boolean
アイデアが有効になっているかどうかを示し Small、29.0
ます。
29.0
managedTopics Boolean
Enabled
コミュニティホームフィードと管理トピック Small、32.0
フィードへのアクセスを示します。
32.0
mobile
Boolean
Notifications
Enabled
将来の使用のために予約されています。
Small、29.0
29.0
multiCurrency Boolean
ユーザの組織がマルチ通貨を使用するか
Small、29.0
(true)、否か (false) を示します。false の
場合、defaultCurrencyIsoCode はデフォ
ルト通貨の ISO コードを示します。
28.0
publisherActions Boolean
パブリッシャーアクションが有効かどうかを Small、29.0
示します。
28.0
ideas
629
Chatter REST API レスポンスボディ
Feed
プロパティ
型
説明
storeData
OnDevices
Enabled
Boolean
Salesforce1 ダウンロード可能アプリケーショ Small、30.0
ンがモバイルデバイス上の安全な永続スト
レージを使用してデータをキャッシュできる
かどうかを示します。
30.0
trendingTopics Boolean
トピックのトレンドが有効かどうかを示しま Small、29.0
す。
24.0
Boolean
既存の Chatter ユーザが同僚を Chatter に招待
できるかどうかを示します。
Small、29.0
24.0
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
feedElement
PostUrl
String
この件名に対するフィード要素を投稿するた Small、31.0
めの URL
viralInvites
Allowed
検索条件グ
ループと
バージョン
使用可能な
バージョン
Feed
31.0
HTTP ヘッダー X-Connect-Bearer-Urls:
true を含む要求によって返される場合、URL
にベアラートークンが含まれます。このベア
ラートークン URL を使用して、POST 要求を実
行します。
feedElementsUrl String
フィード要素の URL
Small、31.0
31.0
String
フィード項目の URL
Small、29.0
23.0 ～ 31.0
feedItemsUrl
isModifiedUrl String
フィードがいつ最終更新されたのかが記述さ Small、29.0
れた不透明トークンを含む since 要求パラ
メータがある News Feed Is-Modified リソース。
フィードがニュースフィードではない場合は
null を返します。
630
23.0
Chatter REST API レスポンスボディ
Feed Directory
Feed Directory
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
favorites
Favorite[]
コンテキストユーザが保存したお気に入りの Small、29.0
コレクション。
24.0
feeds
Feed Directory Item[] コンテキストユーザに表示が許可されている Small、29.0
フィードディレクトリ項目のコレクション。
23.0
Feed Directory Item
フィードの定義。
プロパティ
型
feedElementsUrl String
説明
検索条件グ
ループと
バージョン
特定のフィードのフィード要素のリソースへ Small、31.0
の URL。次に例を示します。
使用可能な
バージョン
31.0
/chatter/feeds/files/me/feed-elements
feedItemsUrl
String
特定のフィードのフィード項目のリソースへ Small、29.0
の URL。次に例を示します。
23.0 ～ 31.0
/chatter/feeds/files/me/feed-elements
feedType
String
フィード種別。次のいずれかの値にします。 Big、30.0
• Bookmarks — コンテキストユーザがブッ
クマークとして保存したすべてのフィー
ド項目が含まれます。
• Company — 種別 TrackedChange の
フィード項目を除くすべてのフィード項
目が含まれます。ユーザがフィード項目
を表示するには、親への共有アクセス権
が必要です。
• Files — コンテキストユーザがフォロー
している人またはグループによって投稿
されたファイルを含むすべてのフィード
項目が含まれます。
• Filter — 指定したオブジェクト種別の
親を持つフィード項目を含むように絞り
631
30.0
Chatter REST API レスポンスボディ
プロパティ
型
Feed Directory Item
説明
検索条件グ
ループと
バージョン
込まれたニュースフィードが含まれま
す。
• Groups — コンテキストユーザが所有す
るか、メンバーであるすべてのグループ
のすべてのフィード項目が含まれます。
• Home — コミュニティの管理トピックに
関連付けられたすべてのフィード項目が
含まれます。
• Moderation — モデレーション用にフラ
グが設定されたすべてのフィード項目が
含まれます。このコミュニティモデレー
ションフィードは、「コミュニティ
フィードのモデレート」権限を持つユー
ザのみが使用できます。
• News — コンテキストユーザがフォロー
する人、ユーザがメンバーとなっている
グループ、およびユーザがフォローする
ファイルとレコードからのすべての更新
が含まれます。また、親がコンテキスト
ユーザであるレコード、およびコンテキ
ストユーザをメンションするかコンテキ
ストユーザがメンバーとなっているグ
ループをメンションするすべてのフィー
ド項目とコメントのすべての更新も含ま
れます。
• People — コンテキストユーザがフォロー
しているすべての人によって投稿された
すべてのフィード項目が含まれます。
• Record — 親が指定したレコードである
すべてのフィード項目が含まれます。レ
コードは、グループ、ユーザ、オブジェ
クト、ファイル、その他の標準またはカ
スタムオブジェクトの場合があります。
レコードがグループの場合、フィードに
はそのグループにメンションしている
フィード項目も含まれます。レコードが
ユーザの場合、フィードにはそのユーザ
に対するフィード項目のみが含まれま
す。
632
使用可能な
バージョン
Chatter REST API レスポンスボディ
プロパティ
型
Feed Element Capabilities
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
• To — コンテキストユーザのメンション
を含むすべてのフィード項目、コンテキ
ストユーザがコメントしたフィード項
目、コンテキストユーザが作成し、コメ
ントされたフィード項目が含まれます。
• Topics — 指定したトピックを含むすべ
てのフィード項目が含まれます。
• UserProfile — フィードで追跡可能な
レコードをユーザが変更したときに作成
されたフィード項目、親がユーザである
フィード項目、およびユーザに@メンショ
ンしているフィード項目が含まれます。
このフィードは、グループ更新など、よ
り多くのフィード項目を返すニュース
フィードとは異なります。
feedUrl
String
特定のフィードのリソースへの URL。次に例 Small、29.0
を示します。
23.0
/services/data/v34.0/
chatter/feeds/files/me
keyPrefix
String
条件フィードの場合、この値は、このフィー Big、30.0
ドの絞り込みに使用されるエンティティ種別
に関連付けられたキープレフィックスです。
このフィードのすべてのフィード項目では、
親のエンティティ種別がこのキープレフィッ
クス値と一致します。条件以外のフィードの
場合、この値は null です。
30.0
キープレフィックスは、レコード ID の先頭
3 文字で、エンティティ種別を示します。
label
String
グループ、人、会社など、フィードの名前
Small、29.0
23.0
Feed Element Capabilities
フィード要素に含めることができるすべての機能のコンテナ。
API バージョン 30.0 以前では、各フィード項目にコメント、いいね!、トピックなどを含めることができました。
バージョン 31.0 以降では、各フィード項目 (およびフィード要素) に一意の機能セットを含めることができま
633
Chatter REST API レスポンスボディ
Feed Element Capabilities
す。フィード要素に機能プロパティが存在する場合、機能プロパティに値がなくてもその機能を使用できま
す。たとえば、ChatterLikes 機能プロパティがフィード要素に存在している場合、(値の有無に関係なく) コ
ンテキストユーザはそのフィード要素にいいね! と言うことができます。機能プロパティが存在しない場合、
そのフィード要素にいいね! と言うことはできません。機能には、関連データを含めることもできます。たと
えば、Moderation 機能には、モデレーションフラグに関するデータが含まれます。
プロパティ名
型
approval
Approval Capability フィード要素にこの機能がある場 Small、32.0
合、承認に関する情報が含まれて
います。
32.0
フィード要素にこの機能がある場 Small、31.0
合、フィード要素にプラット
フォームアクションが関連付けら
れています。
31.0
associatedActions Associated Actions
Capability
説明
検索条件グルー 使用可能なバー
プとバージョン ジョン
banner
Banner Capability
このフィード要素にこの機能があ Small、31.0
る場合、フィード要素にバナーの
モチーフとスタイルが含まれま
す。
31.0
bookmarks
Bookmarks
Capability
フィード要素にこの機能がある場 Small、31.0
合、コンテキストユーザがその
フィード要素をブックマークでき
ます。
31.0
bundle
Generic Bundle
Capability
フィード要素にこの機能がある場 Small、31.0
合、フィード要素は 1 つのフィー
ド要素に集約された他のフィード
要素のグループとなることができ
ます。
31.0
または
Tracked Change
Bundle Capability
canvas
Canvas Capability
フィード要素にこの機能がある場 Small、32.0
合、キャンバスアプリケーション
を表示します。
32.0
caseComment
Case Comment
Capability
フィード要素にこの機能がある場 Small、32.0
合、ケースフィード上にケースコ
メントがあります。
32.0
chatterLikes
Chatter Likes
Capability
フィード要素にこの機能がある場 Small、31.0
合、コンテキストユーザはいいね!
と言うことができます。既存のい
いね! に関する情報が公開されま
す。
31.0
634
Chatter REST API レスポンスボディ
Feed Element Capabilities
プロパティ名
型
説明
検索条件グルー 使用可能なバー
プとバージョン ジョン
comments
Comments
Capability
フィード要素にこの機能がある場 Small、31.0
合、コンテキストユーザはコメン
トを追加できます。
31.0
content
Content Capability
フィード要素にこの機能がある場 Small、32.0
合、添付ファイルがあります。
32.0
フィード要素からコンテンツが削
除された場合、またはアクセス権
が非公開に変更された場合、ほと
んどの Content Capability プロパティ
は null になります。
フィード要素にこの機能がある場 Small、32.0
合、ダッシュボードコンポーネン
Snapshot Capability トのスナップショットがありま
す。スナップショットとは、特定
の時点でのダッシュボードコン
ポーネントの静的な画像です。
32.0
edit
Edit Capability
フィード要素にこの機能がある場 Small、34.0
合、権限を持つユーザはフィード
要素を編集できます。
34.0
emailMessage
Email Message
Capability
フィード要素にこの機能がある場 Small、32.0
合、ケースからのメールメッセー
ジがあります。
32.0
enhancedLink
Enhanced Link
Capability
フィード要素にこの機能がある場 Small、32.0
合、このフィード要素には、アイ
コン、タイトル、説明などの補足
情報が表示されるリンクがありま
す。
32.0
link
Link Capability
フィード要素にこの機能がある場 Small、32.0
合、リンクがあります。
32.0
moderation
Moderation
Capability
フィード要素にこの機能がある場 Small、31.0
合、コミュニティのユーザは
フィード要素にモデレーションフ
ラグを設定できます。このレスポ
ンスボディには、フラグが設定さ
れたコンテンツに関する情報も含
まれます。
31.0
dashboardComponent Dashboard
Component
Snapshot
635
Chatter REST API レスポンスボディ
Feed Element Page
プロパティ名
型
説明
poll
Poll Capability
フィード要素にこの機能がある場 Small、31.0
合、フィード要素に投票のアン
ケートを含めることができます。
31.0
origin
Origin Capability
フィード要素にこの機能がある場 Small、33.0
合、そのフィード要素はフィード
アクションによって作成されてい
ます。
33.0
フィード要素にこの機能がある場 Small、31.0
合、質問があり、フィード要素の
コメントはその質問への回答で
す。
31.0
フィード要素にこの機能がある場 Small、32.0
合、おすすめがあります。
32.0
フィード要素にこの機能がある場 Small、32.0
合、1 つのレコード作成イベントに
ついて、レコードのスナップ
ショットとして取得された項目す
べてが含まれます。
32.0
Topics Capability
フィード要素にこの機能がある場 Small、31.0
合、コンテキストユーザはトピッ
クを追加できます。トピックは、
ユーザが会話を整理して検索する
ために役立ちます。
31.0
trackedChanges Tracked Changes
フィード要素にこの機能がある場 Small、32.0
合、1 つの変更追跡イベントについ
て、レコードへのすべての変更が
含まれます。
32.0
questionAndAnswers Question and
Answers Capability
recommendations Recommendations
Capability
recordSnapshot Record Snapshot
Capability
topics
Capability
検索条件グルー 使用可能なバー
プとバージョン ジョン
Feed Element Page
ページ設定された結果を含むフィード要素のコンテナ。
プロパティ名
型
説明
検索条件グ
ループとバー
ジョン
currentPageUrl
String
現在のページを識別する Chatter Medium、31.0
REST API URL。
636
使用可能な
バージョン
31.0
Chatter REST API レスポンスボディ
プロパティ名
Feed Element Page
型
説明
検索条件グ
ループとバー
ジョン
フィード要素のコレクション。 Small、31.0
フィード要素は次のいずれかに
なります。
elements
使用可能な
バージョン
31.0
• 汎用フィード要素
• Feed Item
isModifiedToken
String
ニュースフィードがいつ最終更 Medium、31.0
新されたのかを記述する不透明
ポーリングトークン。これ
は、/chatter/feeds/news/me
31.0
/feed-elements/is-modified
リソースの since 要求パラメー
タの値として使用します。
isModifiedUrl
String
フィードがいつ最終更新された Medium、31.0
のかが記述された不透明トーク
ンを含む since 要求パラメー
タがある Chatter REST API URL。
フィードがニュースフィードで
ない場合は null を返します。
この URL は、ニュースフィード
をポーリングして更新する場合
に使用します。
31.0
nextPageToken
String
次のページを識別するトーク
ン。次のページがない場合は
null。
Small、31.0
31.0
nextPageUrl
String
次のページを識別する Chatter
Small、31.0
REST API URL。次のページがない
場合は null。別のページを取
得する前に、この値が null で
あるかどうかを確認します。
ページが存在しない場合は、
31.0
ConnectApi.NotFoundException
エラーが返されます。
updatesToken
String
updatedSince パラメータで使 Big、31.0
用するトークン。使用できない
場合は null です。ニュース
フィードがいつ最終更新された
のかを記述する不透明ポーリン
グトークン。これ
637
31.0
Chatter REST API レスポンスボディ
プロパティ名
Feed Entity Is Editable
型
説明
検索条件グ
ループとバー
ジョン
使用可能な
バージョン
は、/chatter/feeds/news/me/feed-elements
リソースの updatedSince 要
求パラメータの値として使用し
ます。
String
updatesUrl
31.0
フィードの更新以降に更新され Big、31.0
たフィード要素を含む
/chatter/feeds/news/me/feed-elements
リソース。フィードが更新の
ポーリングをサポートしていな
い場合、値は null です。
Feed Entity Is Editable
コンテキストユーザがフィード要素またはコメントを編集できるかどうかを示します。
プロパティ名
型
説明
検索条件グルー
プとバージョン
使用可能なバー
ジョン
feedEntityUrl String
フィード要素またはコメントの
URL。
Small、34.0
34.0
isEditableByMe Boolean
コンテキストユーザがフィード要
素またはコメントを編集できる場
合は true、それ以外の場合は
false。
Small、34.0
34.0
Feed Item
フィードは、フィード要素で構成されます。フィード項目は、フィード要素の種類の 1 つです。
プロパティ
型
説明
検索条件グ
ループと
バージョン
actor
親によって異な
る
フィード項目を作成したエンティティ。値は Small、29.0
次のとおりです。
• Record Summary — レコードの場合 (23.0)
• User Summary — ユーザの場合 (23.0)
638
使用可能な
バージョン
Chatter REST API レスポンスボディ
プロパティ
型
Feed Item
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
• Unauthenticated User — Chatter 顧客の場合
(24.0)
メモ: アクターがユーザである場合、
User Summary レスポンスボディが返さ
れ、ユーザ種別の Record Summary は返
されません。
attachment
種別によって異
なる
添付ファイルの type 値によって異なりま
す。次のような値があります。
Medium、29.0
• Approval – Feed Item Attachment: Approval
(v27.0 ～ 31.0)
• BasicTemplate – Feed Item Attachment: Basic
Template (v27.0 ～ 31.0)
• Canvas – Feed Item Attachment: Canvas
Template (v29.0 ～ 31.0)
• CaseComment – Feed Item Attachment: Case
Comment (v24.0 ～ 31.0)
• Content – Feed Item Attachment: Content。コ
ンテンツを使用できない場合は null
(v23.0 ～ 31.0)
• DashboardComponent – Feed Item
Attachment: Dashboard (v24.0 ～ 31.0)
• EmailMessage – Feed Item Attachment: Email
Message (v29.0 ～ 31.0)
• Link – Feed Item Attachment: Link (v23.0 ～ 31.0)
• Poll – Feed Item Attachment: Poll (v26.0 ～ 31.0)
• RecordSnapshot – Feed Item Attachment:
Record Snapshot (v29.0 ～ 31.0)
• TrackedChange – Feed Item Attachment:
Tracked Change (v29.0 ～ 31.0)
重要: API バージョン 32.0 以降では、
capabilities プロパティを使用しま
す。
body
Feed Item Body
フィード項目に関する情報。
API バージョン 28.0 以前では、/body/text
プロパティをテキスト表示のデフォルトケー
スとして使用します。API バージョン 29.0 ～
639
Small、29.0
23.0
Chatter REST API レスポンスボディ
プロパティ
型
Feed Item
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
30.0 では、/preamble/text プロパティをテ
キスト表示のデフォルトケースとして使用し
ます。API バージョン 31.0 以降で
は、/header/text プロパティをテキスト
表示のデフォルトケースとして使用します。
capabilities
Feed Element
Capabilities
フィード要素に関する補助情報。フィード要 Medium、31.0 31.0
素の特性は、これらの機能で構成されます。
canShare
Boolean
フィード項目を共有できる場合は true、そ Medium、29.0 27.0
れ以外の場合は false
clientInfo
ClientInfo
接続の認証に使用される接続アプリケーショ Medium、29.0 23.0
ンに関する情報
comments
Comment Page
このフィード項目へのコメント。
Small、29.0
23.0 ～ 31.0
Small、29.0
23.0
重要: API バージョン 32.0 以降では、
capabilities.comments.page プロ
パティを使用します。
createdDate
String
currentUserLike Reference
ISO8601 の日付文字列 (例:
2011-02-25T18:24:31.000Z)
メモ: このプロパティは、バージョン
24.0 以降、使用できなくなります。代
わりに、myLike プロパティを使用し
てください。
23.0 ～ 24.0
該当する場合は Like オブジェクトへの参照、
それ以外の場合は null。
event
Boolean
feedElementType String
フィード項目が行動の変更によって作成され Medium、29.0 23.0
た場合は true、それ以外の場合は false
フィード要素は、フィードに含まれる最上位 Small、31.0
のオブジェクトです。フィード要素の種類
は、このフィード要素の特徴を記述します。
次のいずれかの値にします。
• Bundle — フィード要素のコンテナ。バ
ンドルには、メッセージセグメントを構
成する本文も含まれます。メッセージセ
グメントは、テキストのみの値に常に適
切に分解できます。
640
31.0
Chatter REST API レスポンスボディ
プロパティ
型
Feed Item
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
• FeedItem — フィード項目には 1 つの親
があり、その範囲は 1 つのコミュニティ
またはすべてのコミュニティになりま
す。フィード項目にはブックマーク、
キャンバス、コンテンツ、コメント、リ
ンク、アンケートなどの機能を設定でき
ます。フィード項目には、メッセージセ
グメントを構成する本文が含まれます。
メッセージセグメントは、テキストのみ
の値に常に適切に分解できます。
• Recommendation — おすすめは、おすす
め機能を備えたフィード要素です。おす
すめは、コンテキストユーザに、フォ
ローするレコード、参加するグループ、
または役に立つアプリケーションを推奨
します。
header
Feed Item Body
ヘッダーは投稿のタイトルです。このプロパ Medium、31.0 31.0
ティには、メッセージのすべてのセグメント
に対する表示可能なプレーンテキストが含ま
れます。クライアントでフィード要素の種類
の表示方法がわからない場合、このテキスト
が表示されます。
id
String
フィード項目の 18 文字の ID
isBookmarked Boolean
ByCurrentUser
Small、29.0
23.0
現在のユーザがこのフィード項目をブック Medium、29.0 24.0 ～ 31.0
マークしている場合は true、それ以外の場
合は false。
重要: API バージョン 32.0 以降では、
capabilities.bookmarks.isBookmarkedByCurrentUser
プロパティを使用します。
isDelete
Restricted
Boolean
コンテキストユーザがフィード項目を削除で Medium、29.0 25.0
きない場合は true を返します。false が
返された場合、コンテキストユーザがコメン
トを削除できる可能性があります。
641
Chatter REST API レスポンスボディ
Feed Item
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
isLikedBy
CurrentUser
Boolean
現在のユーザがこのフィード項目にいいね!
と言った場合は true、それ以外の場合は
false。
Medium、29.0 23.0 ～ 31.0
重要: API バージョン 32.0 以降では、
capabilities.chatterLikes.isLikedByCurrentUser
プロパティを使用します。
likes
Like Page
このフィード項目へのいいね!。
Medium、29.0 23.0 ～ 31.0
重要: API バージョン 32.0 以降では、
capabilities.chatterLikes.page
プロパティを使用します。
likesMessage
Like Message Body
フィード項目にいいね! と言ったユーザを説 Small、29.0
明するメッセージ本文。
27.0 ～ 31.0
重要: API バージョン 32.0 以降では、
capabilities.chatterLikes.likesMessage
プロパティを使用します。
modifiedDate
String
moderationFlags Moderation Flags
ISO8601 の日付文字列 (例:
2011-02-25T18:24:31.000Z)
Small、29.0
このフィード項目のフラグ。コミュニティモ Big、29.0
デレータは、フラグ付き項目を表示したり、
フラグ付き項目に対してアクションを実行し
たりできます。
23.0
29.0 ～ 31.0
Features レスポンスボディの
communityModeration プロパティが
false の場合、このプロパティは null に
なります。
重要: API バージョン 32.0 以降では、
capabilities.moderation.moderationFlags
プロパティを使用します。
myLike
Reference
コンテキストユーザがコメントにいいね! と Medium、29.0 23.0 ～ 31.0
言った場合はその特定のいいね! への参照、
それ以外の場合は null。
重要: API バージョン 32.0 以降では、
capabilities.chatterLikes.myLike
プロパティを使用します。
642
Chatter REST API レスポンスボディ
プロパティ
型
originalFeedItem Reference
originalFeed
ItemActor
種別によって異
なる
Feed Item
説明
検索条件グ
ループと
バージョン
このフィード項目が共有フィード項目の場合 Small、29.0
は、元のフィード項目への参照、それ以外の
場合は null
使用可能な
バージョン
24.0
値は元のフィード項目の種別によって異なり Medium、29.0 24.0
ます。値は次のとおりです。
• Record Summary – 元のフィード項目がレ
コードの場合
• User Summary – 元のフィード項目がユーザ
の場合
• Unauthenticated User — 元のフィード項目が
Chatter 顧客からのものである場合
• このフィード項目が共有フィード項目で
はない場合は null
parent
種別によって異
なる
値は親の種別によって異なります。値は次の Medium、29.0 23.0
とおりです。
• File Summary – 親がファイルの場合
• Group – 親がグループの場合
• Record Summary – 親がレコードの場合
• User Summary – 親がユーザの場合
メモ: 親がユーザである場合、User
Summary レスポンスボディが返され、
ユーザ種別の Record Summary は返され
ません。グループとファイルの両方に
ついても同様です。
photoUrl
String
preamble
Feed Item Preamble preamble は投稿のタイトルです。このプロパ Medium、29.0 27.0 ～ 30.0
Message Body
ティには、「App Builders - Pam Jones」など、
メッセージのすべてのセグメントに対する表
示可能なプレーンテキストが含まれます。
フィード項目に関連付けられた写真の URL
API バージョン 28.0 以前では、/body/text
プロパティをテキスト表示のデフォルトケー
スとして使用します。API バージョン 29.0 ～
30.0 では、/preamble/text プロパティをテ
キスト表示のデフォルトケースとして使用し
ます。API バージョン 31.0 以降で
643
Medium、29.0 23.0
Chatter REST API レスポンスボディ
プロパティ
型
Feed Item
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
28.0
は、/header/text プロパティをテキスト
表示のデフォルトケースとして使用します。
relative
CreatedDate
String
ISO8601 の日付文字列 (例:
2011-02-25T18:24:31.000Z)
Small、29.0
topics
Feed Items Topics
このフィード項目のトピック。
Medium、29.0 28.0 ～ 31.0
重要: API バージョン 32.0 以降では、
capabilities.topics.items プロ
パティを使用します。
type
String
type プロパティは、API バージョンに関係な Small、29.0
く、常にすべての種別を返します。ただし、
すべての API バージョンですべての種別が有
効なわけではありません。
重要: API バージョン 32.0 以降では、
capabilities プロパティを使用して
フィード項目の機能を判断できます。
「機能」を参照してください。
値は次のとおりです。
• ActivityEvent — フィードが有効になっ
ている親レコードに関連付けられた行動
または ToDo が作成または更新されるとき
に、ケースフィードに生成されるフィー
ド項目。
• AdvancedTextPost — 高度に書式設定
されたフィード項目 (グループへのお知ら
せの投稿など)。
• ApprovalPost — 承認機能のあるフィー
ド項目。承認者は、フィード項目の親で
操作を実行できます。
• AttachArticleEvent — ケースフィー
ドのケースに記事が添付されているとき
に生成されるフィード項目。
• BasicTemplateFeedItem — 拡張リンク
機能のあるフィード項目。
• CallLogPost — ケースフィードのケー
スに活動ログが保存されたときに生成さ
れるフィード項目。
644
23.0
Chatter REST API レスポンスボディ
プロパティ
型
Feed Item
説明
検索条件グ
ループと
バージョン
• CanvasPost — パブリッシャーのキャン
バスアプリケーションまたは Chatter REST
API または Chatter in Apex によって生成され
るフィード項目。投稿自体は、キャンバ
スアプリケーションへのリンクです。
• CaseCommentPost — ケースフィードに
ケースコメントが保存されたときに生成
されるフィード項目。
• ChangeStatusPost — ケースの状況が
ケースフィードで変更されたときに生成
されるフィード項目。
• ChatTranscriptionPost — Live Agent
チャットのトランスクリプトがケースに
保存されたときにケースフィードで生成
されるフィード項目。
• CollaborationGroupCreated — 新し
い公開グループが作成されたときに生成
されるフィード項目。新しいグループへ
のリンクが含まれます。
• CollaborationGroupUnarchived — 非
推奨。アーカイブされたグループが有効
化されたときに生成されるフィード項
目。
• ContentPost — コンテンツ機能のある
フィード項目。
• CreateRecordEvent — パブリッシャー
で作成されたレコードを説明するフィー
ド項目。
• DashboardComponentAlert — ダッシュ
ボードアラートのあるフィード項目。
• DashboardComponentSnapshot — ダッ
シュボードコンポーネントスナップ
ショット機能のあるフィード項目。
• EmailMessageEvent — ケースフィード
のケースからメールが送信されたときに
生成されるフィード項目。
• FacebookPost — 非推奨。ケースフィー
ドのケースから Facebook 投稿が作成され
たときに生成されるフィード項目。
645
使用可能な
バージョン
Chatter REST API レスポンスボディ
プロパティ
型
Feed Item
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
• LinkPost — いいね! 機能のあるフィード
項目。
• MilestoneEvent — ケースマイルストン
が完了したか、違反状況になったときに
生成されるフィード項目。ケースマイル
ストンへのリンクが含まれます。
• PollPost —アンケート機能のあるフィー
ド項目。フィード項目の閲覧者がアン
ケートの選択肢に投票できます。
• ProfileSkillPost — スキルがユーザ
のプロファイルに追加されたときに生成
されるフィード項目。
• QuestionPost — 質問が行われたときに
生成されるフィード項目。
API バージョン 33.0 以降では、この種別の
フィード項目には、コンテンツ機能とリ
ンク機能を設定できます。
• ReplyPost — Chatter アンサーの返信に
よって生成されるフィード項目。
• RypplePost — ユーザが感謝を投稿した
ときに生成されるフィード項目。
• SocialPost — ケースフィードのケース
からソーシャル投稿が作成されたときに
生成されるフィード項目。
• TextPost — テキストのみを含むフィー
ド項目。
• TrackedChange — レコードの 1 つ以上
の項目が変更されたときに作成される
フィード項目。
• UserStatus — 非推奨。ユーザ自身のプ
ロファイルへの投稿。
url
String
このフィード項目への URL
Small、29.0
23.0
visibility
String
このフィード項目を表示できるユーザ。値は Small、29.0
次のとおりです。
26.0
• InternalUsers — コミュニティが有効
な場合は、デフォルトの内部コミュニ
646
Chatter REST API レスポンスボディ
プロパティ
型
Feed Item Attachment: Approval
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
ティのメンバーに対してのみフィード項
目を表示できます。
• AllUsers — コミュニティが有効な場合
は、コミュニティのすべてのメンバーに
対してフィード項目を表示できます。
Feed Item Attachment: Approval
承認添付ファイル。
重要: このレスポンスボディは、バージョン 32.0 以降では使用できません。バージョン 32.0 以降では、
Approval Capability が使用されます。
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
id
String
作業項目 ID
Small、29.0
27.0 ～ 31.0
プロセスインスタンスステップ ID。関連付け Small、30.0
られたレコードが承認プロセスの 1 つのス
テップを表します。
30.0 ～ 31.0
承認の状況。値は次のとおりです。
Small、29.0
27.0 ～ 31.0
process
String
InstanceStepId
status
String
• Approved
• Fault
• Held
• NoResponse
• Pending
• Reassigned
• Rejected
• Removed
• Started
postTemplate
Fields
Approval Post
Template Field[]
承認投稿テンプレート項目のコレクション
Small、29.0
28.0 ～ 31.0
type
String
Approval
Small、29.0
27.0 ～ 31.0
647
Chatter REST API レスポンスボディ
Feed Item Attachment: Basic Template
Feed Item Attachment: Basic Template
重要: このレスポンスボディは、バージョン 32.0 以降では使用できません。バージョン 32.0 以降では、
Enhanced Link Capability が使用されます。
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
description
String
最大 500 文字の説明 (省略可能)
Small、29.0
27.0 ～ 31.0
icon
Icon
アイコン (省略可能)
Small、29.0
27.0 ～ 31.0
linkRecordId
String
linkURL が Salesforce レコードを参照する場 Small、29.0
28.0 ～ 31.0
合、linkRecordId にはそのレコードの ID
が含まれます。
linkUrl
String
使用可能なコンテンツをインライン表示でき Small、29.0
ない場合の詳細ページへのリンクの URL (省
略可能)
27.0 ～ 31.0
subtype
String
基本テンプレートのフィード項目に関連付け Big、29.0
られたサブタイプ。値は次のとおりです。
27.0 のみ
• CollaborationGroupCreated
このプロパ
ティは 28.0
で廃止さ
れ、それよ
り前のバー
ジョンのク
ライアント
には常に
None を返
します。
title
String
詳細ページのタイトル (省略可能)
Small、29.0
27.0 ～ 31.0
type
String
BasicTemplate
Small、29.0
27.0 ～ 31.0
Feed Item Attachment: Canvas Template
重要: このレスポンスボディは、バージョン 32.0 以降では使用できません。バージョン 32.0 以降では、
Canvas Capability が使用されます。
648
Chatter REST API レスポンスボディ
Feed Item Attachment: Case Comment
プロパティ
型
説明
description
String
省略可能。キャンバスアプリケーションの説 Small、29.0
明。この項目の文字数は 500 文字までです。
29.0 ～ 31.0
developerName String
キャンバスアプリケーションの開発者名 (API Small、29.0
名)
29.0 ～ 31.0
height
String
省略可能。キャンバスアプリケーションの高 Small、29.0
さ (ピクセル単位)。デフォルトの高さは 200
ピクセルです。
29.0 ～ 31.0
icon
Icon
キャンバスアプリケーションのアイコン
Small、29.0
29.0 ～ 31.0
namespacePrefix String
省略可能。キャンバスアプリケーションが作 Small、29.0
成された Developer Edition 組織の名前空間プレ
フィックス。
29.0 ～ 31.0
String
省略可能。キャンバスアプリケーションに渡 Small、29.0
される JSON 形式のパラメータ。例:
29.0 ～ 31.0
parameters
検索条件グ
ループと
バージョン
使用可能な
バージョン
{'isUpdated'='true'}
thumbnailUrl
String
省略可能。キャンバスアプリケーションのサ Small、29.0
ムネイル画像の URL。最大サイズは 120x120
ピクセルです。
29.0 ～ 31.0
title
String
キャンバスアプリケーションのコールに使用 Small、29.0
されるリンクのタイトル。
29.0 ～ 31.0
type
String
Canvas
Small、29.0
29.0 ～ 31.0
Feed Item Attachment: Case Comment
重要: このレスポンスボディは、バージョン 32.0 以降では使用できません。バージョン 32.0 以降では、Case
Comment Capability が使用されます。
プロパティ
型
説明
検索条件グ
ループと
バージョン
actorType
String
コメントを行ったユーザの種別を示します。 Small、29.0
有効な値は、次のとおりです。
• Customer — Chatter顧客がコメントを行っ
た場合
649
使用可能な
バージョン
24.0 ～ 31.0
Chatter REST API レスポンスボディ
プロパティ
型
Feed Item Attachment: Case Comment
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
• CustomerService — サービス担当者が
コメントを行った場合
createdBy
User Summary
コメントを作成したユーザに関する情報
Small、29.0
24.0 ～ 31.0
createdDate
String
ISO8601 の日付文字列 (例:
2011-02-25T18:24:31.000Z)
Small、29.0
24.0 ～ 31.0
eventType
String
ケースフィードのコメントのイベントタイプ Small、29.0
を示します。次のいずれかの値にします。
29.0 ～ 31.0
• NewInternal — 新しく「社内のみ」と
マークされたケースコメント。
• NewPublished — 新しく公開されたケー
スコメント。
• NewPublishedByCustomer — 新しく公
開された、顧客によるケースコメント。
• PublishExisting — 再公開された既存
のケースコメント。
• PublishExistingByCustomer — 再公
開された、顧客による既存のケースコメ
ント。
• UnpublishExistingByCustomer — 非
公開にされた、顧客による既存のケース
コメント。
• UnpublishExsiting — 非公開にされた
既存のケースコメント。
メモ: この入力ミスは、ドキュメン
トではなくコードに含まれていま
す。コードでこのスペルを使用して
ください。
id
String
ケースコメントの 18 文字の ID
Small、29.0
24.0 ～ 31.0
published
Boolean
コメントが公開されたかどうかを示します。 Small、29.0
24.0 ～ 31.0
text
String
ケースコメントのテキスト
Small、29.0
24.0 ～ 31.0
type
String
CaseComment
Small、29.0
27.0 ～ 31.0
650
Chatter REST API レスポンスボディ
Feed Item Attachment: Content
Feed Item Attachment: Content
フィード項目コンテンツ添付ファイルの説明。
重要: このレスポンスボディは、バージョン 32.0 以降では使用できません。バージョン 32.0 以降では、
Content Capability が使用されます。
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
checkSum
String
ファイルの MD5 チェックサム
Small、29.0
26.0 ～ 31.0
contentUrl
String
リンクファイルおよび Google ドキュメント Small、31.0
の URL。それ以外の場合、値は null です。
31.0 ～ 31.0
description
String
添付ファイルの説明
Small、29.0
23.0 ～ 31.0
downloadUrl
String
ファイルの URL。コンテンツがリンクまたは Small、29.0
Google ドキュメントの場合、この値は null
です。
23.0 ～ 31.0
ファイルの拡張子
Small、29.0
26.0 ～ 31.0
fileExtension String
fileSize
String
ファイルのサイズ (バイト)。サイズを判定で Small、29.0
きない場合は、unknown を返します。
23.0 ～ 31.0
fileType
String
ファイルの種類
Small、29.0
23.0 ～ 31.0
hasImagePreview Boolean
ファイルでプレビュー画像を使用できる場合 Small、29.0
は true、それ以外の場合は false
23.0 ～ 29.0
hasPdfPreview Boolean
ファイルで PDF プレビューを使用できる場合 Small、29.0
は true、それ以外の場合は false
23.0 ～ 31.0
コンテンツの 18 文字の ID
Small、29.0
23.0 ～ 31.0
ファイルが Salesforce Files Sync と同期されてい Small、29.0
る場合は true、同期されていない場合は
false。
26.0 ～ 31.0
id
String
isInMyFileSync Boolean
mimeType
String
ファイルの MIME タイプのコンテンツ
Small、29.0
23.0 ～ 31.0
renditionUrl
String
ファイルの変換リソースへの URL。共有ファ Small、29.0
イルの場合、変換はアップロード後に非同期
で処理されます。非公開ファイルの場合、変
換は最初にファイルプレビューが要求された
ときに処理されるため、ファイルのアップ
ロード直後は使用できません。
26.0 ～ 31.0
renditionUrl
240By180
String
ファイルの 240×180 の変換リソースへの URL。 Small、30.0
共有ファイルの場合、変換はアップロード後
30.0 ～ 31.0
651
Chatter REST API レスポンスボディ
プロパティ
型
Feed Item Attachment: Content
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
に非同期で処理されます。非公開ファイルの
場合、変換は最初にファイルプレビューが要
求されたときに処理されるため、ファイルの
アップロード直後は使用できません。
renditionUrl
720By480
String
ファイルの 720×480 の変換リソースへの URL。 Small、30.0
共有ファイルの場合、変換はアップロード後
に非同期で処理されます。非公開ファイルの
場合、変換は最初にファイルプレビューが要
求されたときに処理されるため、ファイルの
アップロード直後は使用できません。
30.0 ～ 31.0
textPreview
String
可能な場合はファイルのテキストプレ
ビュー、それ以外の場合は null です。
30.0 ～ 31.0
thumb120By90 String
RenditionStatus
Big、30.0
ファイルの 120×90 プレビュー画像の表示状 Medium、30.0 30.0 ～ 31.0
況を示します。次のいずれかの値にします。
• Processing — 画像を表示しています。
• Failed — 表示プロセスが失敗しました。
• Success — 表示プロセスが成功しまし
た。
• Na — この画像は表示できません。
thumb240By180 String
RenditionStatus
ファイルの 240×180 プレビュー画像の表示状 Medium、30.0 30.0 ～ 31.0
況を示します。次のいずれかの値にします。
• Processing — 画像を表示しています。
• Failed — 表示プロセスが失敗しました。
• Success — 表示プロセスが成功しまし
た。
• Na — この画像は表示できません。
thumb720By480 String
RenditionStatus
ファイルの 720×480 プレビュー画像の表示状 Medium、30.0 30.0 ～ 31.0
況を示します。次のいずれかの値にします。
• Processing — 画像を表示しています。
• Failed — 表示プロセスが失敗しました。
• Success — 表示プロセスが成功しまし
た。
• Na — この画像は表示できません。
title
String
ファイルのタイトル
652
Small、29.0
23.0 ～ 31.0
Chatter REST API レスポンスボディ
Feed Item Attachment: Dashboard
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
type
String
Content
Small、29.0
27.0 ～ 31.0
versionId
String
コンテンツのこのバージョンの 18 文字の ID Medium、29.0 23.0 ～ 31.0
Feed Item Attachment: Dashboard
重要: このレスポンスボディは、バージョン 32.0 以降では使用できません。バージョン 32.0 以降では、
Dashboard Component Snapshot Capability が使用されます。
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
componentId
String
コンポーネントの 18 文字の ID
Small、29.0
24.0 ～ 31.0
componentName String
コンポーネントの名前。コンポーネントと一 Small、29.0
緒に名前が保存されていない場合、ローカラ
イズされた文字列 "タイトル未定のコンポー
ネント" を返します。
24.0 ～ 31.0
dashboard
BodyText
String
フィード項目の本文でアクターの横に表示す Small、29.0
るテキスト。これは、デフォルトの本文テキ
ストの代わりに使用されます。テキストが指
定されておらず、デフォルトの本文テキスト
もない場合、null を返します。
24.0 ～ 31.0
dashboardId
String
ダッシュボードの 18 文字の ID
Small、29.0
24.0 ～ 31.0
ダッシュボードの名前
Small、29.0
24.0 ～ 31.0
dashboardName String
fullSize
ImageUrl
String
実寸大のダッシュボード画像の URL
Small、29.0
24.0 ～ 31.0
lastRefresh
Date
String
このダッシュボードの最終更新日の ISO8601
の日付文字列 (例: 2011-02-25T18:24:31.000Z)
Small、29.0
24.0 ～ 31.0
最終更新日の表示テキスト ("最終更新 2011 年 Small、29.0
10 月 31 日" など)。
24.0 ～ 31.0
lastRefreshDate String
DisplayText
runningUser
User Summary
ダッシュボードを実行しているユーザ
Small、29.0
24.0 ～ 31.0
thumbnailUrl
String
サムネイルサイズのダッシュボード画像の
URL
Small、29.0
24.0 ～ 31.0
type
String
DashboardComponent
Small、29.0
27.0 ～ 31.0
653
Chatter REST API レスポンスボディ
Feed Item Attachment: Email Message
Feed Item Attachment: Email Message
ケースフィードのケースレコードから送信されるメールメッセージ。
重要: このレスポンスボディは、バージョン 32.0 以降では使用できません。バージョン 32.0 以降では、
Email Message Capability が使用されます。
プロパティ
型
説明
検索条件グ
ループと
バージョン
direction
String
メールメッセージの方向。次のいずれかの値 Small、29.0
にします。
使用可能な
バージョン
29.0 ～ 31.0
• Inbound — インバウンドメッセージ (顧
客が送信)。
• Outbound — アウトバウンドメッセージ
(サポートエージェントが顧客に送信)。
emailMessageId String
メールメッセージの ID
Small、29.0
29.0 ～ 31.0
subject
String
メールメッセージの件名
Small、29.0
29.0 ～ 31.0
textBody
String
メールメッセージの本文
Big、29.0
29.0 ～ 31.0
toAddresses
Email Address[]
メールメッセージを受信するアドレスのコレ Small、29.0
クション
29.0 ～ 31.0
type
String
Emailmessage
Small、29.0
27.0 ～ 31.0
Feed Item Attachment: Link
重要: このレスポンスボディは、バージョン 32.0 以降では使用できません。バージョン 32.0 以降では、Link
Capability が使用されます。
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
title
String
リンクの説明
Small、29.0
23.0 ～ 31.0
type
String
Link
Small、29.0
27.0 ～ 31.0
url
String
フィード項目 (外部項目の可能性もある) に添 Small、29.0
付された URL
23.0 ～ 31.0
654
Chatter REST API レスポンスボディ
Feed Item Attachment: Poll
Feed Item Attachment: Poll
重要: このレスポンスボディは、バージョン 32.0 以降では使用できません。バージョン 32.0 以降では、Poll
Capability が使用されます。
プロパティ
型
説明
choices
Feed Poll Choice[]
投票を構成するフィードのアンケート選択肢 Small、29.0
のコレクション
26.0 ～ 31.0
myChoiceId
String
このアンケートにおいて現在のユーザが投票 Small、29.0
したアンケート選択肢の 18 文字の ID。現在
のユーザが投票しなかった場合は、null が
返されます。
26.0 ～ 31.0
フィードアンケート項目に投じられた投票の Small、29.0
合計数
26.0 ～ 31.0
Small、29.0
27.0 ～ 31.0
totalVoteCount Integer
type
String
検索条件グ
ループと
バージョン
Poll
使用可能な
バージョン
Feed Item Attachment: Record Snapshot
重要: このレスポンスボディは、バージョン 32.0 以降では使用できません。バージョン 32.0 以降では、
Record Snapshot Capability が使用されます。
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
recordView
Record View
レコードの表現。
Small、29.0
29.0 ～ 31.0
type
String
RecordSnapshot
Small、29.0
29.0 ～ 31.0
Feed Item Attachment: Tracked Change
重要: このレスポンスボディは、バージョン 32.0 以降では使用できません。バージョン 32.0 以降では、
Tracked Changes Capability が使用されます。
655
Chatter REST API レスポンスボディ
Feed Item Body
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
changes
Feed Tracked
Change[]
フィード追跡変更のコレクション。
Small、29.0
29.0 ～ 31.0
type
String
TrackedChange
Small、29.0
29.0 ～ 31.0
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
Feed Item Body
プロパティ
型
messageSegments Segment[]
種別に基づくメッセージセグメントのコレク Medium、29.0 23.0
ション。セグメントは次のいずれかになる可
能性があります。
• Message Segment: Entity Link
• Message Segment: Field Change
• Message Segment: Field Change Name
• Message Segment: Field Change Value
• Message Segment: Hashtag
• Message Segment: Link
• Message Segment: Mention
• Message Segment: More Changes
• Message Segment: Text
text
String
表示可能な状態のメッセージテキスト。メッ Small、29.0
セージセグメントを処理しない場合は、この
テキストを使用します。
23.0
Feed Item Page
重要: このレスポンスボディは、バージョン 32.0 以降では使用できません。バージョン 32.0 以降では、Feed
Element Page が使用されます。
プロパティ
型
currentPageUrl String
説明
検索条件グ
ループと
バージョン
フィード項目の現在のページへの URL
Medium、29.0 23.0 ～ 31.0
656
使用可能な
バージョン
Chatter REST API レスポンスボディ
プロパティ
型
Feed Item Preamble Message Body
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
isModifiedToken String
ニュースフィードがいつ最終更新されたのか Medium、29.0 27.0 ～ 31.0
を記述する不透明ポーリングトークン。この
値は、News Feed Is-Modified リソースの since
要求パラメータとして使用します。
isModifiedUrl String
フィードがいつ最終更新されたのかが記述さ Medium、29.0 23.0 ～ 31.0
れた不透明トークンを含む since 要求パラ
メータがある News Feed Is-Modified リソース。
フィードがニュースフィードではない場合は
null を返します。
items
Feed Item[]
1 つ以上のフィード項目のコレクション
Small、29.0
23.0 ～ 31.0
nextPageUrl
String
フィード項目の次のページへの URL
Small、29.0
23.0 ～ 31.0
updatesToken
String
updatedSince パラメータで使用するトー
Big、30.0
30.0 ～ 31.0
Big、30.0
30.0 ～ 31.0
検索条件グ
ループと
バージョン
使用可能な
バージョン
クン。使用できない場合は null です。
updatesUrl
String
updatesToken プロパティの値を含むクエ
リ文字列を持つ Chatter REST API リソース。こ
のリソースは、最後の要求以降に更新された
フィード項目を返します。URL を変更せずに
そのまま使用します。使用できない場合、プ
ロパティは null です。
Feed Item Preamble Message Body
プロパティ
型
messageSegments Segments[]
説明
種別に基づくメッセージセグメントのコレク Medium、29.0 27.0
ション。セグメントは次のいずれかになる可
能性があります。
• Message Segment: Entity Link
• Message Segment: Text
text
String
preamble は投稿のタイトルです。このプロパ Small、29.0
ティには、「App Builders - Pam Jones」など、
メッセージのすべてのセグメントに対する表
示可能なプレーンテキストが含まれます。
657
27.0
Chatter REST API レスポンスボディ
Feed Items Topics
Feed Items Topics
重要: このレスポンスボディは、バージョン 32.0 以降では使用できません。バージョン 32.0 以降では、
Topics Capability が使用されます。
プロパティ
型
canAssignTopics Boolean
topics
Topic[]
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
トピックをフィード項目に割り当て可能な場 Small、29.0
合は true、それ以外の場合は false
28.0 ～ 31.0
トピックのコレクション
Small、29.0
28.0 ～ 31.0
検索条件グ
ループと
バージョン
使用可能な
バージョン
Feed Modified Info
プロパティ
型
説明
isModified
Boolean
ニュースフィードが最後にポーリングされた Small、29.0
後に変更されている場合は true、それ以外
の場合は false。フィードがニュースフィー
ドではない場合は null を返します。
23.0
isModifiedToken String
ニュースフィードがいつ最終更新されたのか Small、29.0
を記述する不透明ポーリングトークン。この
値は、News Feed Is-Modified リソースの since
要求パラメータとして使用します。
27.0
String
フィードがいつ最終更新されたのかが記述さ Small、29.0
れた不透明トークンを含む since 要求パラ
メータがある News Feed Is-Modified リソース。
フィードがニュースフィードではない場合は
null を返します。Feed または Feed Item Page
レスポンスボディで isModifiedUrl リソー
スに対して要求した後で、このリソースに要
求します。
23.0
nextPollUrl
658
Chatter REST API レスポンスボディ
Feed Poll Choice
Feed Poll Choice
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
id
String
アンケート選択肢の 18 文字の ID
Small、29.0
26.0
position
Integer
このアンケート選択肢があるアンケート内の Small、29.0
場所。最初のアンケート選択肢は 1 から開始
します。
26.0
text
String
アンケート選択肢に関連付けられた表示ラベ Small、29.0
ルテキスト。
26.0
voteCount
Integer
このアンケート選択肢の投票合計数。
Small、29.0
26.0
このアンケートに投じられたすべての投票数 Small、29.0
に対するこのアンケート選択肢への合計投票
数の割合。この割合を 100 で乗算して、この
アンケート選択肢の投票数のパーセントを出
します。
26.0
voteCountRatio Double
Feed Tracked Change
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
fieldName
String
更新された項目の名前。
Small、29.0
29.0
newValue
String
項目の新しい値または null (項目の長さが
長い場合、または空の場合)。
Small、29.0
29.0
oldValue
String
項目の古い値または null (項目の長さが長
い場合、または空の場合)。
Small、29.0
29.0
File Detail
File Summary レスポンスボディのすべてと次の追加項目が含まれます。
659
Chatter REST API レスポンスボディ
File Share Link
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
pageCount
Integer
Flash 変換をサポートするドキュメントのペー Medium、29.0 24.0
ジ数、またはプレゼンテーションのスライド
数。Flash 変換が失敗した場合、またはファ
イルの種類でサポートされていない場合は 0
を返します。
関連トピック:
File Summary
File Share Link
リンクとして共有されるファイルの説明。
プロパティ
型
説明
検索条件グ
ループと
バージョン
fileViewUrl
String
ファイルの表示とダウンロードが可能な
Small、30.0
URL。この値は、ファイル共有リンクとも呼
ばれます。
30.0
sharingType
String
共有の権限レベル。値は次のとおりです。
30.0
• C — コラボレータ
• I — 共有権限は場所によって決まりま
す。これは一般に、共有権限がファイル
ではなくライブラリに設定されている場
合に発生します。この値は、コンテキス
トユーザがファイルの所有者である場合
にも使用されます。
• N — アクセス権限なし
• V — 閲覧者
660
Small、30.0
使用可能な
バージョン
Chatter REST API レスポンスボディ
File Shares Page
File Shares Page
プロパティ
型
currentPageUrl String
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
ファイル共有の現在のページの URL
Medium、29.0 24.0
linkShare
File Share Link
ファイル共有リンクの URL
Small、30.0
30.0
shares
Shares[]
1 つ以上のファイル共有のコレクション
Small、29.0
24.0
nextPageUrl
String
ファイル共有の次のページの URL
Small、29.0
24.0
previousPageUrl String
ファイル共有の前のページの URL
Medium、29.0 24.0
File Summary
ファイルの説明。
すべての変換プロパティについて、次のことに注意してください。共有ファイルの場合、変換はアップロード
後に非同期で処理されます。非公開ファイルの場合、変換は最初にファイルプレビューが要求されたときに処
理されるため、ファイルのアップロード直後は使用できません。
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
checkSum
String
ファイルの MD5 チェックサム
Big、29.0
26.0
contentSize
Integer
ファイルのサイズ (バイト)
Small、29.0
24.0
contentHub
Repository
Files Connect リポ
ジトリ
このファイルに関連付けられた外部データ Small、32.0
ソース、または、外部ファイルを指し示して
いない場合は null。
32.0
content
ModifiedDate
Date
ISO 8601 形式の日付文字列 (例:
Small、32.0
2011-02-25T18:24:31.000Z)。名前変更などの直接
的なファイル操作でのみ更新されるファイル
固有の変更日です。Salesforce以外からのファ
イルの変更により、この日付が更新される場
合があります。
32.0
contentUrl
String
ファイルがリンクの場合は URL を返し、それ Small、29.0
以外の場合は文字列 "null" を返します。
24.0
description
String
ファイルの説明
Medium、29.0 24.0
downloadUrl
String
ファイルへの URL
Small、29.0
661
26.0
Chatter REST API レスポンスボディ
File Summary
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
external
DocumentUrl
String
このファイルが指し示す外部 URL。外部ファ Small、32.0
イルを指し示していない場合は null。
32.0
flash
String
RenditionStatus
ファイルの Flash プレビューバージョンが表 Big、29.0
示されたかどうかを示します。
24.0
fileExtension String
ファイルの拡張子
Small、29.0
26.0
fileType
String
ファイルの種類 (PDF、PowerPoint など)
Medium、29.0 24.0
id
String
ファイルの 18 文字の ID
Small、29.0
24.0
isInMyFileSync Boolean
ファイルが Salesforce Files Sync と同期されてい Medium、29.0 26.0
る場合は true、同期されていない場合は
false。
isMajorVersion Boolean
ファイルがメジャーバージョンの場合は
Medium、31.0 31.0
true、ファイルがマイナーバージョンの場
合は false。メジャーバージョンを置き換
えることはできません。
mimeType
String
moderationFlags Moderation Flags
ファイルの MIME タイプ
Medium、29.0 26.0
このファイルのフラグ。コミュニティモデ Big、30.0
レータは、フラグ付き項目を表示したり、フ
ラグ付き項目に対してアクションを実行した
りできます。
30.0
Features レスポンスボディの
communityModeration プロパティが
false の場合、このプロパティは null に
なります。
modifiedDate
Date
ISO 8601 形式の日付文字列 (例:
Small、29.0
2011-02-25T18:24:31.000Z)。Salesforce 内からの
ファイルの変更により、この日付が更新され
ます。
24.0
motif
Motif
オブジェクトがファイルであることを示す
小、中、大のアイコン。motif にはオブジェ
クトのベース色を含めることもできます。
27.0
Small、29.0
このアイコンは、ファイルのプレビューでは
ありません。
mySubscription Reference
コンテキストユーザがこのファイルをフォ Medium、29.0 23.0
ローしている場合は、登録に関する情報が含
662
Chatter REST API レスポンスボディ
プロパティ
型
File Summary
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
Small、29.0
24.0
まれます。それ以外の場合は、null を返し
ます。
name
String
ファイルの名前
origin
String
ファイルソースを示します。有効な値は、次 Big、29.0
のとおりです。
24.0
• Chatter — ファイルソースが Chatter の
場合
• Content — ファイルソースがコンテンツ
の場合
• FileField — ファイルソースがレコー
ドやその他の形式の場合
owner
User Summary
ファイルの所有者
Small、29.0
24.0
parentFolder
Reference
親フォルダへの参照。
Small、29.0
28.0
pdfRendition
Status
String
ファイルの PDF プレビューバージョンが表示 Big、29.0
されたかどうかを示します。
24.0
ファイルの公開状況。次のいずれかの値にし Small、29.0
ます。
29.0
publishStatus String
• PendingAccess — ファイルは公開を待
機中です。
• PrivateAccess — ファイルは非公開で
す。
• PublicAccess — ファイルは公開されて
います。
renditionUrl
String
ファイルの変換リソースへの URL。共有ファ Medium、29.0 26.0
イルの場合、変換はアップロード後に非同期
で処理されます。非公開ファイルの場合、変
換は最初にファイルプレビューが要求された
ときに処理されるため、ファイルのアップ
ロード直後は使用できません。
renditionUrl
240By180
String
ファイルの 240×180 ピクセルサイズ変換への Medium、29.0 29.0
URL (使用可能な場合)。共有ファイルの場合、
変換はアップロード後に非同期で処理されま
す。非公開ファイルの場合、変換は最初に
ファイルプレビューが要求されたときに処理
663
Chatter REST API レスポンスボディ
プロパティ
型
File Summary
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
されるため、ファイルのアップロード直後は
使用できません。
renditionUrl
720By480
String
repositoryFile String
Url
sharingRole
String
ファイルの 720×480 ピクセルサイズ変換への Medium、29.0 29.0
URL (使用可能な場合)。共有ファイルの場合、
変換はアップロード後に非同期で処理されま
す。非公開ファイルの場合、変換は最初に
ファイルプレビューが要求されたときに処理
されるため、ファイルのアップロード直後は
使用できません。
外部リポジトリファイルのプロパティへのア Small、32.0
クセスを提供する Chatter REST API リソースの
URL。このファイルが外部ファイルを参照し
ていない場合は null。
32.0
ファイルの共有ロール。次のいずれかの値に Medium、29.0 29.0
します。
• Admin — 所有者権限ですが、ファイルは
所有していません。
• Collaborator — 閲覧者権限に加えて、
権限の編集および変更を行ったり、新し
いバージョンのファイルをアップロード
したりできます。
• Owner — コラボレータ権限に加えて、
ファイルを非公開にしたり、ファイルを
削除したりできます。
• Viewer — ファイルを表示、ダウンロー
ド、共有できます。
• WorkspaceManaged — ライブラリで制
御される権限。
textPreview
String
thumb120By90 String
RenditionStatus
可能な場合はファイルのテキストプレ
ビュー、それ以外の場合は null です。
Big、30.0
ファイルの 120×90 プレビュー画像の表示状 Small、29.0
況を示します。次のいずれかの値にします。
• Processing — 画像を表示しています。
• Failed — 表示プロセスが失敗しました。
• Success — 表示プロセスが成功しまし
た。
664
30.0
24.0
Chatter REST API レスポンスボディ
プロパティ
型
File Summary Page
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
• Na — この画像は表示できません。
thumb240By180 String
RenditionStatus
ファイルの 240×180 プレビュー画像の表示状 Small、29.0
況を示します。次のいずれかの値にします。
24.0
• Processing — 画像を表示しています。
• Failed — 表示プロセスが失敗しました。
• Success — 表示プロセスが成功しまし
た。
• Na — この画像は表示できません。
thumb720By480 String
RenditionStatus
ファイルの 720×480 プレビュー画像の表示状 Small、29.0
況を示します。次のいずれかの値にします。
24.0
• Processing — 画像を表示しています。
• Failed — 表示プロセスが失敗しました。
• Success — 表示プロセスが成功しまし
た。
• Na — この画像は表示できません。
title
String
ファイルのタイトル
Small、29.0
24.0
type
String
ContentDocument
Small、29.0
24.0
url
String
ファイルの URL
Small、29.0
24.0
ファイルのバージョン番号
Medium、29.0 24.0
説明
検索条件グ
ループと
バージョン
ファイルの現在のページの URL
Medium、29.0 24.0
versionNumber String
File Summary Page
プロパティ
型
currentPageUrl String
使用可能な
バージョン
files
File Summary[]
1 つ以上のファイルのコレクション
Small、29.0
24.0
nextPageUrl
String
ファイルの次のページの URL
Small、29.0
24.0
previousPageUrl String
ファイルの前のページの URL
Medium、29.0 24.0
665
Chatter REST API レスポンスボディ
Files Connect Provider Type
Files Connect Provider Type
Files Connect プロバイダに関する情報。
プロパティ
型
説明
検索条件グループと
バージョン
使用可
能な
バー
ジョン
label
String
プロバイダタイプのローカライズされ
た表示ラベル。
Small、32.0
32.0
type
String
プロバイダタイプ。次のいずれかの値
にします。
Small、32.0
32.0
検索条件グループと
バージョン
使用可
能な
バー
ジョン
• ContentHubCmis
• ContentHubGoogleDrive
• ContentHubSharepoint
• ContentHubSharepointOffice365
• SimpleUrl
Files Connect リポジトリ
Files Connect リポジトリに関する情報。
プロパティ
型
説明
features
Files Connect リポジトリの機能。
Repository
Features
Small、32.0
32.0
id
String
外部データソースの 18 文字の ID。
Small、32.0
32.0
label
String
リポジトリの表示ラベル。
Small、32.0
32.0
motif
Motif
motif プロパティには、Salesforce レコー Small、32.0
ドタイプを示す小、中、大のアイコン
への URL があります。一般的なレコード
タイプは、ファイル、ユーザ、グルー
プですが、すべてのレコードタイプに
一連の motif アイコンがあります。カス
タムオブジェクトレコードでは、タブ
スタイルアイコンが使用されます。認
証されていないユーザでもすべてのア
32.0
666
Chatter REST API レスポンスボディ
プロパティ
型
Files Connect Repository Collection
説明
検索条件グループと
バージョン
使用可
能な
バー
ジョン
イコンを使用できるため、たとえば、
motif アイコンをメールで表示すること
ができます。motif にはレコードタイプ
のベース色を含めることもできます。
mySubscription
Reference
コンテキストユーザがこのレコードを
フォローしている場合は、登録に関す
る情報が含まれます。それ以外の場合
は、null を返します。
Medium、32.0
32.0
name
String
リポジトリ名。
Small、32.0
32.0
providerType
Files Connect リポジトリプロバイダタイプ。
Provider Type
Small、32.0
32.0
リポジトリのルートフォルダ項目への Small、32.0
URL。リポジトリで参照がサポートされ
ていない場合は null。
32.0
rootFolderItemsUrl String
type
String
レコード ContentHubRepository の
タイプ。
Small、32.0
32.0
url
String
Files Connect リポジトリの Chatter REST API Small、32.0
リソース URL。
32.0
Files Connect Repository Collection
Files Connect リポジトリのコレクション。
プロパティ名
型
currentPageUrl String
nextPageUrl
String
説明
検索条件グルー
プとバージョン
使用可能なバー
ジョン
現在のページを識別する Chatter REST Medium、32.0
API URL。
32.0
次のページを識別する Chatter REST Small、32.0
API URL。次のページがない場合は
null。別のページを取得する前
に、この値が null であるかどうか
を確認します。ページが存在しな
い場合は、
32.0
ConnectApi.NotFoundException
エラーが返されます。
667
Chatter REST API レスポンスボディ
プロパティ名
型
previousPageUrl String
repositories
Files Connect
Repository[]
Files Connect Repository Features
説明
検索条件グルー
プとバージョン
使用可能なバー
ジョン
前のページを識別する Chatter REST
API URL。前のページがない場合は
null。
Medium、32.0
32.0
リポジトリのコレクション。
Small、32.0
32.0
Files Connect Repository Features
Files Connect リポジトリの機能に関する情報。
プロパティ
型
説明
検索条件グループと
バージョン
canBrowse
Boolean
リポジトリのフォルダ階層を参照でき Small、32.0
るか (true)、否か (false) を示します。
32.0
canSearch
Boolean
リポジトリを検索できるか (true)、否
か (false) を示します。
32.0
Small、32.0
使用可
能な
バー
ジョン
Flat Feed
プロパティ
型
currentPageUrl String
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
項目の現在のページの URL
Medium、29.0 25.0 ～ 26.0
items
Flat Feed Item[]
1 つ以上のフラットフィード項目のコレク
ション
Small、29.0
25.0 ～ 26.0
nextPageUrl
String
項目の次のページの URL
Small、29.0
25.0 ～ 26.0
668
Chatter REST API レスポンスボディ
Flat Feed Item
Flat Feed Item
プロパティ
型
item
type によって異 type の値に応じたフラットフィード項目。 Small、29.0
なる
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
25.0 ～ 26.0
有効な値は、次のとおりです。
• type が Comment の場合 — Comment
• type が FeedItem の場合 — Feed Item
type
String
項目の種別。有効な値は、次のとおりです。 Small、29.0
25.0 ～ 26.0
• Comment
• FeedItem
Folder
フォルダの説明。
プロパティ
型
説明
createdDate
Date
フォルダの作成日を指定する ISO-8601 形式の Small、30.0
日付文字列。
30.0
id
String
フォルダの 18 文字の ID。
Small、30.0
30.0
フォルダおよびこのフォルダ内のすべての Small、33.0
フォルダが Salesforce Files Sync と同期されてい
る場合は true、同期されていない場合は
false。
33.0
isInMyFileSync Boolean
検索条件グ
ループと
バージョン
使用可能な
バージョン
modifiedDate
Date
フォルダの最終変更日を指定する ISO-8601 形 Small、30.0
式の日付文字列。
30.0
motif
Motif
レコードタイプを示す小、中、大アイコン。 Small、30.0
motif にはレコードタイプのベース色を含め
ることもできます。
30.0
mySubscription Reference
name
String
コンテキストユーザがこのレコードをフォ Medium、30.0 30.0
ローしている場合、このプロパティには登録
に関する情報が含まれます。それ以外の場合
は、このプロパティが null になります。
フォルダ名。
Small、30.0
669
30.0
Chatter REST API レスポンスボディ
Folder Item
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
parentFolder
Reference
親フォルダへの参照。
Small、30.0
30.0
path
String
フォルダへのパス。
Small、30.0
30.0
type
String
Folder
Small、30.0
30.0
url
String
このリソースへの Chatter REST API URL。
Small、30.0
30.0
Folder Item
フォルダ内の項目 (ファイルまたはフォルダ) の説明。
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
file
File Summary
ファイル表現
Small、30.0
30.0
folder
Folder
フォルダ表現
Small、30.0
30.0
type
String
項目の種別。有効な値は、次のとおりです。 Small、30.0
30.0
• File
• Folder
Folder Item Page
ページが設定された Folder Item レスポンスボディのコレクション。
プロパティ
型
currentPageUrl String
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
現在のページを識別する Chatter REST API URL。 Medium、30.0 30.0
items
Folder Item[]
フォルダ項目のコレクション。
Small、30.0
30.0
nextPageUrl
String
次のページを識別する Chatter REST API URL。次 Small、30.0
のページがない場合は null。別のページを
取得する前に、この値が null であるかどう
かを確認します。ページが存在しない場合
は、ConnectApi.NotFoundException エ
ラーが返されます。
30.0
670
Chatter REST API レスポンスボディ
プロパティ
型
previousPageUrl String
Follower Page
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
前のページを識別する Chatter REST API URL。前 Medium、30.0 30.0
のページがない場合は null。
Follower Page
プロパティ
型
currentPageUrl String
followers
Subscription[]
説明
検索条件グ
ループと
バージョン
現在のページの URL
Medium、29.0 23.0
レコードをフォローしている人の 1 つ以上の Small、29.0
登録のコレクション
mySubscription Reference
使用可能な
バージョン
23.0
23.0 ～ 24.0
メモ: この項目は、バージョン 24.0 以
降、使用できなくなります。
コンテキストユーザがこのユーザをフォロー
している場合は、登録に関する情報が含まれ
ます。それ以外の場合は、null を返しま
す。
nextPageUrl
String
previousPageUrl String
total
Integer
次のページを識別する Chatter REST API URL。次 Small、29.0
のページがない場合は null。別のページを
取得する前に、この値が null であるかどう
かを確認します。ページが存在しない場合
は、ConnectApi.NotFoundException エ
ラーが返されます。
23.0
前のページを識別する Chatter REST API URL。前 Medium、29.0 23.0
のページがない場合は null。
フォローされている人の合計数
Small、29.0
23.0
Following Counts
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
people
Integer
ユーザがフォローしている人の数
Small、29.0
23.0
671
Chatter REST API レスポンスボディ
Following Page
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
records
Integer
ユーザがフォローしているレコードの数
Small、29.0
23.0
ユーザがフォローしている項目の合計数
Small、29.0
23.0
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
現在のページへの URL
Medium、29.0 23.0
トピックは、バージョン 29.0 以降でフォロー
可能なレコードタイプです。
total
Integer
Following Page
プロパティ
型
currentPageUrl String
following
Subscription[]
1 つ以上の登録のコレクション
Small、29.0
23.0
nextPageUrl
String
次のページの URL
Small、29.0
23.0
previousPageUrl String
前のページの URL
Medium、29.0 23.0
フォローされているレコードの合計数
Small、29.0
total
Integer
23.0
Generic Bundle Capability
フィード要素にこの機能がある場合、フィード要素は 1 つのフィード要素に集約された他のフィード要素のグ
ループとなることができます。
メモ: バンドル投稿にはフィード追跡変更が含まれます。Salesforce1 ダウンロード可能アプリケーション
では、バンドル投稿がレコードフィードのみにあります。
プロパティ名
型
説明
検索条件グルー
プとバージョン
使用可能なバー
ジョン
bundleType
String
バンドルの種別を指定します。値
は GenericBundle です。
Small、31.0
31.0
page
Feed Element Page
フィード要素のコレクション。
Small、31.0
31.0
このバンドルで集約するフィード
要素の合計数。
Small、31.0
31.0
totalElements Integer
672
Chatter REST API レスポンスボディ
汎用フィード要素
汎用フィード要素
汎用フィード要素。
プロパティ名
型
説明
検索条件とバー
ジョン
使用可能なバー
ジョン
body
Feed Item Body
フィード要素に関する情報。
Small、22.0
22.0
capabilities
Feed Element
Capabilities
フィード要素に含めることができ
るすべての機能のコンテナ。
Medium、31.0
31.0
createdDate
Date
ISO 8601 形式の日付文字列 (例:
2011-02-25T18:24:31.000Z)。
Small、29.0
31.0
フィード要素は、フィードに含ま Small、31.0
れる最上位のオブジェクトです。
フィード要素の種類は、このフィー
ド要素の特徴を記述します。次の
いずれかの値にします。
31.0
feedElementType String
• Bundle — フィード要素のコン
テナ。バンドルには、メッセー
ジセグメントを構成する本文も
含まれます。メッセージセグメ
ントは、テキストのみの値に常
に適切に分解できます。
• FeedItem — フィード項目には
1 つの親があり、その範囲は 1 つ
のコミュニティまたはすべての
コミュニティになります。
フィード項目にはブックマー
ク、キャンバス、コンテンツ、
コメント、リンク、アンケート
などの機能を設定できます。
フィード項目には、メッセージ
セグメントを構成する本文が含
まれます。メッセージセグメン
トは、テキストのみの値に常に
適切に分解できます。
• Recommendation — おすすめ
は、おすすめ機能を備えた
フィード要素です。おすすめ
は、コンテキストユーザに、
フォローするレコード、参加す
673
Chatter REST API レスポンスボディ
プロパティ名
型
汎用フィード要素
説明
検索条件とバー
ジョン
使用可能なバー
ジョン
るグループ、または役に立つア
プリケーションを推奨します。
header
Feed Item Body
ヘッダーは投稿のタイトルです。
このプロパティには、メッセージ
のすべてのセグメントに対する表
示可能なプレーンテキストが含ま
れます。クライアント側でフィー
ド要素の種類の表示方法が不明の
場合、このテキストが表示されま
す。
Medium、31.0
31.0
id
String
フィード要素の ID。
Small、22.0
22.0
modifiedDate
Date
ISO 8601 形式の日付文字列 (例:
2011-02-25T18:24:31.000Z)。
Small、29.0
31.0
parent
次のいずれかの
レスポンスボ
ディになりま
す。
フィード要素の親。
Medium、29.0
28.0
• File Detail
• File Summary
• Group
• Group Detail
• Record
Summary
• Record View
• User Detail
• User Summary
relative
CreatedDate
Date
相対的なローカライズされた文字
列として書式設定された作成日
(「17 分前」、「昨日」など)
Small、29.0
31.0
url
String
このフィード要素への Chatter REST
API URL。
Small、29.0
22.0
674
Chatter REST API レスポンスボディ
Group
Group
プロパティ
型
説明
additional
Label
String
グループの追加表示ラベル。たとえば、
Small、30.0
「アーカイブ済み」、「非公開」、「非公
開、顧客を含む」などがあります。追加表示
ラベルがない場合、値は null です。
30.0
announcement
Announcement
グループのお知らせ。
Big、31.0
31.0
このグループで Chatter 顧客を許可している
場合は true、それ以外の場合は false
Small、29.0
23.0
canHave
Boolean
ChatterGuests
検索条件グ
ループと
バージョン
使用可能な
バージョン
community
Reference
コミュニティに関する情報。デフォルトのコ Medium、29.0 26.0
ミュニティにグループが存在するか、コミュ
ニティが無効である場合は、null が返され
ます。
description
String
グループに関するテキストのみの説明
Big、29.0
このグループにメールで投稿するためのグ
ループのメールアドレス。
Medium、30.0 30.0
emailTo
String
ChatterAddress
23.0
Chatter メールと、メールによる Chatter への投
稿がどちらも組織で有効ではない場合は、
null を返します。
Boolean
グループがアーカイブされているか (true)、 Big、29.0
否か (false) を示します。
29.0
isAutoArchive Boolean
Disabled
グループの自動アーカイブが無効になってい Big、29.0
るか (true)、否か (false) を示します。
29.0
このグループに投稿されたファイルの数
24.0 ～ 27.0
isArchived
fileCount
Integer
Big、29.0
fileCount
プロパティ
は Group
Detail レスポ
ンスボディ
に含まれま
す。
id
String
lastFeed
Date
ElementPostDate
グループの 18 文字の ID
Small、29.0
グループに投稿された最新のフィード要素の Big、31.0
日付
675
23.0
31.0
Chatter REST API レスポンスボディ
Group
プロパティ
型
説明
検索条件グ
ループと
バージョン
lastFeedItem
PostDate
Date
グループに投稿された最新のフィード項目の Big、29.0
日付。
使用可能な
バージョン
24.0 ～ 30.0
API バージョン 30.0 より後のバージョンでは、
lastFeedElementPostDate を使用します。
memberCount
Integer
グループメンバーの合計数
Small、29.0
23.0
motif
Motif
オブジェクトがグループであることを示す Small、29.0
小、中、大のアイコン。motif にはレコード
タイプのベース色を含めることもできます。
27.0
このアイコンは、グループの写真ではありま
せん。
myRole
String
値は次のとおりです。
Small、29.0
23.0
• GroupOwner
• GroupManager
• NotAMember
• NotAMemberPrivateRequested
• StandardMember
mySubscription Reference
コンテキストユーザがこのグループのメン Medium、29.0 23.0
バーである場合は、登録に関する情報が含ま
れます。それ以外の場合、null を返しま
す。
name
String
グループの名前
Small、29.0
owner
User Summary
グループの所有者に関する情報
Medium、29.0 24.0
photo
Photo
グループの写真に関する情報
Small、29.0
23.0
type
String
CollaborationGroup
Small、29.0
23.0
url
String
グループへの相対 URL 文字列
Small、29.0
23.0
visibility
String
値は次のとおりです。
Small、29.0
23.0
• PrivateAccess — グループのメンバー
のみが、このグループへの投稿を参照で
きます。
• PublicAccess — コミュニティのすべて
のユーザが、このグループへの投稿を参
照できます。
676
23.0
Chatter REST API レスポンスボディ
プロパティ
型
Group Chatter Settings
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
検索条件グ
ループと
バージョン
使用可能な
バージョン
• Unlisted — 今後の使用のために予約さ
れています。
Group Chatter Settings
特定のグループのユーザの Chatter 設定です。
プロパティ
型
emailFrequency String
説明
グループメンバーがグループからメールを受 Small、29.0
信する頻度。次のいずれかの値になります。
27.0
• EachPost
• DailyDigest
• WeeklyDigest
• Never
• UseDefault
値が UseDefault の場合、User Chatter Settings
に定義されたユーザのデフォルトのグローバ
ル設定が使用されます。コミュニティでは、
グループメンバーが 10,000 人を超えると [各
投稿のメール]オプションが無効になります。
このオプションを選択したすべてのメンバー
は、自動的に [毎日のダイジェスト] に切り替
わります。
Group Detail
プロパティ
型
説明
検索条件グ
ループと
バージョン
additional
Label
String
グループの追加表示ラベル。たとえば、
Small、30.0
「アーカイブ済み」、「非公開」、「非公
開、顧客を含む」などがあります。追加表示
ラベルがない場合、値は null です。
677
使用可能な
バージョン
30.0
Chatter REST API レスポンスボディ
Group Detail
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
announcement
Announcement
このグループの現在のお知らせ。
Big、31.0
31.0
このグループで Chatter 顧客を許可している
場合は true、それ以外の場合は false
Small、29.0
23.0
canHave
Boolean
ChatterGuests
community
Reference
コミュニティに関する情報。デフォルトのコ Medium、29.0 26.0
ミュニティにグループが存在するか、コミュ
ニティが無効である場合は、null が返され
ます。
description
String
グループに関するテキストのみの説明
Big、29.0
このグループにメールで投稿するためのグ
ループのメールアドレス。
Medium、30.0 30.0
emailTo
String
ChatterAddress
23.0
Chatter メールと、メールによる Chatter への投
稿がどちらも組織で有効ではない場合は、
null を返します。
fileCount
Integer
このグループに投稿されたファイルの数
Big、29.0
28.0
id
String
グループの 18 文字の ID
Small、29.0
23.0
information
Group Information
グループの [情報] セクション。Web UI では、 Big、29.0
このセクションは [説明] セクションの上にあ
ります。グループが非公開の場合は、このセ
クションはメンバーにのみ表示されます。コ
ンテキストユーザがグループのメンバーでな
い場合や、コンテキストユーザに「すべての
データの編集」権限または「すべてのデータ
の参照」権限がない場合は、値が null にな
ります。
28.0
lastFeed
String
ElementPostDate
グループに投稿された最新のフィード要素の Big、31.0
日付
31.0
String
グループに投稿された最新のフィード項目の Big、29.0
日付。
24.0 ～ 30.0
lastFeed
ItemPostDate
API バージョン 30.0 より後のバージョンでは、
lastFeedElementPostDate を使用します。
memberCount
Integer
グループメンバーの合計数
678
Small、29.0
23.0
Chatter REST API レスポンスボディ
Group Detail
プロパティ
型
説明
検索条件グ
ループと
バージョン
motif
Motif
オブジェクトがグループであることを示す Small、29.0
小、中、大のアイコン。motif にはレコード
タイプのベース色を含めることもできます。
使用可能な
バージョン
27.0
このアイコンは、グループの写真ではありま
せん。
myRole
String
値は次のとおりです。
Small、29.0
23.0
• GroupOwner
• GroupManager
• NotAMember
• NotAMemberPrivateRequested
• StandardMember
mySubscription Reference
コンテキストユーザがこのグループのメン Medium、29.0 23.0
バーである場合は、登録に関する情報が含ま
れます。それ以外の場合、null を返しま
す。
name
String
グループの名前
Small、29.0
owner
User Summary
グループの所有者に関する情報
Medium、29.0 24.0
pendingRequests Integer
23.0
非公開グループへの待機中の参加要求数。公 Medium、29.0 29.0
開グループの場合、値は null です。
photo
Photo
グループの写真に関する情報
Small、29.0
23.0
type
String
CollaborationGroup
Small、29.0
23.0
url
String
グループへの相対 URL 文字列
Small、29.0
23.0
visibility
String
値は次のとおりです。
Small、29.0
23.0
• PrivateAccess — グループのメンバー
のみが、このグループへの投稿を参照で
きます。
• PublicAccess — コミュニティのすべて
のユーザが、このグループへの投稿を参
照できます。
• Unlisted — 今後の使用のために予約さ
れています。
679
Chatter REST API レスポンスボディ
Group Information
Group Information
グループの [情報] セクションを説明します。グループのメンバー、写真、および組織内のグループなど、グ
ループに関する情報。グループの作成および削除、グループへのメンバーの追加、グループの写真の変更を行
います。
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
text
String
グループの [情報] セクションのテキスト
Small、29.0
28.0
title
String
グループの [情報] セクションのタイトル
Small、29.0
28.0
Group Member
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
id
String
グループメンバーシップの 18 文字の ID
Small、29.0
23.0
lastFeed
AccessDate
Date
グループメンバーが最後にグループフィード Small、31.0
にアクセスした日時。
31.0
role
String
値は次のとおりです。
Small、29.0
23.0
• GroupOwner
• GroupManager
• NotAMember
• NotAMemberPrivateRequested
• StandardMember
url
String
このメンバーシップへの URL
Small、29.0
23.0
user
User Summary
このグループに登録しているユーザに関する Small、29.0
情報
23.0
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
メンバーのこのページへの URL
Medium、29.0 23.0
Group Member Page
プロパティ
型
currentPageUrl String
680
Chatter REST API レスポンスボディ
Group Membership Request
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
members
Group Member[]
グループメンバーのコレクション
Small、29.0
23.0
myMembership
Reference
コンテキストユーザがこのグループのメン Medium、29.0 23.0
バーである場合はメンバーシップに関する情
報を返し、それ以外の場合は null を返しま
す。
nextPageUrl
String
メンバーの次のページへの URL
Small、29.0
previousPageUrl String
メンバーの前のページへの URL
Medium、29.0 23.0
グループメンバーの合計数
Small、29.0
23.0
検索条件グ
ループと
バージョン
使用可能な
バージョン
totalMember
Count
Integer
23.0
Group Membership Request
プロパティ
型
説明
createdDate
String
メンバーシップ要求の日付を指定する ISO 形 Big、29.0
式の日付文字列
27.0
id
String
グループメンバー要求オブジェクトの ID
Small、29.0
27.0
lastUpdateDate String
要求の最終更新日を指定する ISO 形式の日付 Small、29.0
文字列
27.0
requestedGroup Reference
ユーザが参加を要求しているグループに関す Big、29.0
る情報
27.0
responseMessage String
メンバーシップ要求が却下された場合にユー Big、29.0
ザに表示するメッセージ。このプロパティの
値は、status プロパティの値が Declined
の場合にのみ使用されます。
27.0
最大文字数は 756 文字です。
status
String
非公開グループへの参加要求の状況。値は次 Small、29.0
のとおりです。
• Accepted
• Declined
• Pending
681
27.0
Chatter REST API レスポンスボディ
Group Membership Request Collection
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
url
String
このグループメンバー要求オブジェクトの
URL
Small、29.0
27.0
user
User Summary
グループのメンバーシップを要求している
ユーザに関する情報
Small、29.0
27.0
検索条件グ
ループと
バージョン
使用可能な
バージョン
Group Membership Request Collection
プロパティ
型
説明
requests
Group Membership 非公開グループへのすべての参加要求に関す Small、29.0
Request
る情報
27.0
total
Integer
非公開グループへの参加要求総数
Small、29.0
27.0
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
グループのこのページへの URL
Medium、29.0 23.0
Group Page
プロパティ
型
currentPageUrl String
groups
Group Detail[]
グループ詳細のコレクション
Small、29.0
23.0
nextPageUrl
String
グループの次のページへの URL
Small、29.0
23.0
previousPageUrl String
グループの前のページへの URL
Medium、29.0 23.0
Group Record
グループに関連付けられたレコード。
プロパティ
型
説明
検索条件グ
ループと
バージョン
id
String
グループに関連付けられたレコードの18 文 Small、33.0
字の ID。
682
使用可能な
バージョン
33.0
Chatter REST API レスポンスボディ
Group Record Page
プロパティ
型
説明
検索条件グ
ループと
バージョン
record
Record Summary
User Summary
グループに関連付けられたレコードに関す Small、33.0
る情報。
33.0
url
String
グループに関連付けられたレコードへの
URL。
33.0
Small、33.0
使用可能な
バージョン
Group Record Page
グループに関連付けられたレコードのページ設定されたリスト。
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
current
PageUrl
String
現在のページへの URL
Medium、33.0 33.0
nextPageUrl
String
次のページへの URL。次のページがない場
合、null を返します。
Small、3.0
previous
PageUrl
String
前のページへの URL。前のページがない場
合、null を返します。
Medium、3.0 33.0
records
Group Record[]
グループに関連付けられたレコードのコレク Small、33.0
ション。
33.0
totalRecord
Count
Integer
グループに関連付けられたレコードの総数。 Small、33.0
33.0
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
height
Integer
アイコンの高さ (ピクセル単位)
Small、29.0
27.0
width
Integer
アイコンの幅 (ピクセル単位)
Small、29.0
27.0
url
String
アイコンの URL。この URL は、認証されてい Small、29.0
ないユーザが使用できます。URL の有効期限
が切れることはありません。
27.0
33.0
Icon
683
Chatter REST API レスポンスボディ
Influence Thresholds
Influence Thresholds
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
name
String
インフルエンサーカテゴリの説明。例:
Small、29.0
24.0
このインフルエンサーカテゴリの下限しきい Small、29.0
値を定義する、未加工のパーセントとして表
された数値。たとえば、0.25 は、Active
Influencer カテゴリの下限値です。つま
り、影響度ランクが 25% 以上で次に高いカテ
ゴリしきい値未満のユーザがこのカテゴリに
含まれます。
24.0
Active Influencer
threshold
Double
Knowledgeable People
指定されたトピックに関する知識のあるユーザを表します。
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
isEndorsedByMe Boolean
コンテキストユーザが、トピックについてこ Small、30.0
の知識のあるユーザを支持している場合は
true、それ以外の場合は false を指定しま
す。
30.0
knowledgeableId String
知識のあるレコードの ID
Small、30.0
30.0
numEndorsements Integer
トピックについて知識のあるユーザが受け
取った支持の数
Medium、30.0 30.0
reasons
String
ユーザがトピックに関する知識があるとみな Medium、30.0 30.0
される理由を指定します。有効な値は、次の
とおりです。
• Influential — ユーザは、トピックを
含む投稿か投稿へのコメントでメンショ
ンされたか、トピックを含む投稿へのコ
メントでいいね! を受信しました。
• Endorsed — ユーザは、トピックについ
て別のユーザから支持を受け取りまし
た。
684
Chatter REST API レスポンスボディ
Knowledgeable People Collection
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
user
User Summary
トピックに関する知識のあるユーザ
Small、30.0
30.0
検索条件グ
ループと
バージョン
使用可能な
バージョン
Knowledgeable People Collection
Knowledgeable People レスポンスボディのコレクション。
プロパティ
型
説明
currentPageUrl String
現在のページを識別する Chatter REST API URL。 Medium、30.0 30.0
knowledgeableUsers Knowledgeable
Knowledgeable People レスポンスボディのコレ Small、30.0
クション。
30.0
次のページを識別する Chatter REST API URL。次 Small、30.0
のページがない場合は null。別のページを
取得する前に、この値が null であるかどう
かを確認します。ページが存在しない場合
は、ConnectApi.NotFoundException エ
ラーが返されます。
30.0
People[]
nextPageUrl
String
previousPageUrl String
前のページを識別する Chatter REST API URL。前 Medium、30.0 30.0
のページがない場合は null。
Like
プロパティ
型
説明
検索条件グ
ループまた
はバージョ
ン
使用可能な
バージョン
id
String
いいね! の 18 文字の ID
Small、29.0
23.0
likedItem
Reference
いいね! と言われたコメントまたはフィード Medium、29.0 27.0
要素への参照
url
String
このいいね! への URL
Small、29.0
23.0
user
User Summary
このコメントまたはフィード要素にいいね!
と言ったユーザに関する情報
Small、29.0
23.0
685
Chatter REST API レスポンスボディ
Like Message Body
Like Message Body
プロパティ
型
messageSegments Segments[]
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
種別に基づくメッセージセグメントのコレク Medium、29.0 27.0
ション。セグメントは次のいずれかになる可
能性があります。
• Message Segment: Entity Link
• Message Segment: Resource Link
• Message Segment: Text
text
String
フィード項目またはコメントにいいね!と言っ Small、29.0
たユーザのテキストサマリー。たとえば、
「あなたがいいね! と言っています。」また
は「Renee Moreau さん、Gordon Johnson さん、
および Pam Jones さんがいいね! と言っていま
す。」などがあります。
27.0
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
いいね! の現在のページへの URL
Medium、29.0 23.0
Like Page
プロパティ
currentPageUrl String
items
Like[]
いいね! のコレクション
Small、32.0
32.0
likes
Like[]
いいね! のコレクション
Small、29.0
23.0 ～ 31.0
重要: API バージョン 32.0 以降では、
items プロパティを使用します。
myLike
Reference
23.0 ～ 24.0
メモ: この項目は、バージョン 24.0 以
降、使用できなくなります。
特定のいいね! への参照を返すか、null を返
します。
String
いいね! の次のページへの URL
Small、29.0
previousPageUrl String
いいね! の前のページへの URL
Medium、29.0 23.0
この項目のいいね! の合計数
Small、29.0
nextPageUrl
total
Integer
686
23.0
23.0
Chatter REST API レスポンスボディ
Link Capability
Link Capability
フィード要素にこの機能がある場合、リンクがあります。
プロパティ名
型
説明
検索条件グルー
プとバージョン
url
String
リンク URL。URL は外部サイトへの Small、32.0
URL にできます。
32.0
urlName
String
リンクの説明。
32.0
Small、32.0
使用可能なバー
ジョン
List View Column
レコードの関連リストの単一列を記述します。列のレイアウト方法を記述し、列のデータは含みません。
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
dataType
String
この列の項目のオブジェクト種別。これは、 Medium、29.0 29.0
REST API と SOAP API で使用されるオブジェク
ト種別です。
fieldId
String
完全修飾された API 項目 ID (Contact.Name
など)。
Big、29.0
29.0
label
String
この列のローカライズされた表示ラベル。
Small、29.0
29.0
name
String
API 項目の短縮名 (Name など)。
Medium、29.0 29.0
List View Definition
レコードビューの関連リスト構造または検索リスト構造を定義します。リストにデータはありません。
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
columns
List View Column[]
このリストビューに表示される項目の列。
Big、29.0
29.0
label
String
このリストビューのローカライズされた表示 Small、29.0
ラベル。
objectType
List View Object
このリストビューに含まれるオブジェクトの Medium、29.0 29.0
種別の定義。
687
29.0
Chatter REST API レスポンスボディ
List View Object
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
rowLimit
Integer
このリストビューのページあたりの最大オブ Medium、29.0 29.0
ジェクト数。この関連リストのすべてのオブ
ジェクトを表示するには、このサイズ以下の
ページ単位でデータを表示します。この
describe から SOQL ステートメントを作成する
には、その SOQL ステートメントにこの値と
等しい LIMIT 値を含める必要があります。含
めないと実行時にエラーが発生します。
sortColumns
List View Sort[]
このリストビューの並び替え基準になる列。 Medium、29.0 29.0
並び替え列を優先度順に示します (1 番目の
並び替え、2 番目の並び替え、以下同様)。
List View Object
関連リストの行に表示されるレコードのタイプを定義します。
プロパティ
型
説明
検索条件グ
ループと
バージョン
fieldId
String
親レコードを参照する API 項目 ID。たとえ
Big、29.0
ば、Account レコードに Contact レコードの関
連リストがある場合、Account の Contact 関連
リスト定義ではこの値は "Account" になる
ことがあります。
29.0
type
String
このオブジェクトのオブジェクト種別名。こ Small、29.0
れは、REST API と SOAP API で使用されるオブ
ジェクト種別です。
29.0
List View Record
レコードのリストビュー。
688
使用可能な
バージョン
Chatter REST API レスポンスボディ
プロパティ
型
fields
List View Sort
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
このリストに表示されるレコードの項目と
値。次のいずれかを含むコレクション。
Medium、30.0 30.0
• Record Field
• Record Field: Blank
• Record Field: Compound
• Record Field: Currency
• Record Field: Date
• Record Field: Percent
• Record Field: Picklist
• Record Field: Reference
• Record Field: Reference with Date
id
String
オブジェクトの 18 文字の ID
Small、29.0
23.0
motif
Motif
オブジェクト種別を示す小、中、大アイコ
ン。motif にはオブジェクトのベース色を含
めることもできます。
Small、29.0
27.0
このアイコンは、ファイルのプレビューでは
ありません。
mySubscription Reference
コンテキストユーザがこのファイルをフォ Medium、29.0 23.0
ローしている場合は、登録に関する情報が含
まれます。それ以外の場合は、null を返し
ます。
name
String
このレコードのローカライズされた名前。
Small、29.0
23.0
type
String
このオブジェクトの固定の種別名。レスポン Small、29.0
スボディの状態を判別するには、この値を調
べます。
23.0
url
String
このオブジェクトの Chatter REST API URL リソー Small、29.0
ス。
23.0
List View Sort
関連リストの並び替え順の序数を定義します。
689
Chatter REST API レスポンスボディ
Maintenance Information
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
column
String
並び替える関連リスト列の項目 ID。
Small、29.0
29.0
order
String
列の並び替え順序。次のいずれかの値にしま Small、29.0
す。
29.0
• Ascending — 昇順 (A から Z)。
• Descending — 降順 (Z から A)。
Maintenance Information
組織の今後の定期メンテナンスに関する情報。
プロパティ名
型
説明
検索条件グルー
プとバージョン
使用可能なバー
ジョン
description
String
メンテナンスの説明。
Small、34.0
34.0
Maintenance
Title
String
メンテナンスのタイトル。
Small、34.0
34.0
Maintenance
Type
String
メンテナンスの種別を指定します。 Small、34.0
次のいずれかになります。
34.0
• Downtime — ダウンタイムメン
テナンス。
• GenerallyAvailable — 正式
リリースモードでのメンテナン
ス。
• MaintenanceWithDowntime —
ダウンタイムを伴う定期メンテ
ナンス。
• ReadOnly — 参照のみモードで
のメンテナンス。
message
Date
EffectiveTime
ユーザへのメンテナンスメッセー
ジの表示開始日。
Small、34.0
34.0
message
Date
ExpirationTime
メンテナンスメッセージの有効期
限。
Small、34.0
34.0
Date
スケジュール設定されたダウンタ
イム終了日。
GenerallyAvailable および
Small、34.0
34.0
scheduledEnd
Downtime
690
Chatter REST API レスポンスボディ
プロパティ名
型
Managed Topic
説明
検索条件グルー
プとバージョン
使用可能なバー
ジョン
ReadOnly メンテナンス種別の場
合は null。
scheduledEnd Date
MaintenanceTime
定期メンテナンス終了日。
Small、34.0
Downtime メンテナンス種別の場合
は null。
34.0
scheduledStart Date
Downtime
スケジュール設定されたダウンタ
イム開始日。
GenerallyAvailable および
ReadOnly メンテナンス種別では
null になります。
Small、34.0
34.0
scheduledStart Date
MaintenanceTime
定期メンテナンス開始日。
Small、34.0
Downtime メンテナンス種別の場合
は null。
34.0
Managed Topic
コミュニティの管理トピックを表します。
プロパティ名
型
説明
検索条件グルー
プとバージョン
使用可能なバー
ジョン
id
String
管理トピックの ID。
Small、32.0
32.0
managedTopic
Type
String
管理トピックの種別。
Small、32.0
32.0
• Featured — コミュニティホー
ムページなどの主要トピック。
ただし、全体的なナビゲーショ
ンは提供しません。
• Navigational — コミュニティ
のナビゲーションメニューに表
示されるトピック。
topic
Topic
トピックに関する情報。
Small、32.0
32.0
url
String
管理トピックへの Chatter REST API
URL。
Small、32.0
32.0
691
Chatter REST API レスポンスボディ
Managed Topic Collection
Managed Topic Collection
コミュニティの管理トピックのコレクション。
プロパティ名
型
説明
検索条件グルー
プとバージョン
使用可能なバー
ジョン
currentPageUrl String
現在のページを識別する Chatter REST Medium、32.0
API URL。
32.0
managedTopics Managed Topic[]
管理トピックのコレクション。
32.0
Small、32.0
Mention Completion
ユーザまたはグループの @メンションに使用できるレコードに関する情報。
プロパティ
型
additionalLabel String
説明
検索条件グ
ループと
バージョン
この補完で表されるレコードの追加の表示ラ Big、29.0
ベル (存在する場合) (「(Customer)」や「(Acme
Corporation)」など)。
使用可能な
バージョン
29.0
description
String
この補完で表されるレコードの説明。
Medium、29.0 29.0
name
String
この補完で表されるレコードの名前
Small、29.0
photoUrl
String
この補完で表されるレコードの写真またはア Medium、29.0 29.0
イコンの URL
recordId
String
この補完で表されるレコードの 18 文字の ID Small、29.0
userType
String
この完了によって表されるレコードがユーザ Medium、30.0 30.0
の場合、この値はそのユーザに関連付けられ
たユーザ種別になります。それ以外の場合
は、null です。
次のいずれかの値にします。
• ChatterGuest — 非公開グループの外部
ユーザ。
• ChatterOnly — Chatter Free ユーザ。
• Guest — 認証されていないユーザ。
• Internal — 標準組織メンバー。
• Portal — カスタマーポータル、パート
ナーポータル、またはコミュニティの外
部ユーザ。
692
29.0
29.0
Chatter REST API レスポンスボディ
プロパティ
型
Mention Completion Page
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
現在のページの URL
Medium、29.0 29.0
• System — Chatter Expert またはシステム
ユーザ。
• Undefined — カスタムオブジェクトの
ユーザ種別
Mention Completion Page
Mention Completion レスポンスボディのページ設定されたリスト。
プロパティ
型
currentPageUrl String
mention
Completions
Mention
Completion[]
メンションで使用する Mention Completion レス Small、29.0
ポンスボディのコレクション。
29.0
nextPageUrl
String
次のページを識別する Chatter REST API URL。次 Small、29.0
のページがない場合は null。別のページを
取得する前に、この値が null であるかどう
かを確認します。ページが存在しない場合
は、ConnectApi.NotFoundException エ
ラーが返されます。
29.0
previousPageUrl String
前のページを識別する Chatter REST API URL。前 Medium、29.0 29.0
のページがない場合は null。
Mention Validation
提案メンションがコンテキストユーザに有効かどうかに関する情報。
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
recordId
String
メンションされたレコードの ID。
Small、29.0
29.0
693
Chatter REST API レスポンスボディ
プロパティ
型
validationStatus String
Mention Validations
説明
検索条件グ
ループと
バージョン
提案メンションの検証エラーの種類を示しま Small、29.0
す (存在する場合)。次のいずれかの値にしま
す。
使用可能な
バージョン
29.0
• Disallowed — 提案メンションは無効で
あり、コンテキストユーザが許可されて
いない対象にメンションしようとしてい
るため却下されます。たとえば、非公開
グループのメンバーでないユーザが非公
開グループにメンションしようとしてい
る場合などです。
• Inaccessible — 提案メンションは許可
されていますが、メンションされるユー
ザまたはレコードには議論されている親
レコードへのアクセス権がないため、通
知されません。
• Ok — 提案メンションに検証エラーはあ
りません。
Mention Validations
メンションのセットがコンテキストユーザに有効かどうかに関する情報。
プロパティ
型
説明
検索条件グ
ループと
バージョン
hasErrors
Boolean
提案メンションのうち、少なくとも 1 つにエ Small、29.0
ラーがあるか (true)、否か (false) を示しま
す。たとえば、コンテキストユーザは自分が
属していない非公開グループにメンションで
きません。そのようなグループがメンション
の検証のリストに含まれていると、
hasErrors は true になり、そのメンショ
ンの検証で Disallowed の
validationStatus がグループに設定され
ます。
mention
Validations
Mention Validation[] メンションのセットがコンテキストユーザに Medium、29.0 29.0
有効かどうかに関する情報。
694
使用可能な
バージョン
29.0
Chatter REST API レスポンスボディ
Message
Message
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
body
Feed Item Body
このメッセージのテキスト
Small、29.0
23.0
conversationId String
このメッセージが含まれる会話の 18 文字の Big、29.0
ID
23.0
conversationUrl String
このメッセージが含まれる会話への URL
Small、29.0
23.0
id
String
メッセージの 18 文字の ID
Small、29.0
23.0
recipients
User Summary[]
1 人以上のメッセージ受信者のコレクション Small、29.0
23.0
メモ: Conversation Detail と Conversation
Summaryの会話の members プロパティ
で会話の参加者は特定されるため、次
のリソースのメール受信者のコレク
ションは空になっています。
•
/chatter/users/me/
conversations
•
/chatter/users/me/
conversations/conversationId
sentDate
String
ISO8601 の日付文字列 (例:
2011-02-25T18:24:31.000Z)
Small、29.0
23.0
sender
User Summary
このメッセージを送信したユーザに関する情 Small、29.0
報
23.0
sendingCommunity Reference
メッセージの送信元のコミュニティに関する Medium、32.0 32.0
情報
デフォルトのコミュニティの場合またはコ
ミュニティが無効の場合は null が返されま
す。
url
String
このメッセージへの URL
695
Small、29.0
23.0
Chatter REST API レスポンスボディ
Message Collection
Message Collection
プロパティ
型
currentPageUrl String
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
現在のページを識別する Chatter REST API URL。 Medium、29.0 23.0
messages
Message[]
1 つ以上のメッセージのコレクション
Small、29.0
23.0
nextPageUrl
String
次のページを識別する Chatter REST API URL。次 Small、29.0
のページがない場合は null。別のページを
取得する前に、この値が null であるかどう
かを確認します。ページが存在しない場合
は、ConnectApi.NotFoundException エ
ラーが返されます。
23.0
Message Segment: Entity Link
ユーザまたはグループなどのエンティティを表します。
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
motif
Motif
エンティティ種別に対応する小、中、大の一 Small、29.0
連のアイコン motif には、エンティティ種別
のベース色を含めることもできます。
27.0
reference
Reference
エンティティに関する情報
Small、29.0
25.0
text
String
このセグメントのプレーンテキスト出力
Small、29.0
25.0
type
String
EntityLink
Small、29.0
25.0
Message Segment: Field Change
インライン項目変更を表します。
例: インライン項目変更の例として、"First Name from Bob to Joe" などがあります。次のセグメ
ント例は、複数のセグメントで構成されています。
[
Text("Owner from "),
FieldChangeValue("Bob Smith"),
696
Chatter REST API レスポンスボディ
Message Segment: Field Change Name
Text(" to "),
FieldChangeValue("Dave Jones")
]
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
segments
Segments[]
種別に基づくメッセージセグメントのコレク Medium、29.0 23.0
ション。セグメントは次のいずれかになる可
能性があります。
• Message Segment: Entity Link
• Message Segment: Field Change
• Message Segment: Field Change Name
• Message Segment: Field Change Value
• Message Segment: Hashtag
• Message Segment: Link
• Message Segment: Mention
• Message Segment: More Changes
• Message Segment: Text
text
String
変更の書式設定済みテキスト。次に例を示し Small、29.0
ます。
23.0
"City from San Francisco to
New Orleans"
type
String
値は FieldChange
Small、29.0
23.0
Message Segment: Field Change Name
項目変更のインライン項目名を表します ("Name" や "Description" など)。これを別個のセグメントにすることで、
名前項目を太字にするなど、項目名に対して特殊なユーザインターフェース処理を行うことができます。
697
Chatter REST API レスポンスボディ
Message Segment: Field Change Value
プロパティ
型
説明
検索条件グ
ループと
バージョン
text
String
変更の書式設定済みテキスト。値には、次の Small、29.0
ものがあります。
使用可能な
バージョン
23.0
• 項目の以前の名前
• 項目の新しい名前
type
String
値は FieldChangeName
Small、29.0
23.0
Message Segment: Field Change Value
項目変更のインライン値を表します ("1" や "Bob Smith" など)。これを別個のセグメントにすることで、値をアン
カータグで囲むなど、特殊なコーディングを追加できます。
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
valueType
String
値の型。次のいずれかの値にします。
Big、29.0
29.0
• NewValue — 項目変更の新しい値。
• OldValue — 項目変更の以前の値。
text
String
変更の書式設定済みテキスト。値には、次の Small、29.0
ものがあります。
23.0
• a blank value という語
メモ: このテキストはローカライズ
されます。
• 項目の以前の値
• 項目の新しい値
type
String
値は FieldChangeValue
Small、29.0
23.0
url
String
項目変更が URL 項目 (Web アドレスなど) に対 Small、29.0
するものである場合、URL 値
23.0
Message Segment: Hashtag
インラインハッシュタグを表します。
698
Chatter REST API レスポンスボディ
Message Segment: Link
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
tag
String
ハッシュ記号 (#) を除いたハッシュタグのテ Small、29.0
キスト
23.0
text
String
ハッシュ記号 (#) 付きのハッシュタグのテキ Small、29.0
スト
23.0
topicUrl
String
次の形式のトピックの URL:
Small、29.0
28.0
/services/data/.../topics?exactMatch=true&q=tag
type
String
値は Hashtag
Small、29.0
23.0
url
String
次の形式のタグの URL 検索:
Small、29.0
23.0
検索条件グ
ループと
バージョン
使用可能な
バージョン
services/data/.../feed-elements?q=tag
Message Segment: Link
URL へのインラインリンクを表します。
プロパティ
型
説明
text
String
このセグメントのフィード項目の書式設定済 Small、29.0
みテキスト
23.0
type
String
値は Link
Small、29.0
23.0
url
String
リンクの URL 値
Small、29.0
23.0
検索条件グ
ループと
バージョン
使用可能な
バージョン
Message Segment: Mention
インラインの @メンションを表します。
プロパティ
型
説明
accessible
Boolean
メンションされたユーザまたはグループがメ Small、29.0
ンションを表示できるか (true)、否か
(false) を示します。
699
23.0
Chatter REST API レスポンスボディ
Message Segment: More Changes
プロパティ
型
説明
name
String
メンションされたユーザまたはグループの名 Small、29.0
前
23.0
text
String
このセグメントのフィード項目の書式設定済 Small、29.0
みテキスト
23.0
type
String
値は Mention
Small、29.0
23.0
メンションされたユーザまたはグループに関 Small、29.0
する情報。次のいずれかのレスポンスボディ
になります。
29.0
record
検索条件グ
ループと
バージョン
使用可能な
バージョン
• Group
• User Detail
• User Summary
user
User Summary
メンションされたユーザに関する情報。コン なし
テキストユーザにアクセス権がない場合は
null。
重要: バージョン 29.0 以降では、
record プロパティを使用します。
23.0 ～ 28.0
29.0 より前
のバージョ
ンでは、メ
ンションが
ユーザでな
い場合、メ
ンションは
Message
Segment: Text
レスポンス
ボディに含
まれます。
Message Segment: More Changes
プロパティ
型
説明
検索条件グ
ループと
バージョン
moreChanges
Message Segment:
Field Change[]
フィード項目の追跡変更の完全なコレクショ Big、29.0
ン。
29.0
moreChanges
Count
Integer
変更の数
23.0
Small、29.0
700
使用可能な
バージョン
Chatter REST API レスポンスボディ
Message Segment: Resource Link
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
text
String
変更数の書式設定済みテキスト。例: "2
Small、29.0
23.0
Small、29.0
23.0
other changes"
メモ: この値はローカライズされます。
type
String
値は MoreChanges
Message Segment: Resource Link
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
text
String
このセグメントの書式設定済みテキスト
Small、29.0
23.0
type
String
値は "ResourceLink"
Small、29.0
23.0
url
String
リソースリンクの URL 値
Small、29.0
27.0
Message Segment: Text
プレーンインラインテキストを表します。
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
text
String
項目に関連付けられた書式設定済みテキス
ト。値には、次のものがあります。
Small、29.0
23.0
Small、29.0
23.0
• コメントの書式設定済みテキスト
• from という語を使用して示される、変
更された項目の名前
type
String
値は Text
Moderation Capability
フィード要素にこの機能がある場合、コミュニティのユーザはフィード要素にモデレーションフラグを設定で
きます。このレスポンスボディには、フラグが設定されたコンテンツに関する情報も含まれます。
701
Chatter REST API レスポンスボディ
プロパティ名
型
moderationFlags Moderation Flags
Moderation Flags
説明
検索条件グルー
プとバージョン
このフィード要素のフラグ。コミュ Big、31.0
ニティモデレータは、フラグ付き
項目を表示したり、フラグ付き項
目に対してアクションを実行した
りできます。
使用可能なバー
ジョン
31.0
Moderation Flags
Moderation flags は、組織で Salesforce Communities が有効になっていて、コミュニティ管理者がコミュニティ設定
時に [メンバーにコンテンツのフラグの設定を許可] を選択した場合に使用できます。
プロパティ
型
説明
検索条件グ
ループと
バージョン
flagCount
Integer
コンテキストユーザがコミュニティモデレー Small、29.0
タの場合、投稿、コメント、またはファイル
のフラグの総数を示します。コンテキスト
ユーザがコミュニティモデレータでない場合
は、値が null になります。
使用可能な
バージョン
29.0
ファイルのフラグは、バージョン 30.0 以降で
使用できます。
flaggedByMe
Boolean
投稿、コメント、またはファイルにコンテキ Small、29.0
ストユーザがフラグを設定したか (true)、否
か (false) を示します。
29.0
ファイルのフラグは、バージョン 30.0 以降で
使用できます。
Motif
motif プロパティには、Salesforce レコードタイプを示す小、中、大のアイコンへの URL があります。一般的なレ
コードタイプは、ファイル、ユーザ、グループですが、すべてのレコードタイプに一連の motif アイコンがあ
ります。カスタムオブジェクトレコードでは、タブスタイルアイコンが使用されます。認証されていないユー
ザでもすべてのアイコンを使用できるため、たとえば、motif アイコンをメールで表示することができます。
motif にはレコードタイプのベース色を含めることもできます。
702
Chatter REST API レスポンスボディ
Motif
例:
メモ: motif 画像はアイコンであり、ユーザがアップロードした画像または写真ではありません。た
とえば、すべてのユーザは同じセットの motif アイコンを使用できます。
カスタムオブジェクトレコードでは、タブスタイルアイコンが使用されます。たとえば、次のカスタム
オブジェクトでは、「boat」タブスタイルが使用されます。
"motif": {
"color": "8C004C",
"largeIconUrl": "/img/icon/custom51_100/boat64.png",
"mediumIconUrl": "/img/icon/custom51_100/boat32.png",
"smallIconUrl": "/img/icon/custom51_100/boat16.png",
"svgIconUrl": null
},
ユーザは、次のアイコンを使用します。
"motif": {
"color": "1797C0",
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png",
"svgIconUrl": null
},
グループは、次のアイコンを使用します。
"motif": {
"color": "1797C0",
"largeIconUrl": "/img/icon/groups64.png",
"mediumIconUrl": "/img/icon/groups32.png",
"smallIconUrl": "/img/icon/groups16.png"
},
ファイルは、次のアイコンを使用します。
"motif": {
703
Chatter REST API レスポンスボディ
Non-Entity Recommendation
"color": "1797C0",
"largeIconUrl": "/img/content/content64.png",
"mediumIconUrl": "/img/content/content32.png",
"smallIconUrl": "/img/icon/files16.png",
"svgIconUrl": null
},
メモ: 前の例のアイコンを表示するには、URL を https://instance_name で置き換えます。たと
えば、https://instance_name/img/icon/profile64.png に保存されます。
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
color
String
レコードタイプのベース色を表す 16 進値ま Small、29.0
たは null。
29.0
largeIconUrl
String
レコードタイプを示す大アイコン
Small、29.0
27.0
mediumIconUrl String
レコードタイプを示す中アイコン
Small、29.0
27.0
smallIconUrl
String
レコードタイプを示す小アイコン
Small、29.0
27.0
svgIconUrl
String
レコードタイプを示す SVG 形式のアイコン、 Small、34.0
またはアイコンが存在しない場合は null。
34.0
Non-Entity Recommendation
Salesforce 以外のエンティティ (アプリケーションなど) のおすすめを表します。
このレスポンスボディは、バージョン 34.0 以降では使用できません。バージョン 34.0 以降では、すべてのおす
すめに Recommendation レスポンスボディが使用されます。
プロパティ名
型
説明
検索条件グルー
プとバージョン
displayLabel
String
非エンティティオブジェクトのロー Small、32.0
カライズされた表示ラベル。
32.0
explanation
Explanation
Summary
おすすめの説明。
Big、29.0
23.0
motif
Motif
非エンティティオブジェクトの
Motif。
Small、32.0
32.0
704
使用可能なバー
ジョン
Chatter REST API レスポンスボディ
プロパティ名
型
recommendationType String
Organization
説明
検索条件グルー
プとバージョン
使用可能なバー
ジョン
おすすめされるレコードのタイプ
を示します。
Small、32.0
32.0
• apps
• files
• groups
• records
• users
Organization
プロパティ
型
accessTimeout Integer
features
Features
maintenanceInfo Maintenance
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
この時間を過ぎると、何も操作を行っていな Small、29.0
いユーザに対し、ログアウトするか操作を続
行するかを選択させるポップアップウィンド
ウが表示されます。
24.0
組織またはコミュニティで使用可能な機能に Small、29.0
関する情報
24.0
Information[]
組織で今後予定されているメンテナンスのリ Medium、34.0 34.0
ストに関する情報。
name
String
組織名
Small、29.0
26.0
orgId
String
組織の 18 文字の ID
Small、29.0
24.0
userSettings
User Settings
ユーザの組織権限に関する情報
Small、29.0
24.0
Origin Capability
フィード要素にこの機能がある場合、そのフィード要素はフィードアクションによって作成されています。
プロパティ名
型
説明
検索条件グルー
プとバージョン
actor
User Summary
フィードアクションを実行したユー Small、33.0
ザ。
705
使用可能なバー
ジョン
33.0
Chatter REST API レスポンスボディ
Phone Number
プロパティ名
型
説明
検索条件グルー
プとバージョン
使用可能なバー
ジョン
originRecord
Reference
フィードアクションが含まれる
フィード要素への参照。
Small、33.0
33.0
Phone Number
電話番号。
プロパティ
型
説明
検索条件グ
ループと
バージョン
label
String
電話の種別を示すローカライズされた文字列 Small、30.0
number
String
メモ: このプロパティは、バージョン
26.0 以降では使用できません。代わり
に、phoneNumber プロパティを使用
してください。
使用可能な
バージョン
30.0
なし
23.0 ～ 26.0
電話番号
phoneNumber
String
電話番号
Small、29.0
27.0
phoneType
String
電話の種別。次のいずれかの値にします。
Small、30.0
30.0
Small、29.0
23.0 ～ 29.0
• Fax
• Mobile
• Work
これらの値はローカライズされません。
type
String
メモ: このプロパティは、バージョン
29.0 以降では使用できません。代わり
に、phoneType プロパティを使用して
ください。
値は次のとおりです。
• Fax
• Mobile
• Work
706
Chatter REST API レスポンスボディ
Photo
Photo
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
fullEmailPhotoUrl String
30 日後に有効期限が切れる大きなプロファ Medium、29.0 27.0
イル写真への一時的な URL。この URL は、認
証されていないユーザが使用できます。
largePhotoUrl String
大きなプロファイル写真への URL。デフォル Medium、29.0 23.0
トの幅は 200 ピクセルです。長さは、元の画
像の比率が維持されるように設定されます。
photoVersionId String
そのバージョンの写真の 18 文字の ID
Small、29.0
24.0
smallPhotoUrl String
小さいプロファイル写真への URL。デフォル Small、29.0
トのサイズは 64x64 ピクセルです。
23.0
standardEmail String
PhotoUrl
30 日後に有効期限が切れる小さいプロファ Small、29.0
イル写真への一時的な URL。この URL は、認
証されていないユーザが使用できます。
27.0
String
Photo レスポンスボディを返すリソースの URL Small、29.0
(/services/data/v34.0
27.0
url
/chatter/users/005D0000001LL8OIAW/photo
など)
Platform Action
コンテキストユーザの状態情報を含むプラットフォームアクションインスタンス。
アクションリンクは、プラットフォームアクションの種別の 1 つなので、Platform Action レスポンスボディとし
て表されます。
プロパティ名
型
説明
検索条件グルー
プとバージョン
使用可能なバー
ジョン
actionUrl
String
subtype Ui または Download の
Medium、33.0
33.0
アクションリンクの場合、このリ
ンクからユーザにダウンロードや
UI アクセスを行わせます。Salesforce
は次の形式でリンクの Javascript リダ
イレクトを発行します:
/action-link-redirect/communityId/
actionLinkId?_bearer=bearerToken
707
Chatter REST API レスポンスボディ
プロパティ名
型
Platform Action
説明
検索条件グルー
プとバージョン
使用可能なバー
ジョン
Api および ApiAsync アクション
リンク、およびすべてのプラット
フォームアクションの場合、この
値は null になります。
Salesforce により、Api および
ApiAsync アクションリンクへの
コールアウトが処理されます。
/connect/action-links/actionLinkId
リソースに対して PATCH 要求を実行
し、status を PendingStatus に
設定して、Api または ApiAsync
アクションリンクをコールするこ
ともできます。
apiName
String
API 名。この値は null になること Medium、33.0
があります。
33.0
confirmation
Message
String
このアクションに確認が必要で、 Medium、33.0
状況が NewStatus の場合は、この
プロパティがローカライズされた
デフォルトのメッセージになり、
このアクションを呼び出す前にエ
ンドユーザに表示されます。それ
以外の場合は、この値が null にな
ります。
33.0
created
Records
Record Summary[]
このアクションがコンテキストユー Medium、33.0
ザによって呼び出された後にその
アクションによって作成されたレ
コードのコレクションです。コン
テキストユーザがアクションを実
行していない場合、またはアクショ
ンによってレコードが作成されて
いない場合、このコレクションは
空になります。コンテキストユー
ザによって作成されたレコードの
みが表示されます。
33.0
プラットフォームアクションの実
行を開始したユーザ。
Medium、33.0
33.0
このプラットフォームアクション
がプラットフォームアクショング
Small、33.0
33.0
executingUser User Summary
groupDefault
Boolean
708
Chatter REST API レスポンスボディ
プロパティ名
型
Platform Action
説明
検索条件グルー
プとバージョン
使用可能なバー
ジョン
ループのデフォルトまたはプライ
マリのプラットフォームアクショ
ンの場合は true、それ以外の場合
は false。デフォルトプラット
フォームアクションはプラット
フォームアクショングループごと
に 1 つのみです。
iconUrl
String
プラットフォームアクションのア Medium、33.0
イコンの URL。この値は、null に
なる場合があります。
33.0
id
String
プラットフォームアクションの ID。 Small、33.0
33.0
type が QuickAction で、
subtype が Create の場合、この
値は null になります。
label
String
このプラットフォームアクション Small、33.0
のローカライズされた表示ラベル。
33.0
modifiedDate
Date
ISO8601 の日付文字列 (例:
2011-02-25T18:24:31.000Z)
Small、33.0
33.0
このプラットフォームアクション
を含むプラットフォームアクショ
ングループへの参照。
Small、33.0
33.0
プラットフォームアクションの実
行状況。値は次のとおりです。
Small、33.0
33.0
platformAction Reference
Group
status
String
• FailedStatus — アクションリ
ンクの実行に失敗しました。
• NewStatus — アクションリン
クの実行の準備が整っていま
す。Download および Ui アク
ションリンクでのみ使用できま
す。
• PendingStatus — アクション
リンクが実行されています。こ
の値を選択すると、Api および
ApiAsync アクションリンクの
API コールがトリガされます。
709
Chatter REST API レスポンスボディ
プロパティ名
型
Platform Action
説明
検索条件グルー
プとバージョン
使用可能なバー
ジョン
Small、33.0
33.0
• SuccessfulStatus — アクショ
ンリンクが正常に実行されまし
た。
アクションリンクに限
り、/connect/action-links/actionLinksId
リソースに対して PATCH 要求を実行
することによって、status を更新
できます。
subtype
String
プラットフォームアクションのサ
ブタイプまたは null。
type プロパティが ActionLink の
場合、使用できる値は次のとおり
です。
• Api — アクションリンクは、ア
クション URL で同期 API をコール
します。Salesforce は、サーバか
ら返された HTTP 状況コードに基
づいて状況を
SuccessfulStatus または
FailedStatus に設定します。
• ApiAsync — アクションリンク
は、アクション URL で非同期 API
をコールします。アクション
は、非同期操作の完了時にサー
ドパーティが
/connect/action-links/actionLinkId
への要求を行って状況を
SuccessfulStatus または
FailedStatus に設定するま
で、PendingStatus 状態のま
まになります。
• Download — アクションリンク
は、アクション URL からファイ
ルをダウンロードします。
• Ui — アクションリンクは、ア
クション URL で Web ページを
ユーザに表示します。
710
Chatter REST API レスポンスボディ
Platform Action Group
プロパティ名
型
説明
検索条件グルー
プとバージョン
使用可能なバー
ジョン
type
String
プラットフォームアクションの種
別。値は次のとおりです。
Small、33.0
33.0
Small、33.0
33.0
• ActionLink — API、Web ペー
ジ、またはファイルを指す、
フィード要素上のインジケータ
で、Salesforce Chatter フィード UI
のボタンによって表されます。
• ProductivityAction — 生産
性アクションは Salesforce によっ
て事前定義され、限られたオブ
ジェクトのセットに適用されま
す。生産性アクションを編集ま
たは削除することはできませ
ん。
• CustomButton — クリックする
と、ウィンドウ内で URL または
Visualforce ページが開くか、
JavaScript が実行されます。
• QuickAction — グローバルア
クションまたはオブジェクト固
有のアクション。
• StandardButton — 事前定義さ
れた Salesforce ボタン ([新規]、[編
集]、[削除] など)。
url
String
プラットフォームアクションの
Chatter REST API リソース URL。
type が QuickAction で、
subtype が Create の場合、この
値は null になります。
Platform Action Group
コンテキストユーザに適した状態のプラットフォームアクショングループインスタンス。
アクションリンクグループは、プラットフォームアクショングループの種別の 1 つなので、Platform Action Group
レスポンスボディとして表されます。
711
Chatter REST API レスポンスボディ
Platform Action Group
プロパティ名
型
説明
検索条件グルー
プとバージョン
使用可能なバー
ジョン
category
String
プラットフォームアクションの優
先度および相対位置を示します。
値は次のとおりです。
Medium、33.0
33.0
• Primary — アクションリンクグ
ループは、フィード要素の本文
に表示されます。
• Overflow — アクションリンク
グループは、フィード要素の
オーバーフローメニューに表示
されます。
id
String
プラットフォームアクショングルー Small、33.0
プの 18 文字の ID か、不透明な文字
列の ID。
33.0
プラットフォームアクションの
type が QuickAction で、
subtype が Create の場合、この
値は null になります。
modifiedDate
Date
platformActions Platform Action[]
ISO8601 の日付文字列 (例:
2011—02—25T18:24:31.000Z)。
Small、33.0
33.0
このグループのプラットフォーム
アクションインスタンス。
Medium、33.0
33.0
アクションリンクグループ内では、
アクションリンクは、Action Link
Group Definition Input リクエストボ
ディの actionLinks プロパティに
リストされる順序で表示されます。
フィード項目内では、アクション
リンクグループは、Associated Actions
Capability Input リクエストボディの
actionLinkGroupIds プロパティ
に指定された順序で表示されます。
url
String
プラットフォームアクショングルー Small、33.0
プの Chatter REST API リソース URL。
プラットフォームアクションの
type が QuickAction で、
subtype が Create の場合、この
値は null になります。
712
33.0
Chatter REST API レスポンスボディ
Poll Capability
Poll Capability
フィード要素にこの機能がある場合、フィード要素に投票のアンケートを含めることができます。
プロパティ名
型
説明
検索条件とバー
ジョン
使用可能なバー
ジョン
choices
Feed Poll Choice[]
アンケートを構成するアンケート
選択肢のコレクション。
Small、32.0
32.0
myChoiceId
String
このアンケートで現在のユーザが Small、32.0
投票した選択肢の 18 文字の ID。現
在のユーザが投票していない場合
は、null を返します。
32.0
フィードアンケート要素に投じら
れた投票の合計数。
32.0
totalVoteCount String
Small、32.0
Question and Answers Capability
フィード要素にこの機能がある場合、質問があり、フィード要素のコメントはその質問への回答です。
プロパティ名
型
説明
検索条件とバー
ジョン
使用可能なバー
ジョン
bestAnswer
Comment
質問の最良の回答として選択され
たコメント。
Small、32.0
32.0
bestAnswer
SelectedBy
User Summary
質問の最良の回答を選択したユー
ザ。
Small、32.0
32.0
canCurrent
Boolean
UserSelectOr
RemoveBestAnswer
現在のユーザが最良の回答を選択
または削除できるか (true)、否か
(false) を示します。
Small、32.0
32.0
escalatedCase Reference
質問の投稿がエスカレーションさ
れた場合、これがエスカレーショ
ン先ケースになります。
Medium、33.0
33.0
questionTitle String
質問のタイトル。
Small、32.0
32.0
Question and Answers Suggestion Collection
質問および回答の提案の検索結果。
713
Chatter REST API レスポンスボディ
Recommendation
プロパティ名
型
説明
検索条件グルー
プとバージョン
使用可能なバー
ジョン
articles
Article Item[]
記事のコレクション。
Small、32.0
32.0
質問のコレクション。質問は次の
いずれかになります。
Small、32.0
32.0
questions
• 汎用フィード要素
• Feed Item
Recommendation
おすすめを表します。
プロパティ
型
説明
検索条件グ
ループと
バージョン
actOnUrl
String
ユーザ、ファイル、グループ、およびレコー Small、29.0
ド entity 種別の場合、この Chatter REST URL
を POST 要求に使用して、おすすめのユーザ、
ファイル、またはレコードをフォローする
か、おすすめのグループに参加します。次に
例を示します。
使用可能な
バージョン
23.0
/services/data/v34.0/chatter/users
/005D0000001AzOAIA0/following
?subjectId=005D0000001B4CvIAK
カスタムのおすすめなど、おすすめのオブ
ジェクト entity 種別の場合、Platform Action
レスポンスボディの actionUrl プロパティ
を使用しておすすめに対応します。
action
String
おすすめに対して実行するアクションを指定 Small、29.0
します。値は次のとおりです。
• follow (V23.0)
• join (V23.0)
• view (V25.0)
entity
File Summary
グループ
受信者がアクションを実行することをすすめ Small、32.0
られたエンティティ。
714
32.0
Chatter REST API レスポンスボディ
プロパティ
型
Recommendation Definition
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
Big、29.0
23.0
Recommended
Object (バージョ
ン 34.0 以降)
Record Summary
User Summary
explanation
Explanation
Summary
おすすめの説明。
object
File Summary
受信者がアクションを実行することをすすめ Small、29.0
られたオブジェクト。
グループ
重要: バージョン 32.0 以降では、
entity プロパティを使用します。
Record Summary
User Summary
platform
ActionGroup
Platform Action
Group
recommendation String
Type
23.0 ～ 31.0
コンテキストユーザに適した状態のプラット Small、34.0
フォームアクショングループインスタンス。
34.0
おすすめされるレコードのタイプを示しま
す。
32.0
Small、32.0
• apps
• files
• groups
• records
• users
type
String
バージョン 23.0 以降では使用できません。
url
String
おすすめへの URL。
23.0 ～ 23.0
Small、34.0
34.0
Recommendation Definition
カスタムおすすめ定義を表します。
プロパティ名
型
説明
検索条件グルー
プとバージョン
使用可能なバー
ジョン
actionUrl
String
このおすすめに基づいて行動する
ための URL。
Small、33.0
33.0
actionUrlName String
ユーザインターフェースでのアク
ション URL のテキストラベル。
Small、34.0
34.0
715
Chatter REST API レスポンスボディ
Recommendation Definition Collection
プロパティ名
型
説明
検索条件グルー
プとバージョン
使用可能なバー
ジョン
explanation
String
おすすめ定義の説明。
Medium、33.0
33.0
id
String
おすすめ定義の 18 文字の ID。
Small、33.0
33.0
name
String
おすすめ定義の名前。この名前が
[設定] に表示されます。
Medium、33.0
33.0
photo
Photo
おすすめ定義の写真。
Medium、33.0
33.0
title
String
おすすめ定義のタイトル。
Small、33.0
33.0
url
String
おすすめ定義の Chatter REST API リ
ソースへの URL。
Small、33.0
33.0
説明
検索条件グルー
プとバージョン
使用可能なバー
ジョン
おすすめ定義のリスト。
Small、33.0
33.0
おすすめ定義コレクションのChatter Small、33.0
REST API リソースへの URL。
33.0
Recommendation Definition Collection
おすすめ定義のリストを表します。
プロパティ名
型
recommendation Recommendation
Definition[]
Definitions
url
String
Recommendations
推奨事項のリスト。
プロパティ名
型
説明
検索条件グ
ループとバー
ジョン
使用可能な
バージョン
recommendations
Recommendation[]
推奨事項のコレクション。
Small、29.0
23.0
Recommendations Capability
フィード要素にこの機能がある場合、おすすめがあります。
716
Chatter REST API レスポンスボディ
Recommended Object
プロパティ名
型
説明
検索条件グルー
プとバージョン
使用可能なバー
ジョン
items
次のレスポンス
ボディからなる
コレクションで
す。
おすすめのコレクション。
Small、32.0
32.0
• Non-Entity
Recommendation
このレスポン
スボディは、
バージョン
34.0 以降では
使用できませ
ん。バージョ
ン 34.0 以降で
は、すべての
おすすめに
Recommendation
レスポンスボ
ディが使用さ
れます。
• Recommendation
Recommended Object
カスタムのおすすめや静的なおすすめなど、おすすめのオブジェクト。
プロパティ名
型
説明
検索条件グルー
プとバージョン
使用可能なバー
ジョン
idOrEnum
String
カスタムのおすすめの、おすすめ
定義の ID。
Small、34.0
34.0
motif
Motif
おすすめのオブジェクトの Motif。
Small、34.0
34.0
name
String
おすすめのオブジェクトの名前。
Small、29.0
22.0
type
String
RecommendedObject
Small、29.0
22.0
Record Field
表示ラベルおよびテキスト値を含む汎用レコード項目。
717
Chatter REST API レスポンスボディ
Record Field: Blank
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
label
String
レコード項目を説明するローカライズされた Small、29.0
文字列。
29.0
text
String
レコード項目のテキスト値。すべてのレコー Small、29.0
ド項目にテキスト値があります。すべてのク
ライアントが新しいコンテンツを使用できる
ことを確認するために、レコード項目の
type プロパティを調べます。認識されない
場合は、デフォルトケースとしてテキスト値
を表示します。
29.0
type
String
有効な値は、次のとおりです。
Small、29.0
29.0
• Boolean
• Email
• Number
• Phone
• Text
Record Field: Blank
項目のグリッドにプレースホルダとして表示されるレコード項目。
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
type
String
Blank
Small、29.0
29.0
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
複合項目を構成するサブ項目のコレクショ
ン。次のレスポンスボディからなるコレク
ションです。
Big、29.0
29.0
Record Field: Compound
サブ項目で構成されるレコード項目。
プロパティ
fields
型
• Record Field
718
Chatter REST API レスポンスボディ
プロパティ
型
Record Field: Currency
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
• Record Field: Blank
• Record Field: Compound
• Record Field: Currency
• Record Field: Date
• Record Field: Percent
• Record Field: Picklist
• Record Field: Reference
• Record Field: Reference with Date
label
String
レコード項目を説明するローカライズされた Small、29.0
文字列。
29.0
text
String
レコード項目のテキスト値。すべてのレコー Small、29.0
ド項目にテキスト値があります。すべてのク
ライアントが新しいコンテンツを使用できる
ことを確認するために、レコード項目の
type プロパティを調べます。認識されない
場合は、デフォルトケースとしてテキスト値
を表示します。
29.0
type
String
有効な値は、次のとおりです。
Small、29.0
29.0
検索条件グ
ループと
バージョン
使用可能な
バージョン
• Address
• Compound
• Location
• Name
Record Field: Currency
通貨値を含むレコード項目。
プロパティ
型
説明
label
String
レコード項目を説明するローカライズされた Small、29.0
文字列。
29.0
text
String
レコード項目のテキスト値。すべてのレコー Small、29.0
ド項目にテキスト値があります。すべてのク
ライアントが新しいコンテンツを使用できる
29.0
719
Chatter REST API レスポンスボディ
プロパティ
型
Record Field: Date
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
Currency
Small、29.0
29.0
使用可能な
バージョン
ことを確認するために、レコード項目の
type プロパティを調べます。認識されない
場合は、デフォルトケースとしてテキスト値
を表示します。
通貨は、組織のデフォルトの通貨の形式にな
ります。
type
String
Record Field: Date
日付を含むレコード項目。
プロパティ
型
説明
検索条件グ
ループと
バージョン
dateValue
Date
機械可読の日付。
Medium、29.0 29.0
label
String
レコード項目を説明するローカライズされた Small、29.0
文字列。
29.0
text
String
レコード項目のテキスト値。すべてのレコー Small、29.0
ド項目にテキスト値があります。すべてのク
ライアントが新しいコンテンツを使用できる
ことを確認するために、レコード項目の
type プロパティを調べます。認識されない
場合は、デフォルトケースとしてテキスト値
を表示します。
29.0
type
String
有効な値は、次のとおりです。
29.0
• Date
• DateTime
• Time
Record Field: Percent
パーセント値を含むレコード項目。
720
Small、29.0
Chatter REST API レスポンスボディ
Record Field: Picklist
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
value
Double
パーセントの値。
Medium、29.0 29.0
label
String
レコード項目を説明するローカライズされた Small、29.0
文字列。
29.0
text
String
レコード項目のテキスト値。すべてのレコー Small、29.0
ド項目にテキスト値があります。すべてのク
ライアントが新しいコンテンツを使用できる
ことを確認するために、レコード項目の
type プロパティを調べます。認識されない
場合は、デフォルトケースとしてテキスト値
を表示します。
29.0
type
String
Percent
Small、29.0
29.0
検索条件グ
ループと
バージョン
使用可能な
バージョン
Record Field: Picklist
列挙値を含むレコード項目。
プロパティ
型
説明
label
String
レコード項目を説明するローカライズされた Small、29.0
文字列。
29.0
text
String
レコード項目のテキスト値。すべてのレコー Small、29.0
ド項目にテキスト値があります。すべてのク
ライアントが新しいコンテンツを使用できる
ことを確認するために、レコード項目の
type プロパティを調べます。認識されない
場合は、デフォルトケースとしてテキスト値
を表示します。
29.0
type
String
Picklist
Small、29.0
29.0
Record Field: Reference
別のオブジェクトへの参照を含むレコード項目。
721
Chatter REST API レスポンスボディ
Record Field: Reference with Date
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
label
String
レコード項目を説明するローカライズされた Small、29.0
文字列。
reference
Reference
レコード項目によって参照されるオブジェク Medium、29.0 29.0
ト。
text
String
レコード項目のテキスト値。すべてのレコー Small、29.0
ド項目にテキスト値があります。すべてのク
ライアントが新しいコンテンツを使用できる
ことを確認するために、レコード項目の
type プロパティを調べます。認識されない
場合は、デフォルトケースとしてテキスト値
を表示します。
29.0
type
String
Reference
Small、29.0
29.0
29.0
Record Field: Reference with Date
特定の時刻に動作した参照されるオブジェクトを含むレコード項目 (「作成者」など)。
プロパティ
型
説明
検索条件グ
ループと
バージョン
dateValue
Date
参照されるオブジェクトが動作した時刻。
Medium、29.0 29.0
label
String
レコード項目を説明するローカライズされた Small、29.0
文字列。
reference
Reference
レコード項目によって参照されるオブジェク Medium、29.0 29.0
ト。
text
String
レコード項目のテキスト値。すべてのレコー Small、29.0
ド項目にテキスト値があります。すべてのク
ライアントが新しいコンテンツを使用できる
ことを確認するために、レコード項目の
type プロパティを調べます。認識されない
場合は、デフォルトケースとしてテキスト値
を表示します。
29.0
type
String
有効な値は、次のとおりです。
29.0
• CreatedBy
• LastModifiedBy
722
Small、29.0
使用可能な
バージョン
29.0
Chatter REST API レスポンスボディ
Record Snapshot Capability
Record Snapshot Capability
フィード要素にこの機能がある場合、1 つのレコード作成イベントについて、レコードのスナップショットと
して取得された項目すべてが含まれます。
プロパティ名
型
説明
検索条件グルー
プとバージョン
使用可能なバー
ジョン
recordView
Record View
メタデータとデータを含むレコー
ド表現で、レコードを簡単に表示
できるようになります。
Small、32.0
32.0
Record Summary
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
id
String
レコードの 18 文字の ID
Small、29.0
23.0
motif
Motif
レコードのタブスタイルを示す小、中、大の Small、29.0
アイコン。motif にはレコードタイプのベー
ス色を含めることもできます。
27.0
mySubscription Reference
コンテキストユーザがこのレコードをフォ Medium、29.0 24.0
ローしている場合は、登録に関する情報が含
まれます。それ以外の場合は、null を返し
ます。
name
String
ローカライズされた名前
Small、29.0
23.0
type
String
レポートタイプ (CustomObject や
ContentDocument など)
Small、29.0
23.0
url
String
このレコードの相対 URL
Small、29.0
23.0
Record Summary List
組織のレコード (カスタムオブジェクトを含む) のコレクションに関するサマリー情報。
723
Chatter REST API レスポンスボディ
プロパティ
型
Record View
説明
検索条件グ
ループと
バージョン
レコードのコレクション。コレクションに Small、30.0
は、次のレスポンスボディのいずれかが含ま
れる場合があります。
records
使用可能な
バージョン
30.0
• File Summary
• Group
• Record Summary
• User Summary
url
String
このレコードのコレクションへの URL。
Small、30.0
30.0
Record View
組織のレコード (カスタムオブジェクトレコードを含む) のビュー。このオブジェクトは、レコードタイプで特
殊なオブジェクト (User や ChatterGroup など) を使用できない場合に使用されます。データとメタデータが含ま
れるため、レコードを 1 つの応答で表示できます。
プロパティ
型
説明
検索条件グ 使用可能な
ループと
バージョン
バージョン
id
String
オブジェクトの 18 文字の ID
Small、29.0 23.0
motif
Motif
オブジェクト種別を示す小、中、大アイ Small、29.0 27.0
コン。motif にはオブジェクトのベース色
を含めることもできます。
このアイコンは、ファイルのプレビュー
ではありません。
mySubscription Reference
コンテキストユーザがこのファイルを Medium、
フォローしている場合は、登録に関する 29.0
情報が含まれます。それ以外の場合は、
null を返します。
name
String
ローカライズされた名前
relatedList
Definitions
List View Definition[]
このオブジェクトの関連リスト定義 (メ Medium、
タデータ)。これらのリスト定義には、 29.0
関連リストデータは含まれません。
sections
Record View Section[]
レコードビューセクションのリスト。
724
23.0
Small、29.0 29.0
29.0
Small、29.0 29.0
Chatter REST API レスポンスボディ
Record View Section
プロパティ
型
説明
検索条件グ 使用可能な
ループと
バージョン
バージョン
type
String
このオブジェクトの固定の種別名。レス Small、29.0 23.0
ポンスボディの状態を判別するには、こ
の値を調べます。
url
String
このオブジェクトの Chatter REST API URL リ Small、29.0 23.0
ソース。
Record View Section
レコード詳細のレコード項目と値のセクション。
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
columnCount
String
レコードセクションに項目をレイアウトする Small、29.0
ために使用する列の数。
29.0
columnOrder
String
レコードセクションに項目をレイアウトする Small、29.0
ために fields プロパティで使用する項目
の順序。
29.0
• LeftRight — 項目は左から右に表示さ
れます。
• TopDown — 項目は上から下に表示されま
す。
fields
このセクションに含まれるレコードの項目と Small、29.0
値。次のレスポンスボディからなるコレク
ションです。
• Record Field
• Record Field: Blank
• Record Field: Compound
• Record Field: Currency
• Record Field: Date
• Record Field: Percent
• Record Field: Picklist
• Record Field: Reference
• Record Field: Reference with Date
725
29.0
Chatter REST API レスポンスボディ
Reference
プロパティ
型
説明
heading
String
この項目のセクションを表示するときに使用 Small、29.0
するローカライズされた表示ラベル。
29.0
このセクションを折りたたんですべての項目 Small、29.0
を非表示にできるか (true)、否か (false) を
示します。
29.0
isCollapsible Boolean
検索条件グ
ループと
バージョン
使用可能な
バージョン
Reference
レコードへの参照。
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
id
String
参照するレコードの ID。18 文字の ID または
他の文字列 ID を指定できます。
Small、29.0
23.0
url
String
リソースエンドポイントへの URL。
Small、29.0
23.0
Repository File Detail
リポジトリファイルの詳細な説明。
Repository File Detail レスポンスボディには、Repository File Summary レスポンスボディのすべてが含まれます。
Repository File Summary
リポジトリファイルの説明。
プロパティ名
型
checkinComment String
説明
検索条件グルー
プとバージョン
使用可能なバー
ジョン
ファイルのチェックインコメント。 Small、32.0
32.0
contentSize
Integer
ファイルのコンテンツの長さ (バイ Small、32.0
ト単位)。
32.0
createdBy
String
ファイルを作成したユーザの名前。 Small、32.0
32.0
createdDate
Date
ファイルの作成日。
Small、32.0
32.0
description
String
ファイルの説明。
Small、32.0
32.0
726
Chatter REST API レスポンスボディ
Repository Folder Item
プロパティ名
型
説明
検索条件グルー
プとバージョン
使用可能なバー
ジョン
downloadUrl
String
リポジトリファイルコンテンツへ
の URL。
Small、32.0
32.0
external
ContentUrl
String
外部システムにおけるこのファイ
ルのコンテンツの URL。
Small、32.0
32.0
external
DocumentUrl
String
外部システムにおけるこのファイ
ルの URL。
Small、32.0
32.0
id
String
ファイルの ID。
Small、32.0
32.0
mimeType
String
ファイルの MIME タイプ。
Small、32.0
32.0
modifiedBy
String
ファイルを最後に変更したユーザ
の名前。
Small、32.0
32.0
modifiedDate
Date
ファイルの変更日。
Small、32.0
32.0
motif
Motif
ファイルの Motif。
Small、32.0
32.0
name
String
ファイルの名前。
Small、32.0
32.0
repository
Reference
ファイルの外部リポジトリ。
Small、32.0
32.0
title
String
ファイルのタイトル。
Small、32.0
32.0
type
String
レコードタイプ file。
Small、32.0
32.0
url
String
このファイルの Chatter REST API URL。 Small、32.0
32.0
versionId
String
外部システムにおけるファイルバー Small、32.0
ジョンの ID。
32.0
Repository Folder Item
フォルダ項目の説明。
プロパティ名
型
説明
検索条件グルー
プとバージョン
使用可能なバー
ジョン
file
Repository File
Summary
このフォルダ項目がファイルを表
す場合は、ファイルのサマリー。
このフォルダ項目がフォルダを表
す場合は、null。
Small、32.0
32.0
folder
Repository Folder
Summary
このフォルダ項目がフォルダを表
す場合は、フォルダのサマリー。
Small、32.0
32.0
727
Chatter REST API レスポンスボディ
プロパティ名
型
Repository Folder Items Collection
説明
検索条件グルー
プとバージョン
使用可能なバー
ジョン
Small、32.0
32.0
検索条件グルー
プとバージョン
使用可能なバー
ジョン
このフォルダ項目がファイルを表
す場合は、null。
type
String
フォルダ項目の種別 (folder また
は file)。
Repository Folder Items Collection
リポジトリフォルダ項目のコレクション。
プロパティ名
型
currentPageUrl String
説明
現在のページを識別する Chatter REST Medium、32.0
API URL。
32.0
items
Repository Folder
Item[]
リポジトリフォルダ内の項目のコ
レクション。
Small、32.0
32.0
nextPageUrl
String
次のページを識別する Chatter REST Small、32.0
API URL。次のページがない場合は
null。別のページを取得する前
に、この値が null であるかどうか
を確認します。ページが存在しな
い場合は、
32.0
ConnectApi.NotFoundException
エラーが返されます。
previousPageUrl String
前のページを識別する Chatter REST
API URL。前のページがない場合は
null。
Medium、32.0
32.0
検索条件グルー
プとバージョン
使用可能なバー
ジョン
Repository Folder Summary
リポジトリフォルダの説明。
プロパティ名
型
説明
createdBy
String
フォルダを作成したユーザの名前。 Small、32.0
32.0
createdDate
Date
フォルダの作成日。
Small、32.0
32.0
description
String
フォルダの説明。
Small、32.0
32.0
728
Chatter REST API レスポンスボディ
プロパティ名
型
評価
説明
検索条件グルー
プとバージョン
使用可能なバー
ジョン
externalFolderUrl String
外部システムにおけるこのフォル
ダの Chatter REST API URL。
Small、32.0
32.0
folderItemsUrl String
このフォルダ内のファイルとフォ
ルダをリストする Chatter REST API
URL。
Small、32.0
32.0
id
String
フォルダの ID。
Small、32.0
32.0
modifiedBy
String
フォルダを最後に変更したユーザ
の名前。
Small、32.0
32.0
modifiedDate
Date
フォルダの変更日。
Small、32.0
32.0
motif
Motif
フォルダの Motif。
Small、32.0
32.0
name
String
フォルダの名前。
Small、32.0
32.0
path
String
外部システムにおけるフォルダの
絶対パス。
Small、32.0
32.0
repository
Reference
フォルダの外部リポジトリ。
Small、32.0
32.0
type
String
レコードタイプ folder。
Small、32.0
32.0
url
String
このフォルダの Chatter REST API URL。 Small、32.0
32.0
型
説明
検索条件グルー
プとバージョン
使用可能なバー
ジョン
reputationLevel Reputation Level
ユーザの評価レベル。
Small、32.0
32.0
reputationPoints Double
ユーザの評価ポイント。評価ポイ
ントは、コミュニティでさまざま
な活動を行うことによって獲得で
きます。
Small、32.0
32.0
評価への Chatter REST API URL。
Small、32.0
32.0
評価
ユーザの評価。
プロパティ名
url
String
Reputation Level
ユーザの評価レベル。
729
Chatter REST API レスポンスボディ
プロパティ名
型
levelImageUrl String
Request Header
説明
検索条件グルー
プとバージョン
使用可能なバー
ジョン
評価レベル画像への URL。
Small、32.0
32.0
levelName
String
評価レベルの名前。
Small、32.0
32.0
levelNumber
Integer
評価レベル番号。レベルの数値ラ Small、32.0
ンクで、最低レベルは 1 です。管理
者が、評価レベルのポイント範囲
を定義します。
32.0
Request Header
HTTP 要求ヘッダー名と値のペア。
プロパティ名
型
説明
検索条件グルー
プとバージョン
使用可能なバー
ジョン
name
String
要求ヘッダーの名前。
Small、33.0
33.0
value
String
要求ヘッダーの値。
Small、33.0
33.0
検索条件グルー
プとバージョン
使用可能なバー
ジョン
スケジュール済みおすすめ
スケジュール済みおすすめを表します。
プロパティ名
型
説明
enabled
Boolean
スケジュールが有効になっている Small、34.0
かどうかを示します。true の場
合、おすすめが有効になり、コミュ
ニティに表示されます。false の
場合、Salesforce1 モバイルブラウザ
アプリケーションでのフィードの
おすすめは削除されませんが、新
しいおすすめは表示されなくなり
ます。Summer '15 以降のバージョン
の Napili テンプレートを使用したコ
ミュニティでは、無効にしたおす
すめは表示されなくなります。
34.0
id
String
スケジュール済みおすすめの 18 文 Small、33.0
字の ID。
33.0
730
Chatter REST API レスポンスボディ
Scheduled Recommendation Collection
プロパティ名
型
説明
検索条件グルー
プとバージョン
使用可能なバー
ジョン
rank
Integer
このスケジュール済みおすすめの
順序を決めるランク。
Small、33.0
33.0
このスケジュール済みおすすめに
よってスケジュールされるおすす
め定義。
Small、33.0
33.0
スケジュール済みおすすめのChatter Small、33.0
REST API リソースへの URL。
33.0
recommendation Recommendation
Definition
Definition
Representation
url
String
Scheduled Recommendation Collection
スケジュール済みおすすめのリストを表します。
プロパティ名
型
説明
検索条件グルー
プとバージョン
使用可能なバー
ジョン
スケジュール済みおすすめのリス
ト。
Small、33.0
33.0
String
スケジュール済みおすすめコレク Small、33.0
ションの Chatter REST API リソースへ
の URL。
33.0
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
entity
共有方法によっ
て異なる
ファイルが共有されているユーザ、レコー
ド、またはグループに関する情報を返しま
す。値は次のいずれかになります。
Small、29.0
24.0
Small、29.0
24.0
scheduled
Scheduled
Recommendations Recommendation[]
url
Shares
• Group
• Record Summary
• User Summary
sharingType
String
共有の権限レベル。値は次のとおりです。
• C — コラボレータ
• I — 共有権限は場所によって決まりま
す。これは一般に、共有権限がファイル
731
Chatter REST API レスポンスボディ
プロパティ
型
Subscription
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
検索条件グ
ループと
バージョン
使用可能な
バージョン
ではなくライブラリに設定されている場
合に発生します。この値は、コンテキス
トユーザがファイルの所有者と同じ場合
にも使用されます。
• N — アクセス権限なし
• V — 閲覧者
Subscription
プロパティ
型
説明
community
Reference
コミュニティに関する情報。デフォルトのコ Medium、29.0 26.0
ミュニティに登録が存在するか、コミュニ
ティが無効である場合は、null が返されま
す。
id
String
登録の 18 文字の ID
subject
状況による
親、つまりフォロー対象のものまたは人に関 Small、29.0
する情報。有効な値は、次のとおりです。
Small、29.0
23.0
• Group (23.0)
• Record Summary (23.0)
• Topic (29.0)
• User Summary (23.0)
subscriber
状況による
登録者、つまりこの項目をフォローしている Small、29.0
人に関する情報。有効な値は、次のとおりで
す。
23.0
• Group
• User Summary
url
String
この特定の登録への相対 URL
732
Small、29.0
23.0
Chatter REST API レスポンスボディ
Subscription Page
Subscription Page
プロパティ
型
currentPageUrl String
nextPageUrl
String
説明
検索条件グ
ループと
バージョン
登録の現在のページを返します。
Medium、29.0 23.0
登録の次のページを返します。次のページが Small、29.0
ない場合、文字列 "null" を返します。
使用可能な
バージョン
23.0
mySubscription Reference
登録に関する情報を返します。コンテキスト Medium、29.0 23.0
ユーザが登録されていない場合は null を返
します。
previousPageUrl String
登録の前のページを返します。前のページが Medium、29.0 23.0
ない場合、文字列 "null" を返します。
subscriptions Subscription[]
登録のコレクション
Small、29.0
23.0
登録の合計数
Small、29.0
23.0
total
Integer
Time Zone
Salesforce の [私の設定] で選択されたユーザのタイムゾーン。この値には、デバイスの現在位置は反映されませ
ん。
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
gmtOffset
Double
GMT との符号付き時差
Small、30.0
30.0
name
String
このタイムゾーンの表示名
Small、30.0
30.0
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
createdDate
String
ISO8601 の日付文字列 (例:
2011-02-25T18:24:31.000Z)
Big、29.0
28.0
description
String
トピックの説明
Big、29.0
28.0
id
String
トピックの 18 文字の ID
Small、29.0
28.0
Topic
733
Chatter REST API レスポンスボディ
Topic Collection
プロパティ
型
説明
検索条件グ
ループと
バージョン
images
Topic Images
トピックに関連付けられた画像
Medium、32.0 32.0
isBeingDeleted Boolean
トピックを現在削除中の場合は true、それ Small、33.0
以外の場合は false。
使用可能な
バージョン
33.0
トピックが削除された後、トピックを取得し
ようとすると、応答は 404: Not Found になりま
す。
name
String
トピックの名前
talkingAbout
Integer
トピックの追加やトピックを含む投稿に対す Medium、29.0 28.0
るコメントなどの要素に基づいた、過去 2 か
月間にこのトピックに言及したユーザの数
url
String
トピックの詳細ページの URL
Small、29.0
29.0
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
トピックの現在のページを返します。
Medium、32.0 29.0
Small、29.0
24.0
Topic Collection
プロパティ
型
currentPageUrl String
Small、29.0
～ 31.0
nextPageUrl
String
トピックの次のページを返します。次のペー Small、29.0
ジがない場合、文字列 "null" を返します。
29.0
topics
Topic[]
トピックのコレクション
Small、29.0
24.0
Topic Endorsement
1 つのトピックについて他のユーザを支持する 1 人のユーザを表します。
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
endorsee
User Summary
支持されているユーザ
Small、30.0
30.0
支持レコードの ID
Small、30.0
30.0
endorsementId String
734
Chatter REST API レスポンスボディ
Topic Endorsement Collection
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
endorser
User Summary
支持しているユーザ
Small、30.0
30.0
topic
Topic
ユーザが支持されているトピック
Small、30.0
30.0
url
String
支持レコードの Chatter REST API リソース URL
Small、30.0
30.0
検索条件グ
ループと
バージョン
使用可能な
バージョン
Topic Endorsement Collection
Topic Endorsement レスポンスボディのコレクション。
プロパティ
型
currentPageUrl String
説明
現在のページを識別する Chatter REST API URL。 Medium、30.0 30.0
topicEndorsements Topic Endorsement[] Topic Endorsement レスポンスボディのコレク
Small、30.0
30.0
次のページを識別する Chatter REST API URL。次 Small、30.0
のページがない場合は null。別のページを
取得する前に、この値が null であるかどう
かを確認します。ページが存在しない場合
は、ConnectApi.NotFoundException エ
ラーが返されます。
30.0
ション
nextPageUrl
String
previousPageUrl String
前のページを識別する Chatter REST API URL。前 Medium、30.0 30.0
のページがない場合は null。
Topic Images
トピックに関連付けられた画像。
プロパティ名
型
説明
検索条件グルー
プとバージョン
使用可能なバー
ジョン
coverImageUrl String
トピックページに表示される、ト Small、32.0
ピックの表紙画像への URL。トピッ
クと管理トピックの両方に、表紙
画像を設定できます。
32.0
featuredImageUrl String
管理トピックの主要画像への URL。 Small、32.0
主要画像は、指定した場所であれ
32.0
735
Chatter REST API レスポンスボディ
プロパティ名
型
Topic Opt Out
説明
検索条件グルー
プとバージョン
使用可能なバー
ジョン
ば、どこにでも表示されます (コ
ミュニティホームページなど)。
Topic Opt Out
トピックからの「除外」。ユーザがトピックに関して知識があると識別されることを望まないことを示しま
す。
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
id
String
Topic Opt Out レコードの ID
Small、30.0
30.0
reason
String
トピックからユーザを除外する理由。
Small、30.0
30.0
有効な値は topicInfluenceHide のみで
す。
topic
Topic
ユーザが除外されるトピック
Small、30.0
30.0
url
String
Topic Opt Out の Chatter REST API リソース URL
Small、30.0
30.0
user
User Summary
トピックから除外するユーザ
Small、30.0
30.0
検索条件グ
ループと
バージョン
使用可能な
バージョン
Topic Opt Out Collection
Topic Opt Out レスポンスボディのコレクション。
プロパティ
型
currentPageUrl String
topicOptOuts
Topic Opt Out[]
説明
現在のページを識別する Chatter REST API URL。 Medium、30.0 30.0
Topic Opt Out レスポンスボディのコレクショ Small、30.0
ン。
736
30.0
Chatter REST API レスポンスボディ
Topic Suggestion
Topic Suggestion
プロパティ
型
existingTopic Topic
name
String
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
すでに存在するトピック、または新規トピッ Small、29.0
クの場合は null
28.0
トピックの名前
Small、29.0
28.0
検索条件グ
ループと
バージョン
使用可能な
バージョン
Topic Suggestion Collection
プロパティ
型
説明
topic
Suggestions
Topic Suggestion[]
Topic Suggestion レスポンスボディのコレクショ Small、29.0
ン
28.0
Topics Capability
フィード要素にこの機能がある場合、コンテキストユーザはトピックを追加できます。トピックは、ユーザが
会話を整理して検索するために役立ちます。
プロパティ名
型
canAssignTopics Boolean
items
Topic[]
説明
検索条件とバー
ジョン
使用可能なバー
ジョン
トピックをフィード要素に割り当 Small、32.0
て可能な場合は true、それ以外の
場合は false。
32.0
このフィード要素に関連付けられ
たトピックのコレクション。
32.0
Topics People Are Knowledgeable About
指定されたユーザが知識のあるトピックを表します。
737
Small、32.0
Chatter REST API レスポンスボディ
プロパティ
型
Topics People Are Knowledgeable About Collection
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
isEndorsedByMe Boolean
コンテキストユーザが、トピックについてこ Small、30.0
の知識のあるユーザを支持している場合は
true、それ以外の場合は false を指定しま
す。
30.0
knowledgeableId String
知識のあるレコードの ID
Small、30.0
30.0
numEndorsements Integer
トピックについて知識のあるユーザが受け
取った支持の数
Medium、30.0 30.0
reasons
String
ユーザがトピックに関する知識があるとみな Medium、30.0 30.0
される理由を指定します。有効な値は、次の
とおりです。
• Influential — ユーザは、トピックを
含む投稿か投稿へのコメントでメンショ
ンされたか、トピックを含む投稿へのコ
メントでいいね! を受信しました。
• Endorsed — ユーザは、トピックについ
て別のユーザから支持を受け取りまし
た。
topic
Topic
ユーザが知識のあるトピック。
Small、30.0
30.0
検索条件グ
ループと
バージョン
使用可能な
バージョン
Topics People Are Knowledgeable About Collection
Topics People Are Knowledgeable About レスポンスボディのコレクション。
プロパティ
型
説明
currentPageUrl String
現在のページを識別する Chatter REST API URL。 Medium、30.0 30.0
knowledgeable Topics People Are
Knowledgeable
AboutTopic
Topics People Are Knowledgeable About レスポン
スボディのコレクション。
Small、30.0
30.0
次のページを識別する Chatter REST API URL。次 Small、30.0
のページがない場合は null。別のページを
取得する前に、この値が null であるかどう
かを確認します。ページが存在しない場合
は、ConnectApi.NotFoundException エ
ラーが返されます。
30.0
About[]
nextPageUrl
String
738
Chatter REST API レスポンスボディ
プロパティ
型
Tracked Change Bundle Capability
説明
previousPageUrl String
検索条件グ
ループと
バージョン
使用可能な
バージョン
前のページを識別する Chatter REST API URL。前 Medium、30.0 30.0
のページがない場合は null。
Tracked Change Bundle Capability
フィード要素にこの機能がある場合、バンドルと呼ばれる 1 つのフィード要素に集約された他のフィード要素
のグループがあります。この種別のバンドルは、フィード追跡変更を集約します。
メモ: バンドル投稿にはフィード追跡変更が含まれます。Salesforce1 ダウンロード可能アプリケーション
では、バンドル投稿がレコードフィードのみにあります。
プロパティ名
型
説明
検索条件グルー 使用可能なバー
プとバージョン ジョン
changes
Feed Tracked
Change[]
フィード追跡変更のコレクショ
ン。
Small、31.0
31.0
bundleType
String
バンドルの種別を指定します。値 Small、31.0
は TrackedChanges です。
31.0
page
Feed Element Page フィード要素のコレクション。
totalElements
Integer
Small、31.0
31.0
このバンドルで集約するフィード Small、31.0
要素の合計数。
31.0
Tracked Changes Capability
フィード要素にこの機能がある場合、1 つの変更追跡イベントについて、レコードへのすべての変更が含まれ
ます。
プロパティ名
型
説明
検索条件グルー
プとバージョン
changes
Feed Tracked
Change[]
フィード追跡変更のコレクション。 Small、32.0
739
使用可能なバー
ジョン
32.0
Chatter REST API レスポンスボディ
Unauthenticated User
Unauthenticated User
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
name
String
ソースメールの [差出人] 項目の名前か、
ソースメールのメールアドレス
Small、29.0
24.0
type
String
UnauthenticatedUser
Small、29.0
24.0
User Capabilities
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
canChat
Boolean
コンテキストユーザが件名ユーザと共に
Chatter Messenger を使用できるか (true)、否
か (false) を示します。
Small、29.0
29.0
canDirectMessage Boolean
コンテキストユーザが件名ユーザに直接メッ Small、29.0
セージを送信できるか (true)、否か (false)
を示します。
29.0
canEdit
Boolean
コンテキストユーザが件名ユーザの取引先を Small、29.0
編集できるか (true)、否か (false) を示しま
す。
29.0
canFollow
Boolean
コンテキストユーザが件名ユーザのフィード Small、29.0
をフォローできるか (true)、否か (false) を
示します。
29.0
canViewFeed
Boolean
コンテキストユーザが件名ユーザのフィード Small、29.0
を表示できるか (true)、否か (false) を示し
ます。
29.0
canView
FullProfile
Boolean
コンテキストユーザが件名ユーザの完全なプ Small、29.0
ロファイルを表示できるか (true)、または制
限されたプロファイルのみを表示できるか
(false) を示します。
29.0
isModerator
Boolean
件名ユーザが Chatter モデレータまたは管理
者か (true)、否か (false) を示します。
29.0
740
Small、29.0
Chatter REST API レスポンスボディ
User Chatter Settings
User Chatter Settings
ユーザのグローバル Chatter 設定。
プロパティ
型
defaultGroup String
EmailFrequency
説明
検索条件グ
ループと
バージョン
ユーザが参加するグループからメールを受信 Small、29.0
するデフォルトの頻度。値は次のとおりで
す。
適用開始
バージョン
27.0
• EachPost
• DailyDigest
• WeeklyDigest
• Never
コミュニティでは、グループメンバーが
10,000 人を超えると [各投稿のメール] オプ
ションが無効になります。このオプションを
選択したすべてのメンバーは、自動的に [毎
日のダイジェスト] に切り替わります。
User Detail
コンテキストユーザにプロパティを表示する権限がない場合、プロパティは null に設定されます。
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
aboutMe
String
ユーザのプロファイルから取得したテキスト Big、29.0
23.0
additional
Label
String
ユーザの追加表示ラベル。たとえば、「顧 Small、30.0
客」、「パートナー」、「Acme Corporation」
などがあります。ユーザに追加表示ラベルが
ない場合、値は null です。
30.0
address
Address
住所
Big、29.0
23.0
chatterActivity Chatter Activity
Chatter 活動統計
Big、29.0
23.0
chatterInfluence Chatter Influence
ユーザの影響度ランク
Big、29.0
23.0
community
Nickname
String
コミュニティでのユーザのニックネーム
Medium、32.0 32.0
companyName
String
会社名
Small、29.0
741
23.0
Chatter REST API レスポンスボディ
プロパティ
型
currentStatus User Status
User Detail
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
23.0 ～ 25.0
メモ: このプロパティは、バージョン
25.0 以降、使用できなくなります。
ユーザの現在の状況
displayName
String
コミュニティで表示されるユーザの名前。 Small、32.0
ニックネームが有効な場合は、ニックネーム
が表示されます。ニックネームが有効ではな
い場合は、氏名が表示されます。
email
String
ユーザのメールアドレス
Medium、29.0 23.0
firstName
String
ユーザの名
Small、29.0
23.0
followersCount Integer
このユーザをフォローしているユーザの数
Big、29.0
23.0
followingCounts Following Counts
ユーザがフォローしている項目に関する情報 Big、29.0
23.0
32.0
groupCount
Integer
ユーザがフォローしているグループの数
Big、29.0
23.0
hasChatter
Boolean
ユーザに Chatter へのアクセス権がある場合
は true、それ以外の場合は false
Small、31.0
31.0
id
String
ユーザの 18 文字の ID
Small、29.0
23.0
isActive
Boolean
ユーザが有効な場合は true、それ以外の場 Small、29.0
合は false
23.0
isChatterGuest Boolean
23.0 ～ 25.0
メモ: このプロパティは、バージョン
26.0 以降、使用できなくなります。代
わりに、userType プロパティを使用
してください。
ユーザが Chatter 顧客の場合は true、それ以
外の場合は false
isInThis
Community
Boolean
ユーザがコンテキストユーザと同じコミュニ Small、29.0
ティに含まれる場合は true、それ以外の場
合は false。範囲が「すべてのユーザ」の
投稿に対するレコードフィードの @メンショ
ンの場合、false になることがあります。
28.0
lastName
String
ユーザの姓
Small、29.0
23.0
managerId
String
ユーザのマネージャの 18 文字の ID
Big、29.0
23.0
managerName
String
ロケールに基づいて連結されたマネージャの Big、29.0
姓と名
23.0
742
Chatter REST API レスポンスボディ
User Detail
プロパティ
型
説明
検索条件グ
ループと
バージョン
motif
Motif
オブジェクトがユーザであることを示す小、 Small、29.0
中、大のアイコン。motif にはオブジェクト
のベース色を含めることもできます。
使用可能な
バージョン
27.0
motif アイコンは、ユーザのプロファイル写
真ではありません。
mySubscription Reference
コンテキストユーザがこのユーザをフォロー Medium、29.0 23.0
している場合は、登録に関する情報が含まれ
ます。それ以外の場合は、null を返しま
す。
name
String
ロケールに基づいて連結されたユーザの姓と Small、29.0
名
23.0
phoneNumbers
Phone Number[]
ユーザの電話番号のコレクション
Big、29.0
23.0
photo
Photo
ユーザの写真に関する情報
Small、29.0
23.0
reputation
評価
コミュニティでのユーザの評価。コミュニ Big、32.0
ティで実行したイベントやアクションを基に
獲得したポイント数によって判断されます。
32.0
ユーザが受け取った感謝の数。
Big、29.0
29.0
thanksReceived Integer
title
String
ユーザの役職
Small、29.0
23.0
type
String
User
Small、29.0
23.0
url
String
ユーザの Chatter プロファイルへの URL
Small、29.0
23.0
username
String
ユーザのユーザ名 ([email protected] Small、29.0
など)
24.0
743
Chatter REST API レスポンスボディ
User Group Page
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
userType
String
ユーザの種別を指定します。有効な値は、次 Medium、29.0 26.0
のとおりです。
• ChatterGuest — 非公開グループの外部
ユーザ。
• ChatterOnly — Chatter Free ユーザ。
• Guest — 認証されていないユーザ。
• Internal — 標準組織メンバー。
• Portal — カスタマーポータル、パート
ナーポータル、またはコミュニティの外
部ユーザ。
• System — Chatter Expert またはシステム
ユーザ。
• Undefined — カスタムオブジェクトの
ユーザ種別
関連トピック:
User Summary
User Group Page
ユーザがメンバーであるグループのページ設定されたコレクション。
プロパティ
型
currentPageUrl String
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
現在のページへの URL
Medium、29.0 23.0
groups
Group[]
ユーザのグループのコレクション
Small、29.0
23.0
nextPageUrl
String
次のページへの URL。次のページがない場合 Small、29.0
は文字列 "null" を返します。
23.0
previousPageUrl String
total
Integer
前のページへの URL。前のページがない場合 Medium、29.0 23.0
は文字列 "null" を返します。
ユーザがメンバーであるグループの総数。
この数値は、要求が検索で応答に総数のサブ
セットが含まれる場合でも、常にユーザがメ
ンバーであるグループの総数です。
744
Small、29.0
23.0
Chatter REST API レスポンスボディ
User Page
User Page
プロパティ
型
currentPageUrl String
nextPageUrl
String
previousPageUrl String
説明
検索条件グ
ループと
バージョン
現在のページへの URL
Medium、29.0 23.0
次のページへの URL。次のページがない場合 Small、29.0
は null を返します。
使用可能な
バージョン
23.0
前のページへの URL。前のページがない場合 Medium、29.0 23.0
は null を返します。
User Detail[]
ユーザ詳細情報のコレクション。
Small、29.0
24.0
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
capabilities
User Capabilities
件名ユーザのプロファイルに固有のコンテキ Medium、29.0 29.0
ストユーザの機能
id
String
プロファイルに添付されるユーザの ID
tabs
User Profile Tab[]
そのユーザ種別でコンテキストユーザに表示 Big、29.0
されるタブ
29.0
url
String
ユーザのプロファイルの URL
Small、29.0
29.0
userDetail
User Detail
プロファイルに添付されるユーザに関する詳 Small、29.0
細情報
29.0
users
User Profile
Small、29.0
29.0
User Profile Tab
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
id
String
タブの一意の識別子 (18 文字の ID)
Small、29.0
29.0
isDefault
Boolean
ユーザプロファイルをクリックしたときにタ Small、29.0
ブが最初に表示されるか (true)、否か
(false) を示します。
29.0
745
Chatter REST API レスポンスボディ
User Settings
プロパティ
型
説明
検索条件グ
ループと
バージョン
tabType
String
ユーザプロファイルタブの種別を示します。 Small、29.0
使用可能な
バージョン
29.0
• CustomVisualForce — Visualforce ページ
からのデータを表示するタブ。
• CustomWeb — 外部の Web ベースのアプ
リケーションまたは Web ページからの
データを表示するタブ。
• Element — 汎用コンテンツをインライン
で表示するタブ。
• Feed — Chatterフィードを表示するタブ。
• Overview — ユーザの詳細を表示するタ
ブ。
tabUrl
String
現在のタブのコンテンツ URL (組み込み以外
のタブの種類の場合)
Small、29.0
29.0
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
User Settings
ユーザ固有の設定。
プロパティ
型
approvalPosts Boolean
ユーザは、Chatter投稿からワークフローを承 Small、29.0
認できるかどうか。
27.0
canFollow
Boolean
コンテキストユーザにフォローが許可されて Small、29.0
いるかどうか。
24.0
canModify
AllData
Boolean
ユーザに「すべてのデータの編集」権限があ Small、29.0
るかどうか。
24.0
canOwnGroups
Boolean
ユーザはグループを所有できるかどうか。
Small、29.0
24.0
canViewAllData Boolean
ユーザに「すべてのデータの参照」権限があ Small、29.0
るかどうか。
24.0
canViewAllGroups Boolean
ユーザに「すべてのグループの参照」権限が Small、29.0
あるかどうか。
24.0
canViewAllUsers Boolean
ユーザに「すべてのユーザの参照」権限があ Small、29.0
るかどうか。
24.0
746
Chatter REST API レスポンスボディ
プロパティ
型
canViewCommunity Boolean
Switcher
User Settings
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
ユーザにコミュニティ切り替えメニューが表 Small、34.0
示されるかどうか。
34.0
canViewFull
UserProfile
Boolean
ユーザが他のユーザの Chatter プロファイル
を表示できるかどうか。
Small、29.0
24.0
canView
PublicFiles
Boolean
ユーザが公開とマークされたすべてのファイ Small、29.0
ルを表示できるかどうか。
24.0
通貨の値を表示するために使用する通貨記 Small、29.0
号。Features レスポンスボディの
multiCurrency プロパティが false の場
合のみ該当します。
28.0
ユーザが Chatter 顧客であるかどうか。
Small、29.0
24.0
ユーザが同期できるファイルの最大数。
Small、32.0
32.0
currencySymbol String
externalUser
Boolean
fileSyncLimit Integer
fileSync
StorageLimit
Integer
同期済みファイルのための最大ストレージ
(MB)
Small、29.0
29.0
folderSync
Limit
Integer
ユーザが同期できるフォルダの最大数。
Small、32.0
32.0
ユーザが、社内組織のメンバーであるかどう Small、29.0
か。
26.0
hasAccess
Boolean
ToInternalOrg
hasChatter
Boolean
ユーザには Chatter へのアクセス権がありま
す。
Small、31.0
31.0
hasFileSync
Boolean
ユーザに「ファイルを同期」権限があるかど Small、29.0
うか。
26.0
hasFileSync
Boolean
ManagedClient
AutoUpdate
ユーザの組織のシステム管理者が File Sync ク Small、34.0
ライアントの自動更新を許可するかどうか。
34.0
hasRestData
ApiAccess
Boolean
ユーザに REST API へのアクセス権があるかど Small、29.0
うか。
29.0
timeZone
Time Zone
Salesforce の [私の設定] で選択されたユーザの Small、30.0
タイムゾーン。この値には、デバイスの現在
位置は反映されません。
30.0
デフォルト通貨の ISO コード。Features レスポ Small、29.0
ンスボディの multiCurrency プロパティ
が true の場合のみ該当します。
28.0
ユーザの 18 文字の ID
24.0
userDefault
String
CurrencyIsoCode
userId
String
747
Small、29.0
Chatter REST API レスポンスボディ
User Status
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
userLocale
String
ユーザのロケール
Small、29.0
24.0
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
body
Feed Item Body[]
投稿の本文
Small、29.0
23.0 ～ 25.0
parentId
String
18 文字の ID
Small、29.0
23.0 ～ 25.0
url
String
このユーザ状況の投稿の URL
Small、29.0
23.0 ～ 25.0
検索条件グ
ループと
バージョン
使用可能な
バージョン
User Status
User Summary
User Summary レスポンスボディは、User Detail レスポンスボディのサブセットです。
プロパティ
型
説明
additional
Label
String
ユーザの追加表示ラベル。たとえば、「顧 Small、30.0
客」、「パートナー」、「Acme Corporation」
などがあります。ユーザに追加表示ラベルが
ない場合、値は null です。
community
Nickname
String
コミュニティでのユーザのニックネーム
Medium、32.0 32.0
companyName
String
会社の名前
Small、29.0
23.0
displayName
String
コミュニティで表示されるユーザの名前。 Small、32.0
ニックネームが有効な場合は、ニックネーム
が表示されます。ニックネームが有効ではな
い場合は、氏名が表示されます。
32.0
firstName
String
ユーザの名
Small、29.0
23.0
id
String
18 文字の ID
Small、29.0
23.0
isActive
Boolean
ユーザが有効な場合は true、それ以外の場 Small、29.0
合は false。
25.0
748
30.0
Chatter REST API レスポンスボディ
プロパティ
型
isChatter
Guest
Boolean
User Summary
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
23.0 ～ 26.0
メモ: このプロパティは、バージョン
26.0 以降、使用できなくなります。代
わりに、userType プロパティを使用
してください。
ユーザが Chatter 顧客の場合は true、それ以
外の場合は false
isInThis
Community
Boolean
ユーザがコンテキストユーザと同じコミュニ Small、29.0
ティに含まれる場合は true、それ以外の場
合は false。範囲が「すべてのユーザ」の
投稿に対するレコードフィードの @メンショ
ンの場合、false になることがあります。
28.0
lastName
String
ユーザの姓
Small、29.0
23.0
motif
Motif
オブジェクトがユーザであることを示す小、 Small、29.0
中、大のアイコン。motif にはオブジェクト
のベース色を含めることもできます。
27.0
motif アイコンは、ユーザのプロファイル写
真ではありません。
mySubscription Reference
コンテキストユーザがこのユーザをフォロー Medium、29.0 23.0
している場合は、登録に関する情報が含まれ
ます。それ以外の場合は、null を返しま
す。
name
String
ロケールに基づいて連結された姓と名
Small、29.0
23.0
photo
Photo
ユーザの写真に関する情報
Small、29.0
23.0
reputation
評価
コミュニティでのユーザの評価。コミュニ Big、32.0
ティで実行したイベントやアクションを基に
獲得したポイント数によって判断されます。
32.0
title
String
ユーザの役職
Small、29.0
23.0
type
String
User
Small、29.0
23.0
url
String
ユーザの Chatter プロファイルへの URL
Small、29.0
23.0
userType
String
ユーザの種別を指定します。有効な値は、次 Medium、29.0 26.0
のとおりです。
• ChatterGuest — 非公開グループの外部
ユーザ。
749
Chatter REST API レスポンスボディ
プロパティ
型
Zone
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
• ChatterOnly — Chatter Free ユーザ。
• Guest — 認証されていないユーザ。
• Internal — 標準組織メンバー。
• Portal — カスタマーポータル、パート
ナーポータル、またはコミュニティの外
部ユーザ。
• System — Chatter Expert またはシステム
ユーザ。
• Undefined — カスタムオブジェクトの
ユーザ種別
例:
メモ: ユーザの名前が Chatter Expert で、戻り値のほとんどが null 値の場合、Chatter Expert ユーザが管理
者によって無効化または引き継ぎされたか、あるいは、Salesforce に Chatter Expert ユーザが導入される
前に組織が作成されたことを示します。Chatter Expert は、Chatterの使用を開始するユーザに、ヒント、
使用方法、およびサンプル投稿を提供する特殊なユーザです。
関連トピック:
User Detail
Zone
Chatter アンサーのゾーン。
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
description
String
ゾーンの説明
Big、29.0
29.0
id
String
ゾーン ID
Small、29.0
29.0
isActive
Boolean
ゾーンが有効であることを示します。
Small、29.0
29.0
ゾーンが Chatter アンサーで使用できること
を示します。
Small、29.0
29.0
isChatterAnswers Boolean
name
String
ゾーンの名前
Small、29.0
29.0
url
String
ゾーンの Chatter REST API リソース URL
Small、30.0
30.0
750
Chatter REST API レスポンスボディ
Zone Page
プロパティ
型
説明
検索条件グ
ループと
バージョン
visibility
String
ゾーンの表示種別。次のいずれかの値にしま Small、29.0
す。
使用可能な
バージョン
29.0
• Community — コミュニティで使用でき
ます。
• Internal — 内部でのみ使用できます。
• Portal — ポータルで使用できます。
visibilityId
String
ゾーンがポータルまたはコミュニティで使用 Small、29.0
できる場合、このプロパティにはそのポータ
ルまたはコミュニティの ID が含まれます。
ゾーンがすべてのポータルで使用できる場
合、このプロパティには All の値が含まれ
ます。
29.0
Zone Page
Chatter アンサーのゾーンのページ。
プロパティ
型
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
zones
Zone[]
1 つ以上のゾーンのコレクション
Small、29.0
29.0
currentPageUrl String
nextPageUrl
String
現在のページを識別する Chatter REST API URL。 Medium、29.0 29.0
次のページを識別する Chatter REST API URL。次 Small、29.0
のページがない場合は null。別のページを
取得する前に、この値が null であるかどう
かを確認します。ページが存在しない場合
は、ConnectApi.NotFoundException エ
ラーが返されます。
Zone Search Page
Chatter アンサーのゾーン内の検索結果のページ。
751
29.0
Chatter REST API レスポンスボディ
プロパティ
型
Zone Search Result
説明
検索条件グ
ループと
バージョン
currentPageToken String
現在のページを識別するトークン。
Medium、29.0 29.0
currentPageUrl String
現在のページを識別する Chatter REST API URL。 Medium、29.0 29.0
Small、29.0
29.0
currentPageToken String
次のページを識別するトークン。次のページ Small、29.0
がない場合は null。
29.0
String
次のページを識別する Chatter REST API URL。次 Small、29.0
のページがない場合は null。別のページを
取得する前に、この値が null であるかどう
かを確認します。ページが存在しない場合
は、ConnectApi.NotFoundException エ
ラーが返されます。
29.0
items
nextPageUrl
Zone Search Result[] 検索結果のコレクション
使用可能な
バージョン
Zone Search Result
Chatter アンサーのゾーン内の検索結果。
プロパティ
型
hasBestAnswer Boolean
説明
検索条件グ
ループと
バージョン
使用可能な
バージョン
検索結果に最良の回答が含まれているかどう Small、29.0
かを示します。
29.0
id
String
検索結果の ID。検索結果は、質問または記事 Small、29.0
になります。
29.0
title
String
検索結果のタイトル
Small、29.0
29.0
type
String
検索結果の種別。次のいずれかの値にしま
す。
Small、29.0
29.0
Small、29.0
29.0
• Article — 検索結果には記事のみが含ま
れます。
• Question — 検索結果には質問のみが含
まれます。
voteCount
String
検索結果への投票数
752
第8章
Chatter REST API の付録
この章には、付録資料があります。
このセクションの内容:
アクションリンクの表示ラベル
アクションリンクボタンには次の表示ラベルを使用します。
アクションリンクの表示ラベル
アクションリンクボタンには次の表示ラベルを使用します。
アクションリンクは、フィード要素上のボタンです。アクションリンクをクリックすると、ユーザを特定の
Web ページに移動したり、ファイルダウンロードを開始したり、Salesforce または外部サーバへの API コールを
呼び出したりできます。アクションリンクには、URL と HTTP メソッドが含まれ、リクエストボディとヘッダー
情報 (認証用の OAuth トークンなど) を含めることができます。アクションリンクを使用して Salesforce および
サードパーティサービスをフィードに統合することで、ユーザはアクションを実行して生産性を高め、イノ
ベーションを促進できます。
Action Link Definition Input リクエストボディの labelKey プロパティでキーを指定します。アクションリンクが
表示されるときに UI には、[新規]、[待機中]、[成功]、[失敗] 状態の表示ラベルが必要に応じて使用されます。
キー
新規
待機中
成功
失敗
Accept
Accept
Acceptance Pending
Accepted
Acceptance Failed
Activate
Activate
Activation Pending
Activated
Activation Failed
Add
Add
Add Pending
Added
Add Failed
Add to Calendar
Add to Calendar
Add to Calendar Pending Added to Calendar
Add to Calendar Failed
Add to Cart
Add to Cart
Add Pending
Added
Add Failed
Agree
Agree
Agree Pending
Agree
Agree Failed
Alert
Alert
Alert Pending
Alerted
Alert Failed
Answer
Answer
Answer Pending
Answered
Answer Failed
Approve
Approve
Approval Pending
Approved
Approval Failed
Assign
Assign
Assign Pending
Assigned
Assign Failed
Assist
Assist
Assistance Pending
Assisted
Assistance Failed
Attach
Attach
Attach Pending
Attached
Attach Failed
Authorize
Authorize
Authorization Pending
Authorized
Authorization Failed
753
Chatter REST API の付録
アクションリンクの表示ラベル
キー
新規
待機中
成功
失敗
Begin
Begin
Begin Pending
Started
Begin Failed
Book
Book
Book Pending
Booked
Book Failed
Buy
Buy
Buy Pending
Bought
Buy Failed
Call
Call
Call Pending
Called
Call Failed
Call Me
Call Me
Call Pending
Call Succeeded
Call Failed
Certify
Certify
Certifcation Pending
Certified
Certification Failed
Change
Change
Change Pending
Changed
Change Failed
Chat
Chat
Chat Pending
Chat Completed
Chat Failed
Check
Check
Check Pending
Checked
Check Failed
Clear
Clear
Clear Pending
Clear
Clear Failed
Clone
Clone
Clone Pending
Cloned
Clone Failed
Close
Close
Close Pending
Closed
Close Failed
Confirm
Confirm
Confirmation Pending
Confirmed
Confirmation Failed
Convert
Convert
Convert Pending
Converted
Convert Failed
Convert a Lead
Convert a Lead
Lead Conversion Pending Lead Converted
Lead Conversion Failed
Create
Create
Create Pending
Created
Create Failed
Deactivate
Deactivate
Deactivation Pending
Deactivated
Deactivation Failed
Decline
Decline
Decline Pending
Declined
Decline Failed
Delete
Delete
Delete Pending
Deleted
Delete Failed
Deny
Deny
Denial Pending
Denied
Denial Failed
Detach
Detach
Detach Pending
Detached
Detach Failed
Disagree
Disagree
Disagree Pending
Disagree
Disagree Failed
Dislike
Dislike
Dislike Pending
Disliked
Dislike Failed
Dismiss
Dismiss
Dismissal Pending
Dismissed
Dismissal Failed
Do
Do
Do Response Pending
Do
Do Response Failed
Donate
Donate
Donation Pending
Donated
Donation Failed
Down
Down
Down Response Pending Down
Down Response Failed
Download
Download
Download Pending
Downloaded
Download Failed
Edit
Edit
Edit Pending
Edited
Edit Failed
End
End
End Pending
Ended
End Failed
754
Chatter REST API の付録
アクションリンクの表示ラベル
キー
新規
待機中
成功
失敗
Endorse
Endorse
Endorsement Pending
Endorsed
Endorsement Failed
Enter
Enter
Enter Pending
Entered
Enter Failed
Escalate
Escalate
Escalation Pending
Escalated
Escalation Failed
Estimate
Estimate
Estimate Pending
Estimate
Estimate Failed
Exclude
Exclude
Exclude Pending
Excluded
Exclude Failed
Exit
Exit
Exit Pending
Exited
Exit Failed
Export
Export
Export Pending
Exported
Export Failed
File
File
File Pending
Filed
File Failed
Fill
Fill
Fill Pending
Filled
Fill Failed
Finish
Finish
Finish Pending
Finished
Finish Failed
Flag
Flag
Flag Pending
Flagged
Flag Failed
Flip
Flip
Flip Pending
Flipped
Flip Failed
Follow
Follow
Follow Pending
Followed
Follow Failed
Generate
Generate
Generate Pending
Generated
Generate Failed
Give
Give
Give Pending
Given
Give Failed
Help
Help
Help Pending
Helped
Help Failed
Hide
Hide
Hide Pending
Hidden
Hide Failed
High
High
High Response Pending
High
High Response Failed
Hold
Hold
Hold Pending
Hold Succeeded
Hold Failed
Import
Import
Import Pending
Imported
Import Failed
Include
Include
Include Pending
Included
Include Failed
Join
Join
Join Pending
Joined
Join Failed
Launch
Launch
Launch Pending
Launched
Launch Failed
Leave
Leave
Leave Pending
Left
Leave Failed
Like
Like
Like Pending
Liked
Like Failed
List
List
List Pending
Listed
List Failed
Log
Log
Log Pending
Logged
Log Failed
Log a Call
Log a Call
Log a Call Pending
Logged a Call
Log a Call Failed
Low
Low
Low Response Pending
Low
Low Response Failed
Mark
Mark
Mark Pending
Marked
Mark Failed
755
Chatter REST API の付録
アクションリンクの表示ラベル
キー
新規
待機中
成功
Maybe
Maybe
Maybe Response Pending Maybe
Maybe Response Failed
Medium
Medium
Medium Response
Pending
Medium
Medium Response Failed
Meet
Meet
Meet Pending
Meet
Meet Failed
Message
Message
Message Pending
Message
Message Failed
Move
Move
Move Pending
Moved
Move Failed
Negative
Negative
Negative Response
Pending
Negative
Negative Response Failed
New
New
New Pending
New
New Failed
No
No
No Response Pending
No
No Response Failed
OK
OK
OK Response Pending
OK
OK Response Failed
Open
Open
Open Pending
Opened
Open Failed
Order
Order
Order Pending
Ordered
Order Failed
Positive
Positive
Positive Response
Pending
Positive
Positive Response Failed
Post
Post
Post Pending
Posted
Post Failed
Post Review
Post Review
Post Pending
Posted
Post Failed
Process
Process
Process Pending
Processed
Process Failed
Provide
Provide
Provide Pending
Provided
Provide Failed
Purchase
Purchase
Purchase Pending
Purchased
Purchase Failed
Quote
Quote
Quote Pending
Quoted
Quote Failed
Receive
Receive
Receive Pending
Received
Receive Failed
Recommend
Recommend
Recommend Pending
Recommended
Recommend Failed
Redo
Redo
Redo Response Pending Redo
Redo Response Failed
Refresh
Refresh
Refresh Pending
Refreshed
Refresh Failed
Reject
Reject
Rejection Pending
Rejected
Rejection Failed
Release
Release
Release Pending
Released
Release Failed
Remind
Remind
Reminder Pending
Reminded
Reminder Failed
Remove
Remove
Removal Pending
Removed
Removal Failed
Repeat
Repeat
Repeat Pending
Repeated
Repeat Failed
Report
Report
Report Pending
Reported
Report Failed
756
失敗
Chatter REST API の付録
アクションリンクの表示ラベル
キー
新規
待機中
成功
失敗
Request
Request
Request Pending
Requested
Request Failed
Reserve
Reserve
Reservation Pending
Reserved
Reservation Failed
Resolve
Resolve
Resolve Pending
Resolved
Resolve Failed
Respond
Respond
Response Pending
Responded
Response Failed
Restore
Restore
Restore Pending
Restored
Restore Failed
Review
Review
Review Pending
Reviewed
Review Failed
Revise
Revise
Revision Pending
Revised
Revision Failed
Save
Save
Save Pending
Saved
Save Failed
Schedule
Schedule
Schedule Pending
Scheduled
Schedule Failed
Sell
Sell
Sell Pending
Sold
Sell Failed
Send
Send
Send Pending
Sent
Send Failed
Send Email
Send Email
Send Email Pending
Email Sent
Send Email Failed
Share
Share
Share Pending
Shared
Share Failed
Ship
Ship
Shipment Pending
Shipped
Shipment Failed
Show
Show
Show Pending
Shown
Show Failed
Start
Start
Start Pending
Started
Start Failed
Stop
Stop
Stop Pending
Stopped
Stop Failed
Submit
Submit
Submit Pending
Submitted
Submit Failed
Subscribe
Subscribe
Subscribe Pending
Subscribed
Subscribe Failed
Test
Test
Test Pending
Tested
Test Failed
Thank
Thank
Thanks Pending
Thanked
Thanks Failed
Unauthorize
Unauthorize
Unauthorization Pending Unauthorized
Unauthorization Failed
Uncheck
Uncheck
Uncheck Pending
Uncheck Failed
Undo
Undo
Undo Response Pending Undo
Undo Response Failed
Unflag
Unflag
Unflag Pending
Unflagged
Unflag Failed
Unfollow
Unfollow
Unfollow Pending
Unfollowed
Unfollow Failed
Unlike
Unlike
Unlike Pending
Unliked
Unlike Failed
Unmark
Unmark
Unmark Pending
Unmarked
Unmark Failed
Unsubscribe
Unsubscribe
Unsubscribe Pending
Unsubscribed
Unsubscribe Failed
Up
Up
Up Response Pending
Up
Up Response Failed
757
Unchecked
Chatter REST API の付録
アクションリンクの表示ラベル
キー
新規
待機中
成功
失敗
Update
Update
Update Pending
Updated
Update Failed
Validate
Validate
Validate Pending
Validated
Validate Failed
Verify
Verify
Verify Pending
Verified
Verify Failed
View
View
View Pending
Viewed
View Failed
Visit
Visit
Visit Pending
Visit Successful
Visit Failed
Yes
Yes
Yes Response Pending
Yes
Yes Response Failed
758

Salesforce お客様事例株式会社ブレス様

株式会社イトーキ様

社内にTwitterがやってくる Yah!Yah!Yah!

社内にTwitterがやってくる Yah!Yah!Yah!

グレード1 SN/CF 5W-40

メタデータ、人工知能を活用した 意味解析技術

テクニカルレポートデータ(PDF形式、1624kバイト)

ソフトウェア演習Ⅲ〔課題 1：文字列処理〕 担当：青野雅樹

PDF版（182KB）

OPJ-A1200PEH・N-V仕様書