Chatter REST API 開発者ガイドresources.docs.salesforce.com/198/0/ja-jp/sfdc/pdf/sales...第 1 章: Chatter REST API の概要. . . . . . . . . . . . . . . . . . . . . . .

Chatter REST API 開発者ガイドバージョン 35.0, Winter ’16

@salesforcedocs最終更新日: 2015/9/1

https://twitter.com/salesforcedocs

© Copyright 2000–2015 salesforce.com, inc. All rights reserved. Salesforce およびその他の名称や商標は、salesforce.com,

inc. の登録商標です。本ドキュメントに記載されたその他の商標は、各社に所有権があります。

目次

第 1 章: Chatter REST API の概要 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Chatter REST API を使用するケースの決定 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2Chatter REST API アーキテクチャ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3Chatter REST API リソース URL の作成 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5HTTP 要求の送信 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6Chatter REST API 要求および応答について . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6Chatter REST API 入力の使用 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13ワイルドカード . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28応答サイズの指定 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

filterGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30exclude . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32include . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

レスポンスボディの符号化 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38状況コードとエラー応答 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39OAuth と Chatter REST API について . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Web サーバ OAuth 認証フローについて . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43ユーザエージェント OAuth 認証フローについて . . . . . . . . . . . . . . . . . . . . . . . . . . 48トークンの使用 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52HTML からの静的アセットの直接要求およびフォーム要求の直接投稿 . . . . . . . . . . 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 に接続する . . . . . . . . . . . . . . . . . . . . . . . 58Salesforce Communities への接続 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

第 3 章: Chatter REST API の機能 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

アクションリンクの使用 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62アクションリンクの使用事例 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64アクションリンクの概要、認証、およびセキュリティ . . . . . . . . . . . . . . . . . . . . . 66アクションリンクテンプレート . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

コミュニティの使用 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90フィードおよびフィード要素の使用 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92Salesforce 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 リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140Action Link Group Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141Action Link Group Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146Action Link Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147Action Link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147

目次

Action Link Diagnostic Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151Announcements リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151Batch リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153Chatter リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162Comments リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163Communities リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165Communities Moderation リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167Connect リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175Dashboard Component Snapshot リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176Datacloud リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178

Datacloud Company Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179Datacloud Contact Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179Datacloud OrderId Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180Datacloud Company Order Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180Datacloud Contact Order Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181Datacloud Orders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182Datacloud Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183

Feed Elements リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184Feed Elements, Post and Search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186Feed Elements, Batch Post . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189Feed Elements, Batch Get . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195Feed Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195Feed Element Capabilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196Feed Elements Capability, Approval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197Feed Elements Capability, Associated Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197Feed Elements Capability, Banner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198Feed Elements Capability, Bookmarks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198Feed Elements Capability, Bundle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199Feed Elements Capability, Bundle Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200Feed Elements Capability, Canvas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201Feed Elements Capability, Case Comment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202Feed Elements Capability, Chatter Likes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202Feed Elements Capability, Chatter Likes Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203Feed Elements Capability, Comments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203Feed Elements Capability, Comments Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204Feed Elements Capability, Content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205Feed Elements Capability, Dashboard Component Snapshot . . . . . . . . . . . . . . . . . . . 206Feed Elements Capability, Editability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206Feed Elements Capability, Email Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207Feed Elements Capability, Enhanced Link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207Feed Elements Capability, Link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208Feed Elements Capability, Moderation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208Feed Elements Capability, Origin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210Feed Elements Capability, Poll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210

目次

Feed Elements Capability, Question and Answers . . . . . . . . . . . . . . . . . . . . . . . . . . . 211Feed Elements Capability, Recommendations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213Feed Elements Capability, Record Snapshot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213Feed Elements Capability, Topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214Feed Elements Capability, Tracked Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216

Feed Items リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216Feed-Items Batch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216Feed-Items Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217Feed-Items, Specific Feed Item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218Feed Items Comments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219Feed-Items Likes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221Feed-Items Polls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222Feed-Items Topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223

Feed リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225Bookmarks Feed リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226Communities Home Feed リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233Communities Moderation Feed リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235Company Feed リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239Favorites Feed リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245Feeds リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252Files Feed リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252Filter Feed リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259Groups Feed リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267News Feed リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274People Feed リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300Record Feed リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307To Feed リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329Topics Feed リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336User Profile Feed リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339

Files Connect Repository リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359Files Connect Repository List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360Files Connect リポジトリ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361Files Connect Repository File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361Files Connect Repository File Content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 362Files Connect Repository Folder Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 362

Files リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363File Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364File Content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367File Shares . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367Files Shares Link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370File Rendition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370File Information, Batch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371

Folders リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372Groups リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 376

目次

List of Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 377Group Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 381Batch Group Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 386Group Announcements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387Group Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 389Group Members . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390Group Members—Private . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393Group Membership Requests—Private . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398Group Memberships リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 400Group Photo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 404Group Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 407Group Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 408Group Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 409Group Topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410

Influence リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 411Likes リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412Managed Topics リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412

Managed Topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 413Managed Topic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 418

Mentions リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419Mentions Completions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419Mentions Validations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 422

Motifs リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423Push Notifications リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 425Question and Answers Suggestions リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427おすすめ定義リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428

Recommendation Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428Recommendation Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 430Recommendation Definition Photo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 432

Records リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 435Followers on Records リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 435Topics on Records リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 436

スケジュール済みおすすめリソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 438スケジュール済みおすすめ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 438スケジュール済みおすすめ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 441

Subscriptions リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 445Topics リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 445

List of Topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 446Topics Suggestions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448Trending Topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 449Topic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 451Topics, Endorse People . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454Topic Endorsements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455Topic Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456

目次

Topic Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 459Topics, Knowledgeable People List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460Related Topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460Topics, Opt Outs from Knowledgeable People List . . . . . . . . . . . . . . . . . . . . . . . . . . . 461Topics, Opt Out from Knowledgeable People List . . . . . . . . . . . . . . . . . . . . . . . . . . . 461

User Profiles リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462Users リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463

User Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 465User Profile Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466Batch User Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 468User Conversations, General . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 469User Conversations, Specific . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 470Change Status of Conversations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 472Get Unread Count for Conversations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 473Users Files, General . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 473User Files, Filtered by Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 477User Files, Filtered by Sharing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 478User Followers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 479Following . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480User Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 482Topics a User is Knowledgeable About . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 483User Messages, General . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 484User Messages, Specific . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495User Photo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495User Recommendations, General . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 499User Recommendations for a Specific Action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 501User Recommendations for a Specific Action and Object Category . . . . . . . . . . . . . . . 503User Recommendations for a Specific Action and Key Prefix . . . . . . . . . . . . . . . . . . . 506User Recommendations for a Specific Action and Object ID . . . . . . . . . . . . . . . . . . . . 509User Recommendations for a Specific Action and Object Type . . . . . . . . . . . . . . . . . . 510User Reputation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 510User Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 511User Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 512Topics Recently Used . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 513

Zones リソース . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 513List of Zones . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 514Zone Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 514Zone Search Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 515

第 6 章: Chatter REST API リクエストボディ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 516

Action Link Definition Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 516Action Link Group Definition Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 522Action Link Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 526Action Link Template Binding Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 527

目次

Announcement Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 528Associated Actions Capability Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 529Attachment Input: Canvas App . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 530Attachment Input: Existing Content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 531Attachment Input: Feed Poll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 532Attachment Input: Link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 533Attachment Input: New File Upload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 534Batch Collection Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 535Batch Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 536Bookmarks Capability Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 539Canvas Capability Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 539Comment Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 540Comment Capabilities Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 541Content Capability Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 542Datacloud Order Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 542Dashboard Component Snapshot Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 544Feed Element Capabilities Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 545Feed Favorite Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 547Feed Item Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 548Feed Item Topic Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 554Feed Poll Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 554File Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 555File Shares Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 556Folder Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 557Folder Item Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 557Following Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 558Generic Batch Collection Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 559Generic Batch Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 560Group Chatter Settings Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 563Group Information Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 563Group Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 564Group Member Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 566Group Membership Request Update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 567Group Record Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 567Link Capability Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 568Managed Topic Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 568Managed Topic Position Collection Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 570Managed Topic Position Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 572Message Body Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 572Message Segment Input: Hash Tag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 573Message Segment Input: Link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 573Message Segment Input: Mention . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 574Message Segment Input: Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 574Moderation Flag Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 574

目次

Photo Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 575Poll Capability Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 576Push Notification Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 577Question and Answers Capability Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 578Recommendation Definition Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 579Request Header Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 580Scheduled Recommendation Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 581Share Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 583Topic Assignment Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 583Topic Endorsement Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 584Topic Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 584User Chatter Settings Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 585User Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 586User Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 587User Message Recipient Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 588User Message Recipient List Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 588User Status Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 589User Stream (Conversation) Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 589

第 7 章: Chatter REST API レスポンスボディ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 590

Action Link Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 590Action Link Diagnostic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 594Action Link Group Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 594Address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 596Announcement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 596Announcement Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 597Approval Capability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 598Approval Post Template Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 598Article Item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 599Associated Actions Capability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 599Banner Capability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 599Batch Result Item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 600Batch Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 601Bookmarks Capability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 601Case Comment Capability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 602Canvas Capability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 603Chatter Activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 604Chatter Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 604Chatter Influence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 605Chatter Likes Capability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 605ClientInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 605Comment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 606Comment Capabilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 607Comment Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 608

目次

Comments Capability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 608Community . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 609Community Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 610Connect Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 610Content Capability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 611Conversation Detail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 613Conversation Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 613Conversation Summary Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 613Conversation Unread Count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 614Dashboard Component Snapshot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 614Dashboard Component Snapshot Capability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 615Datacloud Company . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 615Datacloud Company Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 617Datacloud Contact . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 618Datacloud Contact Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 619Datacloud Order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 620Datacloud Purchase Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 620Edit Capability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 620Email Address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 621Email Message Capability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 622Enhanced Link Capability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 622Error Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 623Error with Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 623Explanation Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 623Explanation Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 625Favorite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 627Favorites Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 628Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 628Feed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 630Feed Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 631Feed Directory Item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 631Feed Element Capabilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 633Feed Element Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 636Feed Entity Is Editable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 638Feed Item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 638Feed Item Attachment: Approval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 647Feed Item Attachment: Basic Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 648Feed Item Attachment: Canvas Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 648Feed Item Attachment: Case Comment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 649Feed Item Attachment: Content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 651Feed Item Attachment: Dashboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 653Feed Item Attachment: Email Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 654Feed Item Attachment: Link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 654Feed Item Attachment: Poll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 655

目次

Feed Item Attachment: Record Snapshot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 655Feed Item Attachment: Tracked Change . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 655Feed Item Body . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 656Feed Item Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 656Feed Item Preamble Message Body . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 657Feed Items Topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 658Feed Modified Info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 658Feed Poll Choice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 659Feed Tracked Change . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 659File Detail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 659File Share Link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 660File Shares Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 661File Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 661File Summary Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 665Files Connect Provider Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 666Files Connect リポジトリ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 666Files Connect Repository Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 667Files Connect Repository Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 668Flat Feed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 668Flat Feed Item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 669Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 669Folder Item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 670Folder Item Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 670Follower Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 671Following Counts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 671Following Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 672Generic Bundle Capability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 672汎用フィード要素 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 673Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 675Group Chatter Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 677Group Detail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 677Group Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 680Group Member . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 680Group Member Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 680Group Membership Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 681Group Membership Request Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 682Group Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 682Group Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 682Group Record Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 683Icon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 683Influence Thresholds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 684Knowledgeable People . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 684Knowledgeable People Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 685Like . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 685

目次

Like Message Body . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 686Like Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 686Link Capability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 687List View Column . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 687List View Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 687List View Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 688List View Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 688List View Sort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 689Maintenance Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 690Managed Topic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 691Managed Topic Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 692Mention Completion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 692Mention Completion Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 693Mention Validation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 693Mention Validations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 694Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 695Message Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 696Message Segment: Entity Link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 696Message Segment: Field Change . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 696Message Segment: Field Change Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 697Message Segment: Field Change Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 698Message Segment: Hashtag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 698Message Segment: Link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 699Message Segment: Mention . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 699Message Segment: More Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 700Message Segment: Resource Link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 701Message Segment: Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 701Moderation Capability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 701Moderation Flags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 702Motif . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 702Non-Entity Recommendation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 704Organization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 705Origin Capability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 705Phone Number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 706Photo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 707Platform Action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 707Platform Action Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 711Poll Capability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 713Question and Answers Capability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 713Question and Answers Suggestion Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 713Recommendation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 714Recommendation Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 715Recommendation Definition Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 716Recommendations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 716

目次

Recommendations Capability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 716Recommended Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 717Record Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 717Record Field: Blank . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 718Record Field: Compound . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 718Record Field: Currency . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 719Record Field: Date . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 720Record Field: Percent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 720Record Field: Picklist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 721Record Field: Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 721Record Field: Reference with Date . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 722Record Snapshot Capability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 723Record Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 723Record Summary List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 723Record View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 724Record View Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 725Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 726Repository File Detail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 726Repository File Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 726Repository Folder Item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 727Repository Folder Items Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728Repository Folder Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728評価 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 729Reputation Level . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 729Request Header . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 730スケジュール済みおすすめ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 730Scheduled Recommendation Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 731Shares . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 731Subscription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 732Subscription Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 733Time Zone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 733Topic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 733Topic Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 734Topic Endorsement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 734Topic Endorsement Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 735Topic Images . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 735Topic Opt Out . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 736Topic Opt Out Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 736Topic Suggestion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 737Topic Suggestion Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 737Topics Capability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 737Topics People Are Knowledgeable About . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 737Topics People Are Knowledgeable About Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . 738Tracked Change Bundle Capability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 739

目次

Tracked Changes Capability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 739Unauthenticated User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 740User Capabilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 740User Chatter Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 741User Detail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 741User Group Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 744User Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 745User Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 745User Profile Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 745User Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 746User Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 748User Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 748Zone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 750Zone Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 751Zone Search Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 751Zone Search Result . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 752

第 8 章: Chatter REST API の付録 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 753

アクションリンクの表示ラベル . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 753

目次

第 1 章 Chatter REST API の概要

エディション

使用可能なエディション:Personal Edition を除くすべてのエディション。さらに、一部の機能では、組織で Chatter が有効になっている必要があります。

特にモバイルアプリケーションで、Salesforceデータを表示するには、Chatter REST API を使用します。Chatter

REST API 応答は、表示用にローカライズおよび構造化されます。アプリケーションに必要な応答のみが含まれるように、応答を絞り込むことができます。また、Chatterフィード、ユーザ、グループ、フォロワーに加え、Chatter REST APIでは、ファイル、おすすめ情報、トピック、通知、Data.com の購入などにプログラムを介してアクセスすることもできます。Chatter REST APIは、Facebook や Twitter などのフィードを提供する他の企業から公開されている API に似ていますが、Chatter 以外の Salesforce 機能も公開されます。

トピック:

• 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 へのアクセス

1

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 ApexConnectApi 名前空間の 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 の概要

http://tools.ietf.org/html/draft-ietf-oauth-v2-10

http://www.iso.org/iso/catalogue_detail?csnumber=40874

戻り値の形式を指定するには、.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 を使用して相互に連結されるため、クライアントはステート間を移動して処理を行うことができます。

統一されたインターフェースすべてのリソースには、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 リソース URL の作成Chatter REST API の概要

デフォルトのコミュニティのリソースにアクセスする場合は、/chatter リソース(/connect/communities/internal なし) を直接使用することもできます。レスポンスボディの URL には、/connect/communities/internal は含まれません。さらに、組織のコミュニティのカスタム URL を使用して、コミュニティ内のリソースにアクセスすることも可能です。次に例を示します。https://communitydomain.force.com/communitypath/services/data/v34.0/connect


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

HTTP 要求の送信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) など、他のレスポンスボディも含まれています。

使用可能なバージョン

検索条件グループとバージョン

説明型プロパティ

23.0Big、29.0ユーザのプロファイルから取得したテキストStringaboutMe

30.0Small、30.0ユーザの追加表示ラベル。たとえば、「顧客」、「パートナー」、「Acme Corporation」

StringadditionalLabel

などがあります。ユーザに追加表示ラベルがない場合、値は null です。

23.0Big、29.0住所Addressaddress

23.0Big、29.0Chatter 活動統計Chatter ActivitychatterActivity

23.0Big、29.0ユーザの影響度ランクChatter InfluencechatterInfluence

32.0Medium、32.0コミュニティでのユーザのニックネームStringcommunityNickname

23.0Small、29.0会社名StringcompanyName

23.0 ～ 25.0User StatuscurrentStatusメモ: このプロパティは、バージョン25.0 以降、使用できなくなります。

ユーザの現在の状況32.0Small、32.0コミュニティで表示されるユーザの名前。

ニックネームが有効な場合は、ニックネームStringdisplayName

7

Chatter REST API 要求および応答についてChatter REST API の概要




が表示されます。ニックネームが有効ではない場合は、氏名が表示されます。

23.0Medium、29.0ユーザのメールアドレスStringemail

23.0Small、29.0ユーザの名StringfirstName

23.0Big、29.0このユーザをフォローしているユーザの数IntegerfollowersCount

23.0Big、29.0ユーザがフォローしている項目に関する情報Following CountsfollowingCounts

23.0Big、29.0ユーザがフォローしているグループの数IntegergroupCount

31.0Small、31.0ユーザに Chatter へのアクセス権がある場合は true、それ以外の場合は false

BooleanhasChatter

23.0Small、29.0ユーザの 18 文字の IDStringid

23.0Small、29.0ユーザが有効な場合は true、それ以外の場合は false

BooleanisActive

23.0 ～ 25.0BooleanisChatterGuestメモ: このプロパティは、バージョン26.0 以降、使用できなくなります。代わりに、userType プロパティを使用してください。

ユーザがChatter顧客の場合は true、それ以外の場合は false

28.0Small、29.0ユーザがコンテキストユーザと同じコミュニティに含まれる場合は true、それ以外の場

BooleanisInThisCommunity

合は false。範囲が「すべてのユーザ」の投稿に対するレコードフィードの @メンションの場合、false になることがあります。

23.0Small、29.0ユーザの姓StringlastName

23.0Big、29.0ユーザのマネージャの 18 文字の IDStringmanagerId

23.0Big、29.0ロケールに基づいて連結されたマネージャの姓と名

StringmanagerName

27.0Small、29.0オブジェクトがユーザであることを示す小、中、大のアイコン。motif にはオブジェクトのベース色を含めることもできます。motif アイコンは、ユーザのプロファイル写真ではありません。

Motifmotif

8





23.0Medium、29.0コンテキストユーザがこのユーザをフォローしている場合は、登録に関する情報が含まれ

ReferencemySubscription

ます。それ以外の場合は、null を返します。

23.0Small、29.0ロケールに基づいて連結されたユーザの姓と名

Stringname

23.0Big、29.0ユーザの電話番号のコレクションPhone Number[]phoneNumbers

23.0Small、29.0ユーザの写真に関する情報Photophoto

32.0Big、32.0コミュニティでのユーザの評価。コミュニティで実行したイベントやアクションを基に獲得したポイント数によって判断されます。

評価reputation

29.0Big、29.0ユーザが受け取った感謝の数。IntegerthanksReceived

23.0Small、29.0ユーザの役職Stringtitle

23.0Small、29.0UserStringtype

23.0Small、29.0ユーザの Chatter プロファイルへの URLStringurl

24.0Small、29.0ユーザのユーザ名 ([email protected]

など)

Stringusername

26.0Medium、29.0ユーザの種別を指定します。有効な値は、次のとおりです。

StringuserType

• ChatterGuest — 非公開グループの外部ユーザ。

• ChatterOnly — Chatter Free ユーザ。• Guest — 認証されていないユーザ。• Internal — 標準組織メンバー。• Portal — カスタマーポータル、パート

ナーポータル、またはコミュニティの外部ユーザ。

• System — Chatter Expert またはシステムユーザ。

• Undefined — カスタムオブジェクトのユーザ種別

9


JSON 形式では、出力は次のようになります。{

"aboutMe": "I'm excited to be part of the team focused on building out our appsbusiness

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


"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


}],

"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 入力の使用

入力での 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 ヘッダー

投稿またはコメントのリクエストボディ。JSON の場合は、nameの値に "json"を使用します。

form-data; name="json"

form-data; name="xml"

Content-Disposition

XML の場合は、nameの値に "xml"を使用します。

13

Chatter REST API 入力の使用Chatter REST API の概要

http://www.w3.org/TR/html401/interact/forms.html#h-17.13.4.2

http://tools.ietf.org/html/rfc2388

説明ヘッダー値とパラメータリッチ入力ボディパートの HTTP ヘッダー

リクエストボディのデータ形式と文字セット。JSON の場合、値は application/jsonにする必要があります。

application/json; charset=UTF-8

application/xml; charset=UTF-8

Content-Type

XML の場合、値は application/xml にする必要があります。

ヒント: Web ブラウザは通常、非バイナリパート (リッチ入力ボディなど) に独自の Content-Type があると、マルチパートの要求を実行することができません。この問題を回避するには、特定のContent-Disposition name を指定して、Salesforce がリッチ入力パートの Content-Type を読み取れるようにします (リッチ入力ボディに Content-Type を指定する必要はありません)。

次の表では、Web ブラウザからのマルチパート/フォームデータ要求のリッチ入力ボディパートに必要な HTTP

ヘッダーとパラメータについて説明します。

説明ヘッダー値とパラメータWeb ブラウザからのリッチ入力ボディパートのHTTP ヘッダー

バイナリファイルを含むフィード要素を投稿するには、name の値を"feedElement"にする必要があります。バイナリファイルを含むコメントを投稿するには、name の値を "comment" にする必要があります。

form-data; name="feedElement"

form-data; name="comment"

form-data; name="photo"

form-data; name="file"

Content-Disposition

ユーザまたはグループの写真を投稿するには、name の値を "photo" にする必要があります。[ファイル] リストにファイルを投稿するには、nameの値を "file"にする必要があります。

次の表では、マルチパート/フォームデータ要求のバイナリアップロードボディパートに必要な HTTP ヘッダーとパラメータを説明します。

14


説明ヘッダー値とパラメータバイナリアップロードボディパートの HTTP ヘッダー

バイナリ添付ファイルを含むフィード要素を投稿するには、name の値を

form-data;name="feedElementFileUpload";filename=string

form-data;name=name="feedElementFileUpload";filename=string

Content-Disposition

"feedElementFileUpload"にする必要があります。バイナリファイルを含むコメントを投稿するには、name の値を

form-data; name="fileUpload"filename=string

"feedElementFileUpload"にする必要があります。

form-data; name="fileData"filename=string

ユーザまたはグループの写真を投稿するには、name の値を "fileUpload" にする必要があります。[ファイル] リストにファイルを投稿するには、nameの値を "fileData"にする必要があります。

メモ: filename パラメータと値を指定する必要があります。ただし、Chatter は、Content Capability Input のtitleプロパティの値を filename

パラメータの値ではなく、ファイル名として使用します。

バイナリファイルのメディアタイプと文字セット。

application/octet-stream;charset=ISO-8859-1

Content-Type

メモ: 空白と改行 (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


-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


"title":"receipt.pdf"

}

},

"feedElementType":"FeedItem",

"subjectId":"005RR000000DmOb"

}


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":"PostNumber 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


以下に、上記の例を、リクエストボディパートが確認できる形式に変えた例を示します。POST /services/data/v34.0/chatter/feed-elements/batch HTTP/1.1



Host: instance_name

Content-Length: 845






{

"inputs": [

{

"binaryPartNames": [

"bin1"

],

"richInput": {

"subjectId": "me",

"body": {

"messageSegments": [

{

"type": "Text",

"text": "Please accept this receipt"

}

]

18


},

"capabilities": {

"content": {

"description": "Receipt for expenses",

"title": "receipt.pdf"

}

},

"feedElementType": "FeedItem"

}

},

{


"bin2"

],

"richInput": {

"subjectId": "me",

"body": {


{

"type": "Text",

"text": "Post Number 2"

}

]

},

"capabilities": {

"content": {


19


"title": "receipt2.pdf"

}

},


}

}

]

}


Content-Disposition: form-data; name="bin1"; filename="receipt.pdf"




Content-Disposition: form-data; name="bin2"; filename="receipt2.pdf"


...contents of receipt2.pdf...


メモ: binaryPartNamesプロパティ内のバイナリパート名は、バイナリリクエストパートの nameプロパティ内のバイナリパート名と一致する必要があります。

20


バイナリファイルを含むコメントの投稿次の例では、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 POSThttps://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/itemsHTTP/1.1

Authorization: OAuth00DD0000000Jhd2!AQIAQC.lh4qTQcBhOPm4TZom5IaOOZLVPVK4wI_rPYJvmE8r2VW8XA.

OZ7S29JEM_7Ctq1lst2dzoV.owisJc0KacUbDxyae



Host: instance_name

Content-Length: 978

Content-Type: multipart/form-data; boundary=F9jBDELnfBLAVmLNbnLIYibT5Icp0h3VJ7mkI

--F9jBDELnfBLAVmLNbnLIYibT5Icp0h3VJ7mkI



{

"body":{

"messageSegments":[

21


{

"type":"Text",

"text":"Here's another receipt."

}

]

},

"capabilities":{

"content":{

"title":"receipt2"

}

}

}

--F9jBDELnfBLAVmLNbnLIYibT5Icp0h3VJ7mkI

Content-Disposition: form-data; name="feedElementFileUpload"; filename="receipt2.txt"


...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


"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",


"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!...


Host: instance_name

Content-Type: multipart/form-data; boundary=123123

--123123


Content-Type: application/json

{

"haltOnError":true,

"batchRequests":[

23


{

"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",



24


"richInput":{

"body":{

"messageSegments":[

{

"type":"Text",


}

]

},

"capabilities":{

"content":{


}

}

}

}

]

}

--123123

Content-Disposition: form-data; name="binaryPart1"; filename="Presentation1.txt"


Content-Transfer-Encoding: binary

This is the content of file 1

--123123

25






--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




Host: instance_name

Content-Length: 543






26


{

"cropX" : "0",

"cropY" : "0",

"cropSize" : "200"

}


Content-Disposition: form-data; name="fileUpload"; filename="myPhoto.jpg"


...contents of myPhoto.jpg...


[ファイル] リストへのファイルの投稿次の例では、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




Host: instance_name

Content-Length: 489

27







{

"title":"BoatPrices"

}


Content-Disposition: form-data; name="fileData"; filename="BoatPrices.txt"


...contents of BoatPrices.txt...


ワイルドカード

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

要求 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

filterGroupChatter REST API の概要

要求 (またはサブ要求) に filterGroup と include の両方のパラメータがあると、include パラメータで指定されたプロパティが常に応答に含まれます。要求 (またはサブ要求) に filterGroup と exclude の両方のパラメータがあると、exclude パラメータで指定されたプロパティが常に応答から除外されます。次の表の行を左から右に読んでいき、応答にプロパティが含まれているかどうかを確認します。

応答にプロパティがある

要求のfilterGroup

にプロパティがある

要求にfilterGroup

がある

要求のexclude 条件にプロパティがある

要求にexclude 条件がある

要求のinclude 条件にプロパティがある

要求にinclude 条件がある

いいえいいえいいえいいえいいえいいえはい

はいはい/いいえはい/いいえいいえいいえはいはい

はいいいえいいえいいえはいいいえいいえ

いいえいいえはいいいえはいいいえいいえ

いいえはい/いいえはい/いいえはいはいいいえいいえ

いいえいいえはいいいえいいえいいえいいえ

はいはいはいいいえいいえいいえいいえ

エラー (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

filterGroupChatter REST API の概要

"color": "1797C0",




},

"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",


},

"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

excludeChatter REST API の概要

絞り込み後の出力Exclude の値元の出力説明

エラーコードINVALID_FILTER_VALUE の 400

エラー

exclude=bar{

"bar" : "bar value",

プロパティ名の前にスラッシュ (/) を含めないと、要求からエラーが返されます。 "baz" : "baz value"

}

{exclude=/bar

{プロパティを名前で絞り込みます。

"baz" : "baz"bar" : "bar value",

value""baz" : "baz value"

}}

<foo>exclude=/foo

<foo>最上位レベルのプロパティは絞り込みできません。こ <bar>bar value<bar>bar value</bar>

のクエリ文字列は</bar><baz>baz value</baz>エラーを返しませ

ん。 <baz>baz value</foo>

</baz>

</foo>

{exclude=/foo%7C/bar

{複数のプロパティを絞り込むには、バー (|) 区切り文字 "baz" : "baz"foo" : "foo value",

を使用します。URLvalue""bar" : "bar value",は、区切り文字を}"baz" : "baz value"

}

%7C として符号化します。

<foo>exclude=/someObject

<foo>レスポンスボディの絞り込みでは、レスポンスボディ <bar>bar value<bar>bar value</bar>

内のすべてが絞り込まれます。 </bar><baz>baz value</baz>

<baz>baz value<someObject>

</baz>sub 1

33



</someObject> </foo>

</foo>

<foo>exclude=/someObject/sub

<foo>レスポンスボディ内でネストされたプロパティを絞り <bar>bar value<bar>bar value</bar>

込むには、親レス</bar><baz>baz value</baz>ポンスボディの名

前を条件セグメン <baz>baz value<someObject>トとして含めます。 </baz>sub value

<someObject></someObject>

</foo> </someObject>

</foo>

<foo>exclude=/someList/item/id

<foo>リスト内の項目は、プロパティ名で識別します。こ <bar>bar value<bar>bar valu</bar>

の例では XML を使用します。 </bar><baz>baz value</baz>

<baz>baz value<someList>

</baz><item>

<someList><id>1</id>

<item/></item>

<item/><item>

<item/><id>2</id>

</someList></item>

</foo><item>

<id>3</id>

</item>

</someList>

</foo>

34



{exclude=/someList/item/id

{リスト内の項目は、プロパティ名で識別します。こ "bar" : "bar value","bar" : "bar value",

の例では JSON を使用します。 "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 の値元の出力説明

エラーコードINVALID_FILTER_VALUE

の 400 エラー

include=bar{


プロパティ名の前にスラッシュ (/) を含めないと、要求

35

includeChatter REST API の概要


からエラーが返されます。

"baz" : "baz value"

}

{include=/bar

{プロパティを名前で絞り込みます。

"bar" : "bar"bar" : "bar value",

value","baz" : "baz value"

}}

<foo>include=/foo

<foo>最上位レベルのプロパティは無視されます。この操作 <bar>bar value<bar>bar value</bar>

を行っても、エ</bar><baz>baz value</baz>ラーにはなりませ

ん。 <baz>baz value</foo>

</baz>

</foo>

{include=/foo%7C/bar

{複数のプロパティを絞り込むには、バー (|) 区切り文字 "foo" : "foo"foo" : "foo value",

を使用します。URLvalue","bar" : "bar value",は、区切り文字を

%7C として符号化します。

"bar" : "bar

value",

"baz" : "baz value"

}

}

<foo>include=/someObject

<foo>レスポンスボディの絞り込みでは、その下にあるすべ <someObject><bar>bar value</bar>

てのものが絞り込まれます。 sub 1<baz>baz value</baz>

<someObject>

</someObject>sub 1

</foo></someObject>

36



</foo>

<foo>include=/someObject/sub

<foo>レスポンスボディ内でネストされたプロパティを絞り <someObject><bar>bar value</bar>

込むには、親レスsub 1<baz>baz value</baz>ポンスボディの名

前を条件セグメン <someObject>トとして含めます。 </someObject>

</foo>

sub value

</someObject>

</foo>

<foo>include=/someList/item/id

<foo>リスト内の項目は、プロパティ名で識別します。こ <someList><bar>bar valu</bar>

の例では XML を使用します。 <item><baz>baz value</baz>

<id>1</id><someList>

</item><item>

<item><id>1</id>

<id>2</id></item>

</item><item>

<item><id>2</id>

<id>3</id></item>

</item><item>

</someList><id>3</id>

</foo></item>

</someList>

</foo>

{include=/someList/item/id

{リスト内の項目は、プロパティ名

37



で識別します。この例では JSON を使用します。

"someList" : [

{


"baz" : "baz value",

"id" : "1""someList" : [

},{

{"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 の概要

https://www.owasp.org/index.php/XSS_%28Cross_Site_Scripting%29_Prevention_Cheat_Sheet

https://www.owasp.org/index.php/XSS_%28Cross_Site_Scripting%29_Prevention_Cheat_Sheet

エスケープ文字文字

<<

>>

""

''

\\

&&

ネイティブのモバイルアプリケーションなど、非 HTML コンテキストの場合、Chatter REST APIクライアントが、要求内の X-Chatter-Entity-Encoding HTTP ヘッダーを false に設定して、未加工 (符号化されていない)

の出力を要求する場合があります。Chatter REST API は、応答ペイロードに含まれる URL 値に特殊な符号化を行います。URL の主部分は、RFC2396 に従って URL 符号化され、クエリ文字列は HTML 形式で符号化されます。この符号化は無効にできません。

状況コードとエラー応答

エラーが発生した場合、または応答が正常な場合、応答ヘッダーには HTTP コードが含まれ、レスポンスボディには通常 HTTP 応答コード、そのエラーに付随するメッセージ、必要に応じてエラーが発生した項目またはオブジェクトが含まれます。

説明HTTP 応答コード

GET、PATCH、または HEAD 要求が成功しました200

POST 要求が成功しました201

DELETE が成功しました204

要求を理解できませんでした。通常は、特定のリソースに対して無効な ID が使用されていることが原因です。たとえば、groupIdが要求される場合に userIdを使用すると、要求は 400 を返します。

400

セッション ID または OAuth トークンが期限切れか無効です。または、要求がゲストユーザによって行われた場合、ゲストユーザはこのリソースにアクセスできません。レスポンスボディに message および errorCode が含まれます。

401

要求が却下されました。コンテキストユーザに要求されたデータへの適切なアクセス権限があること、またはコンテキストユーザが外部ユーザではないことを確認してください。

403

指定されたリソースが見つからなかったか、リソースがすでに削除されています。404

競合が発生しました。たとえば、グループへの参加要求を更新しようとしたら、その要求がすでに承認または却下されていた場合などに発生するエラーです。

409

39

状況コードとエラー応答Chatter REST API の概要

https://www.ietf.org/rfc/rfc2396.txt


前提処理が失敗しました。たとえば、バッチ要求で haltOnError が true に設定され、サブ要求が失敗した場合、後続のサブ要求は 412 を返します。

412

Force.com 内でエラーが発生したため、要求を完了できませんでした。Salesforce カスタマーサポートにお問い合わせください。

500

1 時間あたりの要求数を超えています。503

例この要求ではコメント 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

OAuth と Chatter REST API についてChatter REST API の概要

http://tools.ietf.org/html/draft-ietf-oauth-v2-10

接続アプリケーション定義の作成例については、「ステップ 2: 認証を設定する」 (ページ 57)を参照してください。接続アプリケーションの作成および使用時の考慮事項• 接続アプリケーション定義で使用されるラベルと OAuth 用語は次のように対応付けられます。

説明OAuth 用語接続アプリケーションのラベル

Salesforce に対してアプリケーションを識別する一意の識別子。

client_idコンシューマ鍵

アプリケーションに関連付けられた秘密鍵。

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


• リソースへのアクセス権を付与するかどうかはリソース所有者次第です。このコンテキストでは、システム管理者 (ユーザと接続アプリケーションを管理する) とユーザ (サードパーティアプリケーションにログインしてアクセス権を付与する) を合わせたものがリソース所有者です。

• アプリケーションがリソースにアクセスする場合、リソース所有者からの認証が要求されます。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


https://resources.docs.salesforce.com/198/latest/en-us/sfdc/pdf/salesforce_communities_implementation.pdf

https://developer.salesforce.com/page/Chatter_API

https://developer.salesforce.com/page/Getting_Started_with_the_Force.com_REST_API

https://developer.salesforce.com/page/Digging_Deeper_into_OAuth_2.0_on_Force.com

https://developer.salesforce.com/page/Using_OAuth_to_Authorize_External_Applications

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

Web サーバ OAuth 認証フローについてChatter REST API の概要

https://github.com/developerforce/Force.com-JavaScript-REST-Toolkit/

https://github.com/intridea/omniauth/wiki

https://cwiki.apache.org/confluence/display/AMBER/OAuth+2.0+Client

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 に転送します。

説明パラメータ

この認証フローの場合、必ず code にするresponse_type

このアプリケーション用に定義された接続アプリケーションからの [コンシューマ鍵] 値

client_id

このアプリケーション用に定義された接続アプリケーションからの [コールバック URL] 値

redirect_uri

必要に応じて、次の要求パラメータを含めることもできます。


承認後にコールバック URL で返される、URL 符号化された状態データを指定します。

state

ログインと承認についてユーザにプロンプトメッセージを表示するかどうかを決定します。値は、

immediate

true か false のいずれかです。デフォルトはfalse です。

44



• trueに設定され、ユーザが現在ログインしており、以前にこのアプリケーションを承認している場合、承認ステップはスキップされます。

• trueに設定され、ユーザがログインしていないか、これまでこのアプリケーションを承認したことがない場合、セッションはただちにエラーコード immediate_unsuccessful で終了します。

提供される Web ページの種別を示します。有効な値は、次のとおりです。

display

• page — 全画面のページ認証。これは、値が指定されていない場合のデフォルト値です。

• popup — 最新の Web ブラウザのポップアップウィンドウ用に最適化されたコンパクトなダイアログ。

• touch — Android や iPhone など、最新のスマートフォン用に設計されたモバイル用に最適化されたダイアログ。

• mobile — BlackBerry OS 5 など、機能の少ないスマートフォン用に設計されたモバイル用に最適化されたダイアログ。

2. ログインに成功したら、ユーザはアプリケーションを認証するように要求されます。

45


ユーザがすでにアプリケーションを認証している場合、このステップはスキップされます。3. クライアントアプリケーションが認証されたことが Salesforce で確認されると、エンドユーザの Web ブラウ

ザは、redirect_uri パラメータで指定されたコールバック URL にリダイレクトされます。このパラメータのクエリ文字列には次の値が付加されます。


アクセストークンと更新トークンを取得するために渡される認証コード

code

46



最初の要求の一部として渡される状態値 (該当する場合のみ)。

state

redirect_uri Web ページは、クライアントアプリケーションサーバでホストされていると想定されます。4. クライアントアプリケーションサーバは、認証コードを抽出して、これを含めたアクセストークン要求を

Salesforce に渡す必要があります。この要求は、URL

https://login.instance_name/services/oauth2/token に対する POST 送信として次のクエリパラメータを指定して行う必要があります。


このフローの値は authorization_code である必要があります。

grant_type

接続アプリケーション定義のコンシューマ鍵。client_id

接続アプリケーション定義のコンシューマの秘密。client_secret

承認後にユーザをリダイレクトする URI。これは、接続アプリケーション定義の [コールバック URL]

redirect_uri

項目の値に完全に一致している必要があります。また、最初のリダイレクトによって送信された値と同じ値です。

承認後にコールバックから取得される認証コード。code

期待される戻り形式。このパラメータは省略可能です。デフォルトは json です。値は次のとおりです。

format

• urlencoded

• json

• xml

5. この要求が成功した場合、サーバは次の内容を保持するレスポンスボディを返します。


Chatter REST API要求を行うために使用可能なセッション ID。このセッション ID はユーザインターフェース

access_token

では使用できません。これは、ユーザのセッションと同様に扱い、厳密に保護する必要があります。

47



新しいアクセストークン (セッション) を取得するために将来使用できるトークン。

refresh_token

警告: この値は秘密です。ユーザのパスワードなどと同様に処理し、適切な手段で保護する必要があります。

ユーザの組織のインスタンスを示す URL。この例では、インスタンスは na1:

https://na1.salesforce.com です。

instance_url

ユーザ、およびユーザの詳細に関するクエリの両方を識別するために使用できる ID URL。エンドユーザ

id

に関する詳細な情報を取得するための HTTP 要求で使用できます。

連結 ID と issued_at を含むコンシューマの非公開キーで署名されている Base64 符号化された

signature

HMAC-SHA256 署名。これは、サーバによる送信以降変更されなかった ID URL の確認に使用できます。

いつ署名が作成されたか。issued_at

ユーザエージェント OAuth 認証フローについて通常、このフローは、JavaScript から直接 Chatter REST API にアクセスするモバイルアプリケーションまたはアプリケーションで使用されます。このフローでは、クライアントアプリケーションは信頼できないため、クライアントのログイン情報やユーザのログイン情報を保存できないということを前提にしています。

警告: アクセストークンは符号化され、リダイレクト URI になっているため、エンドユーザや、コンピュータまたはデバイス上にある他のアプリケーションに公開できます。JavaScript を使用して認証する場合、window.location.replace(); をコールし、ブラウザの履歴からコールバックを削除することをお勧めします。

一般的なフローは次のようになります。個々のステップについては、その後に説明します。

48

ユーザエージェント OAuth 認証フローについてChatter REST API の概要

次に、OAuth ユーザエージェントフローの概要を説明します。1. リソースの認証を要求するために、クライアントアプリケーションは、エンドユーザのブラウザをリソー

ス所有者の認証サーバでホストされている Web ページにリダイレクトします。この場合は、Salesforce ログインページです。

2. エンドユーザが Salesforce にログインして自分自身を認証します。この Web ページは、リソース所有者(Salesforce) がホストし、エンドユーザが直接操作しているため、クライアント Web アプリケーションがユーザのログイン情報を見つけることはありません。クライアントアプリケーションがすでにブラウザで実行されている場合、そのままブラウザをリダイレクトできます。クライアントアプリケーションがモバイルアプリケーションの場合、ブラウザを開く必要があります (iOS の UIWebViewなど)。エンドユーザはこの Web ページを使用して自分自身を認証し、その後、クライアントアプリケーションを認証します。

3. 認証されると、認証サーバはエンドユーザの Web ブラウザをリダイレクト URL にリダイレクトします。この URL は、クライアントアプリケーションがアクセストークンと更新トークンを取得するために使用できます。

4. 保護されるリソースは Chatter REST API リソースです。

49


Chatter REST API および Salesforce によるユーザエージェントフローの使用ここでは、OAuth ユーザエージェントフローを SalesforceおよびChatter REST APIで使用する場合の詳細を具体的に説明します。1. 次の要求パラメータを指定して、クライアントの Web ブラウザをページ

https://login.instance_name/services/oauth2/authorize に転送します。


この認証フローの場合、必ず token にするresponse_type

このアプリケーション用に定義された接続アプリケーションからの [コンシューマ鍵] 値

client_id

このアプリケーション用に定義された接続アプリケーションからの [コールバック URL] 値

redirect_uri

必要に応じて、次の要求パラメータを含めることもできます。


提供される Web ページの種別を示します。有効な値は、次のとおりです。

display

• page — 全画面のページ認証。これは、値が指定されていない場合のデフォルト値です。

• popup — 最新の Web ブラウザのポップアップウィンドウ用に最適化されたコンパクトなダイアログ。

• touch — Android や iPhone など、最新のスマートフォン用に設計されたモバイル用に最適化されたダイアログ。

• mobile — BlackBerry OS 5 など、以前のスマートフォン用に設計された、モバイル用に最適化されたダイアログ。

アプリケーションがアクセスできるデータを指定します。Chatter REST APIにアクセスするために値を指定

scope

する必要はありません。値を指定する場合は、chatter_api 値を含める必要があります。

承認後にコールバック URL で返される、URL 符号化された状態データを指定します。

state

50


2. ログインに成功したら、ユーザはアプリケーションを認証するように要求されます。ユーザがすでにアプリケーションを認証している場合、このステップはスキップされます。

3. クライアントアプリケーションが認証されたことが Salesforce で確認されると、エンドユーザの Web ブラウザは、redirect_uri パラメータで指定されたコールバック URL にリダイレクトされます。このパラメータにはハッシュ記号 (#) の後に次の値が付加されます。これは、クエリ文字列ではありません。


Chatter REST API要求を行うために使用可能なセッション ID。このセッション ID はユーザインターフェース

access_token

では使用できません。これは、ユーザのセッションと同様に扱い、厳密に保護する必要があります。

アクセストークンが有効な時間 (秒)。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 要求を正常に行うには、要求に有効なアクセストークンを含める必要があります。これを行うには、HTTP 認証ヘッダーを使用します。Authorization: OAuth <access token>

要求のトークンの期限が切れていたためにエラー応答が返された場合、更新トークンを使用して新しいアクセストークンを取得できます。アクセストークンが取り消されたために要求がエラーになった場合、クライアントアプリケーションがアクセス権を得るには、ユーザによる再認証が必要です。

更新トークンの使用クライアントアプリケーションに更新トークンがある場合、更新トークンを使用して新しいアクセストークンの要求を送信できます。新しいアクセストークンを要求するには、クライアントアプリケーションが次のクエリパラメータを指定したPOST 要求を https://login.instance_name/services/oauth2/token に送信する必要があります。


このフローの値は refresh_tokenである必要があります。

grant_type

クライアントアプリケーションがすでに受け取っている更新トークン。

refresh_token

接続アプリケーション定義のコンシューマ鍵。client_id

必要に応じて、次のパラメータを含めることもできます。


接続アプリケーション定義のコンシューマの秘密。client_secret

期待される戻り形式。デフォルトは jsonです。値は次のとおりです。

format

• urlencoded

• json

• xml

このリクエストが成功した場合、サーバは access_token を保持するペイロードを返します。

52

トークンの使用Chatter REST API の概要

次の追加パラメータも返されますが、このフローと 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

HTML からの静的アセットの直接要求およびフォーム要求の直接投稿

Chatter 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 へのアクセス

エディション

使用可能なエディション:Developer Edition、Enterprise Edition、Performance Edition、Unlimited Edition

ユーザ権限

作成、参照、更新、および削除する• 「すべてのデータの編

集」

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] を選択します。2. [新規] を選択します。3. オリジンの URL パターンを入力します。

オリジンの URL パターンには、HTTPS プロトコルとドメイン名を含める必要があり、ポートを含めることもできます。ワイルドカード文字 (*) はサポートされますが、第 2 レベルドメイン名の前にある必要があります。たとえば、https://*.example.com により、example.com のすべてのサブドメインがホワイトリストに追加されます。オリジンの URL パターンに IP アドレスを使用できます。ただし、IP アドレスと、同じアドレスに解決するドメインは同じオリジンではないため、CORS ホワイトリストには別々のエントリとして追加する必要があります。

54



http://www.w3.org/TR/cors/

重要: OAuth トークンが必要な要求では、OAuth トークンを渡す必要があります。

55



第 2 章 Chatter REST API クイックスタート

Salesforce に接続して認証し、Chatter REST API に対して要求を実行して応答を確認します。

トピック:

• 前提条件• ステップ 1:

Salesforce DeveloperEdition 組織を取得する

• ステップ 2: 認証を設定する

• ステップ 3: OAuthを使用して ChatterREST API に接続する

• SalesforceCommunities への接続

56

前提条件

クイックスタートを開始する前に、次の前提条件を満たしていることを確認してください。次のことに習熟しておいてください。• 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 クイックスタート

http://curl.haxx.se/

https://developer.salesforce.com/signup

このクイックスタートでは、「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 クイックスタート

ヒント: 複数行コマンドを 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サーバインスタンス3MVG9PhR6g6B7ps4xDycwGrI4PvjVZvK9client_id

8870355475032095511client_secret

password

grant_typeの値は使用する OAuth 認証フローに応じて異なります。

grant_type

59


Chatter REST API クイックスタート

値プロパティ

[email protected]

1Lsfdc!password

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


または、ホスト名をコミュニティ URL へのフルパスで置き換えます。https://communitydomain.force.com/communitypath/services/data/v29.0/connect


60

Salesforce Communities への接続Chatter REST API クイックスタート

第 3 章 Chatter REST API の機能

『Chatter REST API開発者ガイド』のこの章では、Chatter REST API 機能の操作に使用するリソースについて説明します。

トピック:

• アクションリンクの使用

• コミュニティの使用

• フィードおよびフィード要素の使用

• Salesforce Files の使用

61

アクションリンクの使用

アクションリンクは、フィード要素上のボタンです。アクションリンクをクリックすると、ユーザを特定の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 メソッドリソース

アクションリンクグループ定義を作成します。アクションリンクをフィード要素に関連付け

POST/connect/action-link-group-definitions

るには、まずアクションリンクグループ定義を作成します。次に、関連付けられたアクション機能を含むフィード要素を投稿します。

関連付けられたアクション機能を含むフィード要素を投稿します。1 つのフィード要素に、

POST/chatter/feed-elements

最大 10 個のアクションリンクグループを関連付けます。

アクションリンクの status の情報取得や更新を行います。アクションリンクの status

GET、PATCH/connect/action-links/actionLinkId

と Action Link Definition Input の labelKey プロパティの組み合わせにより、UI に表示されるテキストが決まります。Api および ApiAsync

アクションリンクの API 要求をトリガするには、status を PendingStatus に設定します。

アクションリンクグループ定義の情報取得や削除を行います。アクションリンクグループ

GET、DELETE/connect/action-link-group-definitions/actionLinkGroupId

定義を削除すると、その定義へのすべての参照がフィード要素から削除されます。アクションリンクグループ定義の取得や削除を行うには、クライアントは定義を作成した接続アプリケーションと同じである必要があり、ユーザは定義を作成したか「すべてのデータの参照」権限を持っている必要があります。

コンテキストユーザの状態を含む、アクションリンクグループに関する情報を取得します。

GET/connect/action-link-groups/actionLinkGroupId

アクションリンクが実行されたときに返された診断情報を取得します。診断情報は、アク

GET/connect/action-links/actionLinkId/diagnostic-info

ションリンクにアクセスできるユーザに対してのみ提供されます。

フィード要素に関連付けられたすべてのプラットフォームアクションを取得します。アクショ

GET/chatter/feed-elements/feedElementId/capabilities/associated-actions

ンリンクは、プラットフォームアクションの種別の 1 つです。

指定されたフィード種別のフィード要素を取得します。フィード要素にアクションリンク

GETFeed リソース/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


アクションリンクの種別アクションリンクを定義するときに、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


アクションリンクテンプレート「アプリケーションのカスタマイズ」ユーザ権限を持つユーザのみが、[設定] でアクションリンクテンプレートの作成、編集、削除、およびパッケージ化を行うことができます。テンプレートに機密情報を保存しないでください。バインド変数を使用して、アクションリンクグループをインスタンス化するときに機密情報を追加します。アクションリンクグループがインスタンス化されると、値は暗号化された形式で保存されます。「バインド変数の定義」を参照してください。

接続アプリケーション接続アプリケーションを使用してアクションリンクを作成する場合、常に制御可能なコンシューマキーのある接続アプリケーションを使用することをお勧めします。接続アプリケーションはサーバ間の通信に使用され、逆コンパイル可能なモバイルアプリケーションに対してはコンパイルされません。

有効期限アクションリンクグループを定義するときは、有効期限 (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


[HTTP リクエストボディ]、および [HTTP ヘッダー]項目でも使用できます。テンプレートの公開後も、これらの項目は編集 (コンテキスト変数の追加と削除を含む) できます。次のコンテキスト変数があります。

説明コンテキスト変数

ユーザが実行したアクションリンクの ID。{!actionLinkId}

ユーザが実行したアクションリンクが含まれるアクションリンクグループの ID。

{!actionLinkGroupId}

ユーザがアクションリンクを実行したコミュニティのID。内部組織の場合、値は空のキー"000000000000000000" になります。

{!communityId}

ユーザがアクションリンクを実行したコミュニティのURL。内部組織の場合、値は空の文字列 "" になります。

{!communityUrl}

ユーザがアクションリンクを実行した組織の ID。{!orgId}

アクションリンクを実行したユーザの ID。{!userId}

バージョン設定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


ローカライズされた表示ラベルアクションリンクは、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


アクションリンクテンプレートの概要[設定] に次のようなアクションリンクグループテンプレートが表示されます。

各アクションリンクグループに、少なくとも 1 つのアクションリンクが必要です。この例のアクションリンクテンプレートには、[アクション URL]項目に API バージョン番号、[HTTP リクエストボディ]項目にアイテム番号、[HTTP ヘッダー] 項目に OAuth トークン値の 3 つのバインド変数があります。

73


アクションリンクグループをインスタンス化して、バインド変数の値を設定する 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 WHEREDeveloperName='Doc_Example'];

// Add binding name-value pairs to a map.

Map<String, String> bindingMap = new Map<String, String>();

74


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 = newList<ConnectApi.ActionLinkTemplateBindingInput>();

for (String key : bindingMap.keySet()) {

ConnectApi.ActionLinkTemplateBindingInput bindingInput = newConnectApi.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 = newConnectApi.ActionLinkGroupDefinitionInput();

actionLinkGroupDefinitionInput.templateId = template.id;

actionLinkGroupDefinitionInput.templateBindings = bindingInputs;

// Instantiate the action link group definition.

ConnectApi.ActionLinkGroupDefinition actionLinkGroupDefinition =

ConnectApi.ActionLinks.createActionLinkGroupDefinition(Network.getNetworkId(),actionLinkGroupDefinitionInput);

テンプレート設計の考慮事項テンプレートを設計するときは次の点を検討します。• アクションリンクグループの有効期限を決定します。

75


「アクションリンクグループの有効期限の設定」を参照してください。• テンプレートにバインド変数を定義して、グループをインスタンス化するときの値を設定します。テンプ

レートに機密情報を保存しないでください。機密情報はバインド変数を使用して実行時に追加します。「バインド変数の定義」を参照してください。

• アクションリンクがフィード要素に関連付けられているときに、アクションリンクを表示できるユーザを決定します。「アクションリンクを表示できるユーザの設定」を参照してください。

• アクションリンクの実行コンテキストに関する情報を取得するためには、テンプレートのコンテキスト変数を使用します。アクションリンクの実行時に、Salesforce が値を入力し、HTTP 要求で送信します。「コンテキスト変数の使用」を参照してください。

アクションリンクグループの有効期限の設定テンプレートからアクションリンクグループを作成するときに、テンプレートに指定された期間に基づいて有効期限を計算することも、アクションリンクグループに有効期限を設定しないことも可能です。テンプレートに有効期限までの時間を設定するには、アクションリンクグループテンプレートの[有効期限までの時間]項目に値を入力します。この値は、アクションリンクグループがインスタンス化されてから、関連付けられたフィード要素から削除され実行できなくなるまでの時間数です。最大値は 8760 で、365 日に相当します。アクションリンクグループをインスタンス化するときに有効期限を設定するには、Action Link Group Definition リクエストボディ (Chatter REST API) または ConnectApi.ActionLinkGroupDefinition 入力クラス (Apex) のいずれかの expirationDate プロパティを設定します。有効期限のないアクションリンクグループを作成するには、テンプレートの [有効期限までの時間] 項目に値を入力せず、アクションリンクグループをインスタンス化するときに expirationDate プロパティにも値を入力しません。テンプレートからアクションリンクグループを作成するときに、expirationDate と [有効期限までの時間]

は次のように連動します。• expirationDate を指定すると、新しいアクションリンクグループでその値が使用されます。• expirationDateを指定せず、テンプレートで [有効期限までの時間]を指定した場合は、新しいアクショ

ンリンクグループで [有効期限までの時間] の値が使用されます。• expirationDateも [有効期限までの時間]も指定しない場合は、テンプレートからインスタンス化された

アクションリンクグループに有効期限が設定されません。

バインド変数の定義テンプレートでバインド変数を定義し、アクションリンクグループをインスタンス化するときにその値を設定します。

重要: テンプレートに機密情報を保存しないでください。機密情報はバインド変数を使用して実行時に追加します。バインドの値が設定されている場合は、Salesforce に暗号化形式で保存されます。

76


バインド変数は、アクションリンクテンプレートの [アクション 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

{


"templateBindings" : [

{

"key":"ApiVersion",

"value":"1.0"

},

{

"key":"ItemId",

"value":"8675309"

},

{

77


http://www.unicode.org/reports/tr18/#Compatibility_Properties

"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 = newConnectApi.ActionLinkTemplateBindingInput();

bindingInput.key = key;

bindingInput.value = bindingMap.get(key);

bindingInputs.add(bindingInput);

}

// Define the action link group definition.

78


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


アクションリンクグループをインスタンス化するときに、バインド変数を設定する場合と同じように値を設定します。


{



{

"key":"Invitee",

"value":"005D00000017u6x"

80


}

]

}

テンプレートで[作成者のマネージャのみに表示]を使用する場合にユーザにマネージャがいなければ、テンプレートからアクションリンクグループをインスタンス化するときにエラーが表示されます。この場合のマネージャは、インスタンス化の時点のマネージャです。インスタンス化した後にユーザのマネージャを変更した場合、この変更は反映されません。

コンテキスト変数の使用コンテキスト変数を使用して、アクションリンクを実行したユーザとアクションリンクが呼び出されたコンテキストに関する情報を、アクションリンクの呼び出しによって実行された HTTP 要求に渡すことができます。コンテキスト変数は、Action Link Definition Input リクエストボディまたはConnectApi.ActionLinkDefinitionInputオブジェクトの actionUrl、headers、および requestBody

プロパティで使用できます。コンテキスト変数はまた、アクションリンクテンプレートの [アクション URL]、[HTTP リクエストボディ]、および [HTTP ヘッダー]項目でも使用できます。テンプレートの公開後も、これらの項目は編集 (コンテキスト変数の追加と削除を含む) できます。使用可能なコンテキスト変数は次のとおりです。






{!communityId}


{!communityUrl}



たとえば、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


この UIアクションリンクをクリックすると、ユーザがSalesforceからアンケートに回答する surveyexample.com

の Web ページに移動します。そのアクションリンクの [HTTP リクエストボディ] または [アクション URL] に {!userId} コンテキスト変数が含まれる場合、ユーザがフィードのアクションリンクをクリックすると、Salesforceはクリックしたユーザの ID を、作成した HTTP 要求に含めてサーバに送信します。アクションリンクを作成する Survey Example のサーバ側コードに {!actionLinkId} コンテキスト変数が含まれる場合は、Salesforce がアクションリンクの ID を含む HTTP 要求を送信するため、この ID をデータベースに保存できます。次の例では、アクションリンクテンプレートの [アクション URL] に {!userId} コンテキスト変数が含まれます。

ヒント: バインド変数とコンテキスト変数は同じ項目で使用できます。たとえば、アクション URLhttps://www.example.com/{!Bindings.apiVersion}/doSurvey?salesforceUserId={!userId}

にはバインド変数とコンテキスト変数が含まれています。

82


アクションリンクテンプレートの作成

エディション

使用可能なエディション:Personal Edition を除くすべてのエディション。

ユーザ権限

アクションリンクグループテンプレートを作成する• 「アプリケーションの

カスタマイズ」

アクションリンクテンプレートを作成する• 「アプリケーションの


[設定] でアクションリンクテンプレートを作成し、Chatter REST API または Apex から共通のプロパティを持つアクションリンクグループをインスタンス化できます。テンプレートをパッケージ化して他の Salesforce 組織に配布できます。

メモ: アクションリンクテンプレートは、[設定] から作成するだけでなく、メタデータ API、SOAP API、および REST APIを使用して作成することもできます。

[アクション URL]、[HTTP リクエストボディ]、および [HTTP ヘッダー] 項目はバインド変数とコンテキスト変数をサポートします。テンプレートにバインド変数を定義し、アクションリンクグループをインスタンス化するときにその値を設定します。テンプレートでコンテキスト変数が使用されている場合、アクションリンクが実行されると Salesforce が値を入力して要求で返します。テンプレートでこれらの変数を使用する方法についての詳細は、「アクションリンクテンプレートの設計」を参照してください。1. [設定] で、[作成] > [アクションリンクテンプレート] をクリックします。2. [新規] をクリックします。3. テンプレートの [名前]を入力します。この名前が、アクションリンクグルー

プテンプレートのリストに表示されます。これがアクションリンクグループテンプレートの公開後に編集可能な唯一のアクションリンクグループテンプレート値です。

4. [API 参照名]を入力します。コードからこのテンプレートを参照するには、開発者名を使用します。[API

参照名] はデフォルトの空白を除いた名前になります。文字、数字、アンダースコア文字のみを使用できます。

5. [カテゴリ]を選択します。これは、インスタンス化したアクションリンクグループをフィード要素上のどこに表示するかを示します。[プライマリ] を選択すると、アクションリンクグループはフィード要素の本文に表示されます。[オーバーフロー] を選択すると、アクションリンクグループはフィード要素のオーバーフローメニューに表示されます。アクションリンクグループテンプレートが [プライマリ] の場合、最大 3 個のアクションリンクテンプレートを含めることができます。アクションリンクグループテンプレートが [オーバーフロー] の場合、最大 4

個のアクションリンクテンプレートを含めることができます。6. [実行可] の数を選択します。これは、このテンプレートからインスタンス化されたアクションリンクグ

ループを何回実行できるかを示します (1 つのグループ内に同じアクションリンクを含めることはできません)。Unlimited を選択すると、グループ内のアクションリンクを種別 Apiまたは ApiAsyncにすることはできません。

7. (省略可能) [有効期限までの時間] を入力します。これは、アクションリンクグループを作成してから、アクションリンクグループが関連するフィード要素から削除され実行できなくなるまでの時間数です。最大値は、8760 です。「アクションリンクグループの有効期限の設定」を参照してください。

8. [保存] をクリックします。

83


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 に設定されます。


{

"templateId" : "07gD00000004C9r",


{

"key":"itemId",

"value": "8675309"

}

]

84


}

この項目には、コンテキスト変数を含めることもできます。コンテキスト変数を使用して、アクションリンクを実行したユーザに関する情報をサーバ側のコードに渡すことができます。たとえば、次のアクションリンクは、アンケートに回答するためにアクションリンクをクリックしたユーザの 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


19. (省略可能) アクションリンクに適した [表示ラベルキー] 値がない場合、[表示ラベルキー] を [なし] に設定して、[表示ラベル] 項目に値を入力します。アクションリンクには、NewStatus、PendingStatus、SuccessStatus、FailedStatus の 4 つの状況があります。次の文字列が、各状況の表示ラベルに追加されます。• 表示ラベル• 表示ラベル待機中• 表示ラベル成功• 表示ラベル失敗たとえば、label の値が「See Example」の場合、4 つのアクションリンクの状態の値は「See Example」、「See Example 待機中」、「See Example 成功」、および「See Example 失敗」になります。アクションリンクでは、表示ラベル名の生成に LabelKey または Label を使用できますが、両方は使用できません。

20. [ユーザ表示設定] を選択します。これはアクションリンクグループを表示できるユーザを示します。[作成者のマネージャのみに表示] を選択した場合、マネージャはアクションリンクグループがインスタンス化されたときの作成者のマネージャになります。アクションリンクグループがインスタンス化された後に作成者のマネージャが変わった場合、変更は反映されません。

21. (省略可能) [カスタムユーザのみに表示] または [カスタムユーザ以外の全員に表示] を選択した場合は、[カスタムユーザ(別名)] を入力します。バインド変数の値を設定する場合と同様に、文字列を入力し、アクションリンクグループをインスタンス化するときにその値を設定します。ただし、テンプレートではバインド変数の構文は使用せずに、値のみ

86


を入力してください。たとえば、ExpenseApprover などと入力します。次の Chatter REST API の例では、ExpenseApprover の値を 005B0000000Ge16 に設定します。


{

"templateId" : "07gD00000004C9r",


{

"key":"ExpenseApprover",

"value": "005B0000000Ge16"

}

]

}

22. このアクションリンクグループテンプレートに別のアクションリンクテンプレートを作成するには、[保存& 新規] をクリックします。

23. このアクションリンクグループテンプレートへのアクションリンクテンプレートの追加が完了したら、[保存] をクリックします。

24. アクションリンクグループテンプレートを公開するには、[最後に開いたビューへ] をクリックして [アクションリンクグループテンプレート] リストビューに戻ります。

重要: Apexまたは Chatter REST APIでアクションリンクグループをテンプレートからインスタンス化するには、事前にテンプレートを公開する必要があります。

25. 公開するアクションリンクグループテンプレートの [編集] をクリックします。26. [公開済み] を選択して、[保存] をクリックします。

87


アクションリンクテンプレートの編集

エディション


ユーザ権限

アクションリンクグループテンプレートを編集する• 「アプリケーションの


アクションリンクテンプレートを編集する• 「アプリケーションの


未公開のアクションリンクグループテンプレートおよび関連付けられているアクションリンクテンプレートのすべての項目を編集できます。1. [設定] で、[作成] > [アクションリンクテンプレート] をクリックします。2. アクションリンクグループテンプレートを編集するには、名前の横にある

[編集] をクリックします。グループテンプレートが公開されていない場合は、任意の項目を編集します。公開されている場合は、[名前] 項目のみを編集します。

3. アクションリンクテンプレートを編集する手順は次のとおりです。a. 主アクションリンクグループテンプレートの名前をクリックします。b. アクションリンクテンプレート ID をクリックして、アクションリンクテ

ンプレートの詳細ページを表示します。c. [編集] をクリックします。

関連付けられているアクションリンクグループテンプレートが公開されていない場合は、任意の項目を編集します。公開されている場合は、次のいずれかの項目を編集します。• アクション URL

• HTTP リクエストボディ• HTTP ヘッダー上記の項目は、コンテキスト変数およびバインド変数をサポートします。これらのいずれかの項目のコンテキスト変数を追加および削除できます。新しいバインド変数を追加することはできません。可能な操作は次のとおりです。• バインド変数をアクションリンクテンプレートの別の編集可能項目に移動する。• アクションリンクテンプレートでバインド変数を複数回使用する。• 同じアクションリンクグループテンプレートに関連付けられている任意のアクションリンクテンプ

レートでバインド変数を複数回使用する。• バインド変数を削除する。

88


アクションリンクグループテンプレートの削除

エディション


ユーザ権限

アクションリンクグループテンプレートを削除する• 「アプリケーションの


アクションリンクテンプレートを削除する• 「アプリケーションの


アクションリンクグループテンプレートを削除すると、関連付けられているアクションリンクテンプレートと、そのテンプレートからインスタンス化されているすべてのアクションリンクグループが削除されます。削除されたアクションリンクグループは、関連付けられているすべてのフィード要素に表示されなくなります。1. [設定] で、[作成] > [アクションリンクテンプレート] をクリックします。2. アクションリンクグループテンプレートを削除するには、名前の横にある

[削除] をクリックします。

重要: アクションリンクグループテンプレートを削除すると、関連付けられているアクションリンクテンプレートと、そのテンプレートからインスタンス化されているすべてのアクションリンクグループが削除されます。アクションリンクグループは、関連付けられているすべてのフィード要素から削除されます。つまり、アクションリンクはフィードの投稿に表示されなくなります。

3. アクションリンクテンプレートを削除する手順は、次のとおりです。a. 主アクションリンクグループテンプレートの名前をクリックします。b. アクションリンクテンプレート ID をクリックして、アクションリンクテンプレートの詳細ページを表示

します。c. [削除] をクリックします。

重要: 公開されているアクションリンクグループテンプレートに関連付けられているアクションリンクテンプレートは削除できません。

アクションリンクテンプレートのパッケージ化

エディション


ユーザ権限

アクションリンクテンプレートをパッケージ化する• 「AppExchange パッ

ケージの作成」

アクションリンクテンプレートをパッケージ化して他の Salesforce 組織に配布できます。アクションリンクグループテンプレートを追加すると、関連付けられているアクションリンクテンプレートもパッケージに追加されます。アクションリンクグループテンプレートは、未管理パッケージまたは管理パッケージに追加できます。アクションリンクグループテンプレートは、パッケージ化できるコンポーネントとして管理パッケージのすべての機能 (AppExchangeのリスト、転送アップグレード、インストール後 Apex スクリプト、ライセンス管理、高度な登録者サポートなど) も活用できます。管理パッケージを作成するには、Developer Edition

組織を使用する必要があります。• 「パッケージの作成および編集」(https://help.salesforce.com) を参照してくださ

い。

89


https://help.salesforce.com

コミュニティの使用

コミュニティは、従業員、お客様、およびパートナーが接続するブランド空間です。ビジネスニーズに合わせてコミュニティをカスタマイズしながら作成することができ、その後もコミュニティ間をシームレスに移行できます。特定のコミュニティでは、ほとんどのChatter REST APIリソースを要求できます。たとえば、特定のコミュニティ内で、Feeds、Files、Groups、Topics、Users リソースに対して要求を実行できます。コミュニティでリソースを使用できる場合、そのドキュメントには /connect/communities/communityIdで始まるリソースが含まれます。一部の Chatter REST API リソースは、コミュニティ内でのみ使用できます。これには、コンテンツのフラグ設定とモデレート、管理トピックの使用、ユーザの評価に関する情報の取得を行うためのリソースが含まれます。コミュニティで使用できるリソースは、ログインなしでのアクセスを許可するかどうかに関係なく使用できます。ただし、コミュニティでログインなしでのアクセスが許可されている場合、ゲストユーザはどの Chatter

REST API リソースにもアクセスできません。次の表に、コミュニティ内でのみ使用できるリソースを示します。

ToDoHTTP メソッドリソース

コンテキストユーザが使用できるすべてのコミュニティリストを返します。

GET/connect/communities

指定されたコミュニティに関する情報を返します。

GET/connect/communities/communityId

コンテキストユーザがコミュニティモデレータの場合、コミュニティメンバーが 1 つのコメ

GET、POST、DELETE

/connect/communities/communityId/chatter/comments/commentId/moderation-flags ントにフラグを設定した回数を返します。ま

た、モデレーションのためにコメントにフラグを設定したり、コメントのすべてのフラグを削除したりします。コンテキストユーザがコミュニティモデレータでない場合は、ユーザがコメントにフラグを設定したかどうかを返します。また、モデレーションのためにコメントにフラグを設定したり、ユーザが以前に追加したフラグを削除したりします。

フィード要素のモデレーション機能に関する情報の取得、フィード要素へのモデレーショ

GET、POST、DELETE

/connect/communities/communityId/chatter/feed-elements/feedElementId/capabilities/moderation ンフラグの追加、またはフィード要素のすべ

てのモデレーションフラグの削除を行います。

90

コミュニティの使用Chatter REST API の機能


コンテキストユーザがコミュニティモデレータの場合、コミュニティメンバーによってフラグが設定されたファイルを返します。

GET/connect/communities/communityId/chatter/files/moderation

コンテキストユーザがコミュニティモデレータの場合、コミュニティメンバーが 1 つのファ

GET、POST、DELETE

/connect/communities/communityId/chatter/files/fileId/moderation-flags

イルにフラグを設定した回数を返します。また、モデレーションのためにファイルにフラグを設定したり、ファイルのすべてのフラグを削除したりします。コンテキストユーザがコミュニティモデレータでない場合は、ユーザがファイルにフラグを設定したかどうかを返します。また、モデレーションのためにファイルにフラグを設定したり、ユーザが以前に追加したフラグを削除したりします。

コンテキストユーザが「コミュニティフィードのモデレート」権限を持つコミュニティモ

GET/connect/communities/communityId/chatter/feeds/moderation/feed-elements

デレータの場合、コミュニティメンバーによってフラグが設定された、コミュニティ内のすべてのフィード要素とコメントのリストを返します。デフォルトでは、結果ページごとに25 件のフィード要素を返します。

コミュニティの管理トピックに関連付けられたすべてのフィード要素のリストを返します。

GET/connect/communities/communityId/chatter/feeds/home/feed-elements

コミュニティのすべての管理トピックを取得します。管理トピックを作成します。管理トピックを並び替えます。

GET、POST、PATCH

/connect/communities/communityId/managed-topics

コミュニティの管理トピックの情報取得または削除を行います。

GET、DELETE/connect/communities/communityId/managed-topics/managedTopicId

指定されたコミュニティユーザの評価を返します。

GET/connect/communities/communityId/chatter/users/userId/reputation

関連トピック:

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


きれいに整理されたフィードをユーザに提供するために、フィード変更追跡のフィード項目はバンドルに集約できます。個々のフィード項目を表示するには、バンドルをクリックします。

バンドルは、バンドル機能を備えた汎用フィード要素です。次のバンドルレイアウト要素があります。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


• 標準およびカスタムレコードのフィード要素 (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


グループの場合、フィードにはそのグループにメンションしているフィード項目も含まれます。レコードがユーザの場合、フィードにはそのユーザに対するフィード項目のみが含まれます。

• 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



"subjectId":"005RR000000DmOg",

"body" : {

"messageSegments" : [

{

"type" : "Text",

"text" : "When should we meet for release planning?"

}

]

}

}

新しく投稿されたフィード項目の parent プロパティには、対象ユーザの User Summary レスポンスボディが含まれます。

グループへの投稿次の例では、リクエストボディを使用して、グループに投稿します。subjectIdプロパティでは、グループ ID を指定します。POST /chatter/feed-elements

{


"subjectId":"0F9RR0000004CPw",

"body" : {


{

"type" : "Text",


}

]

97


}

}

新しく投稿されたフィード項目の parentプロパティには、指定されたグループの Group レスポンスボディが含まれます。

レコード (ファイルや取引先など) への投稿次の例では、リクエストボディを使用して、レコードフィードでユーザにメンションします。subjectId

プロパティでは、レコード ID を指定します。POST /chatter/feed-elements

{

"feedElementType" : "FeedItem",

"subjectId" : "001RR000002G4Y0",

"body" : {


{

"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


フィードからのフィード要素の取得ヒント: フィード要素を含むフィードを返すには、次のメソッドをコールします。API バージョン 31.0 では、フィード要素種別はフィード項目とバンドルのみですが、これは今後変更される可能性があります。

フィードからフィード要素を取得する方法は、どのフィード種別でも似ていますが同一ではありません。会社フィード、ホームフィードまたはモデレーションフィードからフィード要素を取得する場合は、件名 ID

を指定しないでください。

リソースフィード種別

/chatter/feeds/company/feed-elementsCompany

/connect/communities/communityId/chatter/feeds/home/feed-elementsホーム/connect/communities/communityId/chatter/feeds/moderation/feed-elements

Moderation

お気に入りフィードおよびフィルタフィードからフィード要素を取得するには、favoriteIdまたはkeyPrefix

を指定します。keyPrefix はオブジェクト ID の最初の 3 文字であり、オブジェクト種別を示します。次のフィードの場合、subjectId は、コンテキストユーザの ID または別名 me である必要があります。


/chatter/feeds/favorites/subjectId/favoriteId/feed-elementsFavorites

/chatter/feeds/filter/subjectId/keyPrefix/feed-elementsFilter

レコードフィードからフィード要素を取得するには、レコード ID を指定します。


/chatter/feeds/record/recordId/feed-elementsRecord

ヒント: recordId は、フィードをサポートする任意のタイプのレコードにすることができます (グループを含む)。Salesforce UI のグループページ上のフィードは、レコードフィードです。

その他すべてのフィード種別からフィード要素を取得するには、件名 ID を指定します。別のフィードを指定するには、feedTypeを置き換えます。ユーザプロファイルフィードとトピックフィードを除く、次の表のすべてのフィード種別で、subjectId はコンテキストユーザの ID または別名 me である必要があります。

99



/chatter/feeds/feedType/subjectId/feed-elements

例: /chatter/feeds/news/me/feed-elements

Bookmarks、Files、Groups、News、People、To、Topics、User Profile

関連トピック:

Feeds リソース

Salesforce Files の使用

Chatter REST API を使用して、Salesforce Files Sync を含む、Salesforce Files を操作できます。Salesforce Files を使用すると、クラウドでファイルのアップロード、保存、検索、フォロー、共有、およびコラボレーションができます。Salesforce Files Sync を使用すると、Chatter、デスクトップ、モバイルデバイス間でファイルをセキュアに保存、同期、および共有できます。ファイルとフォルダにどこからでもアクセスして、即座に組織全体で更新して最新の状態を維持できます。


フィード要素の投稿や、組織のすべてのフィード要素の検索を行います。

GET、POST/chatter/feed-elements

コンテキストユーザがフォローしている人またはグループによって投稿されたファイルを含むすべてのフィード要素を返します。

GET/chatter/feeds/files/me/feed-elements

コンテキストユーザが所有するグループかメンバーであるグループすべてからの全フィー

GET/chatter/feeds/news/me/feed-elements

ド要素と、コンテキストユーザがフォローしている全ファイル、レコード、およびユーザからの全フィード要素。このリソースは、フィード要素に関する情報を取得し、フィード要素を投稿するために使用します。

コンテキストユーザがフォローしているすべてのレコードのフィード要素、または指定さ

GET/chatter/feeds/records/recordId/feed-elements

れた recordId のすべてのフィード要素を返します。このリソースは、フィードの検索や特定のフィードのフィード要素の取得に使用します。このリソースを使用してグループのフィード要素を取得するには、グループ ID をrecordId として指定します。

100

Salesforce Files の使用Chatter REST API の機能


フィードで追跡可能なすべてのレコードに対するすべてのアクションのフィード要素を返します。

GET/chatter/feeds/user-profile/userId/feed-elements

外部ファイルへの参照を含む、指定されたファイルに関する情報を取得します。外部ファイ

GET、POST、PATCH、DELETE

/chatter/files/fileId

ルへの参照を含む、既存のファイルの新バージョンをアップロードします。ファイルの名称変更、別のフォルダへの移動、ファイルの削除を行います。

外部ファイルへの参照を含む、ファイルのコンテンツを返します。コンテンツは、レスポンスボディとしてストリーミングされます。

GET/chatter/files/fileId/content

指定されたファイルの共有先であるオブジェクトに関する情報を返します。オブジェクト

GET、POST/chatter/files/fileId/file-shares

はユーザ、グループ、またはレコードの場合があります。指定されたファイルをユーザと共有する場合にも使用できます。

リンクとして共有されるファイルの説明。ファイルの共有リンクの作成、アクセス、または削除を行います。

GET、PUT、DELETE

/chatter/files/fileId/file-shares/link

ファイルの変換。変換とは、ファイルのバイナリプレビューです。バイナリの形式は、要求で指定された形式によって異なります。

GET/chatter/files/fileId/rendition

ファイル ID によって指定されたファイルのリストに関する情報。ファイルのリストに関す

GET、DELETE/chatter/files/batch/fileIds

る情報の取得や、ファイルのリストの削除を行います。

指定されたフォルダに関する情報を取得します。フォルダの移動、名前の変更、および削除を行います。ルートフォルダを同期します。

GET、PATCH、DELETE

/chatter/folders/folderId

フォルダの内容に関する情報を取得します。フォルダへのファイルの追加や、フォルダの

GET、POST/chatter/folders/folderId/items

作成を行います。ルートフォルダを同期します。

指定されたグループに投稿されたファイルに関する情報を返します。

GET/chatter/groups/groupId/files

指定されたトピックに最近投稿された 5 つのファイルに関する情報を返します。

GET/connect/topics/topicId/files

101



外部ファイルへの参照を含む、Salesforce Files

Sync へのファイルの投稿、またはユーザが所GET、POST/chatter/users/userId/files

有するファイルに関する情報の取得を行います。ユーザと共有されているファイル、ユーザがフォローしているファイル、一般的な組織ファイルは対象外です。

指定されたユーザがメンバーであるグループに投稿されたファイルに関する情報を返します。

GET/chatter/users/me/files/filter/groups

指定されたユーザと共有されているファイルに関する情報を返します。

GET/chatter/users/me/files/filter/shared-with-me

メモ: 別名 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 活動の統計情報を取得するフォローするユーザのおすすめを取得するグループを作成するグループの写真を更新およびトリミングするグループに参加する非公開グループへの参加を要求する非公開グループへの参加要求を承認または却下するグループに投稿するレコードをフォローするレコードのフォローを停止するレコードフィードを取得するユーザプロファイルを更新するユーザの写真を更新およびトリミングする非公開メッセージを送信する複数のユーザのユーザ情報を取得する

レスポンスボディを絞り込む

リソースすべて

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" : {


{

"type" : "Text",

"text" : "When should we meet for release planning? "

},

{

"type" : "Mention",

"id" : "005D00000016Qxp"

}]

},


"subjectId" : "0F9B000000000W2"

}

要求パラメータの例/services/data/v34.0/chatter/feed-elements?feedElementType=FeedItem&subjectId=0F9B000000000W2&text=New+post

戻り値Feed Item

106

フィード項目を投稿するChatter REST API の例

フィード要素を投稿し、Salesforce のファイルを含める

この例では、Salesforceにアップロードされているファイルを含むフィード要素を投稿します。新しいファイルをアップロードするには、「バイナリファイルのアップロード」を参照してください。リソース

/chatter/feed-elements



リクエストボディの例{

"body":{

"messageSegments":[

{

"type":"Text",

"text":"Please take a look at this file."

}

]

},

"capabilities":{

"content":{

"contentDocumentId":"069D00000001pyS"

}

},

"subjectId":"me",

"feedElementType":"FeedItem"

}

戻り値Feed Item

107

フィード要素を投稿し、Salesforce のファイルを含めるChatter REST API の例

コメントを投稿する

リソース/chatter/feed-elements/feedElementId/capabilities/comments/items


リクエストボディ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


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を使用します。


リクエストボディフィード項目の場合、Feed Item Input を使用します。コメントの場合、Feed Item Input を使用します。どちらの入力の場合も、Message Segment Input: Mention を使用します。

リクエストボディの例次にフィード項目の例を示します。{

"body" : {


{

"type" : "Text",


},

{

"type" : "Mention",

"id" : "005T0000000mzCy"

}

]

},


"subjectId" : "005D00000016Qxp"

}

110

@メンションを投稿するChatter REST API の例

次にコメントの例を示します。{ "body" :

{


{

"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を使用します。


リクエストボディフィード項目の場合、Feed Item Input を使用します。コメントの場合、Feed Item Input を使用します。どちらの入力の場合も、Message Segment Input: Mention を使用します。

111

複数の @メンションを投稿するChatter REST API の例

リクエストボディの例次にフィード項目の例を示します。{

"body" : {


{

"type" : "Text",


},

{

"type" : "Mention",

"id" : "005T0000000mzCy"

},

{

"type" : "Text",

"text" : " "

},

{

"type" : "Mention",

"id" : "005B0000000Ek1S"

}

]

},



}

次にコメントの例を示します。{ "body" :

112


{


{

"type": "mention",

"id":"005D0000001LL8YIAW"

},

{

"type" : "Text",

"text" : " "

},

{

"type": "mention",

"id":"005D0000001LL8sIAG"

},

{

"type": "text",

"text":" Did you see the new plans?"

}

]

}

}

メモ: メンションの前後に空白が自動的に追加されることはないため、必要な位置に空白を含めます。

戻り値Feed Item

Comment

113


@メンション提案のリストを取得する

リソースメンション提案のリストを取得するには、Mentions Completions リソース (/chatter/mentions/completions)

を使用します。コンテキストユーザに対して有効な提案を判定するには、Mentions Validations リソース(/chatter/mentions/validations) を使用します。


要求パラメータ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


リクエストボディ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 APIaction 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 viaan 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 個のアクションリンクグループを関連付けられます。リソース




リクエストボディの例ステップ 1 の Action Link Group Definition レスポンスの id からアクションリンクグループ ID を取得します。POST /services/data/v34.0/chatter/feed-elements

{

116




"body": {


{

"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




レスポンスボディ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



値項目

ドキュメントの例アクションリンクグループテンプレートApiアクションの種類/services/data/{!Bindings.ApiVersion}/chatter/feed-elementsアクション URL

全員に表示ユーザ表示設定{"subjectId": "{!Bindings.SubjectId}","feedElementType":"FeedItem","body": {"messageSegments": [{"type": "Text","text":"{!Bindings.Text}"}]}}

HTTP リクエストボディ

Content-Type: application/jsonHTTP ヘッダー0位置

投稿表示ラベルキーPOSTHTTP メソッド

4. アクションリンクグループテンプレートに戻り、[公開済み] を選択します。[保存] をクリックします。アクションリンクグループテンプレート ID をメモし、ステップ 3 に進みます。

ステップ 2: アクションリンクグループテンプレート ID を取得する[設定] でアクションリンクグループテンプレートへのアクセス権がある場合は、アクションリンググループテンプレート ID を取得してステップ 3 に進むことができます。リソース

/services/data/v33.0/query


要求パラメータq — SOQL クエリ文字列。

要求パラメータの例GET/services/data/v34.0/query?q=SELECT+id+FROM+ActionLinkGroupTemplate+WHERE+DeveloperName='Doc_Example'

cURL の例curlhttps://na1.salesforce.com/services/data/v34.0/query?q=SELECT+id+FROM+ActionLinkGroupTemplate+

WHERE+DeveloperName='Doc_Example' -H "Authorization: Bearer token"

119



レスポンスボディクエリ結果レコードの配列。{

"totalSize":1,

"done":true,

"records":[

{

"attributes":{

"type":"ActionLinkGroupTemplate",

"url":"/services/data/v34.0/sobjects/ActionLinkGroupTemplate/07gD00000004CEhIAM"

},

"Id":"07gD00000004CEhIAM"

}

]

}

ステップ 3: アクションリンクグループをインスタンス化するリソース



リクエストボディAction Link Group Definition Input

リクエストボディの例POST /services/data/v34.0/connect/action-link-group-definitions

{

"templateId":"07gD00000004CEhIAM",


{

"key":"ApiVersion",

120



"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 個のアクションリンクグループを関連付けられます。リソース


121






リクエストボディの例ステップ 3 の Action Link Group Definition レスポンスの id からアクションリンクグループ ID を取得します。POST /services/data/v34.0/chatter/feed-elements

{

"body": {


{

"type": "Text",

"text": "Click to post a feed item."

}

]

},

"subjectId": "me",

"feedElementType": "feedItem",

"capabilities": {



}

}

}

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




{ "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



メモ: 次の場合、アクションリンクの 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


例/services/data/v34.0/chatter/feed-elements/feedElementId/capabilities/chatter-likes/items

戻り値Like

124

フィード項目にいいね! と言うChatter REST API の例

フィード項目にいいね! と言い、いいね! の総数を返す

リソース/connect/batch/


リクエストボディ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

フィード項目を共有する



125

フィード項目にいいね! と言い、いいね! の総数を返すChatter REST API の例


要求パラメータ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 およびコメントが追加された場合、更新されたものとみなされます。いいね! やトピックを追加してもフィード要素は更新されません。


戻り値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 回を超えてニュースフィードをポーリングしないでください。


例この 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


例/services/data/v34.0/chatter/feeds/news/me/feed-elements


グループフィードを取得する

リソース/chatter/feeds/record/recordId/feed-elements

recordId をグループ ID に置き換えます。HTTP メソッド

GET

例/services/data/v34.0/chatter/feeds/record/0F9D00000000I4O/feed-elements


128

自分のニュースフィードを取得するChatter REST API の例

内部のフィード項目のみを含むフィードを取得する



要求パラメータshowInternalOnly

例/services/data/v34.0/chatter/feeds/record/0F9D00000000I4O/feed-elements?showInternalOnly=true


フィードを検索する

リソース/chatter/feed-elements?q=searchString

検索文字列にはワイルドカード文字を含めることができ、ワイルドカード文字を除く 2 文字以上が含まれている必要があります。


要求パラメータq

要求パラメータの例/services/data/v34.0/chatter/feed-elements?q=track


ユーザがフォローしているレコードのリストを取得する

リソース/chatter/users/userId/following


要求パラメータpage (省略可能)

要求パラメータの例/services/data/v34.0/chatter/users/005D0000001GLowIAB/following?page=1

129

内部のフィード項目のみを含むフィードを取得するChatter REST API の例

戻り値Subscription Page

ユーザの Chatter 活動の統計情報を取得する

リソース/chatter/users/userId


例/services/data/v34.0/chatter/users/005D0000001GLowIAB?include=/chatterActivity

戻り値User Detail

フォローするユーザのおすすめを取得する

リソース/chatter/users/me/recommendations/follow/users


例/services/data/v34.0/chatter/users/me/recommendations/follow/users

戻り値Recommendations

グループを作成する

リソース/chatter/groups


リクエストボディGroup Input

要求パラメータ (必須)

name、visibility


"name" : "Chatter API",

130

ユーザの Chatter 活動の統計情報を取得するChatter REST API の例

"visibility" : "PublicAccess"

}

要求パラメータの例/services/data/v34.0/chatter/groups?name=Chatter+API&visibility=PublicAccess

戻り値Group Detail

グループの写真を更新およびトリミングする

この例では、既存の写真 (すでにアップロードされている写真) をトリミングします。写真を新たにアップロードしてから、トリミングすることもできます。新しい写真をアップロードするには、マルチパート/フォームデータ要求を使用する必要があります。「バイナリファイルのアップロード」を参照してください。リソース

/chatter/groups/groupId/photo


リクエストボディ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


リクエストボディGroup Member Input

要求パラメータuserId

リクエストボディの例{"userId": "005D0000001GpHp" }

要求パラメータの例/services/data/v34.0/chatter/groups/0F9D000000006bOKAQ

/members?userId=005D0000001GpHp

戻り値グループメンバー

非公開グループへの参加を要求する

リソース/chatter/groups/groupId/members/requests


例/services/data/v34.0/chatter/groups/0F9D000000006bOKAQ/members/requests

戻り値Group Membership Request

非公開グループへの参加要求を承認または却下する

リソース/chatter/group-memberships-requests/requestId


リクエストボディ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

グループに投稿する




要求パラメータfeedElementType、subjectId、text

リクエストボディの例subjectId にグループを指定します。{

"body" : {


{

"type" : "Text",


},

{

"type" : "Mention",

"id" : "005D00000016Qxp"

133

グループに投稿するChatter REST API の例

}]

},


"subjectId" : "0F9B000000000W2"

}

要求パラメータの例/services/data/v34.0/chatter

/feed-elements?feedElementType=FeedItem&subjectId=0F9B000000000W2&text=New+post

戻り値Feed Item

レコードをフォローする

リソース/chatter/users/me/following


リクエストボディ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 が成功しました完全に構造化されたレスポンスボディは返されず、戻りコードのみが返されます。

レコードフィードを取得する



例/services/data/v34.0/chatter/feeds/record/005x0000001oXx9AAE

/feed-elements


ユーザプロファイルを更新する

リソース/chatter/users/userId


リクエストボディ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


リクエストボディ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/


リクエストボディ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 のリストを使用してこのリソースをコールします。


例/services/data/v34.0/chatter/users

/batch/005D0000001Kl6xIAC,005D0000005J3D4HVB, . . .

戻り値Batch Results

137

複数のユーザのユーザ情報を取得するChatter REST API の例

第 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

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 リソース

Question and Answers Suggestions リソース質問および回答の提案を取得します。おすすめ定義リソースおすすめ定義を使用すると、コミュニティに表示されるカスタムおすすめを作成して、ユーザに動画の閲覧やトレーニングの受講などを促すことができます。これらのリソースは、おすすめ定義の情報取得、作成、変更、削除に使用します。また、おすすめ定義の写真の情報取得、アップロード、変更、および削除にも使用します。Records リソースレコードをフォローしている人に関する情報を取得します。レコードに対するトピックの追加や削除を行います。スケジュール済みおすすめリソーススケジュール済みおすすめに関する情報の取得、スケジュール済みおすすめの作成、変更、削除を行います。Subscriptions リソース指定された登録に関する情報。登録の削除 (レコードまたはトピックのフォロー解除など) にも使用されます。Topics リソース組織のトピックのリスト、指定されたテキスト文字列、フィード項目、またはレコードの推奨トピックのリスト、組織のトピックのトレンドのリスト、指定されたトピックに関する情報、指定されたトピックの支持、指定されたトピックに最近投稿されたファイルに関する情報、指定されたトピックに最近投稿したグループに関する情報、指定されたトピックに関する知識のあるユーザ、および指定されたトピックに関連するトピックのリスト。User Profiles リソースユーザのプロファイルに関する詳細を返します。このユーザプロファイルデータが、プロファイルページ(Chatter プロファイルページとも呼ばれる) に入力されます。このデータには、ユーザ情報 (住所、マネージャ、電話番号など)、一部のユーザ機能 (権限)、および一連のサブタブアプリケーション (プロファイルページのカスタムタブ) が含まれます。Users リソースユーザをフォローしている人、ユーザのファイルやおすすめなど、ユーザに関する情報。フィード項目のpost 送信と会話状況の更新にも使用されます。Zones リソースChatter アンサーゾーンに関する情報。

Action Links リソース

アクションリンクは、フィード要素上のボタンです。アクションリンクをクリックすると、ユーザを特定のWeb ページに移動したり、ファイルダウンロードを開始したり、Salesforce または外部サーバへの API コールを呼び出したりできます。アクションリンクには、URL と HTTP メソッドが含まれ、リクエストボディとヘッダー情報 (認証用の OAuth トークンなど) を含めることができます。アクションリンクを使用して Salesforce およびサードパーティサービスをフィードに統合することで、ユーザはアクションを実行して生産性を高め、イノベーションを促進できます。

140

Action Links リソースChatter REST API リソース

アクションリンクとアクションリンクグループには、定義ビューとコンテキストユーザビューという 2 つのビューがあります。定義には、認証情報などの機密情報が含まれる可能性があります。コンテキストユーザビューは、表示オプションによって絞り込まれ、コンテキストユーザの状態が値に反映されます。使用可能なリソース:

説明リソース

アクションリンクグループ定義を作成します。アクションリンクをフィード要素に関連付けるには、まず


アクションリンクグループ定義を作成します。次に、関連付けられたアクション機能を含むフィード要素を投稿します。

アクションリンクグループ定義の情報取得や削除を行います。アクションリンクグループ定義を削除する

/connect/action-link-group-definitions/actionLinkGroupId

と、その定義へのすべての参照がフィード要素から削除されます。アクションリンクグループ定義の取得や削除を行うには、クライアントは定義を作成した接続アプリケーションと同じである必要があり、ユーザは定義を作成したか「すべてのデータの参照」権限を持っている必要があります。

コンテキストユーザの状態を含む、アクションリンクグループに関する情報を取得します。

/connect/action-link-groups/actionLinkGroupId

アクションリンクの statusの情報取得や更新を行います。アクションリンクの status と Action Link

/connect/action-links/actionLinkId

Definition Input の labelKey プロパティの組み合わせにより、UI に表示されるテキストが決まります。Api

および ApiAsyncアクションリンクの API 要求をトリガするには、statusを PendingStatusに設定します。

アクションリンクが実行されたときに返された診断情報を取得します。診断情報は、アクションリンクにアクセスできるユーザに対してのみ提供されます。

/connect/action-links/actionLinkId/diagnostic-info

関連トピック:

アクションリンクの使用アクションリンクを定義し、フィード要素を使用して投稿する

Action Link Group Definitionsアクションリンクグループ定義を作成します。アクションリンクをフィード要素に関連付けるには、まずアクションリンクグループ定義を作成します。次に、関連付けられたアクション機能を含むフィード要素を投稿します。

141

Action Link Group DefinitionsChatter REST API リソース

すべてのアクションリンクはグループに属している必要があります。1 つのグループ内のアクションリンクは、相互排他的で、同じプロパティを共有します。各自のアクショングループでスタンドアロンアクションを定義します。この画像は、[ダウンロード] と [注文] という 2 つのアクションリンクを含む 1 つのアクションリンクグループがあるフィード要素を示しています。

リソース/connect/action-link-group-definitions

/connect/communities/communityId/action-link-group-definitions

適用開始バージョン33.0

Chatter が必要かどうかいいえ


Action Link Group Definitions リソースは、POST のクエリパラメータをサポートしていません。Action Link Group

Definition Input リクエストボディを使用する必要があります。POST のリクエストボディ

Action Link Group Definition Input

POST のレスポンスボディAction Link Group Definition

POST の例アクションリンクグループをフィード項目に関連付けるには、まずアクションリンクグループ定義を作成します。

142


メモ: Salesforceリソースへの actionUrlは、相対リンクにすることができます。他のすべてのリンクは、https:// で始まる絶対リンクにする必要があります。


{

"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",


},

{

"name" : "X-PrettyPrint",

"value" : "1"

}

143


],

"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",


},

{

"name" : "Accept",


},

{

"name" : "X-PrettyPrint",

"value" : "1"

}

144


],

"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": {


{

"type": "Text",

"text": "Please confirm or deny this item. You can also click Review to provide

145


more feedback."

}

]

},

"subjectId": "me",

"feedElementType": "FeedItem",

"capabilities": {



}

}

}

さまざまな種別のアクションリンクのさまざまなワークフローで status プロパティが設定されます。値は UI に表示されます。詳細は、/connect/action-links/actionLinkIdを参照してください。

メモ: この例では、他の機能は含まれていませんが、アクションリンクのあるフィード項目では、コンテンツ、アンケート、リンクなど、他の機能がサポートされます。

関連トピック:

アクションリンクを定義し、フィード要素を使用して投稿するアクションリンクテンプレートアクションリンクを定義し、フィード要素を使用して投稿するテンプレートのアクションリンクを定義し、フィード要素を使用して投稿する

Action Link Group Definitionアクションリンクグループ定義の情報取得や削除を行います。アクションリンクグループ定義を削除すると、その定義へのすべての参照がフィード要素から削除されます。アクションリンクグループ定義の取得や削除を行うには、クライアントは定義を作成した接続アプリケーションと同じである必要があり、ユーザは定義を作成したか「すべてのデータの参照」権限を持っている必要があります。リソース

/connect/action-link-group-definitions/actionLinkGroupId

/connect/communities/communityId/action-link-group-definitions/actionLinkGroupId


146

Action Link Group DefinitionChatter REST API リソース


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



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

Action Link GroupChatter REST API リソース

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

Action LinkChatter REST API リソース

の非同期操作が開始されます。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



HTTP メソッドGET、PATCH、HEAD

PATCH のリクエストボディルート XML タグ

<actionLink>

JSON の例{ "status" : "SuccessfulStatus" }

149


プロパティ


必須項目/省略可能

説明型名前

33.0必須項目アクションの現在の実行状況。値は次のとおりです。

Stringstatus

• FailedStatus — アクションリンクの実行に失敗しました。

• NewStatus — アクションリンクの実行の準備が整っています。Download および Ui

アクションリンクでのみ使用できます。

• PendingStatus — アクションリンクが実行されています。この値を選択すると、Api および ApiAsync アクションリンクの API コールがトリガされます。

• SuccessfulStatus — アクションリンクが正常に実行されました。

PATCH の要求パラメータ

使用可能なバージョン説明型名前

33.0値は次のとおりです。Stringstatus


• NewStatus — アクションリンクの実行の準備が整っています。Download および Ui

アクションリンクでのみ使用できます。

• PendingStatus — アクションリンクが実行されています。この値を選択すると、Apiお

150



よび 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



レスポンスボディAction Link Diagnostic

Announcements リソース

お知らせに関する情報。既存のお知らせの表示期限の情報取得や更新を行います。お知らせは、削除されるか、別のお知らせで置き換えられない限り、その表示期限の 11:59 p.m. まで Salesforce UI の指定の場所に表示されます。お知らせは、情報を強調表示するために使用します。ユーザは、グループフィードのお知らせに対するディスカッション、いいね!、コメントの投稿ができます。他の投稿と同様に、お知らせが投稿されると、グループ

151

Action Link Diagnostic InformationChatter REST API リソース

メンバーは選択したグループメール通知頻度に応じてメール通知を受信します。フィード投稿を削除するとお知らせが削除されます。次のSalesforceの画像では、お知らせが黄色で表示されています。お知らせを作成すると、お知らせのテキストを含むフィード項目も作成されます。これもこの画像で確認できます。

グループにお知らせを投稿したり、グループ内のすべてのお知らせに関する情報を取得したりするには、Group

Announcements リソース (/chatter/groups/groupId/announcements) を使用します。リソース

/chatter/announcements/announcementId

/connect/communities/communityId/chatter/announcements/announcementId


Chatter が必要かどうかはい

HTTP メソッドGET、PATCH、DELETE、HEAD



必須項目/省略可能説明値パラメータ名

31.0必須項目別のお知らせが最初に投稿されていない

DateexpirationDate

限り、この日付の11:59 p.m. まで

152

Announcements リソースChatter REST API リソース



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

Batch リソースChatter REST API リソース

},

{

"method" : "Get",

"url" : "/v34.0/chatter/feed-elements/feedElementId/capabilities/chatter-likes/items"

}

],

"haltOnError" : "false"

}

バッチ内の各要求はサブ要求と呼ばれます。サブ要求はすべて同じユーザのコンテキスト内で実行されます。各サブ要求は独立しており、相互に情報を渡すことはできません。サブ要求は、リクエストボディ内の順序に従って実行されます。サブ要求が正常に実行されると、データがコミットされます。コミットは、以降のサブ要求の出力に反映されます (前の例のように、フィード項目にいいね! と言ってから、いいね! の総数を取得するなど)。サブ要求が失敗した場合、前のサブ要求で行われたコミットはロールバックされません。リソース

/connect/batch




リクエストボディGeneric Batch Collection Input

ルート XML タグ<batch>

JSON

{

"batchRequests" : [

{

"method" : "Get",

"url" : "/v34.0/chatter/feeds/news/me"

},

154


{

"method" : "Get",

"url" : "/v34.0/chatter/feeds/user-profile/me"

}

]

}

プロパティ


説明型名前

28.0実行するサブ要求の URL を含む、Batch

Request Input リクエストボディのコレクション。

Generic Batch Input[]batchRequests

28.0デフォルト値は、false です。値が false で、バッチ内のサブ要求が完了しない場合、Salesforceは、バッ

BooleanhaltOnError

チ内の後続のサブ要求を実行しようと試みます。値が true で、HTTP 応答 400 番台または 500 番台のエラーが含まれるためにバッチ内のサブ要求が完了しない場合、Salesforce は実行を停止します。バッチ内にある後続のサブ要求の実行は試みず、後続のサブ要求ごとに HTTP

412 状況コードと前の要求が失敗したことを示すBATCH_PROCESSING_HALTED エラーメッセージを返します。/connect/batch への最上位要求は、HTTP 200 を返し、応答内のhasErrors プロパティが true に設定されます。

要求パラメータなし。

応答Batch Results

155


例この単純な例では、https://instance_name/services/data/v34.0/connect/batch に対する POST

要求に、2 つのサブ要求を持つ次のリクエストボディが含まれています。{

"batchRequests" : [

{

"method" : "Get",


},

{

"method" : "Get",


}

]

}

Batch Results レスポンスボディには、サブ要求ごとに Batch Result Item レスポンスボディが含まれます。{

"hasErrors": false,

"results": [

{

"result": {


"feedElementsUrl": "/services/data/v34.0/chatter/feeds

/user-profile/005D0000001LL8OIAW/feed-elements",

"isModifiedUrl": null

},

"statusCode": 200

},

156


{

"result": {


"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",


}

],

"haltOnError" : "true"

}

Batch Results レスポンスボディには、サブ要求ごとに Batch Result Item レスポンスボディが含まれます。/connect/batch への最上位要求は HTTP 200 を返しますが、最初のサブ要求はリソースが見つからな

157


いため 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



"capabilities":{ "content":{ "title":"Presentation1.txt" } } } }, {"url":"/v33.0/chatter/feed-elements/0D5D0000000YG0M/capabilities/comments/items",


"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!...


Host: instance_name

Content-Type: multipart/form-data; boundary=123123

--123123


Content-Type: application/json

{

"haltOnError":true,

"batchRequests":[

159


{

"url":"/v34.0/chatter/feed-elements/0D5D0000000YG0D/capabilities/comments/items",

"method":"Post",



"richInput":{

"body":{

"messageSegments":[

{

"type":"Text",


}

]

},

"capabilities":{

"content":{


}

}

}

},

{

"url":"/v34.0/chatter/feed-elements/0D5D0000000YG0H/capabilities/comments/items",

"method":"Post",



160


"richInput":{

"body":{

"messageSegments":[

{

"type":"Text",


}

]

},

"capabilities":{

"content":{


}

}

}

}

]

}

--123123





--123123

161






--123123--

関連トピック:

フィード項目にいいね! と言い、いいね! の総数を返すFeed Elements, Batch Post

Chatter リソース

Chatter フィード、グループ、およびユーザリソースのディレクトリ。リソース

/chatter

/connect/communities/communityId/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 リソースChatter REST API リソース

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



HTTP メソッドGET、DELETE、PATCH

PATCH はバージョン 34.0 以降でサポートされます。PATCH のリクエストボディルート XML タグ

<comment>

プロパティ


説明型名前

24.0 ～ 31.0省略可能。値は次のとおりです。種別によって異なる。attachment

• Attachment Input: Existing Content

• Attachment Input: New File Upload

163

Comments リソースChatter REST API リソース


説明型名前

重要: バージョン 32.0 以降では、capabilities プロパティを使用します。

23.0メッセージ本文の説明Message Body Inputbody

32.0添付ファイルなど、コメントの機能。Comment Capabilities Inputcapabilities

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




GET のレスポンスボディFeed Entity Is Editable

Comment Likesコメントへのいいね! に関する情報を取得します。コメントへのいいね! にも使用されます。リソース

/chatter/comments/commentId/likes

/connect/communities/communityId/chatter/comments/commentId/likes

164

Comments リソースChatter REST API リソース



HTTP メソッドGET、POST、または HEAD

GET または HEAD の要求パラメータ

メモ: POST は、要求パラメータもリクエストボディも取りません。

説明型パラメータ名

返すページのページ番号を指定します。

Integerpage

ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。サ

IntegerpageSize

イズを指定しない場合、デフォルトは 25 です。

GET のレスポンスボディLike Page

POST のレスポンスボディLike

Communities リソース

コンテキストユーザが使用できるコミュニティに関する情報、または特定のコミュニティに関する情報。次のリソースを使用できます。

説明リソース


/connect/communities

指定されたコミュニティに関する情報を返します。/connect/communities/communityId

List of Communitiesコンテキストユーザが使用できるすべてのコミュニティリストを返します。ユーザがシステム管理者の場合、絞り込み条件を満たすコミュニティすべてのリストを返します。ユーザがシステム管理者ではない場合、絞り込み条件を満たす有効なコミュニティすべてのリストを返します。

165

Communities リソースChatter REST API リソース

リソース/connect/communities




要求パラメータ


28.0特定の状況のコミュニティのみを返します。有

Stringstatus

効な値は、次のとおりです。• Live

• Inactive

• UnderConstruction

「ネットワークの管理」権限が有効化されているユーザのみが、Inactive 状況のコミュニティを表示できます。このパラメータは省略可能です。

レスポンスボディCommunity Page

Community Information指定されたコミュニティに関する情報を返します。リソース

/connect/communities/communityId

166

Communities リソースChatter REST API リソース

指定されたコミュニティの一部であるリソースにアクセスするには、URL のバージョン情報の後、アクセスするリソースの前にこのセグメントを挿入します。たとえば、コミュニティの News Feed リソースにアクセスするには、次の URL を使用します。https://instance_name/services/data/v34.0/connect


詳細は、「Chatter REST API リソース URL の作成」 (ページ 5)を参照してください。適用開始バージョン

26.0



レスポンスボディCommunity

Communities Moderation リソース

ユーザがフィード要素、コメント、またはファイルに不適切フラグを設定したかどうかに関する情報。フラグの削除にも使用されます。次のリソースを使用できます。

説明リソース

フィード要素のモデレーション機能に関する情報の取得、フィード要素へのモデレーションフラグの追加、

/connect/communities/communityId/chatter/feed-elements/feedElementId/capabilities/moderation またはフィード要素のすべてのモデレーションフラグ

の削除を行います。

コンテキストユーザがコミュニティモデレータの場合、コミュニティメンバーが 1 つのコメントにフラグ

/connect/communities/communityId/chatter/comments/commentId/moderation-flags

を設定した回数を返します。また、モデレーションのためにコメントにフラグを設定したり、コメントのすべてのフラグを削除したりします。コンテキストユーザがコミュニティモデレータでない場合は、ユーザがコメントにフラグを設定したかどうかを返します。また、モデレーションのためにコメントにフラグを設定したり、ユーザが以前に追加したフラグを削除したりします。

167

Communities Moderation リソースChatter REST API リソース

説明リソース

コミュニティでフラグが設定されたファイル。コンテキストユーザがコミュニティモデレータの場合、コミュニティメンバーによってフラグが設定されたファイルを返します。

/connect/communities/communityId/chatter/files/moderation

コンテキストユーザがコミュニティモデレータの場合、コミュニティメンバーが 1 つのファイルにフラグ

/connect/communities/communityId/chatter/files/fileId/moderation-flags

を設定した回数を返します。また、モデレーションのためにファイルにフラグを設定したり、ファイルのすべてのフラグを削除したりします。コンテキストユーザがコミュニティモデレータでない場合は、ユーザがファイルにフラグを設定したかどうかを返します。また、モデレーションのためにファイルにフラグを設定したり、ユーザが以前に追加したフラグを削除したりします。

Moderation Flags on Postsコンテキストユーザが「コミュニティフィードのモデレート」権限を持つコミュニティモデレータの場合、コミュニティメンバーが 1 つの投稿にフラグを設定した回数を返します。また、モデレーションのために投稿にフラグを設定したり、投稿のすべてのフラグを削除したりします。コンテキストユーザがコミュニティモデレータでない場合は、ユーザが投稿にフラグを設定したかどうかを返します。また、モデレーションのために投稿にフラグを設定したり、ユーザが以前に追加したフラグを削除したりします。リソース

/connect/communities/communityId/chatter/feed-items/feedItemId/moderation-flags

使用可能なバージョン29.0 ～ 31.0

重要: バージョン 32.0 以降では、Feed Elements Capability, Moderation を使用します。


HTTP メソッドGET、DELETE、HEAD、POST

168


GET の要求パラメータ



説明型名前

30.0 ～ 31.0省略可能さまざまなユーザ種別でのフラグの表示動作を指定します。

Stringvisibility

• ModeratorsOnly — フラグは、フラグが付けられた要素または項目に対するモデレーション権限を持つユーザにのみ表示されます。

• SelfAndModerators — フラグは、フラグの作成者とフラグが付けられた要素または項目に対するモデレーション権限を持つユーザに表示されます。

POST のリクエストボディルート XML タグ

<moderationFlag>

JSON

{

"visibility" : "ModeratorsOnly"

}

プロパティ


説明型名前

30.0さまざまなユーザ種別でのフラグの表示動作を指定します。

Stringvisibility



169


POST の要求パラメータ



説明型名前

30.0 ～ 31.0省略可能さまざまなユーザ種別でのフラグの表示動作を指定します。

Stringvisibility



DELETE の要求パラメータ



説明型名前

29.0

～31.0

省略可能コンテキストユーザの ID。指定されている場合、ユーザが以前に投稿に追加したフラグが削除されます。指定されておらず、コンテキストユーザがコミュニティ

StringuserId

モデレータの場合は、投稿のすべてのフラグが削除されます。

GET および POST のレスポンスボディModeration Flags

Moderation Flags on Commentsコンテキストユーザがコミュニティモデレータの場合、コミュニティメンバーが 1 つのコメントにフラグを設定した回数を返します。また、モデレーションのためにコメントにフラグを設定したり、コメントのすべてのフラグを削除したりします。コンテキストユーザがコミュニティモデレータでない場合は、ユーザがコメントにフラグを設定したかどうかを返します。また、モデレーションのためにコメントにフラグを設定したり、ユーザが以前に追加したフラグを削除したりします。リソース

/connect/communities/communityId/chatter/comments/commentId/moderation-flags

170








説明型名前

30.0省略可能さまざまなユーザ種別でのフラグの表示動作を指定します。

Stringvisibility




<moderationFlag>

JSON

{


}

プロパティ


説明型名前


Stringvisibility


• SelfAndModerators — フラグは、フラグの作成者とフラグが付けられた要

171



説明型名前

素または項目に対するモデレーション権限を持つユーザに表示されます。




説明型名前


Stringvisibility






説明型名前

29.0省略可能コンテキストユーザの ID。指定されている場合、ユーザが以前にコメントに追加したフラグが削除されま

StringuserId

す。指定されておらず、コンテキストユーザがコミュニティモデレータの場合は、コメントのすべてのフラグが削除されます。


Moderation Flags on Filesコンテキストユーザがコミュニティモデレータの場合、コミュニティメンバーが 1 つのファイルにフラグを設定した回数を返します。また、モデレーションのためにファイルにフラグを設定したり、ファイルのすべてのフラグを削除したりします。コンテキストユーザがコミュニティモデレータでない場合は、ユーザがファイルにフラグを設定したかどうかを返します。また、モデレーションのためにファイルにフラグを設定したり、ユーザが以前に追加したフラグを削除したりします。

172


リソース/connect/communities/communityId/chatter/files/fileId/moderation-flags







説明型名前


Stringvisibility




<moderationFlag>

JSON

{


}

プロパティ


説明型名前


Stringvisibility

• ModeratorsOnly — フラグは、フラグが付けられた要素または項目に対する

173



説明型名前

モデレーション権限を持つユーザにのみ表示されます。





説明型名前


Stringvisibility






説明型名前

30.0省略可能コンテキストユーザの ID。指定されている場合、ユーザが以前にファイルに追加したフラグが削除されま

StringuserId

す。指定されておらず、コンテキストユーザがコミュニティモデレータの場合は、ファイルのすべてのフラグが削除されます。


Flagged Filesコミュニティでフラグが設定されたファイル。

174


コンテキストユーザがコミュニティモデレータの場合、コミュニティメンバーによってフラグが設定されたファイルを返します。リソース

/connect/communities/communityId/chatter/files/moderation







説明型名前

30.0省略可能返すページのページ番号を指定します。Integerpage

30.0省略可能ページあたりの項目数を指定します。有効な値は 1 ～100 です。サイズを指定しない場合、デフォルトは 25

です。

IntegerpageSize

33.0省略可能結果を絞り込むクエリ文字列。文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要が

Stringq

あります。ワイルドカードについての詳細は、「ワイルドカード」を参照してください。

レスポンスボディFile Summary

Connect リソース

コンテキストユーザの組織と設定に関する情報、およびコンテキストユーザがメンバーであるコミュニティに関する情報。

メモ: これらのリソースの基本 URL は、/services/data/v34.0/chatter ではなく、/services/data/v34.0/connect です。

次のリソースを使用できます。

説明リソース

コンテキストユーザが使用できる組織およびコミュニティのリソースのディレクトリ。

/connect

コンテキストユーザの組織と設定に関する情報。/connect/organization

175

Connect リソースChatter REST API リソース

説明リソース


/connect/communities

Connectコンテキストユーザが使用できる組織およびコミュニティのリソースのディレクトリ。リソース

/connect



HTTP メソッドGET および HEAD

レスポンスボディConnect Directory

Organizationコンテキストユーザの組織と設定に関する情報。リソース

/connect/organization




レスポンスボディOrganization

関連トピック:

News Feed リソース

Dashboard Component Snapshot リソース

ダッシュボードコンポーネントのスナップショット。

176

Dashboard Component Snapshot リソースChatter REST API リソース

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

/connect/dashboards/components/componentId/snapshots




リクエストボディルート XML タグ

<dashboardComponentSnapshot>

JSON

{

"parentId" : "0F9D00000000I4O",

"feedItemBody" : {


{

"text" : "Sales Heat",

"type" : "Text"

}

]

}

}

プロパティ


25.0スナップショットの post 送信先となるユーザ、グループ、またはダッシュボードの ID。

StringparentId

25.0省略可能。ダッシュボード絞り込み項目の ID。

StringfilterId1

177

Dashboard Component Snapshot リソースChatter REST API リソース


25.0省略可能。2 つ目のダッシュボード絞り込み項目の ID。

StringfilterId2


StringfilterId3

25.0ダッシュボードコンポーネントスナップショットに関連付

Message Body InputfeedItemBody

けられたフィード項目に付随するテキストが含まれます。

25.0省略可能。ダッシュボードのビューの作成元となるユーザID (作成者以外の場合)。

StringrunningUserId


説明型名前

スナップショットの post 送信先となるユーザ、グループ、またはダッシュボードのID。

StringparentId

省略可能。ダッシュボード絞り込み項目のID。

String。filterId1

省略可能。2 つ目のダッシュボード絞り込み項目の ID。

StringfilterId2

省略可能。3 つ目のダッシュボード絞り込み項目の ID。

StringfilterId3

ダッシュボードコンポーネントスナップショットに付随するテキスト。

StringfeedItemText

省略可能。ダッシュボードのビューの作成元となるユーザ ID (作成者以外の場合)。

StringrunningUserId

レスポンスボディAPI バージョン 23.0 ～ 31.0 では、Feed Item Attachment: Dashboard を返します。API バージョン 32.0 以降では、Dashboard Component Snapshot を返します。

Datacloud リソース

Data.com の取引先責任者または会社を購入するために使用する Datacloud リソースに関する情報。

178

Datacloud リソースChatter REST API リソース

Datacloud リソースを使用してData.comの取引先責任者または会社を購入し、利用できるクレジット数など、購入に関する情報を取得します。

説明リソース

指定された companyIdの会社項目の値を返します。/connect/datacloud/companies/companyId

指定された取引先責任者の取引先責任者情報を返します。

/connect/datacloud/contacts/contactId

指定された注文に含まれるすべての会社に関するすべての情報を返します。

/connect/datacloud/orders/orderId/companies

取引先責任者の特定の orderId の注文情報をすべて返します。

/connect/datacloud/orders/orderId/contacts

リストされた ID の取引先責任者または会社を購入します。POST 要求には取引先責任者 ID または会社 ID を

/connect/datacloud/orders

指定できますが、両方は指定できません。orderInput。

Monthly ユーザまたは Listpool ユーザの利用状況情報を返します。

/connect/datacloud/usage/userId

Datacloud Company Information指定された companyId の会社項目の値を返します。リソース

/connect/datacloud/companies/companyId




レスポンスボディDatacloudCompanyRepresentation

Datacloud Contact Information指定された取引先責任者の取引先責任者情報を返します。リソース

/connect/datacloud/contacts/contactId

179

Datacloud Company InformationChatter REST API リソース




レスポンスボディDatacloudContactRepresentation

Datacloud OrderId Information特定の orderId の情報を返します。リソース

注文情報には、orderId、orderId で購入したレコード数、注文情報の URL、購入したレコードのリストの URL が含まれます。/connect/datacloud/orders/orderId




レスポンスボディDatacloudOrderRepresentation

Datacloud Company Order Information指定された注文に含まれるすべての会社に関するすべての情報を返します。orderIdは購入した会社のものである必要があります。取引先責任者の orderIdへの要求は失敗します。注文情報には、orderId、その注文で購入したレコード数、購入した会社の情報、次ページと前ページの URL が含まれます。リソース

/connect/datacloud/orders/orderId/companies




180

Datacloud OrderId InformationChatter REST API リソース





32.0必須項目現在のページの URL として設定するページ番号。

Integerpage

32.0省略可能返すページの数。デフォルトのページサイズは 25 です。

IntegerpageSize

GET のレスポンスボディDatacloudCompanyCollectionRepresentation

Datacloud Contact Order Information取引先責任者の特定の orderId の注文情報をすべて返します。注文情報には、orderId、orderIdで購入したレコード数、注文情報の URL、購入した取引先責任者の詳細が含まれます。orderIdは、購入した取引先責任者のものである必要があります。購入した会社の orderIdを含む要求は失敗します。リソース

/connect/datacloud/orders/orderId/contacts








32.0省略可能返すページの数。Integerpage

32.0省略可能ページごとに返す取引先責任者の数。デフォルトのページサイズは25 です。

IntegerpageSize

GET のレスポンスボディDatacloudContactCollectionRepresentation

181

Datacloud Contact Order InformationChatter REST API リソース

Datacloud Ordersリストされた ID の取引先責任者または会社を購入します。POST 要求には取引先責任者 ID または会社 ID を指定できますが、両方は指定できません。orderInput。1 回の POST 要求で取引先責任者または会社を購入し、指定します。リソース

/connect/datacloud/orders





<DatacloudOrder>

JSON の例{

"companyIds":[

"23456",

"24548"

],

"userType":"Monthly"

}

プロパティ



説明型名前

32.0必須項目購入する会社のリスト。contactIds とcompanyIdsが共に含まれていると、購入は失敗します。

StringcompanyIds

32.0必須項目購入する取引先責任者のリスト。リストには取引先責任者のみを含めることをお勧めしま

StringcontactIds

す。companyIds と contactIds が共に含まれていると、購入は失敗します。

182

Datacloud OrdersChatter REST API リソース



説明型名前

32.0省略可能 —

ユーザ種別Data.com ユーザ種別。StringuserType

• Monthy — Data.comレコードの購入の毎月のポイント制限が割り当てられるユーザが指定され

ていない場種別。毎月のポイントを使用できるのは、合、デフォ割り当てられたユーザのみです。ポインルトはトは、月末に期限切れになります。MonthlyMonthly です。

は、DatacloudUserType のデフォルト設定です。

• Listpool — Data.com レコードを購入するためのポイントをユーザがプールから引き出すことを許可するユーザ種別。





32.0必須項目取引先責任者 ID または会社 ID のリストを含むリクエストボディ。

ObjectorderInput

POST のレスポンスボディDatacloudOrderRepresentation

Datacloud UsageMonthly ユーザまたは Listpool ユーザの利用状況情報を返します。リソース

/connect/datacloud/usage/userId




レスポンスボディDatacloudPurchaseUsageRepresentation

183

Datacloud UsageChatter REST API リソース

Feed Elements リソース

フィード要素に関する情報。フィード要素へのアクセス、フィード要素の編集、投稿、検索、削除を行います。バンドルやそのフィード要素など、フィード要素の機能にアクセスします。使用可能なリソース:

説明リソース

フィード要素の投稿や、組織のすべてのフィード要素の検索を行います。


最大 500 件のフィード要素を一括投稿します。

/chatter/feed-elements/batch

最大 500 個のフィード要素から成るカンマ区切りのリストに関する情報

/chatter/feed-elements/batch/feedElementIds

を取得します。読み込みできないフィード要素のエラーは、結果で返されます。

フィード要素へのアクセス、あるいはその編集または削除を行います。

/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

Feed Elements リソースChatter REST API リソース

説明リソース

フィード要素のキャンバス機能にアクセスします。

/chatter/feed-elements/feedElementId/capabilities/canvas

フィード要素のケースコメント機能にアクセスします。

/chatter/feed-elements/feedElementId/capabilities/case-comment

フィード要素の Chatter のいいね! 機能に関する情報にアクセスします

/chatter/feed-elements/feedElementId/capabilities/chatter-likes

フィード要素のいいね! のページにアクセスするか、フィード要素にいいね! を追加します。

/chatter/feed-elements/feedElementId/capabilities/chatter-likes/items

フィード要素のコメント機能にアクセスします。

/chatter/feed-elements/feedElementId/capabilities/comments

フィード要素のコメントにアクセスするか、フィード要素にコメントを追加します。


フィード要素のコンテンツ機能にアクセスします。

/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

Feed Elements リソースChatter REST API リソース

説明リソース

がある場合、そのフィード要素はフィードアクションによって作成されています。

フィード要素のアンケートへのアクセス、アンケートの作成、またはアンケートへの投票を行います。

/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フィード要素の投稿や、組織のすべてのフィード要素の検索を行います。リソース


/connect/communities/communityId/chatter/feed-elements



HTTP メソッドGET、POST

186

Feed Elements, Post and SearchChatter REST API リソース





31.0省略可能情報ページの表示に使用されるページトークンを指定します。

Stringpage

ページトークンは、currentPageToken またはnextPageToken のように、応答クラスの一部として返されます。nullを渡すと、最初のページが返されます。

31.0省略可能ページあたりのフィード要素数を指定します。有効な値は 1 ～

IntegerpageSize

100 です。null を渡すと、デフォルトサイズの 25 に設定されます。

31.0必須項目コンテキストユーザに表示されるフィード要素に含まれる 1 つ

Stringq

以上の検索キーワード。検索文字列にはワイルドカード文字を含めることができ、ワイルドカード文字を除く 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。

31.0省略可能フィード要素ごとに返されるコメントの最大数。デフォルト値は 3 です。

IntegerrecentCommentCount

31.0省略可能作成日や最終更新日などで並び替えて返される順序を指定します。

Stringsort

• CreatedDateDesc — 作成日の新しい順に並び替えます。

• LastModifiedDateDesc —

活動の新しい順に並び替えられます。

GET のレスポンスボディFeed Element Page

187


POST のリクエストボディFeed Item Input





31.0必須項目フィード要素は、フィードに含まれる最上位の項目です。フィードは、フィード要素コンテナです。使用可能な値は FeedItemのみです。

StringfeedElementType

31.0省略可能このフィード要素が共有されている場合、これは元のフィード要素の 18 文字の ID です。

StringoriginalFeedElementId

31.0必須項目このフィード要素が投稿された親の ID。この値は、ユーザ、グルー

StringsubjectId

プ、レコードの ID、またはコンテキストユーザを示す文字列 me になります。

31.0必須項目フィード要素のテキスト。Stringtext

31.0省略可能フィード要素を表示できるユーザの種別を指定します。

Stringvisibility

• AllUsers — 表示は内部ユーザに限定されません。

• InternalUsers — 表示は内部ユーザに限定されます。

POST のレスポンスボディFeed Item

POST の例次の例では、ユーザにメンションするテキストを投稿します。POST /chatter/feed-elements

{

"body" : {


188


{

"type" : "Text",


},

{

"type" : "Mention",

"id" : "005D00000016Qxp"

}]

},



}

関連トピック:

アクションリンクテンプレートアクションリンクを定義し、フィード要素を使用して投稿するテンプレートのアクションリンクを定義し、フィード要素を使用して投稿する

Feed Elements, Batch Post最大 500 件のフィード要素を一括投稿します。リソース

/chatter/feed-elements/batch

/connect/communities/communityId/chatter/feed-elements/batch



HTTP メソッドPOST、HEAD

POST のリクエストボディBatch Collection Input

このバッチコレクションのリッチ入力は Feed Item Input です。

189

Feed Elements, Batch PostChatter REST API リソース

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":"PostNumber1"}]},"feedElementType":"FeedItem"}},{"richInput":{"subjectId":"me","body":{"messageSegments":[{"type":"Text","text":"PostNumber 2"}]},"feedElementType":"FeedItem"}}]};type=application/json' -X POSThttps://instance_name/services/data/v34.0/chatter/feed-elements/batch -H 'Authorization:OAuth 00DD00000007HoR!...' --insecure

次に、同じ例のリクエストボディのみを示します。{

"inputs": [

{

"richInput": {

"subjectId": "me",

"body": {


{

"type": "Text",


}

]

},


}

},

190


{

"richInput": {

"subjectId": "me",

"body": {


{

"type": "Text",


}

]

},


}

}

]

}

バイナリファイルを含むフィード要素の一括投稿次の例では、/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":"PostNumber 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


-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



Host: instance_name

Content-Length: 845






{

"inputs": [

{


"bin1"

],

"richInput": {

"subjectId": "me",

"body": {


{

"type": "Text",


192


}

]

},

"capabilities": {

"content": {



}

},


}

},

{


"bin2"

],

"richInput": {

"subjectId": "me",

"body": {


{

"type": "Text",


}

]

},

"capabilities": {

193


"content": {


"title": "receipt2.pdf"

}

},


}

}

]

}


Content-Disposition: form-data; name="bin1"; filename="receipt.pdf"




Content-Disposition: form-data; name="bin2"; filename="receipt2.pdf"


...contents of receipt2.pdf...


194


メモ: binaryPartNamesプロパティ内のバイナリパート名は、バイナリリクエストパートの nameプロパティ内のバイナリパート名と一致する必要があります。

関連トピック:

Chatter REST API 入力の使用Batch リソース

Feed Elements, Batch Get最大 500 個のフィード要素から成るカンマ区切りのリストに関する情報を取得します。読み込みできないフィード要素のエラーは、結果で返されます。リソース

/chatter/feed-elements/batch/feedElementIds

/connect/communities/communityId/chatter/feed-elements/batch/feedElementIds




GET のレスポンスボディBatch Results

Feed Elementフィード要素へのアクセス、あるいはその編集または削除を行います。フィード要素の種類のうち、編集可能なのはフィード項目のみです。リソース

/chatter/feed-elements/feedElementId

/connect/communities/communityId/chatter/feed-elements/feedElementId



HTTP メソッドGET、DELETE、PATCH

PATCH はバージョン 34.0 以降でサポートされます。

195

Feed Elements, Batch GetChatter REST API リソース





31.0省略可能バンドルあたりの最大フィード要素数。デフォルトおよび最大値は、10 です。

IntegerelementsPerBundle



PATCH のリクエストボディFeed Item Input

PATCH のレスポンスボディFeed Item

GET のレスポンスボディGeneric Feed Element または Feed Item


Feed Element Capabilitiesフィード要素の機能セットにアクセスします。リソース

/chatter/feed-elements/feedElementId/capabilities

/connect/communities/communityId/chatter/feed-elements/feedElementId/capabilities










196

Feed Element CapabilitiesChatter REST API リソース




31.0省略可能フィード要素ごとに返されるコメントの最大数。デフォルト値は 3

です。


GET のレスポンスボディFeed Element Capabilities

Feed Elements Capability, Approvalフィード要素の承認機能にアクセスします。リソース

/chatter/feed-elements/feedElementId/capabilities/approval

/connect/communities/communityId/chatter/feed-elements/feedElementId/capabilities/approval




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




197

Feed Elements Capability, ApprovalChatter REST API リソース

GET のレスポンスボディAssociated Actions Capability


Feed Elements Capability, Bannerフィード要素のバナー機能にアクセスします。リソース

/chatter/feed-elements/feedElementId/capabilities/banner

/connect/communities/communityId/chatter/feed-elements/feedElementId/capabilities/banner




GET のレスポンスボディBanner Capability


Feed Elements Capability, Bookmarksフィード要素がブックマークされているかどうかの情報の取得や、フィード要素へのブックマークの追加を行います。リソース

/chatter/feed-elements/feedElementId/capabilities/bookmarks

/connect/communities/communityId/chatter/feed-elements/feedElementId/capabilities/bookmarks



HTTP メソッドGET、PATCH


<bookmarksCapability>

<isBookmarkedByCurrentUser>true</isBookmarkedByCurrentUser>

198

Feed Elements Capability, BannerChatter REST API リソース

</bookmarksCapability>

JSON の例{

"isBookmarkedByCurrentUser": true

}

プロパティ



説明型名前

32.0必須項目フィード要素をユーザのためにブックマークする必要があるか

BooleanisBookmarkedByCurrentUser

(true)、否か (false) を指定します。








GET、PATCH のレスポンスボディBookmarks Capability


Feed Elements Capability, Bundleフィード要素のバンドル機能にアクセスします。リソース

/chatter/feed-elements/feedElementId/capabilities/bundle

/connect/communities/communityId/chatter/feed-elements/feedElementId/capabilities/bundle


199

Feed Elements Capability, BundleChatter REST API リソース










です。


GET のレスポンスボディ次のいずれかのレスポンスボディになります。• Generic Bundle Capability

• Tracked Change Bundle Capability


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




200

Feed Elements Capability, Bundle ElementsChatter REST API リソース








Stringpage

ページトークンは、currentPageToken またはnextPageToken のように、応答クラスの一部として返されます。nullを渡すと、最初のページが返されます。

31.0省略可能ページあたりのフィード要素数を指定します。有効な値は 1 ～

IntegerpageSize

100 です。null を渡すと、デフォルトサイズの 25 に設定されます。





Feed Elements Capability, Canvasフィード要素のキャンバス機能にアクセスします。リソース

/chatter/feed-elements/feedElementId/capabilities/canvas

/connect/communities/communityId/chatter/feed-elements/feedElementId/capabilities/canvas



201

Feed Elements Capability, CanvasChatter REST API リソース


GET のレスポンスボディCanvas Capability


Feed Elements Capability, Case Commentフィード要素のケースコメント機能にアクセスします。リソース

/chatter/feed-elements/feedElementId/capabilities/case-comment

/connect/communities/communityId/chatter/feed-elements/feedElementId/capabilities/case-comment




GET のレスポンスボディCase Comment Capability


Feed Elements Capability, Chatter Likesフィード要素の Chatter のいいね! 機能に関する情報にアクセスしますリソース

/chatter/feed-elements/feedElementId/capabilities/chatter-likes

/connect/communities/communityId/chatter/feed-elements/feedElementId/capabilities/chatter-likes




応答Chatter Likes Capability


202

Feed Elements Capability, Case CommentChatter REST API リソース

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省略可能返すページのページ番号を指定します。値を指定しないと、最初のページが返されます。

Integerpage

32.0省略可能1 ページあたりのいいね! の数を指定します。有効な値は 1 ～ 100 で

IntegerpageSize

す。サイズを指定しない場合、デフォルトは 25 です。


フィード要素がこの機能をサポートしていない場合、応答は 404: Not Found になります。GET のレスポンスボディ

Like Page


Feed Elements Capability, Commentsフィード要素のコメント機能にアクセスします。リソース

/chatter/feed-elements/feedElementId/capabilities/comments

/connect/communities/communityId/chatter/feed-elements/feedElementId/capabilities/comments

203

Feed Elements Capability, Chatter Likes ItemsChatter REST API リソース




GET のレスポンスボディComments Capability


Feed Elements Capability, Comments Itemsフィード要素のコメントにアクセスするか、フィード要素にコメントを追加します。コメントの post 送信についての詳細は、「入力での POST、PATCH、または PUT の使用」を参照してください。コメントに添付するバイナリファイルをアップロードするには、マルチパート/フォームデータ要求に含めて送信する必要があります。コメントのテキストを送信するには、マルチパート/フォームデータ要求に JSON または XML リッチ入力ボディパートを含める方法があります。または、その情報を要求パラメータパートで渡すように選択することもできます。マルチパート/フォームデータメッセージを作成する方法についての詳細は、「バイナリファイルのアップロード」を参照してください。リソース


/connect/communities/communityId/chatter/feed-elements/feedElementId/capabilities/comments/items





<comment>

プロパティ


説明型名前




204

Feed Elements Capability, Comments ItemsChatter REST API リソース


説明型名前

重要: バージョン 32.0 以降では、capabilitiesプロパティを使用します。







32.0必須項目コメントのテキスト。Stringtext





32.0省略可能コメントの次のページへの URL。Stringpage

32.0省略可能ページあたりのコメント数。デフォルト値は 3 です。

IntegerpageSize

GET のレスポンスボディComment Page

フィード要素がこの機能をサポートしていない場合、応答は 404: Not Found になります。POST のレスポンスボディ

Comment


Feed Elements Capability, Contentフィード要素のコンテンツ機能にアクセスします。リソース

/chatter/feed-elements/feedElementId/capabilities/content

/connect/communities/communityId/chatter/feed-elements/feedElementId/capabilities/content

205

Feed Elements Capability, ContentChatter REST API リソース




GET のレスポンスボディContent Capability


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




GET のレスポンスボディDashboard Component Snapshot Capability


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



206

Feed Elements Capability, Dashboard Component SnapshotChatter REST API リソース


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




GET のレスポンスボディEmail Message Capability


Feed Elements Capability, Enhanced Linkフィード要素の拡張リンク機能にアクセスします。リソース

/chatter/feed-elements/feedElementId/capabilities/enhanced-link

/connect/communities/communityId/chatter/feed-elements/feedElementId/capabilities/enhanced-link




GET のレスポンスボディEnhanced Link Capability


207

Feed Elements Capability, Email MessageChatter REST API リソース

Feed Elements Capability, Linkフィード要素のリンク機能にアクセスします。リソース

/chatter/feed-elements/feedElementId/capabilities/link

/connect/communities/communityId/chatter/feed-elements/feedElementId/capabilities/link




GET のレスポンスボディLink Capability


Feed Elements Capability, Moderationフィード要素のモデレーション機能に関する情報の取得、フィード要素へのモデレーションフラグの追加、またはフィード要素のすべてのモデレーションフラグの削除を行います。リソース

/connect/communities/communityId/chatter/feed-elements

/feedElementId/capabilities/moderation



HTTP メソッドGET、POST、DELETE、HEAD

GET および POST の要求パラメータ




31.0省略可能さまざまなユーザ種別でのフラグの表示動作を指定します。次のいずれかの値にします。

Stringvisibility

• ModeratorsOnly — フラグは、フラグが付けられた要素ま

208

Feed Elements Capability, LinkChatter REST API リソース




たは項目に対するモデレーション権限を持つユーザにのみ表示されます。



<moderationFlag>

JSON

{


}

プロパティ


説明型名前


Stringvisibility



GET および POST のレスポンスボディModeration Capability


209

Feed Elements Capability, ModerationChatter REST API リソース

Feed Elements Capability, Originフィード要素の発生源機能にアクセスします。フィード要素にこの機能がある場合、そのフィード要素はフィードアクションによって作成されています。リソース

/chatter/feed-elements/feedElementId/capabilities/origin

/connect/communities/communityId/chatter/feed-elements/feedElementId/capabilities/origin




GET のレスポンスボディOrigin Capability


Feed Elements Capability, Pollフィード要素のアンケートへのアクセス、アンケートの作成、またはアンケートへの投票を行います。リソース

/chatter/feed-elements/feedElementId/capabilities/poll

/connect/communities/communityId/chatter/feed-elements/feedElementId/capabilities/poll




PATCH のリクエストボディXML の例

<pollCapability>

<pollChoices>

<choice>Monday</choice>

<choice>Tuesday</choice>

</pollChoices>

210

Feed Elements Capability, OriginChatter REST API リソース

</pollCapability>

JSON の例{

"choices" : [

"Monday", "Tuesday"

]

}

プロパティ



説明型名前

32.0アンケートの作成では必須

新しいアンケートの作成に使用する選択肢。アンケートには 2 個から 10 個のアンケート選択肢を指定する必要があります。

String []choices

32.0アンケートへの投票では必須

フィードアンケートの既存の選択肢の ID。既存のアンケートに投票するために使用されます。

StringmyChoiceId





32.0必須項目アンケート選択肢 ID。StringmyChoiceId

GET、PATCH のレスポンスボディPoll Capability


Feed Elements Capability, Question and Answersフィード要素の質問と回答へのアクセス、またはフィード要素の質問と回答の更新を行います。

211

Feed Elements Capability, Question and AnswersChatter REST API リソース

リソース/chatter/feed-elements/feedElementId/capabilities/question-and-answers

/connect/communities/communityId/chatter/feed-elements/feedElementId/capabilities/question-and-answers





<questionAndAnswersCapability>

<bestAnswerId>0D7D00000000lMAKAY</bestAnswerId>

</questionAndAnswersCapability>

JSON の例{

"bestAnswerId": "0D7D00000000lMAKAY"

}

プロパティ



説明型名前

32.0フィード要素のPATCH では必須です。POST 要求ではサポートされていません。

質問フィード要素の最良の回答として使用するコメント ID。最良の回答コメントは、質問フィード要素にすでに存在する必要があります。

StringbestAnswerId

32.0フィード要素のPOST では必須です。PATCH 要求ではサポートされていません。

質問フィード要素のタイトル。StringquestionTitle

212

Feed Elements Capability, Question and AnswersChatter REST API リソース





32.0必須項目質問フィード要素の最良の回答として使用するコメント ID。最良の

StringbestAnswerId

回答コメントは、質問フィード要素にすでに存在する必要があります。

GET、PATCH のレスポンスボディQuestion and Answers Capability


Feed Elements Capability, Recommendationsフィード要素のおすすめ機能にアクセスします。リソース

/chatter/feed-elements/feedElementId/capabilities/recommendations

/connect/communities/communityId/chatter/feed-elements/feedElementId/capabilities/recommendations




GET のレスポンスボディRecommendations Capability


Feed Elements Capability, Record Snapshotフィード要素のレコードスナップショット機能にアクセスします。リソース

/chatter/feed-elements/feedElementId/capabilities/record-snapshot

/connect/communities/communityId/chatter/feed-elements/feedElementId/capabilities/record-snapshot


213

Feed Elements Capability, RecommendationsChatter REST API リソース



GET のレスポンスボディRecord Snapshot Capability


Feed Elements Capability, Topicsフィード要素に関連付けられたトピックの取得、削除、および投稿を行います。リソース

/chatter/feed-elements/feedElementId/capabilities/topics

/connect/communities/communityId/chatter/feed-elements/feedElementId/capabilities/topics



HTTP メソッドGET、DELETE、POST


<feedItemTopic>

JSON

次の例では、フィード項目に新規のトピックを添付します。{ "topicName": "W3C"

}

プロパティ


必須項目/省略可能説明型名前

29.0topicName プロパティが使用されていない場合、既存のトピックに必要です。

既存のトピックの IDStringtopicId

214

Feed Elements Capability, TopicsChatter REST API リソース



29.0新規のトピック、およびtopicId プロパティが使

新規または既存のトピックの名前 (最大 150 文字)

StringtopicName

用されていない場合の既存のトピックに必要です。





32.0topicNameプロパティが使用さ

既存のトピックの ID。StringtopicId

れていない場合、既存のトピックに必要です。

32.0新規のトピック、および

新規または既存のトピックの名前(最大 150 文字)。

StringtopicName

topicIdプロパティが使用されていない場合の既存のトピックに必要です。





32.0必須項目既存のトピック ID。StringtopicId

POST のレスポンスボディTopic

フィード要素がこの機能をサポートしていない場合、応答は 404: Not Found になります。GET のレスポンスボディ

Topics Capability


215

Feed Elements Capability, TopicsChatter REST API リソース

Feed Elements Capability, Tracked Changesフィード要素の変更追跡機能にアクセスします。リソース

/chatter/feed-elements/feedElementId/capabilities/tracked-changes

/connect/communities/communityId/chatter/feed-elements/feedElementId/capabilities/tracked-changes




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


重要: バージョン 32.0 以降では、Feed Elements, Batch Get を使用します。



GET のレスポンスボディBatch Results

216

Feed Elements Capability, Tracked ChangesChatter REST API リソース

Feed-Items Queryフィード項目のページ設定されたコレクション。このリソースは、フィード項目の検索に使用します。クエリパラメータ (q) が必要です。追跡変更を含む、すべての種別のフィード項目が検索されます。検索では、フィード項目本文に検索語が含まれるフィード項目と、コメントに検索語が含まれるフィード項目を返します。クエリパラメータにワイルドカードを使用することもできます。リソース

/chatter/feed-items?q=searchTerm


重要: バージョン 32.0 以降では、Feed Elements, Post and Search を使用します。




適用開始バージョン



23.0 ～ 31.0省略可能

生成されたトークン。フィード内のフィード項目のビューを示します。

Stringpage

23.0 ～ 31.0省略可能

ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。サイズを指定しない場合、デフォルトは 25 です。

IntegerpageSize

23.0 ～ 31.0必須項目

検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。ワイルドカードについての詳細は、「ワイルドカード」を参照してください。クエリパラメータは、追跡変更を含む、すべての種別のフィード項目を検索します。検索では、フィード項目本文に検索語

Stringq

が含まれるフィード項目と、コメントに検索語が含まれるフィード項目を返します。

29.0 ～ 31.0省略可能

フィード項目ごとに含めるコメントの最大数。デフォルト値は 3 です。


28.0 ～ 31.0省略可能

結果の並び替え順。値は次のとおりです。Stringsort

• CreatedDateDesc

• LastModifiedDateDesc

デフォルト値は、CreatedDateDesc です。

217

Feed-Items QueryChatter REST API リソース

レスポンスボディFeed Item Page

Feed-Items, Specific Feed Item特定のフィード項目のアクセス、削除、またはブックマークを行います。リソース

/chatter/feed-items/feedItemId


重要: バージョン 32.0 以降では、Feed Element を使用します。


HTTP メソッドGET、DELETE、PATCH、または HEAD

PATCH のリクエストボディXML ルートタグは <feedItem> です。


現在のユーザのブックマーク済みフィード項目のリストに現在の


フィード項目を追加するには、true を指定します。現在のユーザのブックマーク済みフィード項目のリストからこのフィード項目を削除するには、falseを指定します。



現在のユーザのブックマーク済みフィード項目のリストに現在の


フィード項目を追加するには、true を指定します。現在のユーザのブックマーク済みフィード項目のリストからこのフィード項目を削除するには、falseを指定します。

218

Feed-Items, Specific Feed ItemChatter REST API リソース

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 を使用します。




<comment>

プロパティ


説明型名前




219

Feed Items CommentsChatter REST API リソース


説明型名前




POST の要求パラメータ既存のファイルを添付するためのパラメータ


必須項目/省略可能説明型パラメータ名

27.0 ～ 31.0必須項目添付ファイルの種別。値ExistingContent を含める必要があります。

StringattachmentType

24.0 ～ 31.0必須項目post 送信する既存のファイルの ID。StringcontentDocumentId

23.0 ～ 31.0省略可能コメントのテキスト。Stringtext

テキストを post 送信するためのパラメータ



23.0 ～ 31.0必須項目コメントのテキスト。

Stringtext




23.0 ～ 31.0省略可能生成されたトークン。フィード内の

Stringpage

フィード項目のビューを示します。ページトークンは、レスポンスボディの一部として、nextPageURL な

220

Feed Items CommentsChatter REST API リソース



ど、いずれかの URL

パラメータで返されます。

23.0 ～ 31.0省略可能ページあたりの項目数を指定します。有

IntegerpageSize

効な値は 1 ～ 100 です。サイズを指定しない場合、デフォルトは 25 です。このパラメータは、ページあたりのコメント数を指定します。

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


重要: バージョン 32.0 以降では、Feed Elements Capability, Chatter Likes Items を使用します。

221

Feed-Items LikesChatter REST API リソース




メモ: POST には要求パラメータはありません。


返すページのページ番号を指定します。

Integerpage


IntegerpageSize


GET または HEAD のレスポンスボディLike Page


関連トピック:

フィード項目にいいね! と言う

Feed-Items Polls既存のアンケートにアクセスまたは投票するために使用されます。リソース

/chatter/feed-items/feedItemId/poll

feedItemId は PollPost 型である必要があります。使用可能なバージョン

26.0 ～ 31.0

重要: バージョン 32.0 以降では、Feed Elements Capability, Poll を使用します。


HTTP メソッドGET、PATCH、または HEAD

PATCH を使用して既存のアンケートに投票するか、現在のユーザの投票を変更します。

222

Feed-Items PollsChatter REST API リソース


<feedPoll>

プロパティ


26.0 ～ 31.0フィードアンケートの既存の選択肢の ID。現在の

StringmyChoiceId

ユーザが投票するアンケート選択肢の ID を指定するために使用されます。




StringmyChoiceId


レスポンスボディFeed Item Attachment: Poll

Feed-Items Topics特定のフィード項目に関連付けられたトピック。新規または既存のトピックを特定のフィード項目に関連付けます。トピックを特定のフィード項目から削除します。フィード項目で既存のトピックを追加または削除できるのは、「トピックの割り当て」権限を持つユーザのみです。フィード項目に新規のトピックを追加できるのは、「トピックの作成」権限を持つユーザのみです。リソース

/chatter/feed-items/feedItemId/topics


重要: バージョン 32.0 以降では、Feed Elements Capability, Topics を使用します。


223

Feed-Items TopicsChatter REST API リソース

HTTP メソッドDELETE、POST




28.0 ～ 31.0必須項目既存のトピックの IDStringtopicId


<feedItemTopic>

JSON


}

プロパティ







StringtopicName





28.0 ～ 31.0topicName パラメータが使用されて


いない場合、既存のトピックに必要です。

224

Feed-Items TopicsChatter REST API リソース



28.0 ～ 31.0新規のトピック、および topicId パラ

新規または既存のトピックの名前 (最大150 文字)

StringtopicName

メータが使用されていない場合の既存のトピックに必要です。



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

Feed リソースChatter REST API リソース

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

Bookmarks Feed リソースChatter REST API リソース

説明リソース

コンテキストユーザのブックマークフィードの URL を返します。

/chatter/feeds/bookmarks/me

コンテキストユーザがブックマークしたすべてのフィード要素を返します。

/chatter/feeds/bookmarks/me/feed-elements

Bookmarks Feed URLコンテキストユーザのブックマークフィードの URL を返します。リソース

/chatter/feeds/bookmarks/userId

/connect/communities/communityId/chatter/feeds/bookmarks/userId

メモ: userId は、コンテキストユーザの ID または別名 me である必要があります。






作成日や最終更新日などで並び替えて返される順序を指定します。

Stringsort


• LastModifiedDateDesc — 活動の新しい順に並び替えられます。

デフォルト値は、CreatedDescDate です。

レスポンスボディFeed

Bookmarks Feed Elementsコンテキストユーザがブックマークしたすべてのフィード要素を返します。

227


リソース/chatter/feeds/bookmarks/userId/feed-elements

/connect/communities/communityId/chatter/feeds/bookmarks/userId/feed-elements









31.0省略可能

フィードの密度。次のいずれかの値にします。

Stringdensity

• AllUpdates — ユーザがフォローする人とレコード、およびユーザがメンバーとなっているグループからのすべての更新が表示されます。

• FewerUpdates — ユーザがフォローする人とレコード、およびユーザがメンバーとなっているグループからのすべての更新が表示されますが、レコードからのシステム生成された更新は非表示になります。

デフォルト値は、AllUpdates です。

31.0省略可能

バンドルに含める最大フィード要素数。値は0 ～ 10 の整数である必要があります。デフォルト値は 3 です。



228





31.0省略可能

生成されたトークン。フィード内のフィード要素のビューを示します。ページトークンは、レスポンスボディの一部として、nextPageURLなど、いずれかの URL

Stringpage

パラメータで返されます。たとえば、次のようになります。"nextPageUrl":

"/services/data/v34.0/

chatter/feeds/news/

005D0000001GLowIAN

/feed-elements

?page=2011-03-30T17:34:50Z,

0D5D0000000DSv4KAG"

31.0省略可能

ページあたりの要素数を指定します。有効な値は 1 ～ 100 です。サイズを指定しない場合、デフォルトは 25 です。

IntegerpageSize

31.0省略可能

このフィード内のフィード要素の本文とコメントに含まれる 1 つ以上の検索キーワード。検索文字列にはワイルドカード文字を含めることができ、ワイルドカード文字を除く 2 文

Stringq

字以上が含まれている必要があります。「ワイルドカード」を参照してください。

31.0省略可能

フィード要素ごとに含めるコメントの最大数。デフォルト値は 3 です。最大値は、25 です。


31.0省略可能


Stringsort



デフォルト値は、CreatedDescDateです。

229


レスポンスボディFeed Element Page

Bookmarks Feed Itemsコンテキストユーザがブックマークしたすべてのフィード項目を返します。リソース

/chatter/feeds/bookmarks/me/feed-items

または/chatter/feeds/bookmarks/userId/feed-items



重要: バージョン 32.0 以降では、Bookmarks Feed Elements を使用します。







29.0 ～ 31.0省略可能


Stringdensity




230





23.0 ～ 31.0省略可能

生成されたトークン。フィード内のフィード項目のビューを示します。ページトークンは、レスポンスボディの一部として、

Stringpage

nextPageURLなど、いずれかの URL パラメータで返されます。たとえば、次のようになります。"nextPageUrl":


chatter/feeds/news/

005D0000001GLowIAN

/feed-items

?page=2011-03-30T17:34:50Z,

0D5D0000000DSv4KAG"

23.0 ～ 31.0省略可能


IntegerpageSize

28.0 ～ 31.0省略可能

このフィード内のフィード項目の本文とコメントに含まれる 1 つ以上の検索キーワード。検索文字列にはワイルドカード文字を含めることができ、ワイルドカード文字を除く 2 文

Stringq


29.0 ～ 31.0省略可能

フィード項目ごとに含めるコメントの最大数。デフォルト値は 3 です。最大値は、25 です。


23.0 ～ 31.0省略可能


Stringsort




231



Bookmarks Feed Items Flatこのリソースは、バージョン 26.0 で廃止されました。フラットフィードを返します。つまり、フィード項目とコメントの間に階層がなく、フィード項目とコメントはすべて同じレベルに配置されます。すべての項目は、時系列に返されます。リソース

/chatter/feeds/bookmarks/me/feed-items/flat

または/chatter/feeds/bookmarks/userId/feed-items/flat







返されるフィード項目数を指定します。有効な値は 0 ～ 100 です。

IntegernumFeedItems

デフォルト値は 25 です。フィード項目にはコメントが含まれる場合があるため、25 個のフラットフィード項目を指定しても、実際に返される数がそれより多くなることがあります。たとえば、各フィード項目に 1 つのコメントがあり、recentCommentCount が1 よりも大きい場合、50 個のフラットフィード項目が返されます。

生成されたトークン。フィード内のフィード項目のビューを示しま

Stringpage

す。ページトークンは、レスポンスボディの一部として、

232



nextPageURL など、いずれかのURL パラメータで返されます。

返される最近のコメントの数を指定します。有効な値は 0 ～ 25 です。デフォルト値は 3 です。


返されたフィードを、作成日の昇順、または最終更新日の昇順で並

String。次のいずれかになります。sort

• CreatedDateDescび替えます。デフォルトはLastModifiedDateDesc です。


レスポンスボディFlat Feed

関連トピック:


Communities Home Feed リソースコミュニティの管理トピックに関連付けられたすべてのフィード要素のリストを返します。リソース

/connect/communities/communityId/chatter/feeds/home/feed-elements




GET パラメータ




32.0省略可能

フィードに適用可能な検索条件値を指定します。

Stringfilter

• AllQuestions — 質問であるフィード要素のみ。

• CommunityScoped — 今後の使用のための予約。

233

Communities Home Feed リソースChatter REST API リソース




• SolvedQuestions — 質問で最良の回答があるフィード要素のみ。

• UnansweredQuestions — 質問で回答がないフィード要素のみ。

• UnsolvedQuestions — 質問で最良の回答がないフィード要素のみ。

29.0省略可能

生成されたトークン。フィード内のフィード要素のビューを示します。ページトークンは、レスポンスボディの一部として、

Stringpage

nextPageURL など、いずれかの URL パラメータで返されます。たとえば、次のようになります。"nextPageUrl":


chatter/feeds/news/

005D0000001GLowIAN

/feed-elements

?page=2011-03-30T17:34:50Z,

0D5D0000000DSv4KAG"

29.0省略可能


IntegerpageSize

29.0省略可能

このフィード内のフィード要素の本文とコメントに含まれる 1 つ以上の検索キーワード。検索文字列にはワイルドカード文字を含めることができ、ワイルドカード文字を除く

Stringq

2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。

234

Communities Home Feed リソースChatter REST API リソース




29.0省略可能


Stringsort





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



235

Communities Moderation Feed リソースChatter REST API リソース


GET パラメータ




29.0省略可能


Stringpage



chatter/feeds/news/

005D0000001GLowIAN

/feed-elements

?page=2011-03-30T17:34:50Z,

0D5D0000000DSv4KAG"

29.0省略可能


IntegerpageSize

29.0省略可能

このフィード内のフィード要素の本文とコメントに含まれる 1 つ以上の検索キーワード。検索文字列にはワイルドカード文字を含めることができ、ワイルドカード文字を除く

Stringq


29.0省略可能


Stringsort



236







フィード要素にコメントが含まれる場合、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


重要: バージョン 32.0 以降では、Communities Moderation Feed Elements を使用します。



237


GET パラメータ




29.0 ～ 31.0省略可能


Stringpage



chatter/feeds/news/

005D0000001GLowIAN

/feed-items

?page=2011-03-30T17:34:50Z,

0D5D0000000DSv4KAG"

29.0 ～ 31.0省略可能


IntegerpageSize

29.0 ～ 31.0省略可能

このフィード内のフィード項目の本文とコメントに含まれる 1 つ以上の検索キーワード。検索文字列にはワイルドカード文字を含めることができ、ワイルドカード文字を除く

Stringq


29.0 ～ 31.0省略可能


Stringsort




238


GET のレスポンスボディFeed Item Page

フィード項目にコメントが含まれる場合、Comment Page レスポンスボディの totalプロパティにコメント数を示す値が含まれます。ただし、comments プロパティにはコメントのコレクションは含まれません。たとえば、次の応答の抜粋ではコメントが全部で 2 つあることが示されますが、コメントに関する情報は示されません。

"comments": {

"comments": [],

"currentPageUrl": "/services/data/v34.0/connect/communities/0DBD000000002etOAA

/chatter/feed-items/0D5D0000000LYi9KAG/comments",


"total": 2

},

GET の例次の例では GET 要求を行います。GET /connect/communities/0DBD000000002etOAA/chatter/feeds/moderation/feed-items

応答は Feed Item Page レスポンスボディです。

関連トピック:


Company Feed リソース会社全体からのすべてのフィード要素とコメントを含むフィード。会社フィードには、以下からの投稿とコメントが含まれます。• 社内のユーザ。ユーザがフォローしている人とフォローしていない人の両方。• 公開グループ。ユーザがメンバーでないグループを含む。• ユーザがメンバーである非公開グループ。• システム管理者がフィード追跡を有効に設定したレコードおよび項目の更新。ユーザがフォローしていな

いものも含む。ただし、ユーザに表示されるのは、ユーザにアクセスが許可されているレコードの更新のみです。

次の点に注意してください。• これらのリソースはコミュニティでは使用できません。次のリソースを使用できます。

239

Company Feed リソースChatter REST API リソース

説明リソース

会社フィードへの URL を返します。/chatter/feeds/company

会社フィードのフィード要素を返します。/chatter/feeds/company/feed-elements

Company Feed URL会社フィードへの URL を返します。リソース

/chatter/feeds/company

/connect/communities/communityId/chatter/feeds/company







Stringsort





Company Feed Elements会社フィードのフィード要素を返します。

240


リソース/chatter/feeds/company/feed-elements

/connect/communities/communityId/chatter/feeds/company/feed-elements








31.0省略可能フィードの密度。次のいずれかの値にします。Stringdensity




31.0省略可能バンドルに含める最大フィード要素数。値は 0

～ 10 の整数である必要があります。デフォルト値は 3 です。


31.0省略可能生成されたトークン。フィード内のフィード要素のビューを示します。ページトークンは、レスポンスボディの一部として、nextPageURLなど、いずれかの URL パラ

Stringpage

メータで返されます。たとえば、次のようになります。"nextPageUrl":


chatter/feeds/news/

241





005D0000001GLowIAN

/feed-elements

?page=2011-03-30T17:34:50Z,

0D5D0000000DSv4KAG"

31.0省略可能ページあたりの要素数を指定します。有効な値は 1 ～ 100 です。サイズを指定しない場合、デフォルトは 25 です。

IntegerpageSize

31.0省略可能このフィード内のフィード要素の本文とコメントに含まれる 1 つ以上の検索キーワード。検索文字列にはワイルドカード文字を含めることができ、ワイルドカード文字を除く 2 文字以

Stringq

上が含まれている必要があります。「ワイルドカード」を参照してください。

31.0省略可能フィード要素ごとに含めるコメントの最大数。デフォルト値は 3 です。最大値は、25 です。



Stringsort



デフォルト値は、CreatedDescDate です。31.0省略可能フィードの変更タイムスタンプと並び替え順を

定義する不透明トークン。このトークンは作成しません。Feed Element Page

レスポンスボディの updatesTokenプロパティから、このトークンを取得します。

StringupdatedSince


242


Company Feed Items会社フィードのフィード項目を返します。リソース

/chatter/feeds/company/feed-items


重要: バージョン 32.0 以降では、Company Feed Elements を使用します。







29.0 ～ 31.0省略可能フィードの密度。次のいずれかの値にします。Stringdensity




23.0 ～ 31.0省略可能生成されたトークン。フィード内のフィード要素のビューを示します。ページトークンは、レスポンスボディの一部として、nextPageURLなど、いずれかの URL パラ

Stringpage



chatter/feeds/news/

243





005D0000001GLowIAN

/feed-elements

?page=2011-03-30T17:34:50Z,

0D5D0000000DSv4KAG"

23.0 ～ 31.0省略可能ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。サイズを指定しない場合、デフォルトは 25 です。

IntegerpageSize

28.0 ～ 31.0省略可能このフィード内のフィード要素の本文とコメントに含まれる 1 つ以上の検索キーワード。検索文字列にはワイルドカード文字を含めることができ、ワイルドカード文字を除く 2 文字以

Stringq


29.0 ～ 31.0省略可能フィード項目ごとに含めるコメントの最大数。デフォルト値は 3 です。最大値は、25 です。


23.0 ～ 31.0省略可能作成日や最終更新日などで並び替えて返される順序を指定します。

Stringsort




30.0 ～ 31.0省略可能フィードの変更タイムスタンプと並び替え順を定義する不透明トークン。このトークンは作成しません。Feed Element Page


StringupdatedSince


関連トピック:


244


Favorites Feed リソースコンテキストユーザが保存したお気に入りを含むフィード。お気に入りとは、コンテキストユーザが Chatter のお気に入りとして追加した検索、リストビュー、およびトピックです。次のリソースを使用できます。

説明リソース

コンテキストユーザのすべてのお気に入りを返します。Chatterフィード検索またはトピックのお気に入りを作成します。

/chatter/feeds/favorites/me

指定されたお気に入りのフィードを返します。指定されたお気に入りを削除します。指定されたお気に入りの最終参照日を更新します。

/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




HTTP メソッドGET、HEAD、または POST


<favorite>

245

Favorites Feed リソースChatter REST API リソース

POST の JSON

{

"searchText" : "release",

"targetId" : "0TOD0000000099d"

}

POST のプロパティ


24.0フィード検索のテキスト。このパラメータは、

StringsearchText

フィード検索にのみ使用します。

28.0トピックの ID。このパラメータは、トピックにのみ使用します。

StringtargetId




StringsearchText



StringtargetId

GET のレスポンスボディFavorites Page

POST のレスポンスボディFavorite

Favorite指定されたお気に入りのフィードを返します。指定されたお気に入りを削除します。指定されたお気に入りの最終参照日を更新します。

246


リソース/chatter/feeds/favorites/userId/favoriteId

/connect/communities/communityId/chatter/feeds/favorites/userId/favoriteId




HTTP メソッドGET、HEAD、PATCH、または DELETE




Stringsort





<favorite>

PATCH の JSON

{

"updateLastViewDate" : "true"

}

PATCH のプロパティ


24.0指定されたフィードのお気に入りの最終参照日を

BooleanupdateLastViewDate

現在のシステム時刻に設

247



定します。デフォルト値は false です。



指定されたフィードのお気に入りの最終参照日を現在のシステム時


刻に設定します。デフォルト値はfalse です。

GET のレスポンスボディFavorite

PATCH のレスポンスボディFavorite

Favorites Feed Items絞り込み済みのフィードを返し、指定されたお気に入りの絞り込まれたフィード項目のみを表示します。リソース

/chatter/feeds/favorites/me/favoriteId/feed-items

または/chatter/feeds/favorites/userId/favoriteId/feed-items



重要: バージョン 32.0 以降では、Favorites Feed Elements を使用します。



248






29.0 ～ 31.0省略可能


Stringdensity




23.0 ～ 31.0省略可能


Stringpage



chatter/feeds/news/

005D0000001GLowIAN

/feed-items

?page=2011-03-30T17:34:50Z,

0D5D0000000DSv4KAG"

23.0 ～ 31.0省略可能


IntegerpageSize

249





28.0 ～ 31.0省略可能


Stringq


29.0 ～ 31.0省略可能



23.0 ～ 31.0省略可能


Stringsort





関連トピック:


Favorites Feed Elements絞り込み済みのフィードを返し、指定されたお気に入りの絞り込まれたフィード要素のみを表示します。リソース

/chatter/feeds/favorites/userId/favoriteId/feed-elements

/connect/communities/communityId/chatter/feeds/favorites/userId/favoriteId/feed-elements




250










31.0省略可能ページの表示に使用するページトークン。ページトークンは、

Stringpage

currentPageToken またはnextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。

31.0省略可能ページあたりのフィード要素数を指定します。有効な値は 1 ～ 100

IntegerpageSize

です。null を渡すと、デフォルトサイズの 25 に設定されます。


です。



Stringsort



null を渡すと、デフォルト値のCreatedDescDate が使用されます。

251



Feeds リソースコンテキストユーザが表示可能なすべてのフィードのリスト。ユーザによって表示されるフィードが異なる場合があります。このリソースは、使用可能なフィードを判定するために使用します。さらに、各フィードが一意の URL と表示ラベルを持つ場合があります。表示ラベルの値をハードコードすることは避け、このリソースで返された表示ラベルを使用するようにしてください。リソース

/chatter/feeds/

/connect/communities/communityId/chatter/feeds/




レスポンスボディFeed Directory

Files Feed リソースコンテキストユーザがフォローしている人またはグループによって投稿されたファイルを含むすべてのフィード要素を含むフィード。次のリソースを使用できます。

説明リソース

コンテキストユーザがフォローしているユーザまたはグループによって投稿されたファイルを含むフィード要素への URL を返します。

/chatter/feeds/files/me

コンテキストユーザがフォローしている人またはグループによって投稿されたファイルを含むすべてのフィード要素を返します。

/chatter/feeds/files/me/feed-elements

Files Feed URLコンテキストユーザがフォローしているユーザまたはグループによって投稿されたファイルを含むフィード要素への URL を返します。

252

Feeds リソースChatter REST API リソース

リソース/chatter/feeds/files/userId

/connect/communities/communityId/chatter/feeds/files/userId








Stringsort





Files Feed Elementsコンテキストユーザがフォローしている人またはグループによって投稿されたファイルを含むすべてのフィード要素を返します。リソース

/chatter/feeds/files/userId/feed-elements

/connect/communities/communityId/chatter/feeds/files/userId/feed-elements



253

Files Feed リソースChatter REST API リソース















Stringpage



chatter/feeds/news/

005D0000001GLowIAN

/feed-elements

?page=2011-03-30T17:34:50Z,

0D5D0000000DSv4KAG"

254






IntegerpageSize


Stringq





Stringsort






StringupdatedSince


Files Feed Itemsコンテキストユーザがフォローしている人またはグループによって投稿されたファイルを含むすべてのフィード項目を返します。リソース

/chatter/feeds/files/me/feed-items

255


または/chatter/feeds/files/userId/feed-items



重要: バージョン 32.0 以降では、Files Feed Elements を使用します。












Stringpage



chatter/feeds/news/

005D0000001GLowIAN

256





/feed-elements

?page=2011-03-30T17:34:50Z,

0D5D0000000DSv4KAG"


IntegerpageSize


Stringq





Stringsort






StringupdatedSince


Files Feed Items Flatこのリソースは、バージョン 26.0 で廃止されました。

257


フラットフィードを返します。つまり、フィード項目とコメントの間に階層がなく、フィード項目とコメントはすべて同じレベルに配置されます。すべての項目は、時系列に返されます。リソース

/chatter/feeds/files/me/feed-items/flat

または/chatter/feeds/files/userId/feed-items/flat








IntegernumFeedItems



Stringpage

す。ページトークンは、レスポンスボディの一部として、nextPageURL など、いずれかのURL パラメータで返されます。



258








関連トピック:


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

Filter Feed リソースChatter REST API リソース

フィードに適用できるキープレフィックスフィルタフィードのリストを返します。「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



レスポンスボディ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



260





Stringsort





レスポンスボディの例この要求では、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/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 を使用します。












Stringpage



262





chatter/feeds/news/

005D0000001GLowIAN

/feed-elements

?page=2011-03-30T17:34:50Z,

0D5D0000000DSv4KAG"


IntegerpageSize


Stringq





Stringsort






StringupdatedSince


263


例この要求では、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








IntegernumFeedItems



Stringpage

す。ページトークンは、レスポン

264



スボディの一部として、nextPageURL など、いずれかのURL パラメータで返されます。








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


265







31.0省略可能Stringdensity • AllUpdates — ユーザがフォローする人とレコード、およびユーザがメンバーとなっているグループからのすべての更新が表示されます。





31.0省略可能ページの表示に使用するページトークン。ページトークンは、

Stringpage

currentPageToken またはnextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。

31.0省略可能ページあたりのフィード要素数を指定します。有効な値は 1 ～ 100

IntegerpageSize

です。null を渡すと、デフォルトサイズの 25 に設定されます。

31.0省略可能コンテキストユーザに表示されるフィード要素に含まれる 1 つ以上

Stringq

266





の検索キーワード。検索文字列にはワイルドカード文字を含めることができ、ワイルドカード文字を除く 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。


です。



Stringsort



null を渡すと、デフォルト値のCreatedDescDate が使用されます。

31.0省略可能フィードの変更タイムスタンプと並び替え順を定義する不透明トークン。

StringupdatedSince


Groups Feed リソース現在のユーザが所有するか、メンバーである全グループからのすべてのフィード要素を含むフィード。次のリソースを使用できます。

説明リソース

現在のサインインユーザがメンバーである全グループのフィード要素への URL を返します。

/chatter/feeds/groups/me

現在のユーザが所有するか、メンバーである全グループの全フィード要素を返します。

/chatter/feeds/groups/me/feed-elements

267

Groups Feed リソースChatter REST API リソース

Groups Feed URL現在のサインインユーザがメンバーである全グループのフィード要素への URL を返します。リソース

/chatter/feeds/groups/userId

/connect/communities/communityId/chatter/feeds/groups/userId



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











• FewerUpdates — ユーザがフォローする人とレコード、およびユーザがメンバーとなっ

268





ているグループからのすべての更新が表示されますが、レコードからのシステム生成された更新は非表示になります。






Stringpage



chatter/feeds/news/

005D0000001GLowIAN

/feed-elements

?page=2011-03-30T17:34:50Z,

0D5D0000000DSv4KAG"


IntegerpageSize


Stringq




269






Stringsort






StringupdatedSince


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



重要: バージョン 32.0 以降では、Groups Feed Elements を使用します。



270











Stringpage



chatter/feeds/news/

005D0000001GLowIAN

/feed-elements

?page=2011-03-30T17:34:50Z,

0D5D0000000DSv4KAG"


IntegerpageSize


Stringq

271









Stringsort






StringupdatedSince


Groups Feed Items Flatこのリソースは、バージョン 26.0 で廃止されました。フラットフィードを返します。つまり、フィード項目とコメントの間に階層がなく、フィード項目とコメントはすべて同じレベルに配置されます。すべての項目は、時系列に返されます。リソース

/chatter/feeds/groups/me/feed-items/flat

または/chatter/feeds/groups/userId/feed-items/flat




272






IntegernumFeedItems



Stringpage









関連トピック:

Groups リソースRecord Feed リソースフィードおよびフィード要素の使用

273


News Feed リソースコンテキストユーザが関心を示しているフィード要素を含むフィード。ニュースフィードへのフィード項目のpost 送信に使用できます。

メモ: このフィードの構成は、Chatter Web UI に表示されているフィードと一致させるために、リリースによって異なる場合があります。


説明リソース

コンテキストユーザの全フィードのフィード要素へのURL を返します。また、フィードをポーリングして更新するための Is-Modified リソースも返します。

/chatter/feeds/news/me

指定した日時以降、ニュースフィードが更新または変更されたかどうかについての情報を返します。

/chatter/feeds/news/me/is-modified

コンテキストユーザが所有するグループかメンバーであるグループすべてからの全フィード要素と、コンテ


キストユーザがフォローしている全ファイル、レコード、およびユーザからの全フィード要素。このリソースは、フィード要素に関する情報を取得し、フィード要素を投稿するために使用します。

News Feed URLコンテキストユーザの全フィードのフィード要素への URL を返します。また、フィードをポーリングして更新するための Is-Modified リソースも返します。リソース

/chatter/feeds/news/userId

/connect/communities/communityId/chatter/feeds/news/userId





274

News Feed リソースChatter REST API リソース




Stringsort





レスポンスボディの例{


"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


メモ: 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





276





23.0必須項目フィードの変更タイムスタンプと並び替え順に関する情報を含む不透明トークン。このトークンは作成しません。Feed Item Page

または Feed Modified Info レスポンスボディの

Stringsince

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





277














32.0省略可能フィードに適用可能な検索条件の値を指定します。

Stringfilter


• CommunityScoped — 今後の使用のために予約されています。




278





31.0省略可能生成されたトークン。フィード内のフィード要素のビューを示します。ページトークンは、レスポンスボディの一部として、nextPageURLなど、いずれかの URL パラメータで返されます。"nextPageUrl":

Stringpage


chatter/feeds/news/

005D0000001GLowIAN

/feed-elements

?page=2011-03-30T17:34:50Z,

0D5D0000000DSv4KAG"


IntegerpageSize


Stringq





Stringsort




279





31.0省略可能フィードの変更タイムスタンプと並び替え順を定義する不透明トークン。このトークンは作成しません。Feed Element Page


StringupdatedSince


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



重要: バージョン 32.0 以降では、News Feed Elements を使用します。


HTTP メソッドGET、POST、HEAD

280






29.0 ～ 31.0省略可能


Stringdensity




23.0 ～ 31.0省略可能


Stringpage

nextPageURLなど、いずれかの URL パラメータで返されます。"nextPageUrl":


chatter/feeds/news/

005D0000001GLowIAN

/feed-items

?page=2011-03-30T17:34:50Z,

0D5D0000000DSv4KAG"

23.0 ～ 31.0省略可能


IntegerpageSize

281





28.0 ～ 31.0省略可能


Stringq


29.0 ～ 31.0省略可能



23.0 ～ 31.0省略可能


Stringsort




30.0 ～ 31.0省略可能

フィードの変更タイムスタンプと並び替え順を定義する不透明トークン。このトークンは作成しません。Feed Item Page

レスポンスボディの updatesToken プロパティから、このトークンを取得します。

StringupdatedSince


<feedItem>

JSON

次の例では、フィード項目にアンケートを添付します。{

"body":{

"messageSegments":[

{

"type":"Text",

282


"text":"When should we meet for release planning?"

}

]

},

"capabilities":{

"poll":{

"choices":[

"Monday",

"Tuesday"

]

}

},


"subjectId":"me"

}

フィード項目は複数の機能をサポートします。次の例では、ファイルをフィード項目に添付し、ブックマークします。{

"body":{

"messageSegments":[

{

"type":"Text",

"text":"Check out the latest marketing collateral."

}

]

},

"capabilities":{

"bookmarks":{

283



},

"content":{

"contentDocumentId": "069D00000001uQO"

}

},


"subjectId":"me"

}

プロパティ



省略可能attachment パラメータには、次のいずれか 1 つの値のみを

種別によって異なる。

attachment

指定できます。値は次のとおりです。• 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




23.0フィード項目にコンテンツ機能また

メッセージ本文の説明。本文には 25 文字まで使用できます。フィード項目を共有するための originalFeedItemIdを

Message Body Inputbody

はリンク機能がある場合を除き、必須

指定する場合、body プロパティを使用してコメントをフィード項目に追加します。このフィード項目が共有されている場合、この値は最初のコメントの本文です。

31.0省略可能このフィード要素の動作を定義する機能。

Feed ElementCapabilities Input

capabilities

24.0 ～31.0

省略可能新しいフィード項目をユーザのためにブックマークするか(true)、否か (false) を指定


します。デフォルト値は、false です。

重要: API バージョン32.0 以降では、capabilities.bookmarks.isBookmarkedByCurrentUser

プロパティを使用します。

31.0必須項目この入力が表すフィード要素の種別。有効な値は FeedItem のみです。


31.0省略可能このフィード要素が共有されている場合、これは元の


フィード要素の 18 文字の ID

です。

メモ: このパラメータは、他のすべてのパラメータよりも優先されます。たとえば、投稿

285




を共有し、さらにファイルのアップロードも試みる場合、生成されたフィード項目には共有された投稿のみが含まれます。1 つの POST

内では、投稿の共有かファイルのアップロードのどちらか 1 つのみ(両方ではなく) を行う必要があります。

24.0 ～31.0

省略可能このフィード項目が共有されている場合、これは元のフィード項目の 18 文字の ID

です。

StringoriginalFeedItemId

重要: API バージョン32.0 以降は、originalFeedElementId


31.0必須項目このフィード要素が投稿された親の ID。この値は、ユー

StringsubjectId

ザ、グループ、レコードのID、またはコンテキストユーザを示す文字列 meになります。

26.0省略可能投稿を表示できるユーザ。有効な値は、次のとおりです。

Stringvisibility

• InternalUsers — コミュニティが有効な場合は、デフォルトの内部コミュニティのメンバーに対してのみフィード項目を表示できます。

• AllUsers — コミュニティが有効な場合は、コミュニティのすべてのメ

286




ンバーに対してフィード項目を表示できます。

デフォルト値は、次のとおりです。• 外部ユーザの場合、デ

フォルト値は AllUsers

です。外部ユーザが投稿を表示するには、この値を使用する必要があります。

• 内部ユーザの場合、デフォルト値はInternalUsers です。内部ユーザは、この値を受け入れるか、値AllUsers を使用して外部ユーザに投稿の表示を許可します。

フィード項目の親が User または Group の場合、フィード項目の visibility はAllUsersである必要があります。

POST の要求パラメータ次のいずれかのパラメータセットを使用します。たとえば、リンクの post 送信とファイルの添付を同じ要求で行うことはできません。既存のファイルを添付するためのパラメータ




27.0 ～31.0

必須項目添付ファイルの種別。値 ExistingContent

を含める必要があります。StringattachmentType

23.0 ～31.0

必須項目既存のファイルの 18 文字の ID。StringcontentDocumentId

287





26.0 ～31.0

省略可能新しいフィード項目をユーザのためにブックマークするか (true)、否か (false) を指定します。デフォルト値は、false です。


23.0 ～31.0

省略可能フィード項目のテキスト。Stringtext

26.0 ～31.0

省略可能投稿を表示できるユーザ。有効な値は、次のとおりです。

Stringvisibility


• AllUsers — コミュニティが有効な場合は、コミュニティのすべてのメンバーに対してフィード項目を表示できます。

デフォルト値は、次のとおりです。• 外部ユーザの場合、デフォルト値は

AllUsersです。外部ユーザが投稿を表示するには、この値を使用する必要があります。

• 内部ユーザの場合、デフォルト値はInternalUsersです。内部ユーザは、この値を受け入れるか、値 AllUsersを使用して外部ユーザに投稿の表示を許可します。

フィード項目の親が User または Group の場合、フィード項目の visibilityは AllUsersである必要があります。

新規のファイルを添付するためのパラメータ




27.0 ～31.0

必須項目添付ファイルの種別。値 NewFileを含める必要があります。


288





23.0 ～26.0

省略可能post 送信するファイルの説明。Stringdesc

注意: このパラメータは、バージョン 27.0

以降では使用しないでください。代わりに description を使用します。

27.0 ～31.0

省略可能post 送信するファイルの説明。Stringdescription

23.0 ～24.0

必須項目post 送信するファイルのファイル名。StringfileName


以降では使用しないでください。代わりに title を使用します。

26.0 ～31.0



23.0 ～31.0


24.0 ～31.0

必須項目アップロードまたは post 送信するファイルのファイル名。

Stringtitle

26.0 ～31.0


Stringvisibility





• 内部ユーザの場合、デフォルト値はInternalUsers です。内部ユーザは、この値を受け入れるか、値 AllUsersを使用

289





して外部ユーザに投稿の表示を許可します。


リンクを post 送信するためのパラメータ




27.0 ～31.0

必須項目添付ファイルの種別。値 Link を含める必要があります。


26.0 ～31.0

省略可能新しいフィード項目をユーザのためにブックマークするか (true)、否か (false)

を指定します。デフォルト値は、false

です。


23.0 ～31.0


23.0 ～31.0

必須項目リンクの URL。Stringurl

23.0 ～31.0

省略可能URL の名前。StringurlName

26.0 ～31.0


Stringvisibility



デフォルト値は、次のとおりです。

290





• 外部ユーザの場合、デフォルト値はAllUsersです。外部ユーザが投稿を表示するには、この値を使用する必要があります。

• 内部ユーザの場合、デフォルト値はInternalUsers です。内部ユーザは、この値を受け入れるか、値AllUsersを使用して外部ユーザに投稿の表示を許可します。

フィード項目の親が User または Group の場合、フィード項目の visibility はAllUsers である必要があります。

アンケートを post 送信するためのパラメータ




27.0 ～31.0

必須項目添付ファイルの種別。値 Poll を含める必要があります。


26.0 ～31.0



です。


26.0 ～31.0

必須項目この選択肢を使用して、アンケートを含むフィード項目を作成します。アンケートには 2 個から 10 個のアンケート選択肢を指定します。

StringpollChoice1 ～pollChoice10

23.0 ～31.0

必須項目フィード項目のテキスト。Stringtext

26.0 ～31.0


Stringvisibility

• InternalUsers — コミュニティが有効な場合は、デフォルトの内部コミュ

291





ニティのメンバーに対してのみフィード項目を表示できます。






投稿を共有するためのパラメータ




26.0 ～31.0



24.0 ～31.0

必須項目共有するフィード項目の 18 文字の ID。StringoriginalFeedItemId

メモ: 投稿の共有は、ファイルのアップロードよりも優先されます。1 つの POST 内では、投稿の共有とファイルのアップロードの両方は行わないでください。

292





28.0 ～31.0

省略可能共有されるフィード項目に対するコメント。

Stringtext

26.0 ～31.0


Stringvisibility







テキストのみを post 送信するためのパラメータ




26.0 ～31.0



293





23.0 ～31.0

必須項目フィード項目のテキスト。最大文字数は1000 文字です。

Stringtext

26.0 ～31.0


Stringvisibility







キャンバスアプリケーションを post 送信するためのパラメータ




29.0 ～31.0

必須項目添付ファイルの種別。値 Canvas を含める必要があります。


29.0 ～31.0

省略可能キャンバスアプリケーションの説明Stringdescription

294





29.0 ～31.0

必須項目キャンバスアプリケーションの開発者名 (API

名)

StringdeveloperName

29.0 ～31.0

省略可能キャンバスアプリケーションの高さ (ピクセル単位)。デフォルトの高さは 200 ピクセルです。

Stringheight

29.0 ～31.0



29.0 ～31.0

省略可能キャンバスアプリケーションが作成されたDeveloper Edition 組織の名前空間プレフィックス。

StringnamespacePrefix

29.0 ～31.0

省略可能キャンバスアプリケーションに渡される JSON

形式のパラメータ。JSON は URL でエンコードされている必要があります。parameters={'isUpdated'='true';}"

Stringparameters

29.0 ～31.0

省略可能フィード項目のテキストStringtext

29.0 ～31.0

省略可能キャンバスアプリケーションのサムネイル画像の URL。最大サイズは 120x120 ピクセルです。

StringthumbnailUrl

29.0 ～31.0

省略可能キャンバスアプリケーションへのリンクのタイトル

Stringtitle

29.0 ～31.0


Stringvisibility





295









ファイルポストの例この例では、新しい添付ファイルがある投稿でニュースフィードを更新します。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: Bearer00DD0000000Jhd2!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


...

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


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" : {


{

"type": "Link",

"url" : "http://www.chatter.com"

},

{

"type": "Text",

"text" : "Is everyone following this?"

}

]

}

}

298


次のリクエストボディには、フィード項目投稿への添付ファイルとしてリンクが含まれます。{ "body" : {


{

"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



重要: API バージョン 32.0 以降は、/chatter/feeds/news/userId/feed-elementsを使用します。



299





IntegernumFeedItems



Stringpage









関連トピック:


People Feed リソースコンテキストユーザがフォローしているすべての人によって投稿されたすべてのフィード要素。次のリソースを使用できます。

300

People Feed リソースChatter REST API リソース

説明リソース

コンテキストユーザがフォローしているすべての人のフィード要素への URL を返します。

/chatter/feeds/people/me

コンテキストユーザがフォローしているすべての人からのすべてのフィード要素を返します。

/chatter/feeds/people/me/feed-elements

People Feed URLコンテキストユーザがフォローしているすべての人のフィード要素への URL を返します。リソース

/chatter/feeds/people/userId

/connect/communities/communityId/chatter/feeds/people/userId








Stringsort





People Feed Elementsコンテキストユーザがフォローしているすべての人からのすべてのフィード要素を返します。

301


リソース/chatter/feeds/people/userId/feed-elements

/connect/communities/communityId/chatter/feeds/people/userId/feed-elements

















Stringpage



302





chatter/feeds/news/

005D0000001GLowIAN

/feed-elements

?page=2011-03-30T17:34:50Z,

0D5D0000000DSv4KAG"


IntegerpageSize


Stringq





Stringsort






StringupdatedSince


303


People Feed Itemsコンテキストユーザがフォローしているすべての人からのすべてのフィード項目を返します。リソース

/chatter/feeds/people/me/feed-items

または/chatter/feeds/people/userId/feed-items



重要: バージョン 32.0 以降では、People Feed Elements を使用します。












Stringpage

304







chatter/feeds/news/

005D0000001GLowIAN

/feed-elements

?page=2011-03-30T17:34:50Z,

0D5D0000000DSv4KAG"


IntegerpageSize


Stringq





Stringsort






StringupdatedSince

305



People Feed Items Flatこのリソースは、バージョン 26.0 で廃止されました。フラットフィードを返します。つまり、フィード項目とコメントの間に階層がなく、フィード項目とコメントはすべて同じレベルに配置されます。すべての項目は、時系列に返されます。リソース

/chatter/feeds/people/me/feed-items/flat

または/chatter/feeds/people/userId/feed-items/flat








IntegernumFeedItems



Stringpage

す。ページトークンは、レスポンスボディの一部として、

306



nextPageURL など、いずれかのURL パラメータで返されます。








関連トピック:


Record Feed リソース指定されたレコードのフィード。レコードは、グループ、人、オブジェクト、ファイルなどの場合があります。レコードフィードへのフィード項目の post 送信に使用できます。次のリソースを使用できます。

説明リソース

現在のユーザがフォローしているすべてのレコードのフィード要素への URL、または指定された recordId

/chatter/feeds/record/recordId

のすべてのフィード要素への URL を返します。このリソースは、グループフィードを取得するために使用します。

コンテキストユーザがフォローしているすべてのレコードのフィード要素、または指定された recordId

/chatter/feeds/record/recordId/feed-elements

のすべてのフィード要素を返します。このリソースは、フィードの検索や特定のフィードのフィード要素の取得に使用します。このリソースを使用してグループのフィード要素を取得するには、グループ ID をrecordId として指定します。

307

Record Feed リソースChatter REST API リソース

Record Feed URL現在のユーザがフォローしているすべてのレコードのフィード要素への URL、または指定された recordIdのすべてのフィード要素への URL を返します。このリソースは、グループフィードを取得するために使用します。リソース

/chatter/feeds/record/recordId

/connect/communities/communityId/chatter/feeds/record/recordId

メモ: recordId がユーザ ID の場合、現在のユーザまたは別名 me と同じである必要があります。







Stringsort





Record Feed Elementsコンテキストユーザがフォローしているすべてのレコードのフィード要素、または指定された recordId のすべてのフィード要素を返します。このリソースは、フィードの検索や特定のフィードのフィード要素の取得に使用します。このリソースを使用してグループのフィード要素を取得するには、グループ ID を recordId

として指定します。

308



/connect/communities/communityId/chatter/feeds/record/recordId/feed-elements









31.0省略可能


Stringdensity




31.0省略可能




309





32.0省略可能


Stringfilter






31.0省略可能

生成されたトークン。フィード内のフィード要素のビューを示します。ページトークンは、レスポンスボディの一部として、nextPageURLなど、いずれかの URL

Stringpage

パラメータで返されます。たとえば、次のようになります。"nextPageUrl":


chatter/feeds/news/

005D0000001GLowIAN

/feed-elements

?page=2011-03-30T17:34:50Z,

0D5D0000000DSv4KAG"

31.0省略可能


IntegerpageSize

31.0省略可能


Stringq

310






31.0省略可能



31.0省略可能

内部 (コミュニティ以外の) ユーザからのフィード要素のみを表示するか (true)、否か(false) を指定します。デフォルト値は、false です。

BooleanshowInternalOnly

31.0省略可能


Stringsort



デフォルト値は、CreatedDescDateです。31.0省略可

能フィードの変更タイムスタンプと並び替え順を定義する不透明トークン。このトークンは作成しません。Feed Element

Page レスポンスボディの updatesToken プロパティから、このトークンを取得します。

StringupdatedSince


Record Feed Itemsコンテキストユーザがフォローしているすべてのレコードのフィード項目、または指定された recordId のすべてのフィード項目を返します。このリソースは、新しいフィード項目の post 送信やフィードの検索に使用します。このリソースを使用して特定のグループのフィード項目を取得するには、グループ ID を recordId

として指定します。フィード項目の post 送信についての詳細は、「入力での POST、PATCH、または PUT の使用」を参照してください。バイナリファイルのアップロードとフィード項目への添付についての詳細は、「バイナリファイルのアップロード」を参照してください。

311


メモ: レコードタイプが ContentDocumentの場合は、レコードフィードへのフィード項目の post 送信はできません。

API バージョン 29.0 では、フィード項目に 5000 文字まで含めることができます。この変更には後方互換性があり、以前のすべての API バージョンで 5000 文字の制限がサポートされています。リソース

/chatter/feeds/record/me/feed-items

または/chatter/feeds/record/recordId/feed-items



重要: バージョン 32.0 以降では、Record Feed Elements を使用します。







29.0 ～ 31.0省略可能


Stringdensity




23.0 ～ 31.0省略可能


Stringpage

312







chatter/feeds/news/

005D0000001GLowIAN

/feed-items

?page=2011-03-30T17:34:50Z,

0D5D0000000DSv4KAG"

23.0 ～ 31.0省略可能


IntegerpageSize

28.0 ～ 31.0省略可能


Stringq


29.0 ～ 31.0省略可能



30.0 ～ 31.0省略可能

内部 (コミュニティ以外の) ユーザからのフィード項目のみを表示するか (true)、否か(false) を指定します。デフォルト値は、false です。

BooleanshowInternalOnly

23.0 ～ 31.0省略可能


Stringsort



313






30.0 ～ 31.0省略可能

フィードの変更タイムスタンプと並び替え順を定義する不透明トークン。このトークンは作成しません。Feed Item Page

レスポンスボディの updatesToken プロパティから、このトークンを取得します。

StringupdatedSince


<feedItem>

JSON


"body":{

"messageSegments":[

{

"type":"Text",


}

]

},

"capabilities":{

"poll":{

"choices":[

"Monday",

"Tuesday"

]

}

314


},


"subjectId":"me"

}


"body":{

"messageSegments":[

{

"type":"Text",


}

]

},

"capabilities":{

"bookmarks":{


},

"content":{


}

},


"subjectId":"me"

}

315


プロパティ





attachment


(v29.0 ～ 31.0)


Content (v23.0 ～ 31.0)


(v26.0 ～ 31.0)


～ 31.0)


Upload (v23.0 ～ 31.0)









capabilities

24.0 ～31.0



316












です。

メモ: このパラメータは、他のすべてのパラメータよりも優先されます。たとえば、投稿を共有し、さらにファイルのアップロードも試みる場合、生成されたフィード項目には共有された投稿のみが含まれます。1 つの POST


24.0 ～31.0


です。


重要: API バージョン32.0 以降は、

317




originalFeedElementId



StringsubjectId



Stringvisibility






• 内部ユーザの場合、デフォルト値はInternalUsers です。内部ユーザは、この値を受け入れるか、値AllUsers を使用して外部ユーザに投稿の表示を許可します。

318









27.0 ～31.0



23.0 ～31.0


26.0 ～31.0



23.0 ～31.0


26.0 ～31.0


Stringvisibility




AllUsersです。外部ユーザが投稿を表示

319





するには、この値を使用する必要があります。







27.0 ～31.0



23.0 ～26.0




27.0 ～31.0


23.0 ～24.0




26.0 ～31.0



23.0 ～31.0


320





24.0 ～31.0


Stringtitle

26.0 ～31.0


Stringvisibility





• 内部ユーザの場合、デフォルト値はInternalUsers です。内部ユーザは、この値を受け入れるか、値 AllUsersを使用して外部ユーザに投稿の表示を許可します。






27.0 ～31.0



321





26.0 ～31.0



です。


23.0 ～31.0


23.0 ～31.0


23.0 ～31.0


26.0 ～31.0


Stringvisibility








322





27.0 ～31.0



26.0 ～31.0



です。


26.0 ～31.0



23.0 ～31.0


26.0 ～31.0


Stringvisibility







323






26.0 ～31.0



24.0 ～31.0



28.0 ～31.0


Stringtext

26.0 ～31.0


Stringvisibility






324










26.0 ～31.0



23.0 ～31.0


Stringtext

26.0 ～31.0


Stringvisibility






325










29.0 ～31.0



29.0 ～31.0


29.0 ～31.0


名)

StringdeveloperName

29.0 ～31.0


Stringheight

29.0 ～31.0



29.0 ～31.0



29.0 ～31.0



Stringparameters

29.0 ～31.0


29.0 ～31.0


StringthumbnailUrl

326





29.0 ～31.0


Stringtitle

29.0 ～31.0


Stringvisibility









GET の例次の要求は、文字列 track を含むフィード項目を検索します。/chatter/feeds/record/me/feed-items?q=track

Feed Item Page レスポンスボディの feed-items/items/body/text プロパティで、文字列 track が検索されます。

327


Record Feed Items Flatこのリソースは、バージョン 26.0 で廃止されました。フラットフィードを返します。つまり、フィード項目とコメントの間に階層がなく、フィード項目とコメントはすべて同じレベルに配置されます。すべての項目は、時系列に返されます。リソース

/chatter/feeds/record/me/feed-items/flat

または/chatter/feeds/record/userId/feed-items/flat








IntegernumFeedItems



Stringpage


328










関連トピック:

Records リソースフィードおよびフィード要素の使用レコードフィードを取得する

To Feed リソースコンテキストユーザのすべての @メンションと、コンテキストユーザのフィードに対して行われたすべての投稿を含むフィード。次のリソースを使用できます。

説明リソース

コンテキストユーザのフィードのフィード要素へのURL を返します。

/chatter/feeds/to/me

コンテキストユーザのすべての @メンションのフィード要素と、ユーザのフィードに対して行われたすべての投稿のフィード要素を返します。

/chatter/feeds/to/me/feed-elements

To Feed URLコンテキストユーザのフィードのフィード要素への URL を返します。リソース

/chatter/feeds/to/userId

/connect/communities/communityId/chatter/feeds/to/userId


329

To Feed リソースChatter REST API リソース







Stringsort





To Feed Elementsコンテキストユーザのすべての @メンションのフィード要素と、ユーザのフィードに対して行われたすべての投稿のフィード要素を返します。To Feed には、ユーザにメンションしている投稿と、他のユーザがユーザのウォールに対して行った投稿が含まれます。ユーザ自身の投稿は、コメントがある場合にのみ含まれます。この場合、自分からのコメントと別のユーザからのコメントの両方が対象となります。リソース

/chatter/feeds/to/userId/feed-elements

/connect/communities/communityId/chatter/feeds/to/userId/feed-elements





330






31.0省略可能


Stringdensity




31.0省略可能




31.0省略可能


Stringpage



chatter/feeds/news/

005D0000001GLowIAN

/feed-elements

331





?page=2011-03-30T17:34:50Z,

0D5D0000000DSv4KAG"

31.0省略可能

ページあたりのフィード要素数。有効な値は1 ～ 100 です。デフォルトサイズは 25 です。

IntegerpageSize

31.0省略可能


Stringq


31.0省略可能



31.0省略可能


Stringsort





To Feed Itemsコンテキストユーザのすべての @メンションのフィード項目と、ユーザのフィードに対して行われたすべての投稿のフィード項目を返します。To Feed には、ユーザにメンションしている投稿と、他のユーザがユーザのウォールに対して行った投稿が含まれます。ユーザ自身の投稿は、コメントがある場合にのみ含まれます。この場合、自分からのコメントと別のユーザからのコメントの両方が対象となります。リソース

/chatter/feeds/to/me/feed-items

または/chatter/feeds/to/userId/feed-items

332




重要: バージョン 32.0 以降では、To Feed Elements を使用します。







29.0 ～ 31.0省略可能


Stringdensity




23.0 ～ 31.0省略可能


Stringpage



chatter/feeds/news/

005D0000001GLowIAN

/feed-items

333





?page=2011-03-30T17:34:50Z,

0D5D0000000DSv4KAG"

23.0 ～ 31.0省略可能


IntegerpageSize

28.0 ～ 31.0省略可能


Stringq


29.0 ～ 31.0省略可能



23.0 ～ 31.0省略可能


Stringsort





To Feed Items Flatこのリソースは、バージョン 26.0 で廃止されました。フラットフィードを返します。つまり、フィード項目とコメントの間に階層がなく、フィード項目とコメントはすべて同じレベルに配置されます。すべての項目は、時系列に返されます。リソース

/chatter/feeds/to/me/feed-items/flat

334


または/chatter/feeds/to/userId/feed-items/flat








IntegernumFeedItems



Stringpage








335



関連トピック:


Topics Feed リソース特定のトピックのフィード。次のリソースを使用できます。

説明リソース

特定のトピックのフィード項目への URL を返します。/chatter/feeds/topics/topicId

コンテキストユーザのすべての @メンションのフィード要素と、ユーザのフィードに対して行われたすべての投稿のフィード要素を返します。

/chatter/feeds/topics/topicId/feed-elements

Topics Feed URL特定のトピックのフィード項目への URL を返します。リソース

/chatter/feeds/topics/topicId

/connect/communities/communityId/chatter/feeds/topics/topicId







Stringsort


336

Topics Feed リソースChatter REST API リソース





Topics Feed Elements指定されたトピックのフィード要素をすべて返します。リソース

/chatter/feeds/topics/topicId/feed-elements

/connect/communities/communityId/chatter/feeds/topics/topicId/feed-elements








32.0省略可能


Stringfilter






337





31.0省略可能


Stringpage

nextPageURLなど、いずれかの URL パラメータで返されます。

31.0省略可能

ページあたりのフィード要素数を指定します。有効な値は 1 ～ 100 です。デフォルト値は 25 です。

IntegerpageSize

31.0省略可能


Stringsort





Topics Feed Items指定されたトピックのフィード項目をすべて返します。トピックを投稿するには、Feed-Items Topicsリソースを使用します。リソース

/chatter/feeds/topics/topicId/feed-items


重要: バージョン 32.0 以降では、Topics Feed Elements を使用します。



338






28.0 ～ 31.0省略可能


Stringpage

nextPageURLなど、いずれかの URL パラメータで返されます。

28.0 ～ 31.0省略可能


IntegerpageSize

28.0 ～ 31.0省略可能


Stringsort





関連トピック:


User Profile Feed リソースフィードで追跡可能なレコードに対して現在のユーザが行ったアクションを含むフィード。このフィードは、投稿、グループ更新、レコード更新などのより多くの要素を返す /chatter/feeds/news とは異なります。User-Profile Feed へのフィード項目の post 送信に使用できます。

メモ: このフィードの構成は、Chatter Web UI に表示されているフィードと一致させるために、リリースによって異なる場合があります。


説明リソース

ユーザプロファイルフィードのフィード要素への URL

を返します。/chatter/feeds/user-profile/me

339

User Profile Feed リソースChatter REST API リソース

説明リソース

フィードで追跡可能なすべてのレコードに対するすべてのアクションのフィード要素を返します。

/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


User Profile Feed Elementsフィードで追跡可能なすべてのレコードに対するすべてのアクションのフィード要素を返します。リソース

/chatter/feeds/user-profile/userId/feed-elements

/connect/communities/communityId/chatter/feeds/user-profile/userId/feed-elements








31.0省略可能


Stringdensity


• FewerUpdates — ユーザがフォローする人とレコード、およびユーザがメンバー

340





となっているグループからのすべての更新が表示されますが、レコードからのシステム生成された更新は非表示になります。


31.0省略可能




値は、CommunityScopedのみです。コミュニティを範囲とするフィード要素のみが含ま

Stringfilter

れるようにフィードを絞り込みます。すべてのコミュニティで常に表示されるフィード要素は除外されます。現在、コミュニティを範囲とするフィード要素には、User または Group

親レコードがあります。ただし、今後、他の親レコードタイプがコミュニティを範囲とする可能性があります。

31.0省略可能


Stringpage

nextPageURLなど、いずれかの URL パラメータで返されます。"nextPageUrl":


chatter/feeds/news/

005D0000001GLowIAN

/feed-elements

?page=2011-03-30T17:34:50Z,

0D5D0000000DSv4KAG"

341





31.0省略可能

ページあたりのフィード要素数を指定します。有効な値は 1 ～ 100 です。デフォルト値は 25 です。

IntegerpageSize

31.0省略可能


Stringq


31.0省略可能



31.0省略可能


Stringsort





User Profile Feed Itemsフィードで追跡可能なすべてのレコードに対するすべてのアクションのフィード項目を返します。このリソースは、新しいフィード項目の post 送信にも使用できます。フィード項目の post 送信についての詳細は、「入力での POST、PATCH、または PUT の使用」を参照してください。バイナリファイルをアップロードするには、マルチパート/フォームデータ要求のボディパートとして送信する必要があります。投稿またはコメントのテキストのような情報を、同じマルチパート/フォームデータ要求の JSON または XML リッチ入力ボディパートとして送信できます。または、その情報を要求パラメータで送信するように選択することもできます。リッチ入力リクエストボディと要求パラメータの両方を渡すと、要求パラメータは無視されます。マルチパート/フォームデータメッセージを作成する方法についての詳細は、「バイナリファイルのアップロード」を参照してください。API バージョン 29.0 では、フィード項目に 5000 文字まで含めることができます。この変更には後方互換性があり、以前のすべての API バージョンで 5000 文字の制限がサポートされています。API バージョン 23.0 および 24.0

342


では、User Profile Feed Items リソースへの投稿でユーザ状況更新が作成されますが、フィード項目は作成されません。このため、これらの API バージョンでは、User Profile Feed Items リソースの文字制限は引き続き 1000 文字になります。リソース

/chatter/feeds/user-profile/me/feed-items

または/chatter/feeds/user-profile/userId/feed-items


重要: バージョン 32.0 以降では、User Profile Feed Elements を使用します。




<feedItem>

JSON


"body":{

"messageSegments":[

{

"type":"Text",


}

]

},

"capabilities":{

"poll":{

"choices":[

"Monday",

343


"Tuesday"

]

}

},


"subjectId":"me"

}


"body":{

"messageSegments":[

{

"type":"Text",


}

]

},

"capabilities":{

"bookmarks":{


},

"content":{


}

},


"subjectId":"me"

344


}

プロパティ





attachment


(v29.0 ～ 31.0)


Content (v23.0 ～ 31.0)


(v26.0 ～ 31.0)


～ 31.0)


Upload (v23.0 ～ 31.0)









capabilities

345




24.0 ～31.0











です。

メモ: このパラメータは、他のすべてのパラメータよりも優先されます。たとえば、投稿を共有し、さらにファイルのアップロードも試みる場合、生成されたフィード項目には共有された投稿のみが含まれます。1 つの POST


346




24.0 ～31.0


です。


重要: API バージョン32.0 以降は、originalFeedElementId



StringsubjectId



Stringvisibility






• 内部ユーザの場合、デフォルト値は

347




InternalUsers です。内部ユーザは、この値を受け入れるか、値AllUsers を使用して外部ユーザに投稿の表示を許可します。






27.0 ～31.0



23.0 ～31.0


26.0 ～31.0



23.0 ～31.0


26.0 ～31.0


Stringvisibility


348














27.0 ～31.0



23.0 ～26.0




27.0 ～31.0


23.0 ～24.0




349





26.0 ～31.0



23.0 ～31.0


24.0 ～31.0


Stringtitle

26.0 ～31.0


Stringvisibility





• 内部ユーザの場合、デフォルト値はInternalUsers です。内部ユーザは、この値を受け入れるか、値 AllUsersを使用して外部ユーザに投稿の表示を許可します。



350





27.0 ～31.0



26.0 ～31.0



です。


23.0 ～31.0


23.0 ～31.0


23.0 ～31.0


26.0 ～31.0


Stringvisibility







351






27.0 ～31.0



26.0 ～31.0



です。


26.0 ～31.0



23.0 ～31.0


26.0 ～31.0


Stringvisibility







352






26.0 ～31.0



24.0 ～31.0



28.0 ～31.0


Stringtext

26.0 ～31.0


Stringvisibility






353










26.0 ～31.0



23.0 ～31.0


Stringtext

26.0 ～31.0


Stringvisibility






354










29.0 ～31.0



29.0 ～31.0


29.0 ～31.0


名)

StringdeveloperName

29.0 ～31.0


Stringheight

29.0 ～31.0



29.0 ～31.0



29.0 ～31.0



Stringparameters

29.0 ～31.0


29.0 ～31.0


StringthumbnailUrl

355





29.0 ～31.0


Stringtitle

29.0 ～31.0


Stringvisibility











29.0 ～ 31.0省略可能


Stringdensity


356







23.0 ～ 31.0省略可能


Stringpage



chatter/feeds/news/

005D0000001GLowIAN

/feed-items

?page=2011-03-30T17:34:50Z,

0D5D0000000DSv4KAG"

23.0 ～ 31.0省略可能


IntegerpageSize

28.0 ～ 31.0省略可能


Stringq


29.0 ～ 31.0省略可能



357





23.0 ～ 31.0省略可能


Stringsort






User-Profile Feed Items Flatこのリソースは、バージョン 26.0 で廃止されました。フラットフィードを返します。つまり、フィード項目とコメントの間に階層がなく、フィード項目とコメントはすべて同じレベルに配置されます。すべての項目は、時系列に返されます。リソース

/chatter/feeds/user-profile/me/feed-items/flat

または/chatter/feeds/user-profile/userId/feed-items/flat







IntegernumFeedItems

デフォルト値は 25 です。フィード項目にはコメントが含まれる場合

358



があるため、25 個のフラットフィード項目を指定しても、実際に返される数がそれより多くなることがあります。たとえば、各フィード項目に 1 つのコメントがあり、recentCommentCount が1 よりも大きい場合、50 個のフラットフィード項目が返されます。


Stringpage









関連トピック:


Files Connect Repository リソース

Files Connect リポジトリは、Salesforceに接続している外部コンテンツリポジトリです。これらのリソースを使用して、リポジトリのリストの取得、リポジトリまたはリポジトリファイルに関する情報の取得、リポジトリファイルのコンテンツの取得を行います。また、リポジトリフォルダ内のファイルとフォルダに関する情報の取得にもこれらのリソースを使用します。使用可能なリソース:

説明リソース

Files Connect リポジトリのリストを取得します。/connect/content-hub/repositories

359

Files Connect Repository リソースChatter REST API リソース

説明リソース

Files Connect リポジトリに関する情報を取得します。/connect/content-hub/repositories/repositoryId

Files Connect リポジトリファイルに関する情報を取得します。

/connect/content-hub/repositories/repositoryId/files/repositoryFileId

外部システムからリポジトリファイルのコンテンツを取得します。コンテンツは、レスポンスボディとしてストリーミングされます。

/connect/content-hub/repositories/repositoryId/files/repositoryFileId/content

リポジトリフォルダ内のファイルとフォルダに関する情報を取得します。

/connect/content-hub/repositories/repositoryId/folders/repositoryFolderId/items

リポジトリファイルへの参照を処理するには、次のファイルリソースを使用します。

説明リソース

既存の参照のバージョンの情報取得や更新を行います。


参照の内容を取得します。コンテンツは、レスポンスボディとしてストリーミングされます。

/chatter/files/fileId/content

参照を作成します。/chatter/users/me/files/

Files Connect Repository ListFiles Connect リポジトリのリストを取得します。リソース

/connect/content-hub/repositories








32.0省略可能参照をサポートするリポジトリのみを取得します。

BooleancanBrowseOnly

360

Files Connect Repository ListChatter REST API リソース




32.0省略可能検索をサポートするリポジトリのみを取得します。

BooleancanSearchOnly


Integerpage

ページトークンは、currentPageToken またはnextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。

32.0省略可能ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。

IntegerpageSize

null を渡すと、デフォルトの 25

に設定されます。

GET のレスポンスボディFiles Connect Repository Collection

Files Connect リポジトリFiles Connect リポジトリに関する情報を取得します。リソース

/connect/content-hub/repositories/repositoryId




レスポンスボディFiles Connect Repository

Files Connect Repository FileFiles Connect リポジトリファイルに関する情報を取得します。リソース

/connect/content-hub/repositories/repositoryId/files/repositoryFileId

361

Files Connect リポジトリChatter REST API リソース




レスポンスボディRepository File Detail

Files Connect Repository File Content外部システムからリポジトリファイルのコンテンツを取得します。コンテンツは、レスポンスボディとしてストリーミングされます。リソース

/connect/content-hub/repositories/repositoryId/files/repositoryFileId/content




レスポンスボディファイルのコンテンツのバイナリストリーム。

Files Connect Repository Folder Itemsリポジトリフォルダ内のファイルとフォルダに関する情報を取得します。リソース

/connect/content-hub/repositories/repositoryId/folders/repositoryFolderId/items




362

Files Connect Repository File ContentChatter REST API リソース






Integerpage

ページトークンは、currentPageToken またはnextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。

32.0省略可能ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。

IntegerpageSize

null を渡すと、デフォルトの 25

に設定されます。

GET のレスポンスボディRepository Folder Items Collection

Files リソース

コンテンツ、表示されているバージョン、共有など、ファイルに関する情報。次のリソースを使用できます。

説明リソース

外部ファイルへの参照を含む、指定されたファイルに関する情報を取得します。外部ファイルへの参照を含


む、既存のファイルの新バージョンをアップロードします。ファイルの名称変更、別のフォルダへの移動、ファイルの削除を行います。

外部ファイルへの参照を含む、ファイルのコンテンツを返します。コンテンツは、レスポンスボディとしてストリーミングされます。


指定されたファイルの共有先であるオブジェクトに関する情報を返します。オブジェクトはユーザ、グルー

/chatter/files/fileId/file-shares

プ、またはレコードの場合があります。指定されたファイルをユーザと共有する場合にも使用できます。

363

Files リソースChatter REST API リソース

説明リソース

リンクとして共有されるファイルの説明。ファイルの共有リンクの作成、アクセス、または削除を行います。


ファイルの変換。変換とは、ファイルのバイナリプレビューです。バイナリの形式は、要求で指定された形式によって異なります。

/chatter/files/fileId/rendition

ファイル ID によって指定されたファイルのリストに関する情報。ファイルのリストに関する情報の取得や、ファイルのリストの削除を行います。

/chatter/files/batch/fileIds

File Information外部ファイルへの参照を含む、指定されたファイルに関する情報を取得します。外部ファイルへの参照を含む、既存のファイルの新バージョンをアップロードします。ファイルの名称変更、別のフォルダへの移動、ファイルの削除を行います。既存のファイルの新しいバージョンをアップロードするには、POST 要求を実行します。新しいバージョンは、マルチパート/フォームデータ要求のバイナリパートとしてアップロードする必要があります。「バイナリファイルのアップロード」 (ページ 13)を参照してください。新しいファイルを [ファイル] タブにアップロードするには、/chatter/users/me/files (ページ 473)を使用します。リソース


/connect/communities/communityId/chatter/files/fileId



HTTP メソッドGET、POST、PATCH、DELETE、または HEAD

メモ: POST、PATCH、および DELETE は、バージョン 26.0 以降で使用できます。

POST のリクエストボディSharePoint 2010 へのアップロードは、最大 3 MB です。ルート XML タグ

<fileInput>

JSON

{

364

File InformationChatter REST API リソース

"desc" : "Employee Survey Results",

"title" : "emp_surv_results"

}

プロパティ



説明型名前

32.0省略可能ファイル固有の最終更新日。クライアント側の更新日を設定するために使用できます。

DatecontentModifiedDate

24.0省略可能アップロードするファイルの説明。

Stringdesc

31.0省略可能ファイルが Salesforce Files Syncと同期されている場合は true、同期されていない場合は false。

BooleanisInMyFileSync

31.0省略可能ファイルがメジャーバージョンの場合は true、ファイルがマイ

BooleanisMajorVersion

ナーバージョンの場合はfalse。メジャーバージョンを置き換えることはできません。

31.0省略可能収容フォルダの ID。StringparentFolderId

32.0省略可能外部ファイルの ID。StringrepositoryFileId

32.0省略可能外部データソースの ID。StringrepositoryId

24.0省略可能ファイルのタイトル。Stringtitle

POST の要求パラメータSharePoint 2010 へのアップロードは、最大 3 MB です。


説明型名前

26.0アップロードするファイルの説明。Stringdesc

31.0要求は自動クライアントによって自動生成されます。BooleanisDataSync

31.0ファイルがSalesforce Files Syncと同期されている場合はtrue、同期されていない場合は false。


365



説明型名前

31.0ファイルがメジャーバージョンの場合は true、ファイルがマイナーバージョンの場合はfalse。メジャーバージョンを置き換えることはできません。


26.0ファイルのタイトル。Stringtitle

GET の要求パラメータ指定されたファイルに関する情報を取得します。


説明型名前

23.0ファイルの既存のバージョン番号を指定します。指定されていない場合、最新のバージョンが返されます。

IntegerversionNumber

PATCH の要求パラメータファイルのタイトルまたは同期状態の更新や、別のフォルダへのファイルの移動を行います。


説明型名前

32.0ファイルの新しい説明Stringdesc

26.0ファイルの新しいタイトルStringtitle

31.0ファイルが Salesforce Files Sync と同期されている場合は true、同期されていない場合は false。


31.0収容フォルダの IDStringparentFolderId

GET、POST、PATCH、および HEAD のレスポンスボディFile Detail

DELETE のレスポンスボディ状況コード 204 を返します。

例この PATCH 要求は、ファイルのタイトルを更新します。/chatter/files/069D00000001FHF?title=A+New+Title

366


File Content外部ファイルへの参照を含む、ファイルのコンテンツを返します。コンテンツは、レスポンスボディとしてストリーミングされます。リソース


/connect/communities/communityId/chatter/files/fileId/content








31.0省略可能要求は自動クライアントによって自動生成されます。

BooleanisDataSync

24.0省略可能ファイルの既存のバージョン番号を指定します。指定されていない


場合、最新のバージョンが返されます。

レスポンスボディファイルのコンテンツのバイナリストリーム。

File Shares指定されたファイルの共有先であるオブジェクトに関する情報を返します。オブジェクトはユーザ、グループ、またはレコードの場合があります。指定されたファイルをユーザと共有する場合にも使用できます。リソース

/chatter/files/fileId/file-shares

/connect/communities/communityId/chatter/files/fileId/file-shares



367

File ContentChatter REST API リソース

HTTP メソッドGET、HEAD、POST

POST は、バージョン 30.0 以降で使用できます。GET の要求パラメータ

バージョン 30.0 以降の場合、GET 要求で最初に返される共有は組織のレコード共有です。コミュニティの場合、最初に返される共有はネットワークレコード共有です。

適用開始バージョン必須項目/省略可能説明型名前

24.0省略可能トピックのページを指定する 0

より大きい整数。デフォルト値は、0 です。

Integerpage

24.0省略可能ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。デフォルト値は 25 です。

IntegerpageSize


<fileShares>

JSON の例{

"message": "I shared a document with you.",

"shares": [

{ "id": "005D0000001Az4l", "sharingType": "V" },

{ "id": "005D0000001B2ny", "sharingType": "C" }

]

}

プロパティ


説明型名前

30.0受信者に送信される非公開のメッセージ本文。Salesforce Communities が有効な場合、非

Stringmessage

公開メッセージではなくメールが送信されます。

368

File SharesChatter REST API リソース


説明型名前

30.0Share Input リクエストボディのコレクション。

Share Input[]shares

POST の要求パラメータファイルをユーザと共有するためのパラメータ

適用開始バージョン必須項目/省略可能説明型名前

30.0必須項目このファイルの共有先である最大 9 個のユーザ ID のリスト。

Stringid(1–9)

このリストは、共有種別のリストと一致する必要があります。

30.0省略可能受信者に送信される非公開のメッセージ本文。Salesforce

Stringmessage

Communities が有効な場合、非公開メッセージではなくメールが送信されます。

30.0必須項目共有種別のリスト。コラボレータの場合はC、閲覧者の場合は

StringsharingType(1–9)

V です。このリストは、ユーザ ID のリストと一致する必要があります。

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

File SharesChatter REST API リソース

{ "id": "005D0000001QdEL", "sharingType": "V" }

]

}

Files Shares Linkリンクとして共有されるファイルの説明。ファイルの共有リンクの作成、アクセス、または削除を行います。リソース


/connect/communities/communityId/chatter/files/fileId/file-shares/link



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



370

Files Shares LinkChatter REST API リソース



説明型名前

特定のページの変換を指定します。最初のページは 0 です。特定

Integerpage

のページを指定しない場合、最初のページの変換が返されます。PDF ファイルの変換の場合、ドキュメント全体の変換になります。有効な値は 0 のみです。単一ページの変換は取得できません。

返される変換の種別を指定します。デフォルト値は

Stringtype

THUMB120BY90 です。有効な値は、次のとおりです。• FLASH

• PDF

• THUMB120BY90

• THUMB240BY180

• THUMB720BY480

レスポンスボディ変換のバイナリストリーム。

File Information, Batchファイル ID によって指定されたファイルのリストに関する情報。ファイルのリストに関する情報の取得や、ファイルのリストの削除を行います。指定できるファイル ID 数は、URL の長さによって制限されます。通常、カンマ区切りのリストに最大 100 個のファイル ID を指定できます。リソース

/chatter/files/batch/fileIds

/connect/communities/communityId/chatter/files/batch/fileIds


371

File Information, BatchChatter REST API リソース


HTTP メソッドGET、DELETE

レスポンスボディBatch Result Item

Folders リソース

フォルダまたはフォルダの内容に関する情報。フォルダの変更と削除、フォルダへの項目の追加、およびルートフォルダの同期を行います。使用可能なリソース:

説明リソース

指定されたフォルダに関する情報を取得します。フォルダの移動、名前の変更、および削除を行います。ルートフォルダを同期します。


フォルダの内容に関する情報を取得します。フォルダへのファイルの追加や、フォルダの作成を行います。ルートフォルダを同期します。

/chatter/folders/folderId/items

Folder Information指定されたフォルダに関する情報を取得します。フォルダの移動、名前の変更、および削除を行います。ルートフォルダを同期します。フォルダを削除すると、そのフォルダ内のフォルダはすべて削除され、削除されたフォルダからすべてのファイルが削除されるため、同期されなくなります。リソース


メモ: root を folderId として使用できます。



HTTP メソッドGET、HEAD、PATCH、DELETE

PATCH のリクエストボディFolder Input

372

Folders リソースChatter REST API リソース

PATCH の要求パラメータフォルダの移動


必須項目/省略可能説明型パラメータ

33.0省略可能フォルダおよびこのフォルダ内のすべてのフォルダが Salesforce Files Syncと同期されてい


る場合は true、同期されていない場合はfalse。isInMyFileSync 設定は、ルートフォルダでのみ有効です。一度 trueに設定すると、isInMyFileSyncを falseに設定することはできません。

30.0必須項目新しい親フォルダの ID。null の場合、フォルダは現在のフォルダから削除されます。

StringparentFolderId

指定された ID が root の場合、フォルダはユーザのフォルダ階層のルートに移動します。

フォルダ名の変更






30.0必須項目フォルダの新しい名前Stringname

GET および PATCH のレスポンスボディFolder

Folder Contentsフォルダの内容に関する情報を取得します。フォルダへのファイルの追加や、フォルダの作成を行います。ルートフォルダを同期します。

373


フォルダを作成するには、POST 要求でリクエストボディまたは要求パラメータを使用できます。ファイルを作成するには、マルチパート/フォームデータの POST 要求のボディパートとして送信する必要があります。説明とタイトル情報を送信するには、マルチパート/フォームデータ要求の一部として JSON またはXML リッチ入力ボディに含めます。または、説明、タイトル、および種別を要求パラメータで送信できます。「バイナリファイルのアップロード」 (ページ 13)を参照してください。ファイルを [ファイル] タブに追加するには、/chatter/users/me/filesを使用します。リソース

/chatter/folders/folderId/items

メモ: root を folderId として使用できます。







33.0省略可能フォルダ内の項目の検索条件を指定します。値 IsInMyFileSyncは、フォルダで同期されていない項目を除外します。

Stringfilter

30.0省略可能項目のページを指定する整数。デフォルト値は 0 で、最初のページを返します。

Integerpage

30.0省略可能ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。サイズを指定しない場合、デフォルトは 25 です。

IntegerpageSize

GET のレスポンスボディFolder Item Page

POST のリクエストボディFolder Item Input

POST の要求パラメータフォルダへのファイルの追加



30.0省略可能ファイルの説明Stringdesc

374







30.0省略可能ファイルのタイトルStringtitle

30.0必須項目項目の種別。ファイルをフォルダに追加するには、値を Fileにする必要があります。

Stringtype

フォルダの作成



30.0必須項目フォルダへのパスStringfolderPath




30.0必須項目項目の種別。フォルダを作成するには、値を Folder にする必要があります。

Stringtype

POST のレスポンスボディFolder Item

ファイルをフォルダに追加する例{

"file" :

{

375


"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

Groups リソースChatter REST API リソース

説明リソース

組織内のすべてのグループのリスト。グループに関する情報を取得するか、グループを作成します。

/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

設定に関する情報です。/chatter/groups/groupId/my-settings

指定されたグループの写真。写真を取得、投稿、トリミング、削除します。


指定されたグループに関連付けられたレコードのリストを返します。レコードをグループに関連付けるためにも使用されます。

/chatter/groups/groupId/records

指定されたグループで最近使用されたトピックを最大5 個返します。

/chatter/groups/groupId/topics

関連トピック:

Groups Feed リソース

List of Groups組織内のすべてのグループのリスト。グループに関する情報を取得するか、グループを作成します。リソース

/chatter/groups/

/connect/communities/communityId/chatter/groups/

377

List of GroupsChatter REST API リソース


POST は 29.0 で使用可能Chatter が必要かどうか

はいHTTP メソッド

GET、HEAD、POST


使用可能説明型パラメータ名

29.0指定のアーカイブ状況で絞り込まれたグループのリストを返します。

StringarchiveStatus

• All — アーカイブ対象かどうかに関係なく、すべてのグループ。

• Archived — アーカイブ対象のグループのみ。

• NotArchived — アーカイブ対象外のグループのみ。

デフォルト値は、NotArchived です。

23.0項目のページを指定する整数。デフォルト値は 0 で、最初のページを返します。

Integerpage

23.0ページあたりの項目数を指定します。有効な値は 1 ～ 250 です。デフォルト値は 25 です。

IntegerpageSize

23.0検索する文字列を指定します。検索文字列にはワイルドカード文字を除

Stringq

いて 2 文字以上が含まれている必要があります。ワイルドカードについての詳細は、「ワイルドカード」を参照してください。


<group>

378


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",


"owner" : "00590000000DmPw",


}

プロパティ


説明型名前

31.0お知らせ ID。お知らせは、削除されるか、別のお知らせで置き換えられない限

Stringannouncement

り、その表示期限の 11:59 p.m. までSalesforce UI の指定の場所に表示されます。

29.0このグループで Chatter 顧客を許可している場合は true、それ以外

BooleancanHaveChatterGuests

の場合は false。このプロパティを true に設定した後で、false

に設定することはできません。29.0グループの [説明] セクションStringdescription

28.0グループの [情報] セクション Web

UI では、[情報] セクションは [説明]

Group Information Inputinformation

379



説明型名前

セクションの上にあります。グループが非公開の場合は、[情報]

セクションはメンバーにのみ表示されます。[説明] セクションは全員に表示されます。

29.0グループがアーカイブ済みの場合は true、それ以外の場合は

BooleanisArchived

false。デフォルトは false です。

29.0グループの自動アーカイブが無効の場合は true、それ以外の場合

BooleanisAutoArchiveDisabled

は false。デフォルトは false

です。29.0グループの名前Stringname

29.0グループ所有者の ID。このプロパティは、PATCH 要求でのみ使用できます。

Stringowner

29.0グループの表示種別を指定します。次のいずれかの値になります。

Stringvisibility

• PrivateAccess — グループのメンバーのみが、このグループへの投稿を参照できます。

• PublicAccess — コミュニティのすべてのユーザが、このグループへの投稿を参照できます。

• Unlisted — 今後の使用のために予約されています。


使用可能必須項目/省略可能


29.0省略可能このグループで Chatter 顧客を許可している場合は true、それ以外の場合は false。このプ


380


使用可能必須項目/省略可能


ロパティを true に設定した後で、false に設定することはできません。

29.0省略可能グループの [説明] セクションStringdescription

29.0省略可能グループの [情報] セクション内のテキストStringinformationText

29.0省略可能グループの [情報] セクションのタイトルStringinformationTitle

29.0必須項目グループの名前Stringname

29.0必須項目グループの表示種別を指定します。次のいずれかになります。

Stringvisibility




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

Group InformationChatter REST API リソース


PATCH は 28.0 で使用可能Chatter が必要かどうか


GET、DELETE、HEAD、PATCH

DELETE は 29.0 でサポートPATCH は 28.0 でサポート

PATCH のリクエストボディGroup Input

ルート XML タグ<group>

JSON

{




"information" : {



},




"owner" : "00590000000DmPw",


}

382


プロパティ


説明型名前

31.0お知らせ ID。お知らせは、削除されるか、別のお知らせで置き換えられない限

Stringannouncement

り、その表示期限の 11:59 p.m. までSalesforce UI の指定の場所に表示されます。

29.0このグループで Chatter 顧客を許可している場合は true、それ以外


の場合は false。このプロパティを true に設定した後で、false

に設定することはできません。29.0グループの [説明] セクションStringdescription

28.0グループの [情報] セクション Web

UI では、[情報] セクションは [説明]

Group Information Inputinformation

セクションの上にあります。グループが非公開の場合は、[情報]

セクションはメンバーにのみ表示されます。[説明] セクションは全員に表示されます。

29.0グループがアーカイブ済みの場合は true、それ以外の場合は

BooleanisArchived


29.0グループの自動アーカイブが無効の場合は true、それ以外の場合


は false。デフォルトは false

です。29.0グループの名前Stringname


Stringowner

383



説明型名前


Stringvisibility




Group Information Input

JSON

{

"text" : "Post questions about the API.",

"title" : "API Questions"

}

プロパティ


説明型名前

28.0グループの [情報] セクション内のテキスト。HTML はサポートされて

Stringtext

いません。最大文字数は 4000 文字(バイト) です。

28.0グループの [情報] セクションのタイトル。最大文字数は 240 文字 (バイト) です。

Stringtitle

384






31.0省略可能お知らせとして使用するフィード項目の ID。お知らせは、削除されるか、別のお知らせで置き換えられない限り、その表示期限の 11:59 p.m. までSalesforce UI の指定の場所に表示されます。

Stringannouncement

29.0省略可能このグループで Chatter 顧客を許可している場合はtrue、それ以外の場合は false。このプロパティ


を trueに設定した後で、falseに設定することはできません。

29.0省略可能グループの [説明] セクションStringdescription

28.0省略可能グループの [情報] セクション。Web UI では、[情報]

セクションは [説明] セクションの上にあります。グStringinformationText

ループが非公開の場合は、[情報] セクションはメンバーにのみ表示されます。[説明] セクションは全員に表示されます。

28.0省略可能グループの [情報] セクションのタイトルStringinformationTitle

29.0省略可能グループがアーカイブ済みの場合は true、それ以外の場合は false。デフォルトは false です。

StringisArchived

29.0省略可能グループの自動アーカイブが無効の場合は true、それ以外の場合は false。デフォルトは false です。


29.0省略可能グループの名前Stringname

29.0省略可能グループ所有者の ID。このプロパティは、PATCH 要求でのみ使用できます。

Stringowner

29.0省略可能グループの表示種別を指定します。次のいずれかの値になります。

Stringvisibility




385


GET および PATCH のレスポンスボディGroup Detail

PATCH の例このリクエストボディは、グループの [情報] セクションのテキストとタイトルを更新します。{

"information" : {

"text" : "Post questions about the API to this group. If you have the answer toa 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



レスポンスボディBatch Results

386

Batch Group InformationChatter REST API リソース

Group Announcements指定されたグループに投稿されたお知らせに関する情報。グループへのお知らせの情報取得や投稿を行います。お知らせは、情報を強調表示するために使用します。ユーザは、グループフィードのお知らせに対するディスカッション、いいね!、コメントの投稿ができます。他の投稿と同様に、お知らせが投稿されると、グループメンバーは選択したグループメール通知頻度に応じてメール通知を受信します。フィード投稿を削除するとお知らせが削除されます。特定のお知らせに関する情報の取得、お知らせの表示期限の更新、またはお知らせの削除を行うには、Announcements リソース (/chatter/announcements/announcementId) を使用します。リソース

/chatter/groups/groupID/announcements

/connect/communities/communityId/chatter/groups/groupID/announcements





適用開始バージョン説明型パラメータ名

31.0項目のページを指定する整数。デフォルト値は 0

Integerpage

で、最初のページを返します。

31.0ページあたりの項目数を指定します。有効な値は

IntegerpageSize

1 ～ 100 です。サイズを指定しない場合、デフォルトは 25 です。


<announcement>

JSON の例{ "body":

{

387

Group AnnouncementsChatter REST API リソース


{

"text": "Please install the updates for all iOS devices.",

"type": "Text"

}

]

}

"expirationDate": "2014-02-22T00:00:00.000Z",

}

プロパティ



説明型名前

31.0必須項目お知らせのテキスト。Message BodyInput

body

31.0必須項目別のお知らせが最初に投稿されていない限り、この日付の 11:59 p.m.

DateexpirationDate

までSalesforce UI にお知らせが表示されます。Salesforce UI では、expirationDate の時間値は無視されます。ただし、時間値を使用して各自の UI で独自の表示ロジックを作成することはできます。



31.0別のお知らせが最初に投稿されていない限り、こ

DateexpirationDate

の日付の 11:59 p.m. までSalesforce UI にお知らせが表示されます。Salesforce

UI では、expirationDateの時間値は無視されます。ただ

388

Group AnnouncementsChatter REST API リソース


し、時間値を使用して各自の UI で独自の表示ロジックを作成することはできます。

GET のレスポンスボディAnnouncement Page

POST のレスポンスボディAnnouncement

POST の例次の要求は、グループへのお知らせを投稿します。POST /chatter/groups/0F9D00000000I1d/announcements

レスポンスボディは次のようになります。{ "body":

{


{


"type": "Text"

}

]

}


}

Group Files指定されたグループに投稿されたファイルに関する情報を返します。リソース

/chatter/groups/groupID/files

/connect/communities/communityId/chatter/groups/groupID/files

389

Group FilesChatter REST API リソース







Integerpage



IntegerpageSize


27.0結果を絞り込むクエリ文字列。文字列にはワイル

Stringq

ドカード文字を除いて 2

文字以上が含まれている必要があります。ワイルドカードについての詳細は、「ワイルドカード」を参照してください。

レスポンスボディFile Summary Page

Group Members指定されたグループのメンバー。メンバーを取得し、グループにメンバーを追加します。メンバーを追加するには、コンテキストユーザがグループ所有者またはモデレータである必要があります。リソース

/chatter/groups/groupId/members

/connect/communities/communityId/chatter/groups/groupId/members


390

Group MembersChatter REST API リソース




<member>

プロパティ


29.0メンバーのロール。次のいずれかの値にします。

Stringrole

• GroupManager

• StandardMember

23.0グループに追加するメンバーのユーザ ID。

StringuserId


使用可能なバージョン説明型パラメータ名


Stringrole

• GroupManager

• StandardMember

23.0グループに追加するユーザの ID。StringuserId




Integerpage



IntegerpageSize

1 ～ 1000 です。サイズを

391



指定しない場合、デフォルトは 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": {


"firstName": "Gordon",

"id": "005D0000001LLO1IAO",

"isActive": true,


"lastName": "Johnson",

"motif": {

"color": "1797C0",




},

"mySubscription": {

392


"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

Group Members—PrivateChatter REST API リソース

メモ: 非公開グループのメンバーシップを要求するには、Group Members リソースを使用します。

リソース/chatter/groups/groupId/members/requests

/connect/communities/communityId/chatter/groups/groupId/members/requests



HTTP メソッドGET、HEAD、および POST



27.0省略可能。このパラメータを含めると、指定した

Stringstatus

状況と一致するものを含むように結果が絞り込まれます。有効な値は次のとおりです。• Accepted

• Declined

• Pending

GET または HEAD のレスポンスボディGroup Membership Request Collection

POST のレスポンスボディGroup Membership Request

次の表に、このリソースに固有の HTTP 応答コードの説明を示します。他の HTTP 応答コードの説明は、「状況コードとエラー応答」を参照してください。


次のいずれかになります。201

• 成功• ユーザは、このグループに対してメンバーシップを要求済みです。

ユーザは、すでにこのグループのメンバーです。204

394



次のいずれかになります。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": {



"id": "005D0000001LLO1IAO",

"isActive": true,


"motif": {

395


"color": "1797C0",




},

"mySubscription": {

"id": "0E8D0000000T5ZUKA0",


},


"photo": {

"fullEmailPhotoUrl": "https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cPhK

rC7plNhUw5eOz7Aj1u-zWLMxsSybO7lwUPg5_Xne",




"standardEmailPhotoUrl": "https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0

cPhKrC7plNhUw5eOz7Aj1u_2Vnyzx4jZ2zFiKBz_sTt2",


},


"type": "User",



}

}],

"total": 1

396


}

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": {



"id": "005D0000001LLO1IAO",

"isActive": true,



"motif": {

"color": "1797C0",




397


},



"photo": {







},


"type": "User",



}

}

関連トピック:

非公開グループへの参加を要求する

Group Membership Requests—Private非公開グループに参加するユーザによって要求の状況を更新するか、非公開グループへの参加要求に関する情報を取得します。/chatter/groups/groupId/members/requests への POST 要求のGroup Membership Request

応答から、requestId の値を取得します。

398

Group Membership Requests—PrivateChatter REST API リソース

リソース/chatter/group-membership-requests/requestId

/connect/communities/communityId/chatter/group-membership-requests/requestId



HTTP メソッドGET、HEAD、および PATCH

PATCH のリクエストボディGroup Membership Request Update



27.0このプロパティを使用して、メンバーシップ要求が却下された場合にユーザ

StringresponseMessage

に表示するメッセージを指定します。このプロパティの値は、statusプロパティの値が Declined の場合にのみ使用されます。最大文字数は 756 文字です。

27.0有効な値は次のとおりです。Stringstatus

• 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

Group Membership Requests—PrivateChatter REST API リソース

Group Memberships リソースChatter グループのメンバーシップに関する情報。次のリソースを使用できます。

説明リソース

グループのメンバーに関する情報へのアクセス、グループからのメンバーの削除、およびグループメンバーのロールの更新に使用されます。


グループメンバーのリストに関する情報へのアクセスに使用されます。

/chatter/group-memberships/batch/membershipIds

Group Memberships Informationグループのメンバーに関する情報へのアクセス、グループからのメンバーの削除、およびグループメンバーのロールの更新に使用されます。メンバーシップ ID は /chatter/groups/groupId/membershipsリソースから返されます。リソース


/connect/communities/communityId/chatter/group-memberships/membershipId



HTTP メソッドGET、DELETE、HEAD、PATCH

PATCH は 29.0 でサポートPATCH のリクエストボディ

ルート XML タグ<member>

JSON の例{

"role" : "GroupManager",

"userId" : "005B0000000Ge16"

}

400

Group Memberships リソースChatter REST API リソース

プロパティ



Stringrole

• GroupManager

• StandardMember


StringuserId

メモ: PATCH 要求でグループメンバーのロールを更新するには、userId プロパティは渡さずに role

プロパティのみを渡します。PATCH の要求パラメータ



Stringrole

• 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





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": {



"id": "005D0000001LLO1IAO",

"isActive": true,



"motif": {

"color": "1797C0",


402




},

"mySubscription": {

"id": "0E8D0000000T5ZUKA0",


},


"photo": {


"largePhotoUrl": "https:/instance_name/profilephoto/729D00000000LJL/F",


"smallPhotoUrl":"https://instance_name/profilephoto/729D00000000LJL/T",



},


"type": "User",



}

},

"statusCode": 200

403


},

{

"result": [{

"errorCode": "NOT_FOUND",

"message": "The requested resource does not exist"

}],

"statusCode": 404

}

]

}

2 つ目のグループメンバーシップが見つかっていません。バッチ要求は、サブ要求ごとの状況コードを返します。

Group Photo指定されたグループの写真。写真を取得、投稿、トリミング、削除します。[ファイル] ページからの画像をグループの写真 (既存のコンテンツ) として使用するには、リクエストボディのfileId プロパティまたは fileId 要求パラメータでファイル ID を渡します。[グループ] ページでアップロードした画像にはファイル ID は含まれず、fileId としては使用できません。バイナリファイルをグループの写真としてアップロードするには、マルチパート/フォームデータメッセージでそのファイルを送信する必要があります。マルチパート/フォームデータメッセージを作成する方法についての詳細は、「バイナリファイルのアップロード」を参照してください。リソース


/connect/communities/communityId/chatter/groups/groupId/photo



HTTP メソッドGET、POST、DELETE、または HEAD


<photo>

404

Group PhotoChatter REST API リソース

JSON の例{ "cropSize" : "120",

"cropX" : "0",

"cropY" : "0",

"fileId" : "069D00000001IOh"

}

プロパティ



29.0アップロードされたファイルまたは既存のファイルを

トリミングする正方形の任意の境界の長さ (ピクセル単位)。

IntegercropSize

トリミングする必要があります。


画像の左端を起点とした、トリミングする正方形の開始位

IntegercropX


置 X (ピクセル単位)。左上の位置は (0,0) です。


画像の上端を起点とした、トリミングする正方形の開始位

IntegercropY


置 Y (ピクセル単位)。左上の位置は (0,0) です。

25.0既存のファイルを選択する必要があります。

既存のファイルの 18 文字のID。キープレフィックスは069、ファイルサイズは 2 MB

未満にする必要があります。

StringfileId

メモ: グループページおよびユーザページにアップロードされた画像にはファイル ID がないため、使用できません。

25.0省略可能既存のファイルのバージョン番号。指定されていない場


合、最新のバージョンが使用されます。

405





29.0アップロードされたファイルまたは既存


IntegercropSize

のファイルをトリミングする必要があります。


画像の左端を起点とした、トリミングす

IntegercropX

のファイルをトリミる正方形の開始位置ングする必要があります。

X (ピクセル単位)。左上の位置は (0,0) です。


画像の上端を起点とした、トリミングす

IntegercropY


Y (ピクセル単位)。左上の位置は (0,0) です。


既存のファイルの 18

文字の ID。キープレフィックスは 069、ファイルサイズは 2

StringfileId

MB 未満にする必要があります。

メモ: [グループ] ページおよび [ユーザプロファイル] ページでアップロードしたファイルにはファイル ID は含まれず、投稿やトリミングはできません。[ファイル] ページでアップロードしたファイル

406




にはファイルID は含まれず、投稿やトリミングはできません。

25.0省略可能既存のコンテンツのバージョン番号。指


定されていない場合、最新のバージョンが使用されます。

メモ: 写真は非同期に処理され、すぐには表示されない場合があります。

GET または HEAD のレスポンスボディPhoto

POST のレスポンスボディPhoto

関連トピック:

グループの写真を更新およびトリミングする

Group Records指定されたグループに関連付けられたレコードのリストを返します。レコードをグループに関連付けるためにも使用されます。リソース

/chatter/groups/groupID/records

/connect/communities/communityId/chatter/groups/groupID/records




407

Group RecordsChatter REST API リソース




Integerpage

33.0ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。サイズを指定しない場合、デフォルトは 25 です。

IntegerpageSize


<groupRecord>

JSON の例

{"recordId" : "001D000000Io9cD"}

プロパティ



説明型名前

34.0必須項目レコードの ID。StringrecordId



34.0レコードの ID。StringrecordId

GET のレスポンスボディGroup Record Page

POST のレスポンスボディGroup Record

Group Recordグループレコードに関する情報の取得、またはレコードとグループ間の関連付けの削除を行います。

408

Group RecordChatter REST API リソース

リソース/chatter/group-records/groupRecordId

/connect/communities/communityId/chatter/group-records/groupRecordId




GET のレスポンスボディGroup Record


Group Settings指定されたグループのコンテキストユーザの Chatter 設定に関する情報です。リソース

/chatter/groups/groupId/my-settings

/connect/communities/communityId/chatter/groups/groupId/my-settings



HTTP メソッドGET、HEAD、または PATCH


<groupChatterSettings>

プロパティユーザの Chatter 設定。

409

Group SettingsChatter REST API リソース


説明型名前

27.0グループメンバーがグループからメールを受信する頻度。有効な値は、次のとおりです。

StringemailFrequency

• EachPost

• DailyDigest

• WeeklyDigest

• Never

コミュニティでは、グループメンバーが 10,000 人を超えると [各投稿のメール] オプションが無効になります。このオプションを選択したすべてのメンバーは、自動的に [毎日のダイジェスト] に切り替わります。



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

Group TopicsChatter REST API リソース




レスポンスボディTopic Collection

Influence リソース

組織のユーザを Chatter での影響度によって分類するために使用するパーセントしきい値のリスト。ユーザは、自分が行った投稿とコメントの数、および受け取ったコメントといいね! の数に基づいてランク付けされます。カテゴリに関連付けられたパーセントは、そのインフルエンサーカテゴリの下限しきい値を表します。たとえば、0.25 は、Active Influencer カテゴリの下限値です。つまり、影響度ランクが 25% 以上で次に高いカテゴリしきい値未満のユーザがこのカテゴリに含まれます。

Influence Thresholdsリソース

/chatter/influence/thresholds

/connect/communities/communityId/chatter/influence/thresholds




レスポンスボディInfluence Thresholds

レスポンスボディの例{"thresholds": [

{

"name": "Top Influencer",

"threshold": "0.8",

}

411

Influence リソースChatter REST API リソース

{

"name": "Active Influencer",

"threshold": "0.25",

}

{

"name": "Observer",

"threshold": "0.0",

}

]}

Likes リソース

指定されたいいね! に関する情報。いいね! の削除にも使用されます。ニュースフィードやレコードフィードなど、任意のフィードから特定のいいね! の ID を検索できます。

Likeリソース

/chatter/likes/likeId

/connect/communities/communityId/chatter/likes/likeId



HTTP メソッドGET、DELETE、または HEAD

GET または HEAD のレスポンスボディLike

Managed Topics リソース

コミュニティの管理トピック。管理トピックのリストを取得します。コミュニティの管理トピックの作成、削除、または並び替えを行います。使用可能なリソース:

412

Likes リソースChatter REST API リソース

説明リソース

コミュニティのすべての管理トピックを取得します。管理トピックを作成します。管理トピックを並び替えます。


コミュニティの管理トピックの情報取得または削除を行います。

/connect/communities/communityId/managed-topics/managedTopicId

Managed Topicsコミュニティのすべての管理トピックを取得します。管理トピックを作成します。管理トピックを並び替えます。コミュニティマネージャ (「コミュニティの作成および設定」または「コミュニティの管理」権限を持つユーザ) のみが、管理トピックの作成または並び替えを行うことができます。リソース




HTTP メソッドGET、POST、PATCH、HEAD





32.0省略可能管理トピックの種別。StringmanagedTopicType • Featured — コミュニティホー

ムページなどの主要トピック。ただし、全体的なナビゲーションは提供しません。

• Navigational — コミュニティのナビゲーションメニューに表示されるトピック。

1 つのトピックは最大 2 つの種別の管理トピックに関連付けることができるため、1 つのトピックをFeatured トピックとNavigationalトピックの両方にすることができます。

413

Managed TopicsChatter REST API リソース

GET のレスポンスボディManaged Topic Collection


<managedTopic>

JSON の例{

"managedTopicType" :"Featured",

"recordId" :"0TOD00000000cwk"

}

プロパティ



説明型名前

32.0必須項目管理トピックの種別。StringmanagedTopicType • Featured — コミュニティ

ホームページなどの主要トピック。ただし、全体的なナビゲーションは提供しません。


1 つのトピックは最大 2 つの種別の管理トピックに関連付けることができるため、1 つのトピックをFeatured トピックとNavigational トピックの両方にすることができます。managedTopicType につき、最大 25 個の管理トピックを作成できます。

32.0新規トピックでは必須name またはrecordIdを指

管理トピックの名前。Stringname

定する必要があ

414




説明型名前

ります。両方を指定することはできません。

32.0Name プロパティが使用され

管理トピックになるレコードのID。バージョン 32.0 では、recordId

はトピック ID である必要があります。

StringrecordId

ていない場合、既存のトピックに必要です。name またはrecordIdを指定する必要があります。両方を指定することはできません。





32.0必須項目管理トピックの種別。StringmanagedTopicType • Featured — コミュニティホー



1 つのトピックは最大 2 つの種別の管理トピックに関連付けることができるため、1 つのトピックをFeatured トピックとNavigationalトピックの両方にすることができます。managedTopicTypeにつき、最大25 個の管理トピックを作成できます。

415





32.0新規トピックでは必須name またはrecordId を指


定する必要があります。両方を指定することはできません。




StringrecordId

ていない場合は必須name またはrecordId を指定する必要があります。両方を指定することはできません。

POST のレスポンスボディManaged Topic


<managedTopicPositionCollection>

JSON の例{

"managedTopicPositions" : [

{

"managedTopicId" :"0mtD0000000001aIAA",

"position" :"0"

},

{

"managedTopicId" :"0mtD0000000002qIAA",

416


"position" :"2"

}

]

}

プロパティ



説明型名前

32.0必須項目Managed Topic Position リクエストボディのコレクション。このコレク

Managed TopicPosition Input[]

managedTopicPositions

ションには、Featured およびNavigational 管理トピックを含めることができます。また、すべての管理トピックを含める必要はありません。managedTopicPositions にすべての管理トピックを含めない場合、管理トピックはmanagedTopicPositions で指示された位置に従って並び替えられ、managedTopicPositions

に含まれない管理トピックは次に空いている位置まで順序を下げられます。「管理トピックの並び替えの例」を参照してください。

管理トピックの並び替えの例次の管理トピックがあるとします。

位置管理トピック

0ManagedTopicA

1ManagedTopicB

2ManagedTopicC

3ManagedTopicD

4ManagedTopicE

Managed Topic Position Collection Input に次の情報を含めて管理トピックを並び替えます。

417



0ManagedTopicD

2ManagedTopicE

結果は次のとおりです。


0ManagedTopicD

1ManagedTopicA

2ManagedTopicE

3ManagedTopicB

4ManagedTopicC

PATCH のレスポンスボディManaged Topic Collection

Managed Topicコミュニティの管理トピックの情報取得または削除を行います。コミュニティマネージャ (「コミュニティの作成および設定」または「コミュニティの管理」権限を持つユーザ) のみが、管理トピックを削除できます。リソース

/connect/communities/communityId/managed-topics/managedTopicId




GET のレスポンスボディManaged Topic


418

Managed TopicChatter REST API リソース

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




419

Mentions リソースChatter REST API リソース




29.0省略可能検索結果を絞り込むフィード項目 ID (コメント内のメンションの場合) または

StringcontextId

フィード件名 ID (フィード項目内のメンションの場合) であり、最も的確な結果が最初に表示されます。

29.0省略可能返すページの数。番号付けは 0 から開始します。0を渡すか、このプロパティを

Integerpage

省略すると、最初のページが返されます。結果が 500 件を超えるページを試行すると、空の応答が返されます。

29.0省略可能ページあたりの項目数。有効な値は 1 ～100 です。デフォルトサイズは 25 です。500 件を超える結果を取得しようとすると、空の応答が返されます。

IntegerpageSize

29.0必須項目検索語。一致するユーザおよびグループの名前を検索します。ユーザを検索する

Stringq

場合、1 文字以上を指定する必要があります。グループを検索する場合、2 文字以上を指定する必要があります。このパラメータではワイルドカードは使用できません。

29.0省略可能メンションの補完の種類。次のいずれかの値にします。

Stringtype

• All — メンションで参照するレコードタイプに無関係の、すべてのメンションの補完。

• Group — グループのメンションの補完。

• User — ユーザのメンションの補完。デフォルト値は、All です。

GET のレスポンスボディMention Completion Page

420

Mentions CompletionsChatter REST API リソース

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",


"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"

}

],


"previousPageUrl": null

}

関連トピック:


421

Mentions CompletionsChatter REST API リソース

Mentions Validations指定されたメンションがコンテキストユーザに対して有効であるかどうかを示す情報。たとえば、コンテキストユーザは自分が属していない非公開グループにメンションできません。そのようなグループがメンションの検証のリストに含まれていると、Mention Validations レスポンスボディの hasErrors プロパティは true になり、そのメンションの検証で Disallowed の validationStatus がグループに設定されます。リソース

/chatter/mentions/validations

/connect/communities/communityId/chatter/mentions/validations







29.0必須項目フィード項目の親 ID (新しいフィード項目の場合) またはフィード項目 ID (コメントの場合)。

StringparentId

29.0必須項目メンションする ID のカンマ区切りのリスト。最大値は、25 です。

String[]recordIds

29.0必須項目フィード項目を表示できるユーザの種別を指定します。

Stringvisibility

• AllUsers — 表示は内部ユーザに限定されません。

• InternalUsers — 表示は内部ユーザに限定されます。

GET のレスポンスボディMention Validation

422

Mentions ValidationsChatter REST API リソース

使用方法まず、Mentions Completionsを要求し、提案メンションのリストを取得します。これらの提案メンションを Mentions

Validations リソースに渡し、メンションがコンテキストユーザに対して有効であるかどうかを判定します。

関連トピック:


Motifs リソース

小、中、大の一連の motif アイコンの URL を返します。レコードの一連の motif アイコンは、レコードタイプによって異なります。motif にはレコードタイプのベース色を含めることもできます。次のリソースを使用できます。

説明リソース

指定したレコードの小、中、大の一連の motif アイコンを返します。指定されたレコードのベース色を返すこともできます。

/connect/motifs/idOrPrefix

指定した複数のレコードの小、中、大の一連の motif

アイコンを返します。指定された各レコードのベース色を含めることもできます。

/connect/motifs/batch/idOrPrefixList

Motifs リソース指定したレコードの小、中、大の一連の motif アイコンを返します。指定されたレコードのベース色を返すこともできます。idOrPrefix の ID またはキープレフィックスのいずれかを指定します。リソース

/connect/motifs/idOrPrefix

/connect/communities/communityId/motifs/idOrPrefix




レスポンスボディMotif

423

Motifs リソースChatter REST API リソース

GET の例ユーザの motifs の要求: /connect/motifs/005D0000001LLO1

応答:

{

"color": "1797C0",




}

Batch Motifs リソース指定した複数のレコードの小、中、大の一連の motif アイコンを返します。指定された各レコードのベース色を含めることもできます。idOrPrefixList の ID とキープレフィックスのカンマ区切りのリストを指定します。ID とキープレフィックスは、同じ要求に混在できます。リソース

/connect/motifs/batch/idOrPrefixList

/connect/communities/communityId/motifs/batch/idOrPrefixList





GET の例ユーザおよびファイルの motifs の要求: /connect/motifs/batch/005D0000001LLO1,069D00000001FHF

応答:

{"results": [

{

"result": {

"color": "1797C0",

424

Motifs リソースChatter REST API リソース




},

"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




425

Push Notifications リソースChatter REST API リソース


<pushNotification>

JSON の例{ "appName" : "TestApp",

"namespace" : "abc",

"userIds" : ["005x00000013dPK", "005x00000013dPL"],

"payload" : "{'aps':{'alert':'test', 'badge':0, 'sound':'default'}}"

}

プロパティ



説明型名前

31.0必須項目転送通知の送信先の接続アプリケーションの API 名。

StringappName

31.0必須項目 (名前空間が設定されている場合)

転送通知の送信先の接続アプリケーションの名前空間。

Stringnamespace

31.0必須項目JSON 形式の転送通知ペイロード。Stringpayload

31.0必須項目転送通知受信者のユーザ ID。String []userIds






StringappName



Stringnamespace



426

Push Notifications リソースChatter REST API リソース

Question and Answers Suggestions リソース

質問および回答の提案を取得します。リソース

/connect/question-and-answers/suggestions

/connect/communities/communityId/question-and-answers/suggestions








32.0省略可能検索結果にナレッジ記事を含める場合は、true を指定します。質

BooleanincludeArticles

問のみを返す場合は、falseを指定します。

32.0省略可能項目種別ごとに返す結果の最大数。有効な値は 1 ～ 10 です。デフォルト値は 5 です。

IntegermaxResults

32.0必須項目検索する文字列を指定します。検索文字列にはワイルドカード文字

Stringq

を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。最大文字数は 255 文字です。

32.0省略可能そのオブジェクトに関する質問のみを検索するには、件名 ID を指定

StringsubjectId

します。ID がトピックまたはユーザの場合、ID は無視されます。

GET のレスポンスボディQuestion and Answers Suggestion Collection

427

Question and Answers Suggestions リソース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




428

おすすめ定義リソースChatter REST API リソース

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?"}

プロパティ



説明型名前

33.0必須項目おすすめに基づいて行動するための URL （グループに参加するための URL など）。

StringactionUrl

34.0必須項目ユーザインターフェースのアクション URL のテキストラベル("Launch" など)。

StringactionUrlName

33.0必須項目おすすめの説明 (本文)。Stringexplanation

33.0必須項目おすすめ定義の名前。この名前が[設定] に表示されます。

Stringname

33.0省略可能おすすめ定義のタイトル。Stringtitle





33.0必須項目おすすめに基づいて行動するための URL （グループに参加するための URL など）。

StringactionUrl

34.0必須項目ユーザインターフェースのアクション URL のテキストラベル("Launch" など)。

StringactionUrlName

33.0必須項目おすすめの説明 (本文)。Stringexplanation

429

Recommendation DefinitionsChatter REST API リソース




33.0必須項目おすすめ定義の名前。この名前が[設定] に表示されます。

Stringname


POST のレスポンスボディRecommendation Definition

GET のレスポンスボディRecommendation Definition Collection

Recommendation Definitionおすすめ定義に関する情報の取得、おすすめ定義の変更または削除を行います。コミュニティマネージャ (「コミュニティの作成および設定」または「コミュニティの管理」権限を持つユーザ) および「すべてのデータの編集」権限を持つユーザのみが、おすすめ定義とスケジュール済みおすすめのアクセス、作成、および削除を行うことができます。これらのおすすめは、Salesforce1 モバイルブラウザアプリケーションのコミュニティのフィードに直接表示されます。また、Summer '15 以降のバージョンの Napili テンプレートを使用すると、コミュニティのホームページの右側にもデフォルトで表示されます。リソース

/connect/recommendation-definitions/recommendationDefinitionId

/connect/communities/communityId/recommendation-definitions/recommendationDefinitionId




PATCH のリクエストボディJSON の例

{





430

Recommendation DefinitionChatter REST API リソース


プロパティ



説明型名前

33.0省略可能おすすめに基づいて行動するための URL （グループに参加するための URL など）。

StringactionUrl

34.0省略可能ユーザインターフェースのアクション URL のテキストラベル("Launch" など)。

StringactionUrlName

33.0省略可能おすすめの説明 (本文)。Stringexplanation

33.0省略可能おすすめ定義の名前。この名前が[設定] に表示されます。

Stringname






33.0省略可能おすすめに基づいて行動するための URL （グループに参加するための URL など）。

StringactionUrl

34.0省略可能ユーザインターフェースのアクション URL のテキストラベル("Launch" など)。

StringactionUrlName

33.0省略可能おすすめの説明 (本文)。Stringexplanation

33.0省略可能おすすめ定義の名前。この名前が[設定] に表示されます。

Stringname


GET および PATCH のレスポンスボディRecommendation Definition


431

Recommendation DefinitionChatter REST API リソース

Recommendation Definition Photoおすすめ定義の写真に情報取得、アップロード、変更または削除を行います。コミュニティマネージャ (「コミュニティの作成および設定」または「コミュニティの管理」権限を持つユーザ) および「すべてのデータの編集」権限を持つユーザのみが、おすすめ定義とスケジュール済みおすすめのアクセス、作成、および削除を行うことができます。これらのおすすめは、Salesforce1 モバイルブラウザアプリケーションのコミュニティのフィードに直接表示されます。また、Summer '15 以降のバージョンの Napili テンプレートを使用すると、コミュニティのホームページの右側にもデフォルトで表示されます。[ファイル] ページからの画像をおすすめ定義の写真 (既存のコンテンツ) として使用するには、リクエストボディの fileId プロパティまたは fileId 要求パラメータでファイル ID を渡します。バイナリファイルをおすすめ定義の写真としてアップロードするには、マルチパート/フォームデータメッセージでそのファイルを送信する必要があります。マルチパート/フォームデータメッセージを作成する方法についての詳細は、「バイナリファイルのアップロード」を参照してください。リソース

/connect/recommendation-definitions/recommendationDefinitionId/photo



HTTP メソッドGET、HEAD、PUT、DELETE

PUT のリクエストボディルート XML タグ

<photo>


"cropX" : "0",

"cropY" : "0",

"fileId" : "069D00000001IOh"

}

プロパティ





IntegercropSize

432

Recommendation Definition PhotoChatter REST API リソース






IntegercropX





IntegercropY






StringfileId





PUT の要求パラメータ





IntegercropSize




IntegercropX

のファイルをトリミる正方形の開始位置

433





ングする必要があります。



IntegercropY


Y (ピクセル単位)。左上の位置は (0,0) です。




StringfileId


メモ: [グループ] ページおよび [ユーザプロファイル] ページでアップロードしたファイルにはファイル ID は含まれず、投稿やトリミングはできません。[ファイル] ページでアップロードしたファイルにはファイルID は含まれず、投稿やトリミングはできません。




434



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



435

Records リソースChatter REST API リソース



項目のページを指定する整数。デフォルト値は 0 で、最初のページを返します。

Integerpage


IntegerpageSize


レスポンスボディSubscription Page

Topics on Records リソース指定されたレコードに割り当てられているトピック。指定されたレコードに割り当てられているトピックに関する情報の取得、および指定されたレコードに対するトピックの追加や削除を行います。ユーザがオブジェクト種別のレコードにトピックを追加できるようにするには、事前にシステム管理者がそのオブジェクトでトピックを有効化しておく必要があります。リソース

/connect/records/recordId/topics

/connect/communities/communityId/records/recordId/topics



HTTP メソッドGET、DELETE、POST




30.0必須項目既存のトピックの IDStringtopicId


436

Topics on Records リソースChatter REST API リソース


<topicAssignment>

JSON

次の例では、トピックをレコードに割り当てます。{ "topicId": "0TOD0000000090r"

}

プロパティ






新規または既存のトピックの名前。

StringtopicName





30.0topicName パラメータが使用されて


いない場合、既存のトピックに必要です。

30.0新規のトピック、および topicId パラ

新規または既存のトピックの名前

StringtopicName

メータが使用されていない場合の既存のトピックに必要です。

437

Topics on Records リソースChatter REST API リソース


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



438

スケジュール済みおすすめリソースChatter REST API リソース


POST のリクエストボディ新しいスケジュール済みおすすめを作成する JSON の例

{

"rank" : "2",

"recommendationDefinitionId" : "0RDD00000004CEhOAM"}

既存のスケジュール済みおすすめを更新する JSON の例{ "rank" : "2"}

プロパティ



説明型名前

34.0省略可能スケジュールが有効になっているかどうかを示します。trueの場

Booleanenabled

合、おすすめが有効になり、コミュニティに表示されます。false の場合、Salesforce1 モバイルブラウザアプリケーションでのフィードのおすすめは削除されませんが、新しいおすすめは表示されなくなります。Summer '15 以降のバージョンの Napili テンプレートを使用したコミュニティでは、無効にしたおすすめは表示されなくなります。

33.0省略可能スケジュール済みおすすめの相対的なランク。1 から開始する昇順の整数で示されます。ランクを設定することと、順序付きリストに挿入することは同じで

Integerrank

す。スケジュール済みおすすめは、rankで指定された位置に挿入されます。それ以降のすべてのスケジュール済みおすすめのrank が 1 つずつ下がります。「スケジュール済みおすすめにランクを付ける場合の例」を参照してください。

439

スケジュール済みおすすめChatter REST API リソース



説明型名前

指定された rankがリストのサイズよりも大きい場合は、スケジュール済みおすすめがリストの末尾に配置されます。スケジュール済みおすすめの rankには、指定された値の代わりにリストのサイズが指定されます。rank が指定されていない場合は、スケジュール済みおすすめがリストの末尾に配置されます。

33.0スケジュール済みおすすめを作

このスケジュール済みおすすめによってスケジュールされたおすすめ定義の ID。

StringrecommendationDefinitionId

成する場合は必須です。既存のスケジュール済みおすすめを更新する場合は、recommendationDefinitionId

を指定できません。





34.0省略可能スケジュールが有効になっているかどうかを示します。true の場

Booleanenabled

合、おすすめが有効になり、コミュニティに表示されます。falseの場合、Salesforce1 モバイルブラウザアプリケーションでのフィードのおすすめは削除されませんが、新しいおすすめは表示されなくなります。Summer '15 以降のバージョンの Napili テンプレートを使用したコミュニティでは、無

440





効にしたおすすめは表示されなくなります。


Integerrank

す。スケジュール済みおすすめは、rank で指定された位置に挿入されます。それ以降のすべてのスケジュール済みおすすめのrank

が 1 つずつ下がります。「スケジュール済みおすすめにランクを付ける場合の例」を参照してください。指定された rank がリストのサイズよりも大きい場合は、スケジュール済みおすすめがリストの末尾に配置されます。スケジュール済みおすすめの rank には、指定された値の代わりにリストのサイズが指定されます。rankが指定されていない場合は、スケジュール済みおすすめがリストの末尾に配置されます。

33.0必須項目このスケジュール済みおすすめによってスケジュールされたおすすめ定義の ID。


POST のレスポンスボディスケジュール済みおすすめ

GET のレスポンスボディScheduled Recommendation Collection

スケジュール済みおすすめスケジュール済みおすすめに関する情報の取得、スケジュール済みおすすめの更新または削除を行います。

441


コミュニティマネージャ (「コミュニティの作成および設定」または「コミュニティの管理」権限を持つユーザ) および「すべてのデータの編集」権限を持つユーザのみが、おすすめ定義とスケジュール済みおすすめのアクセス、作成、および削除を行うことができます。これらのおすすめは、Salesforce1 モバイルブラウザアプリケーションのコミュニティのフィードに直接表示されます。また、Summer '15 以降のバージョンの Napili テンプレートを使用すると、コミュニティのホームページの右側にもデフォルトで表示されます。リソース

/connect/scheduled-recommendations/scheduledRecommendationId

/connect/communities/communityId/scheduled-recommendations/scheduledRecommendationId




PATCH のリクエストボディ新しいスケジュール済みおすすめを作成する JSON の例

{

"rank" : "2",



プロパティ



説明型名前

34.0省略可能スケジュールが有効になっているかどうかを示します。trueの場

Booleanenabled


442




説明型名前


Integerrank

す。スケジュール済みおすすめは、rankで指定された位置に挿入されます。それ以降のすべてのスケジュール済みおすすめのrank が 1 つずつ下がります。「スケジュール済みおすすめにランクを付ける場合の例」を参照してください。指定された rankがリストのサイズよりも大きい場合は、スケジュール済みおすすめがリストの末尾に配置されます。スケジュール済みおすすめの rankには、指定された値の代わりにリストのサイズが指定されます。rank が指定されていない場合は、スケジュール済みおすすめがリストの末尾に配置されます。






443







Booleanenabled

合、おすすめが有効になり、コミュニティに表示されます。falseの場合、Salesforce1 モバイルブラウザアプリケーションでのフィードのおすすめは削除されませんが、新しいおすすめは表示されなくなります。Summer '15 以降のバージョンの Napili テンプレートを使用したコミュニティでは、無効にしたおすすめは表示されなくなります。


Integerrank


が 1 つずつ下がります。「スケジュール済みおすすめにランクを付ける場合の例」を参照してください。指定された rank がリストのサイズよりも大きい場合は、スケジュール済みおすすめがリストの末尾に配置されます。スケジュール済みおすすめの rank には、指定された値の代わりにリストのサイズが指定されます。rankが指定されていない場合は、スケジュール済みおすすめがリストの末尾に配置されます。

444


PATCH のレスポンスボディスケジュール済みおすすめ

DELETE のレスポンスボディ204: DELETE が成功しましたスケジュール済みおすすめの削除は、順序付きリストでの削除に相当します。スケジュール済みおすすめを削除すると、削除されたものの後にあるすべてのスケジュール済みおすすめが自動的に上位に順位付けされます。

Subscriptions リソース

指定された登録に関する情報。登録の削除 (レコードまたはトピックのフォロー解除など) にも使用されます。登録 ID は、follower リソースと following リソースのレスポンスボディの一部として返されます。たとえば、/records/recordId/followersのようになります。さらに、登録 ID は、グループサマリーやユーザサマリーなど、多くのサマリーレスポンスボディでも返されます。リソース

/chatter/subscriptions/subscriptionId

/connect/communities/communityId/chatter/subscriptions/subscriptionId




GET のレスポンスボディSubscription

関連トピック:

レコードのフォローを停止する

Topics リソース

組織のトピックのリスト、指定されたテキスト文字列、フィード項目、またはレコードの推奨トピックのリスト、組織のトピックのトレンドのリスト、指定されたトピックに関する情報、指定されたトピックの支持、指定されたトピックに最近投稿されたファイルに関する情報、指定されたトピックに最近投稿したグループに関する情報、指定されたトピックに関する知識のあるユーザ、および指定されたトピックに関連するトピックのリスト。使用可能なリソース:

445

Subscriptions リソースChatter REST API リソース

説明リソース

組織のトピックのリスト。/connect/topics

指定されたトピックに関する情報。トピックに関する情報の取得、トピックの名前または説明の更新、トピックのマージおよび削除を行います。

/connect/topics/topicId

指定されたテキスト文字列、フィード項目、またはレコードの推奨トピックのリスト。

/connect/topics/suggestions

組織のトピックのトレンド上位 5 つのリスト。/connect/topics/trending

指定されたトピックに関する知識のあるユーザへの支持。指定されたトピックに関する支持の取得、および

/connect/topics/topicId/endorsements

指定されたトピックに関するユーザへの支持を行います。

支持。支持に関する情報の取得と、支持の削除を行います。

/connect/topic-endorsements/endorsementId

指定されたトピックに最近投稿された 5 つのファイルに関する情報を返します。

/connect/topics/topicId/files

指定されたトピックに最近投稿した 5 つのグループに関する情報を返します。

/connect/topics/topicId/groups

トピックに関する知識のあるユーザ。指定されたトピックに関する知識のあるユーザのリストを取得します。

/connect/topics/topicId/knowledgeable-users

指定されたトピックへの関連性が最も強い 5 つのトピックのリスト。

/connect/topics/topicId/related-topics

トピックからの除外。指定されたトピックについてトピックからの除外のリストを取得します。指定された

/connect/topics/topicId/topic-opt-outs

トピックの [知識のあるユーザ] リストで自分を非表示にします。

トピックからの除外。[知識のあるユーザ] リストで自分を非表示にした後、再度表示します。

/connect/topic-opt-outs/topicOptOutId

List of Topics組織のトピックのリスト。リソース

/connect/topics

/connect/communities/communityId/topics

446

List of TopicsChatter REST API リソース


バージョン 28.0 では、/chatter/topics を使用します。Chatter が必要かどうか

いいえHTTP メソッド

GET または HEAD




28.0省略可能大文字と小文字を含め、完全一致する名

BooleanexactMatch

前でトピックを検索する場合は、true

を指定し、q パラメータと一緒に使用します。デフォルト値は false です。

28.0省略可能トピックのページを指定する 0 より大き

Integerpage

い整数。デフォルト値は、0 です。

28.0省略可能ページあたりの項目数を指定します。有

IntegerpageSize

効な値は 1 ～ 100 です。デフォルト値は25 です。

28.0省略可能結果を絞り込むクエリ文字列。文字列に

Stringq

はワイルドカード文字を除いて 2 文字以上が含まれている必要があります。

28.0省略可能次のいずれかの値になります。

Stringsort

• popularDesc:

トピックを人気順に並び替えます。この値がデフォルトです。

447

List of TopicsChatter REST API リソース



• alphaAsc: トピックをアルファベット順に並び替えます。


GET の例この例では、アルファベット順に並び替えられたトピックのリストを要求します。/connect/topics?sort=alphaAsc

Topics Suggestions指定されたテキスト文字列、フィード項目、またはレコードの推奨トピックのリスト。リソース

/connect/topics/suggestions

/connect/communities/communityId/topics/suggestions


バージョン 28.0 では、/chatter/topics/suggestions を使用します。Chatter が必要かどうか


GET または HEAD



省略可能返される推奨トピックの最大数。デフォルト値は

IntegermaxResults

5 です。値は 1 以上 25 以下で指定する必要があります。

text パラメータが使用されていない場合に必要です。

トピックの抽出元になるフィード項目またはレコードの18 文字の ID。オブジェクト種別のレコー

StringrecordId

448

Topics SuggestionsChatter REST API リソース


ドについてトピックの提案を表示するには、システム管理者がそのオブジェクトでトピックを有効化しておく必要があります。オブジェクトのトピックは、バージョン30.0 で使用できます。

recordId パラメータが使用されていない場合に必要です。

トピックの抽出元のテキスト。

Stringtext

レスポンスボディ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


バージョン 24.0 ～ 28.0 では、/chatter/topics/trending および/connect/communities/communityId/chatter/topics/trending を使用します。

449

Trending TopicsChatter REST API リソース




説明値パラメータ名

返されるトピックのトレンドの最大数。デフォルト値は 5 です。値

IntegermaxResults

は 1 以上 100 未満で指定する必要があります。


レスポンスボディの例 (バージョン 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.",


"name" : "Dreamforce",

450

Trending TopicsChatter REST API リソース

"url": "/services/data/v34.0/connect/topics/0TOD000000006RxOAI"

},

{

"createdDate": "2013-02-25T10:47:51.000Z",

"id" : "0TOD0000000090rOAA",

"description" : "All things related to mobile.",


"name" : "Mobile",

"url": "/services/data/v34.0/connect/topics/0TOD0000000090rOAA"

}

]}

レスポンスボディの例 (バージョン 24.0 ～ 27.0)

{"topics" : [

{

"name" : "#API"

},

{

"name" : "#Dreamforce"

},

{

"name" : "#Mobile"

}

]}

Topic指定されたトピックに関する情報。トピックに関する情報の取得、トピックの名前または説明の更新、トピックのマージおよび削除を行います。

451

TopicChatter REST API リソース

「トピックを編集」または「すべてのデータの編集」権限を持つユーザは、トピックの名前および説明を編集できます。「トピックの削除」または「すべてのデータの編集」権限を持つユーザは、トピックをマージおよび削除できます。

メモ: トピックのマージはベータ版で、既知の制限があります。IdeaExchange でフィードバックをお寄せください。

リソース/connect/topics/topicId

/connect/communities/communityId/topics/topicId


バージョン 28.0 では、/chatter/topics/topicId を使用します。Chatter が必要かどうか


GET、PATCH、DELETE、および HEAD


<topic>

JSON

{

"description" : "World Wide Web Consortium (W3C) is the main international standardsorganization for the Web."

"name" : "W3C"}

プロパティ


28.0トピックのテキストによる説明

Stringdescription

33.0トピックにマージする最大 5 個のトピック ID のリスト。

String []idsToMerge

メモ: トピックのマージはベータ版で、既知の制限があります。IdeaExchange で

452


https://success.salesforce.com/ideaSearch



フィードバックをお寄せください。

28.0トピックの名前トピック名の大文字、小文字、スペースのみを変

Stringname

更するには、このプロパティを使用します。



28.0トピックのテキストによる説明Stringdescription


String []idsToMerge

メモ: トピックのマージはベータ版で、既知の制限があります。IdeaExchangeでフィードバックをお寄せください。

28.0トピックの名前トピック名の大文字、小文字、スペースのみを変更するには、このプロパティを使用します。

Stringname

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



これは、同じ要求に JSON リクエストボディを使用しています。/connect/topics/0TOD000000006RxOAI

{

"description" : "Edit requests"

}

Topics, Endorse People指定されたトピックに関する知識のあるユーザへの支持。指定されたトピックに関する支持の取得、および指定されたトピックに関するユーザへの支持を行います。リソース

/connect/topics/topicId/endorsements

/connect/communities/communityId/topics/topicId/endorsements





適用開始バージョン必須項目/省略可能説明型パラメータ名

31.0省略可能支持を受け取ったユーザの ID を指定します。

StringendorseeId

31.0省略可能他のユーザを支持したユーザの ID を指定します。

StringendorserId

30.0省略可能支持のページを指定する 0 より大きい整

Integerpage

数。デフォルト値は、0 です。


IntegerpageSize

効な値は 1 ～ 100 で

454

Topics, Endorse PeopleChatter REST API リソース

適用開始バージョン必須項目/省略可能説明型パラメータ名

す。デフォルト値は25 です。


<topicEndorsement>

JSON

{

"userId" : "005B0000000Ge16"

}

プロパティ



30.0必須項目指定したトピックについて支持されるユーザの ID。

StringuserId



30.0支持するユーザの IDStringuserId

GET のレスポンスボディTopic Endorsement Collection

POST のレスポンスボディTopic Endorsement

Topic Endorsements支持。支持に関する情報の取得と、支持の削除を行います。リソース

/connect/topic-endorsements/endorsementId

/connect/communities/communityId/topic-endorsements/endorsementId

455

Topic EndorsementsChatter REST API リソース



HTTP メソッドGET、HEAD、DELETE

GET のレスポンスボディTopic Endorsement


DELETE の例トピックについて他のユーザを支持すると、キープレフィックス 0enの支持レコードが作成されます。支持を削除するには、この支持レコードを削除します。DELETE /connect/topic-endorsements/0enD0000000003UIAQ

次にレスポンスボディを示します。HTTP 204

Topic Files指定されたトピックに最近投稿された 5 つのファイルに関する情報を返します。リソース

/connect/topics/topicId/files

/connect/communities/communityId/topics/topicId/files


バージョン 28.0 では、/chatter/topics/topicId/files を使用します。Chatter が必要かどうか


GET または HEAD


レスポンスボディの例この GET 要求は、指定されたトピックのすべてのファイルに関する情報を返します。/connect/topics/0TOD000000009Q2/files

456

Topic FilesChatter REST API リソース

応答は次のようになります。{

"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",



"smallIconUrl": "/img/icon/files16.png"

},

"mySubscription": {

"id": "0E8D0000000T5JrKAK",

"url": "/services/data/v34.0/chatter/subscriptions/0E8D0000000T5JrKAK"

},

"name": "Recruitment Poster",

457


"origin": "Chatter",

"owner": {

"companyName": "SeattleApps",

"firstName": "Rene",

"id": "005D0000001LFNnIAO",

"isActive": true,

"lastName": "Holmes",

"motif": {

"color": "1797C0",


"mediumIconUrl": "/img/icon/profile.png",

"smallIconUrl": "/img/icon/profile.png"

},


"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_",


},

"title": null,

"type": "User",

458


"url": "/services/data/v34.0/chatter/users/005D0000001LFNnIAO",


},

"parentFolder" : "null",

"pdfRenditionStatus": "Na",

"renditionUrl": "/services/data/v34.0/chatter/files/069D00000001E32IAE/rendition",

"thumb120By90RenditionStatus": "Success",



"title": "Recruitment Poster",

"type": "ContentDocument",

"url": "/services/data/v34.0/chatter/files/069D00000001E32IAE?versionNumber=1",

"versionNumber": "1"

}],


"previousPageUrl": null

}

Topic Groups指定されたトピックに最近投稿した 5 つのグループに関する情報を返します。リソース

/connect/topics/topicId/groups

/connect/communities/communityId/topics/topicId/groups


バージョン 28.0 では、/chatter/topics/topicId/groups を使用します。Chatter が必要かどうか


GET または HEAD

459

Topic GroupsChatter REST API リソース

レスポンスボディGroup Page

Topics, Knowledgeable People Listトピックに関する知識のあるユーザ。指定されたトピックに関する知識のあるユーザのリストを取得します。リソース

/connect/topics/topicId/knowledgeable-users

/connect/communities/communityId/topics/topicId/knowledgeable-users








Integerpage



IntegerpageSize


レスポンスボディKnowledgeable People Collection

Related Topics指定されたトピックへの関連性が最も強い 5 つのトピックのリスト。リソース

/connect/topics/topicId/related-topics

/connect/communities/communityId/topics/topicId/related-topics

460

Topics, Knowledgeable People ListChatter REST API リソース


バージョン 28.0 では、/chatter/topics/topicId/relatedtopics を使用します。Chatter が必要かどうか


GET または HEAD


Topics, Opt Outs from Knowledgeable People Listトピックからの除外。指定されたトピックについてトピックからの除外のリストを取得します。指定されたトピックの [知識のあるユーザ] リストで自分を非表示にします。リソース

/connect/topics/topicId/topic-opt-outs

/connect/communities/communityId/topics/topicId/topic-opt-outs




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



461

Topics, Opt Outs from Knowledgeable People ListChatter REST API リソース

HTTP メソッドGET、HEAD、DELETE

GET のレスポンスボディTopic Opt Out


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




462

User Profiles リソースChatter REST API リソース

http://help.salesforce.com

パラメータ


29.0ユーザの IDStringuserId

29.0コミュニティの IDStringcommunityId

GET のレスポンスボディUser Profile

Users リソース

ユーザをフォローしている人、ユーザのファイルやおすすめなど、ユーザに関する情報。フィード項目の post

送信と会話状況の更新にも使用されます。次のリソースを使用できます。

説明リソース

組織のすべてのユーザに関する情報を返します。

/chatter/users

コンテキストユーザまたは指定されたユーザの Chatterプロファイルに関する情報。

/chatter/users/me

指定されたユーザのプロファイルに関する情報を返します。

/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

外部ファイルへの参照を含む、Salesforce

Files Syncへのファイルの投稿、またはユー/chatter/users/me/files/

ザが所有するファイルに関する情報の取得を行います。ユーザと共有されているファイル、ユーザがフォローしている

463

Users リソースChatter REST API リソース

説明リソース

ファイル、一般的な組織ファイルは対象外です。

指定されたユーザがメンバーであるグループに投稿されたファイルに関する情報を返します。

/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非公開メッセージを返します。

/chatter/users/me/messages/messageId

ユーザの写真。写真を取得、投稿およびトリミングします。

/chatter/users/me/photo

コンテキストユーザへのユーザ、グループ、ファイル、レコード、およびカスタムのおすすめを返します。

/chatter/users/me/recommendations

コンテキストユーザへの指定されたアクションのおすすめを返します。

/chatter/users/me/recommendations/action

コンテキストユーザへの指定されたアクションおよびオブジェクトカテゴリのおすすめを返します。

/chatter/users/me/recommendations/action/objectCategory

464

Users リソースChatter REST API リソース

説明リソース

コンテキストユーザへの指定されたアクションおよびキープレフィックスのおすすめを返します。

/chatter/users/me/recommendations/action/idPrefix

コンテキストユーザへの指定されたアクションおよびオブジェクト ID のおすすめ

/chatter/users/me/recommendations/action/objectID

を返します。おすすめの削除にも使用されます。

コンテキストユーザへの指定されたアクションおよびオブジェクト種別の静的な

/chatter/users/userId/recommendations/action/objectEnum

おすすめを返します。静的なおすすめの削除にも使用されます。

指定されたコミュニティユーザの評価を返します。

/connect/communities/communityId/chatter/users/userId/reputation

コンテキストユーザのグローバル Chatter

設定に関する情報を返します。/chatter/users/me/settings

ユーザの最新の状況フィード項目を返します。ユーザの状況の更新または削除にも使用されます。

/chatter/users/me/status

指定されたユーザが最近使用したトピック。指定されたユーザが最近使用したトピックを最大 5 個取得します。

/chatter/users/me/topics

User Information組織のすべてのユーザに関する情報を返します。リソース

/chatter/users

/connect/communities/communityId/chatter/users




465

User InformationChatter REST API リソース



説明型パラメータ


Integerpage

23.0ページあたりの項目数。有効な値は 1 ～ 250 です。デフォルト値は 25 です。

IntegerpageSize

23.0検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があり

Stringq

ます。ワイルドカードについての詳細は、「ワイルドカード」を参照してください。このパラメータが検索するのはユーザ名で、メールアドレス、役職などは検索しません。

28.0検索結果のコンテキストを提供するフィード項目 ID を指定します。このパラメータは、@メンションのコンプリートに使用します。searchContextIdにフィード項目 ID を渡すと、返

StringsearchContextId

されたコレクションのスレッドで前にメンションされているユーザが照合されます。このパラメータを使用する場合、クエリできる結果は 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


466

User Profile InformationChatter REST API リソース

PATCH は 29.0 で使用可能Chatter が必要かどうか


GET、HEAD、PATCH


<user>

プロパティ


29.0User Detail レスポンスボディの aboutMe プロパ

StringaboutMe

ティ。最大文字数は 1000

文字です。このプロパティが、コミュニティまたは組織のすべてのメンバーに表示されるユーザプロファイルの [自己紹介] セクションに入力されます。

JSON の例{

"aboutMe": "Staff Technical Writer responsible for the Connect API and Connect inApex documentation."

}




StringaboutMe


文字です。このプロパティが、コミュニティまたは組織のすべてのメンバーに表示されるユーザプロファイルの [自己紹

467

User Profile InformationChatter REST API リソース


介] セクションに入力されます。

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

Batch User InformationChatter REST API リソース





関連トピック:

複数のユーザのユーザ情報を取得する

User Conversations, Generalコンテキストユーザの非公開の会話をすべて返します。すべての会話を対象とした検索にも使用されます。「User Conversations, Specific」 (ページ 470)および「User Messages, General」 (ページ 484)を参照してください。リソース

/chatter/users/userId/conversations

/connect/communities/communityId/chatter/users/userId/conversations







説明必須項目/省略可能型パラメータ名

23.0取得を開始する場所を示すページトーク

省略可能Stringpage

ン。レスポンスボディのNextPageUrl プロパティからこのトークンを取得します。

23.0ページあたりの項目数を指定します。有

省略可能IntegerpageSize

469

User Conversations, GeneralChatter REST API リソース



効な値は 1 ～ 100 です。サイズを指定しない場合、デフォルトは 25 です。

24.0検索する文字列を指定します。検索文字

省略可能Stringq

列にはワイルドカード文字を除いて 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

User Conversations, SpecificChatter REST API リソース




HTTP メソッドGET、PATCH、または HEAD





省略可能Stringq


メモ: クエリパラメータが検索するのはメッセージテキスト本文のみで、ユーザ名、役職などは検索しません。


<conversation>

471

User Conversations, SpecificChatter REST API リソース

プロパティ


24.0会話状況を未読 (false)

または既読 (true) に変更します。

Booleanread



会話状況を未読 (false) または既読 (true) に変更します。

Booleanread

GET または HEAD のレスポンスボディConversation Detail

Change Status of Conversations指定された会話の状況を変更します。「入力での POST、PATCH、または PUT の使用」も参照してください。conversations リソースに PATCH を使用しても、指定された会話の状況を変更できます。リソース

/chatter/users/me/conversations/conversationId/mark-read



HTTP メソッドPOST または PUT

リクエストボディルート XML タグ

<conversation>

プロパティ




Booleanread

472

Change Status of ConversationsChatter REST API リソース



会話状況を未読 (false) または既読 (true) に変更します。

Booleanread

Get Unread Count for Conversationsコンテキストユーザまたは指定されたユーザについて未読メッセージがある会話の数を返します。リソース

/chatter/users/userId/conversations/unread-count

/connect/communities/communityId/chatter/users/userId/conversations/unread-count



リクエストボディConversation Unread Count

Users Files, General外部ファイルへの参照を含む、Salesforce Files Sync へのファイルの投稿、またはユーザが所有するファイルに関する情報の取得を行います。ユーザと共有されているファイル、ユーザがフォローしているファイル、一般的な組織ファイルは対象外です。ファイルを post 送信すると、[ファイル] タブに非公開ファイルとしてアップロードされ、ファイル所有者のみが使用できるようになります。ファイルをアップロードするには、マルチパート/フォームデータ要求で送信する必要があります。ファイルの説明とタイトルをマルチパート/フォームデータ要求に JSON または XML リクエストボディとして含めることができます。情報を要求パラメータとして送信することもできます。マルチパート/フォームデータメッセージを作成する方法についての詳細は、「バイナリファイルのアップロード」を参照してください。

重要: このリソースは、大量のデータを返す場合があり、その場合は処理に時間がかかることがあります。

リソース/chatter/users/userId/files/

/connect/communities/communityId/chatter/users/userId/files/


473

Get Unread Count for ConversationsChatter REST API リソース



POST のリクエストボディこのリクエストボディでは、新しいファイル入力について説明します。ファイルをアップロードするには、name="fileData"のマルチパート/フォームデータボディパートにそのバイナリファイルを含める必要があります。「バイナリファイルのアップロード」を参照してください。

ルート XML タグ<fileInput>

JSON

{

"desc":"Employee Survey Results",

"title":"emp_surv_results"

}

プロパティ



説明型名前




Stringdesc

31.0省略可能ファイルが Salesforce Files Syncと同期されている場合は true、同期されていない場合は false。


31.0省略可能ファイルがメジャーバージョンの場合は true、ファイルがマイ


ナーバージョンの場合はfalse。メジャーバージョンを置き換えることはできません。





474

Users Files, GeneralChatter REST API リソース




説明型名前



24.0省略可能ファイルの説明Stringdesc

31.0省略可能要求は自動クライアントによって自動生成されます。

BooleanisDataSync

31.0省略可能ファイルが Salesforce Files Sync と同期されている場合は true、同期されていない場合は false。デフォルト値は、falseです。


31.0省略可能ファイルがメジャーバージョンの場合はtrue、ファイルがマイナーバージョンの場


合は false。メジャーバージョンを置き換えることはできません。デフォルト値は、false です。



24.0省略可能ファイルのタイトルStringtitle




Integerpage



IntegerpageSize



Stringq


475




GET のレスポンスボディFile Summary Page

POST のレスポンスボディFile Summary

POST 要求の例次の例では、新しいファイルを作成し、Salesforce Files Sync にアップロードします。この例は、マルチパート/フォームデータ要求のボディパートを示します。最初のボディパートは File Input リクエストボディです。2 つ目は、ファイルのコンテンツです。詳細は、「バイナリファイルのアップロード」を参照してください。POST /services/data/v34.0/chatter/users/me/files




Host: instance_name

Content-Length: 489






{

"title":"BoatPrices"

476


}


Content-Disposition: form-data; name="fileData"; filename="BoatPrices.txt"


...contents of BoatPrices.txt...


User Files, Filtered by Group指定されたユーザがメンバーであるグループに投稿されたファイルに関する情報を返します。リソース

/chatter/users/userId/files/filter/groups

/connect/communities/communityId/chatter/users/userId/files/filter/groups







Integerpage



IntegerpageSize


477

User Files, Filtered by GroupChatter REST API リソース



Stringq




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







Integerpage



IntegerpageSize

1 ～ 100 です。サイズを指

478

User Files, Filtered by SharingChatter REST API リソース


定しない場合、デフォルトは 25 です。


Stringq




User Followers指定されたユーザをフォローしている人に関する情報を返します。リソース

/chatter/users/userId/followers

/connect/communities/communityId/chatter/users/userId/followers






返すページ番号を指定します。デフォルト値は 0 で、最初のページを返します。

Integerpage


IntegerpageSize


479

User FollowersChatter REST API リソース

レスポンスボディFollower Page

Following指定されたユーザがフォローしている人、グループ、レコード、トピック、ファイルに関するリストを返します。レコードのフォローにも使用されます。「入力での POST、PATCH、または PUT の使用」を参照してください。

メモ: users リソースを使用して、ユーザをグループに追加することはできません。代わりに、groups リソースを使用してください。

リソース/chatter/users/userId/following

/connect/communities/communityId/chatter/users/userId/following


トピックのフォローは、バージョン 29.0 以降で使用できます。Chatter が必要かどうか


GET、POST、または HEAD


<following>

プロパティ


23.0

トピック ID は 29.0 で使用できます。

フォローする対象の ID。たとえば、ユーザ ID、レコード ID、ファイル ID、トピック ID などがあります。

StringsubjectId

メモ: グループにメンバーを追加する場合には Group

Member Inputを使用します。

480

FollowingChatter REST API リソース


使用可能説明型パラメータ名

23.0


ユーザが指定されたレコードをフォローできるようにします。ユーザID、ファイル ID、トピッ

StringsubjectId

ク ID などの場合があります。

GET または HEAD の要求パラメータすべてのパラメータは省略可能です。


返されるオブジェクトの種別を絞り込みするためのキープレフィッ

StringfilterType

クスを指定します。キープレフィックスは、オブジェクト ID に含まれる 3 文字のプレフィックスコードです。オブジェクト ID はオブジェクト型を示す 3 文字のコードが先頭に付けられます。たとえば、User オブジェクトのプレフィックスは 005、Group オブジェクトのプレフィックスは 0F9 です。自分でキープレフィックスを生成する必要はありません。使用可能なキープレフィックスを確認するには、List of Filter Feed URLsを使用します。

返すページ番号を指定します。デフォルト値は 0 で、最初のページを返します。

Integerpage


IntegerpageSize


GET または HEAD のレスポンスボディFollowing Page

481

FollowingChatter REST API リソース

POST のレスポンスボディSubscription

関連トピック:

レコードをフォローするユーザがフォローしているレコードのリストを取得する

User Groups指定されたユーザがメンバーであるグループ。リソース

/chatter/users/userId/groups

/connect/communities/communityId/chatter/users/userId/groups








23.0省略可能生成されたトークン。フィード項目のビューを示します。ページトークンは、レスポンスボディの

Tokenpage

一部として、nextPageURLなど、いずれかの URL

パラメータで返されます。23.0省略可能ページあたりの項目数を指定します。有効な値は


IntegerpageSize

30.0省略可能検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれて

Stringq

いる必要があります。「ワイルドカード」を参照してください。

482

User GroupsChatter REST API リソース

レスポンスボディ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








Integerpage



IntegerpageSize


レスポンスボディTopics People Are Knowledgeable About Collection

483

Topics a User is Knowledgeable AboutChatter REST API リソース

User Messages, Generalコンテキストユーザのすべての非公開会話のすべてのメッセージを返します。すべてのメッセージを対象とした検索や、メッセージの投稿にも使用されます。「入力での POST、PATCH、または PUT の使用」を参照してください。「User Conversations, General」 (ページ 469)も参照してください。リソース

/chatter/users/userId/messages

/connect/communities/communityId/chatter/users/userId/messages






<message>

プロパティ


23.0メッセージ本文のテキスト

Stringbody

23.0このメッセージが含まれる会話を識別する既存の

StringinReplyTo

メッセージの ID。recipients またはinReplyTo を指定する必要があります。両方ではなく、どちらか一方を指定する必要があります。

23.0目的のメッセージ受信者であるユーザ (最大 9 人)

User Message Recipient ListInput

recipients

のリスト。ユーザ ID のカンマ区切りのリスト。recipients またはinReplyTo を指定する必要があります。両方で

484

User Messages, GeneralChatter REST API リソース


はなく、どちらか一方を指定する必要があります。

XML 形式の例:

<message>

<body>Text of the message</body>

<recipients>

<recipient>userID</recipient>


</recipients>

<inReplyTo>messageID</inReplyTo>

</message>

JSON 形式の例:

{

"body": "Text of the message",

"recipients": ["userID","userID"],

"inReplyTo": "messageID"

}




23.0このメッセージが含まれる会話を識別す

recipientsまたはinReplyTo を指定

StringinReplyTo

る既存のメッセージの ID

する必要があります。両方を指定することはできません。

23.0目的のメッセージ受信者であるユーザ

recipientsまたはinReplyTo を指定

Stringrecipients

485




(最大 9 人) のリスト。ユーザ ID のカ

する必要があります。両方を指定することはできません。ンマ区切りのリス

ト。23.0メッセージのテキス

ト (最大 10,000 文字)

必須項目Stringtext




23.0取得を開始する場所を示すページトーク

省略可能Stringpage

ン。レスポンスボディのNextPageUrl プロパティからこのトークンを取得します。

23.0ページあたりの項目数を指定します。有

省略可能IntegerpageSize

効な値は 1 ～ 100 です。サイズを指定しない場合、デフォルトは 25 です。


省略可能Stringq


メモ: クエリパラメータが検索するのは

486




メッセージテキスト本文のみで、ユーザ名、役職などは検索しません。

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 thisweek?"

},

"conversationId": "03MD000000002LTMAY",

"conversationUrl":"/services/data/v34.0/chatter/users/me/conversations/03MD000000002LTMAY",

"id": "03JD000000003XGMAY",

"recipients": [

{



"id": "005D0000001LFNnIAO",

487


"isActive": true,


"motif": {

"color": "1797C0",




},



"photo": {


"largePhotoUrl":"https://instance_name/profilephoto/729D00000000XA5/F",

"photoVersionId": "729D00000000XA5",

"smallPhotoUrl":"https://instance_name/profilephoto/729D00000000XA5/T",



},

"title": "Senior Manager",

"type": "User",



},

{

488


"companyName": null,

"firstName": "Desmond",

"id": "005D0000001LJvOIAW",

"isActive": true,

"lastName": "Catillo",

"motif": {

"color": "1797C0",




},


"name": "Desmond Catillo",

"photo": {







},


"type": "User",

489


"url": "/services/data/v34.0/chatter/users/005D0000001LJvOIAW",


}

],

"sender": {



"id": "005D0000001LFNnIAO",

"isActive": true,


"motif": {

"color": "1797C0",




},



"photo": {


"largePhotoUrl": "https://instance_name/profilephoto/729D00000000XA5/F",


"smallPhotoUrl": "https://instance_name/profilephoto/729D00000000XA5/T",



490


},


"type": "User",



},

"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 onChatter.\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": [

{



"id": "005D0000001LFNnIAO",

"isActive": true,


"motif": {

"color": "1797C0",

491





},



"photo": {







},


"type": "User",



},

{

"companyName": null,

"firstName": "Desmond",

"id": "005D0000001LJvOIAW",

492


"isActive": true,

"lastName": "Catillo",

"motif": {

"color": "1797C0",




},


"name": "Desmond Catillo",

"photo": {







},


"type": "User",

"url": "/services/data/v34.0/chatter/users/005D0000001LJvOIAW",


}

],

493


"sender": {



"id": "005D0000001LFNnIAO",

"isActive": true,


"motif": {

"color": "1797C0",




},



"photo": {


"largePhotoUrl": "https://instance_name/profilephoto/729D00000000XA5/F",


"smallPhotoUrl": "https://instance_name/profilephoto/729D00000000XA5/T",



},


"type": "User",

494




},

"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





レスポンスボディMessage

User Photoユーザの写真。写真を取得、投稿およびトリミングします。[ファイル] ページからの画像をユーザの写真として使用するには、リクエストボディの fileIdプロパティまたは fileId要求パラメータでファイル ID を渡します。[ユーザ] ページでアップロードした画像にはファイルID は含まれず、fileId としては使用できません。

495

User Messages, SpecificChatter REST API リソース

バイナリファイルをユーザの写真としてアップロードするには、マルチパート/フォームデータメッセージでそのファイルを送信する必要があります。マルチパート/フォームデータメッセージを作成する方法についての詳細は、「バイナリファイルのアップロード」を参照してください。ユーザプロファイルの写真をフィードに表示するには、ユーザの写真をキャッシュします。次に、Photo レスポンスボディの photoVersionId プロパティを使用して、いつ写真を更新する必要があるかを判断します。この方法により、制限を超えて実行することを避け、モバイルクライアントのパフォーマンスを改善できる場合があります。リソース

/chatter/users/userId/photo

/connect/communities/communityId/chatter/users/userId/photo





<photo>


"cropX" : "0",

"cropY" : "0",

"fileId" : "069D00000001IOh"

}

プロパティ





IntegercropSize




IntegercropX



496

User PhotoChatter REST API リソース





IntegercropY






StringfileId










IntegercropSize




IntegercropX





IntegercropY


Y (ピクセル単位)。

497




左上の位置は (0,0) です。




StringfileId


メモ: [グループ] ページおよび [ユーザプロファイル] ページでアップロードしたファイルにはファイル ID は含まれず、投稿やトリミングはできません。[ファイル] ページでアップロードしたファイルにはファイルID は含まれず、投稿やトリミングはできません。





GET または HEAD のレスポンスボディPhoto

498


POST のレスポンスボディPhoto

関連トピック:

ユーザの写真を更新およびトリミングする

User Recommendations, Generalコンテキストユーザへのユーザ、グループ、ファイル、レコード、およびカスタムのおすすめを返します。リソース

/chatter/users/userId/recommendations

/connect/communities/communityId/chatter/users/userId/recommendations







33.0ユーザが直前に実行したアクション。サポートさ

StringcontextAction

れている値は、次のとおりです。• follow

• view

直前に実行されたアクションに基づいて新しいおすすめを取得するには、contextAction とcontextObjectId を一緒に使用します。

499

User Recommendations, GeneralChatter REST API リソース


33.0ユーザが直前に実行したアクションのオブジェクトの ID。

StringcontextObjectId

• contextAction がfollow の場合、contextObjectId

は、ユーザ ID、ファイル ID、またはレコードID になります。

• contextAction がview の場合、contextObjectId

は、ユーザ ID、ファイル ID、グループ ID、またはレコード ID になります。


23.0 ～ 32.0ユーザの ID。このユーザID のコンテキストに基づ

Stringfollowed

いて新しいおすすめを提供します。

重要: バージョン33.0 以降では、contextActionおよびcontextObjectId

を使用します。

23.0おすすめの結果の最大数。デフォルトは 10 で

IntegermaxResults

す。値は 0 よりも大きくする必要があります。

23.0 ～ 33.0ファイルの ID。このファイル ID のコンテキストに

Stringviewed

基づいて新しいおすすめを提供します。

500

User Recommendations, GeneralChatter REST API リソース




レスポンスボディRecommendations

User Recommendations for a Specific Actionコンテキストユーザへの指定されたアクションのおすすめを返します。リソース

/chatter/users/userId/recommendations/action

/connect/communities/communityId/chatter/users/userId/recommendations/action


action の有効値と、その結果返されるおすすめは次のようになります。• follow は、フォローするユーザ、ファイル、およびレコードのおすすめを返します。• join は、参加するグループのおすすめを返します。• view は、表示するユーザ、ファイル、グループ、およびレコードのおすすめを返します (バージョン

25.0 以降)。バージョン 34.0 以降、view はカスタムのおすすめも返します。適用開始バージョン

24.0






StringcontextAction


501

User Recommendations for a Specific ActionChatter REST API リソース


• view










Stringfollowed




502

User Recommendations for a Specific ActionChatter REST API リソース



IntegermaxResults



Stringviewed




レスポンスボディ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


• 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 以降)。


503

User Recommendations for a Specific Action and ObjectCategory







StringcontextAction


• view









504





Stringfollowed





IntegermaxResults



Stringviewed




GET のレスポンスボディRecommendations

直前に実行されたアクションに基づいて新しいおすすめを取得するための要求 URL の例ユーザ ID が 005D0000001GLowIAB である Pam を直前にフォローした場合、次の URL を使用します。/chatter/users/me/recommendations/follow/users?contextAction=follow&contextObjectId=005D0000001GLowIAB

これにより、Pam をフォローするユーザがフォローしているユーザのおすすめのみが取得されます。この例では、John が Pam をフォローしており、John は Suzanne もフォローしているため、Suzanne をフォローするためのおすすめが取得されます。

505



自分が参照中のファイルを参照したユーザが参照したファイルのリストを取得するための要求 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



– join

– view

• キープレフィックス、つまりリソース URL 内の idPrefix はオブジェクト ID の最初の 3 文字であり、オブジェクト種別を示します。この URL の idPrefix の有効値は次のとおりです。– action が follow の場合、idPrefix はユーザ (005)、ファイル (069)、またはレコード (001 や 003 な

ど) のキープレフィックスです。

506

User Recommendations for a Specific Action and Key PrefixChatter REST API リソース

– action が join の場合、idPrefix はグループ (0F9) のキープレフィックスです。– バージョン 34.0 以降では、action が view の場合、idPrefix はユーザ (005)、ファイル (069)、グ

ループ (0F9)、レコード (001 や 003 など)、またはカスタムのおすすめ (0RD) のキープレフィックスです。







StringcontextAction


• view








507





Stringfollowed





IntegermaxResults



Stringviewed




リクエスト URL の例/chatter/users/me/recommendations/view/001


508


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



– 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 以降)。




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




509

User Recommendations for a Specific Action and Object IDChatter REST API リソース

User Recommendations for a Specific Action and Object Typeコンテキストユーザへの指定されたアクションおよびオブジェクト種別の静的なおすすめを返します。静的なおすすめの削除にも使用されます。リソース

/chatter/users/userId/recommendations/action/objectEnum

/connect/communities/communityId/chatter/users/userId/recommendations/action/objectEnum


• action の有効値は次のとおりです。– view

• objectEnum の有効値は次のとおりです。– Today — ID のない静的なおすすめ (Today アプリケーションのおすすめなど)。






User Reputation指定されたコミュニティユーザの評価を返します。リソース

/connect/communities/communityId/chatter/users/userId/reputation




レスポンスボディReputation

510

User Recommendations for a Specific Action and Object TypeChatter REST API リソース

User Settingsコンテキストユーザのグローバル Chatter 設定に関する情報を返します。リソース

/chatter/users/userId/settings

/connect/communities/communityId/chatter/users/userId/settings




HTTP メソッドGET、HEAD、または PATCH


<userChatterSettings>

プロパティ


説明型名前

27.0ユーザが参加するグループからメールを受信するデフォルトの頻度。有効な値は、次のとおりです。

StringdefaultGroupEmailFrequency

• EachPost

• DailyDigest

• WeeklyDigest

• Never


511

User SettingsChatter REST API リソース



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



HTTP メソッドGET、DELETE、POST、または HEAD

512

User StatusChatter REST API リソース


<userStatus>

プロパティ


23.0 ～ 24.0メッセージ本文の説明。Message Body Inputbody


説明型名前

ユーザの状況に post 送信する項目のテキスト

String 投稿するテキストtext

GET または POST のレスポンスボディUser Status

Topics Recently Used指定されたユーザが最近使用したトピック。指定されたユーザが最近使用したトピックを最大 5 個取得します。リソース

/chatter/users/userId/topics

/connect/communities/communityId/chatter/users/userId/topics





Zones リソース

Chatter アンサーゾーンに関する情報。使用可能なリソース:

513

Topics Recently UsedChatter REST API リソース

説明リソース

組織の Chatter アンサーゾーンのリスト。コンテキストユーザが使用できるゾーンに関する情報を取得します。

/connect/zones

指定された Chatter アンサーゾーンに関する情報。/connect/zones/zoneId

Chatter アンサーゾーン内の検索の検索結果。/connect/zones/zoneId/searchResults

List of Zones組織のChatter アンサーゾーンのリスト。コンテキストユーザが使用できるゾーンに関する情報を取得します。リソース

/connect/zones/

/connect/communities/communityId/zones/








Integerpage


IntegerpageSize

GET のレスポンスボディZone Page

Zone Information指定された Chatter アンサーゾーンに関する情報。

514

List of ZonesChatter REST API リソース

リソース/connect/zones/zoneId

/connect/communities/communityId/zones/zoneId




GET のレスポンスボディZone

Zone Search ResultsChatter アンサーゾーン内の検索の検索結果。リソース

/connect/zones/zoneId/search-results

/connect/communities/communityId/zones/zoneId/search-results








Integerpage


IntegerpageSize

GET のレスポンスボディZone Search Result

515

Zone Search ResultsChatter REST API リソース

第 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 によって値が代入されます。使用可能なコンテキスト変数は次のとおりです。



516





{!communityId}


{!communityUrl}



ルート 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 anAPI action link.\"}]}}",

"headers":[

{

"name":"Content-Type", "value":"application/json"

}]

}

517

Action Link Definition InputChatter REST API リクエストボディ

次の例ではテンプレートを使用しています。{



{

"key":"Bindings.version",

"value":"v33.0"

}

]

}

プロパティ



説明型名前

33.0必須項目アクションリンクテンプレート

アクションリンクの種別を定義します。値は次のとおりです。

StringactionType

• Api — アクションリンクは、アクション URL で同期 API をに定義できま

す。コールします。Salesforce は、サーバから返された HTTP 状況コードに基づいて状況をSuccessfulStatus またはFailedStatus に設定します。

• ApiAsync — アクションリンクは、アクション URL で非同期API をコールします。アクションは、非同期操作の完了時にサードパーティが/connect/action-links/actionLinkId

への要求を行って状況をSuccessfulStatus またはFailedStatus に設定するまで、PendingStatus状態のままになります。

518




説明型名前

• Download — アクションリンクは、アクション URL からファイルをダウンロードします。

• Ui — アクションリンクは、アクション URL で Web ページをユーザに表示します。

ユーザがアクションを実行する前にページを読み込む必要がある場合、Uiを使用します。たとえば、アクションの実行前にユーザが入力を行う場合やユーザに情報を表示したりする場合などです。


アクションリンクの URL。たとえば、Ui アクションリンク URL はWeb ページになります。Download

アクションリンク URL は、ダウン

StringactionUrl

に定義できます。ロードするファイルへのリンクに

なります。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




説明型名前

expirationDate プロパティを使用して API のアップグレードや機能変更による問題を避けることができます。

33.0省略可能[ユーザ表示設定] および [カ

アクションの実行から除外する単一ユーザの ID。excludedUserId

を指定した場合、userId を指定できません。

StringexcludedUserId

スタムユーザ(別名)] 項目を使用してアクションリンクテンプレートに定義できます。

33.0省略可能アクションリンクテンプレート

このアクションがアクションリンクグループのデフォルトアクションリンクである場合は true、それ以外の場合は false。各アク

BooleangroupDefault

に定義できます。ションリンクグループに含めるこ

とができるデフォルトアクションリンクは 1 つだけです。Salesforce

UI では、デフォルトアクションリンクには区別しやすいスタイルが適用されます。


Apiおよび ApiAsyncアクションリンク種別の要求ヘッダー。「認証」を参照してください。

Request HeaderInput[]

headers

に定義できます。


ユーザインターフェースに表示される表示ラベルのセットのキー。セットには、NewStatus、PendingStatus、SuccessStatus、

StringlabelKey

に定義できます。FailedStatus の状態の表示ラベルが

含まれます。たとえば、Approve

キーを使用する場合、[承認]、[待機中]、[承認済み]、[失敗] の表示ラベルが含まれます。

520




説明型名前

キーおよび表示ラベルの完全なリストについては、「アクションリンクの表示ラベル」を参照してください。アクションリンクに適した定義済み表示ラベルがない場合は、カスタム表示ラベルを使用します。カスタム表示ラベルを使用するには、アクションリンクテンプレートを作成します。「アクションリンクテンプレートの作成」を参照してください。


次のいずれかの HTTP メソッド。Stringmethod

• 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




説明型名前


Apiおよび ApiAsyncアクションリンク種別のリクエストボディ。

StringrequestBody

メモ: requestBody 値の疑問符文字をエスケープします。



ユーザにアクションを確認するように要求する場合は true、それ以外の場合は false。

BooleanrequiresConfirmation


33.0省略可能[ユーザ表示設定] および [カ

アクションを実行できるユーザのID。指定しない場合や null の場合、すべてのユーザがアクションを実行できます。userId を指定

StringuserId

スタムユーザ(別した場合、excludedUserIdを指定できません。名)] 項目を使

用してアクションリンクテンプレートに定義できます。

関連トピック:


Action Link Group Definition Input

アクションリンクグループの定義。すべてのアクションリンクはグループに属している必要があります。1 つのグループ内のアクションリンクは、相互排他的で、同じプロパティを共有します。各自のアクショングループでスタンドアロンアクションを定義します。アクションリンク定義の情報はサードパーティの機密情報 (OAuth ベアラトークンヘッダーなど) である可能性があります。そのため、アクションリンク定義を作成した接続アプリケーション経由で実行された要求のみが定義を参照、変更、または削除できます。さらに、要求を実行するユーザは、定義を作成したユーザか、「すべてのデータの参照」権限を持つユーザである必要があります。ルート XML タグ

<actionLinkGroup>

522

Action Link Group Definition InputChatter REST API リクエストボディ

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",


"category": "Primary"

}

次の例では、テンプレートからアクションリンクグループ定義をインスタンス化しています。{


523



{

"key":"Bindings.version",

"value":"v33.0"

}

]

}

プロパティ



説明型名前

33.0テンプレートを使用せずにアク

グループ内の各アクションリンク。アクションリンクグループ内では、アクションリンクは、Action

Action LinkDefinition Input[]

actionLinks

ションリンクグループをインスタンス化する場合は必須。テンプレートからインスタンス

Link Group Definition Input リクエストボディの actionLinks プロパティにリストされる順序で表示されます。フィード項目内で

化する場合は、は、アクションリンクグループ値を指定しないでください。

は、Associated Actions Capability Input

リクエストボディのactionLinkGroupIds プロパティに指定された順序で表示されます。


関連付けられたフィード項目内でのアクションリンクの優先度

Stringcategory

ションリンクグおよび相対位置を示します。値は次のとおりです。ループをインス

タンス化する場合は必須。テンプレートからインスタンス

• Primary — アクションリンクグループは、フィード要素の本文に表示されます。

• Overflow — アクションリンクグループは、フィード要素化する場合は、

値を指定しないでください。

のオーバーフローメニューに表示されます。

524




説明型名前

Primary グループには最大 3

個、Overflowグループには最大4 個のアクションリンクを作成できます。


アクションリンクを実行できる回数を定義します。値は次のとおりです。

StringexecutionsAllowed

ションリンクグループをインス• Once — アクションリンク

は、すべてのユーザで 1 回のみ実行できます。

タンス化する場合は必須。テンプレートからインスタンス

• OncePerUser — アクションリンクは、各ユーザで 1 回のみ実行できます。化する場合は、

値を指定しないでください。

• Unlimited — アクションリンクは、各ユーザで無制限に実行できます。アクションリンクの actionType が Api

または ApiAsyncの場合、この値を使用できません。


このアクションリンクグループが関連付けられたフィード項目

DateexpirationDate

ションリンクグから削除され、実行できなくなループをインスる日時を表す ISO 8601 日付文字列タンス化する場合は必須。テンプレートからインスタンス

(例: 2011-02-25T18:24:31.000Z)。expirationDate は、作成日から 1 年以内の日時である必要があります。アクションリンクグループ定義に OAuth トークンが含まれる場

化する場合は省略可能。

合、アクションリンクグループの有効期限を OAuth トークンの有効期限と同じ値に設定することをお勧めします。そうすれば、ユーザがアクションリンクを実行できず、OAuth エラーは発生しません。テンプレートからインスタンス化するときに日付を設定する場合は、「アクションリンクグルー

525




説明型名前

プの有効期限の設定」を参照してください。

33.0テンプレートを使用せずにイン

アクションリンクテンプレートからバインド変数値またはカス

Action LinkTemplate BindingInput[]

templateBindings

スタンス化するタムユーザ別名に入力されるキー場合は、値を指- 値のペアのコレクション。バイ定しないでください。バインド変数を使用するテンプ

ンド変数を使用するアクションリンクテンプレートからこのアクションリンクグループをインスタンス化するには、すべての変数の値を指定する必要がありレートからこのます。「バインド変数の定義」を参照してください。

アクションリンクグループをインスタンス化する場合は必須。

33.0テンプレートを使用せずにイン

このアクションリンクグループのインスタンス化に使用された

StringtemplateId

スタンス化するアクションリンクグループテンプレートの ID。場合は、値を指

定しないでください。テンプレートからこのアクションリンクグループをインスタンス化する場合は必須。

関連トピック:

アクションリンクを定義し、フィード要素を使用して投稿するアクションリンクを定義し、フィード要素を使用して投稿するテンプレートのアクションリンクを定義し、フィード要素を使用して投稿する

Action Link Input

アクションリンクの想定される実行状況。

526

Action Link InputChatter REST API リクエストボディ

ルート XML タグ<actionLink>

JSON の例{ "status" : "SuccessfulStatus" }

プロパティ



説明型名前

33.0必須項目アクションの現在の実行状況。値は次のとおりです。

Stringstatus


• NewStatus — アクションリンクの実行の準備が整っています。Download および Ui アクションリンクでのみ使用できます。

• PendingStatus — アクションリンクが実行されています。この値を選択すると、ApiおよびApiAsyncアクションリンクのAPI コールがトリガされます。


関連トピック:


Action Link Template Binding Input

アクションリンクテンプレートのバインド変数値に入力されるキー - 値ペア。JSON の例

{

"key":"version",

"value":"33.0"

527

Action Link Template Binding InputChatter REST API リクエストボディ

}

プロパティ



説明型名前

33.0必須項目[設定] でアクションリンクテンプレートに指定されたバインド変数

Stringkey

キーの名前。たとえば、テンプレートのバインド変数が{!Binding.firstName} の場合、キーは firstName です。

33.0必須項目バインド変数キーの値。たとえば、キーが firstName の場合、この値は Joan などになります。

Stringvalue

Announcement Input

お知らせは、削除されるか、別のお知らせで置き換えられない限り、その表示期限の 11:59 p.m. までSalesforce UI

の指定の場所に表示されます。ルート XML タグ

<announcement>

JSON の例{ "body":

{


{


"type": "Text"

}

]

}


}

528

Announcement InputChatter REST API リクエストボディ

プロパティ



説明型名前

31.0必須項目お知らせのテキスト。Message Body Inputbody

31.0必須項目別のお知らせが最初に投稿されていない限り、この日付の 11:59 p.m.

DateexpirationDate

まで Salesforce UI にお知らせが表示されます。Salesforce UI では、expirationDateの時間値は無視されます。ただし、時間値を使用して各自の UI で独自の表示ロジックを作成することはできます。

Associated Actions Capability Input

フィード要素で作成または更新できるアクションリンクを記述します。アクションリンクグループをフィード要素に関連付けるには、クライアントがアクションリンクグループ定義を作成したものと同じ接続アプリケーションで、ユーザが定義を作成したユーザまたは「すべてのデータの参照」権限を持つユーザである必要があります。アクションリンクは、フィード要素上のボタンです。アクションリンクをクリックすると、ユーザを特定のWeb ページに移動したり、ファイルダウンロードを開始したり、Salesforce または外部サーバへの API コールを呼び出したりできます。アクションリンクには、URL と HTTP メソッドが含まれ、リクエストボディとヘッダー情報 (認証用の OAuth トークンなど) を含めることができます。アクションリンクを使用して Salesforce およびサードパーティサービスをフィードに統合することで、ユーザはアクションを実行して生産性を高め、イノベーションを促進できます。JSON の例


"actionLinkGroupIds":["0Agxx00000000d1CAA", "0Agxx00000000d2DFY"]

}

プロパティ



説明型名前

33.0必須項目フィード要素に関連付けるアクションリンクグループ ID。1 つの

String []actionLinkGroupIds

Primaryアクションリンクグループを含め、合計で最大 10 個のアクションリンクグループをフィード

529

Associated Actions Capability InputChatter REST API リクエストボディ



説明型名前

項目に関連付けます。アクションリンクグループは、このプロパティに指定された順序で返されます。/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" : "{"itinerary":"123"}",

"height" : "250px",

"title" : "TravelItinerary",

}

}

530

Attachment Input: Canvas AppChatter REST API リクエストボディ

プロパティ


説明型名前

29.0 ～ 31.0添付ファイルの種別。値 Canvasを含める必要があります。


29.0 ～ 31.0省略可能。キャンバスアプリケーションの説明。Stringdescription

29.0 ～ 31.0キャンバスアプリケーションの開発者名 (API 名)StringdeveloperName

29.0 ～ 31.0省略可能。キャンバスアプリケーションの高さ (ピクセル単位)。デフォルトの高さは 200 ピクセルです。

Stringheight

29.0 ～ 31.0省略可能。キャンバスアプリケーションが作成されたDeveloper Edition 組織の名前空間プレフィックス。


29.0 ～ 31.0省略可能。キャンバスアプリケーションに渡されるJSON 形式のパラメータ。JSON はエスケープする必要があります。

Stringparameters

29.0 ～ 31.0省略可能。キャンバスアプリケーションのサムネイル画像の URL。最大サイズは 120x120 ピクセルです。

StringthumbnailUrl

29.0 ～ 31.0省略可能。キャンバスアプリケーションのコールに使用されるリンクのタイトル。

Stringtitle

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

Attachment Input: Existing ContentChatter REST API リクエストボディ

"contentDocumentId": "069D00000001FHF"

}

}

プロパティ


27.0 ～ 31.0添付ファイルの種別。値ExistingContent を含める必要があります。


23.0 ～ 31.0既存のコンテンツの IDStringcontentDocumentId

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

Attachment Input: Feed PollChatter REST API リクエストボディ

]

}

}

プロパティ


27.0 ～ 31.0添付ファイルの種別。値Poll を含める必要があります。


26.0 ～ 31.0フィードアンケートに使用される選択肢のリスト。

String[]pollChoices

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

Attachment Input: LinkChatter REST API リクエストボディ

プロパティ


27.0 ～ 31.0添付ファイルの種別。値Link を含める必要があります。


23.0 ～ 31.0添付ファイルに含まれるURL。

Stringurl

23.0 ～ 31.0省略可能。URL の名前。指定されない場合、名前

StringurlName

は 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

Attachment Input: New File UploadChatter REST API リクエストボディ

}

プロパティ


説明型名前

27.0 ～ 31.0添付ファイルの種別。値 NewFile


23.0 ～ 26.0ファイルの説明。Stringdesc

注意: このパラメータは、バージョン 27.0 以降では使用しないでください。代わりに、description を使用してください。

27.0 ～ 31.0省略可能。ファイルの説明。Stringdescription

24.0 ～ 31.0ファイルのタイトル。Stringtitle

Batch Collection Input

バッチ要求用の入力のコレクションを記述します。JSON の例

{

"inputs": [

{

"richInput": {

"subjectId": "me",

"body": {


{

"type": "Text",


}]

535

Batch Collection InputChatter REST API リクエストボディ

},


}

}, {

"richInput": {

"subjectId": "me",

"body": {


{

"type": "Text",


}]

},


}

}]

}

プロパティ



説明型名前

32.0必須項目一緒に処理される入力 (リクエストボディ) のコレクション。

Batch Input[]inputs

すべての Batch Input リクエストボディの richInput プロパティには、同じ種別のリクエストボディが含まれている必要があります。

Batch Input

Batch Collection Input 内にネストされる個別のバッチ入力。

536

Batch InputChatter REST API リクエストボディ

JSON の例バイナリパートのない例:

{

"richInput": {

"subjectId": "me",

"body": {


{

"type": "Text",


}]

},


}

}

バイナリパートのある例:

{


"bin1"

],

"richInput": {

"subjectId": "me",

"body": {


{

"type": "Text",


}

537


]

},

"capabilities": {

"content": {



}

},


}

}

この例では、バイナリボディパートの Content-Dispositionヘッダー内の nameパラメータの値が bin1

である必要があります。プロパティ



説明型名前

32.0省略可能この入力で含めるバイナリボディパートのContent-Dispositionヘッダー内の name

String []binaryPartNames

パラメータのリスト。この値が存在する場合、対応するバイナリパートが要求に含まれている必要があります。

メモ:/chatter/feed-elements/batchリソースとともに使用する場合、このプロパティに設定できる値は 1 つのみで、値のリストではありません。

32.0必須項目要求の入力ボディ (リクエストボディ)。richInputプロパティには、リソースが想

richInput

定するリクエストボディが含まれている必要があります。/chatter/feed-elements/batchリソースでは、Feed Item Input リクエストボディを想定します。

538


Bookmarks Capability Input

フィード要素のブックマークを作成または更新します。ルート XML タグ


<isBookmarkedByCurrentUser>true</isBookmarkedByCurrentUser>


JSON の例{


}

プロパティ



説明型名前




Canvas Capability Input

フィード要素に関連付けられたキャンバスアプリケーションを作成または更新します。ルート XML タグ

<canvasCapability>

<developerName>true</developerName>

<title>true</title>

</canvasCapability>

JSON の例{

"developerName": "myNewApp",

539

Bookmarks Capability InputChatter REST API リクエストボディ

"title": "My New App"

}

プロパティ



説明型名前

32.0省略可能キャンバスアプリケーションの説明。最大サイズは 255 文字です。

Stringdescription

32.0必須項目接続アプリケーションの API 名 (開発者名)。

StringdeveloperName

32.0省略可能キャンバスアプリケーションの高さ (ピクセル単位)。

Stringheight

32.0省略可能キャンバスアプリケーションの一意の名前空間プレフィックス。


32.0省略可能キャンバスアプリケーションに渡される JSON パラメータ。

Stringparameters

32.0省略可能プレビュー画像へのサムネイルURL。最大サムネイルサイズは、120 × 120 ピクセルです。

StringthumbnailUrl

32.0必須項目キャンバスリンクのタイトル。Stringtitle

Comment Input

ルート XML タグ<comment>

JSON

次の例では、コメントに既存のファイルを添付します。{

"body" : {


{

"text" : "FY14 Sales Projections",

"type" : "Text"

}

540

Comment InputChatter REST API リクエストボディ

]

},

"capabilities": {

"contentDocumentId":"069D00000001FHF"

}

}

プロパティ


説明型名前




重要: バージョン 32.0 以降は、capabilities プロパティを使用します。



関連トピック:

コメントを投稿するコメントを投稿し、Salesforce のファイルを含める@メンションを投稿する複数の @メンションを投稿する

Comment Capabilities Input

ルート XML タグ<commentCapabilities>

プロパティ


説明型名前

32.0添付ファイル。Content Capability Inputcontent

541

Comment Capabilities InputChatter REST API リクエストボディ

Content Capability Input

フィード要素に関連付けられたファイルを作成または更新します。ルート XML タグ

<contentCapability>

<contentDocumentId>069D00000001pyS</contentDocumentId>

</contentCapability>

JSON の例{

"contentDocumentId": "069D00000001pyS"

}

プロパティ



説明型名前

32.0既存のコンテンツでは必須新規コンテンツではサポート対象外

既存のコンテンツの ID。StringcontentDocumentId

32.0新規コンテンツでは省略可能既存のコンテンツではサポート対象外

アップロードするファイルの説明。

Stringdescription

32.0新規コンテンツでは必須既存のコンテンツではサポート対象外

ファイルのタイトル。この値は、新しいコンテンツのファイル名として使用されます。たとえば、タイトルが「My Title」で、ファイルが .txt ファイルの場合、ファイル名は My Title.txt になります。

Stringtitle

Datacloud Order Input

特定の userType によって取引先責任者または会社の購入に使用される Data.com 識別番号のリスト。

542

Content Capability InputChatter REST API リクエストボディ

ルート XML タグ<DatacloudOrder>

JSON の例{

"companyIds":[

"23456",

"24548"

],

"userType":"Monthly"

}

プロパティ



説明型名前

32.0必須項目購入する会社のリスト。contactIds とcompanyIds が共に含まれていると、購入は失敗します。

StringcompanyIds

32.0必須項目購入する取引先責任者のリスト。リストには取引先責任者のみを含めることをお勧めしま

StringcontactIds

す。companyIds と contactIds が共に含まれていると、購入は失敗します。

32.0省略可能 —

ユーザ種別がData.com ユーザ種別。StringuserType

• Monthy — Data.com レコードの購入の毎月のポイント制限が割り当てられるユーザ種指定されてい

ない場合、デ別。毎月のポイントを使用できるのは、割フォルトはり当てられたユーザのみです。ポイントMonthly です。

は、月末に期限切れになります。Monthly

は、DatacloudUserTypeのデフォルト設定です。

• Listpool — Data.com レコードを購入するためのポイントをユーザがプールから引き出すことを許可するユーザ種別。

543

Datacloud Order InputChatter REST API リクエストボディ

Dashboard Component Snapshot Input

ルート XML タグ<dashboardComponentSnapshot>

JSON

{

"parentId" : "0F9D00000000I4O",

"feedItemBody" : {


{

"text" : "Sales Heat",

"type" : "Text"

}

]

}

}

プロパティ


25.0スナップショットの post 送信先となるユーザ、グループ、またはダッシュボードの ID。

StringparentId

25.0省略可能。ダッシュボード絞り込み項目の ID。

StringfilterId1


StringfilterId2


StringfilterId3

25.0ダッシュボードコンポーネントスナップショットに関連付

Message Body InputfeedItemBody

けられたフィード項目に付随するテキストが含まれます。

544

Dashboard Component Snapshot InputChatter REST API リクエストボディ


25.0省略可能。ダッシュボードのビューの作成元となるユーザID (作成者以外の場合)。

StringrunningUserId

Feed Element Capabilities Input

新しいフィード要素を作成するときに含めることができるすべての機能のコンテナ。API バージョン 30.0 以前では、各フィード項目にコメント、いいね!、トピックなどを含めることができました。バージョン 31.0 以降では、各フィード項目 (およびフィード要素) に一意の機能セットを含めることができます。フィード要素に機能プロパティが存在する場合、機能プロパティに値がなくてもその機能を使用できます。たとえば、ChatterLikes機能プロパティがフィード要素に存在している場合、(値の有無に関係なく) コンテキストユーザはそのフィード要素にいいね! と言うことができます。機能プロパティが存在しない場合、そのフィード要素にいいね! と言うことはできません。機能には、関連データを含めることもできます。たとえば、Moderation 機能には、モデレーションフラグに関するデータが含まれます。XML の例

<capabilities>

<associatedActions>

<actionLinkGroupIds>

<actionLinkGroupId/>0Agxx00000000d1CAA<actionLinkGroupId/>

<actionLinkGroupId/>0Agxx00000000d2DFY<actionLinkGroupId/>

</actionLinkGroupIds>

</associatedActions>


<isBookmarkedByCurrentUser>false</isBookmarkedByCurrentUser>


<contentCapability>

<contentDocumentId>069D00000001pyS</contentDocumentId>

</contentCapability>

</capabilities>

545

Feed Element Capabilities InputChatter REST API リクエストボディ

JSON の例"capabilities": {


"actionLinkGroupIds":["0Agxx00000000d1CAA", "0Agxx00000000d2DFY"]

},

"bookmarks": {

"isBookmarkedByCurrentUser": false

},

"content": {

"contentDocumentId": "069D00000001pyS"

}

}

プロパティ



説明型名前

31.0省略可能フィード要素で作成または更新できるアクションリンクを記述しま

Associated ActionsCapability Input

associatedActions

す。アクションリンクグループをフィード要素に関連付けるには、クライアントがアクションリンクグループ定義を作成したものと同じ接続アプリケーションで、ユーザが定義を作成したユーザまたは「すべてのデータの参照」権限を持つユーザである必要があります。

32.0省略可能フィード要素のブックマークを作成または更新します。

BookmarksCapability Input

bookmarks

32.0省略可能フィード要素に関連付けられたキャンバスアプリケーションを作成または更新します。

Canvas CapabilityInput

canvas

32.0省略可能フィード要素を使用してファイルを添付または更新します。このク

Content CapabilityInput

content

ラスを使用して、新しいファイル

546

Feed Element Capabilities InputChatter REST API リクエストボディ



説明型名前

を添付したり、すでに Salesforce にアップロードされているファイルを更新したりします。

32.0省略可能フィード要素に添付されたリンクを作成または更新します。

Link Capability Inputlink

32.0省略可能フィード要素に添付されたアンケートの作成、更新、または投票を行います。

Poll Capability Inputpoll

32.0省略可能質問フィード要素を作成するか、既存の質問フィード要素の最良の回答を設定します。

Question andAnswers CapabilityInput

questionAndAnswers

Feed Favorite Input

ルート XML タグ<favorite>

POST の JSON

{

"searchText" : "release",

"targetId" : "0TOD0000000099d"

}

POST のプロパティ



StringsearchText



StringtargetId

547

Feed Favorite InputChatter REST API リクエストボディ

PATCH の JSON

{

"updateLastViewDate" : "true"

}

PATCH のプロパティ


24.0指定されたフィードのお気に入りの最終参照日を


現在のシステム時刻に設定します。デフォルト値は false です。

Feed Item Input

ルート XML タグ<feedItem>

JSON


"body":{

"messageSegments":[

{

"type":"Text",


}

]

},

"capabilities":{

"poll":{

"choices":[

"Monday",

548

Feed Item InputChatter REST API リクエストボディ

"Tuesday"

]

}

},


"subjectId":"me"

}


"body":{

"messageSegments":[

{

"type":"Text",


}

]

},

"capabilities":{

"bookmarks":{


},

"content":{


}

},


"subjectId":"me"

549


}

プロパティ



省略可能attachment パラメータには、次のいずれか 1 つの値のみを指


attachment

定できます。値は次のとおりです。• Attachment Input: Canvas App

(v29.0 ～ 31.0)


Content (v23.0 ～ 31.0)


(v26.0 ～ 31.0)

• Attachment Input: Link (v23.0 ～31.0)


Upload (v23.0 ～ 31.0)

重要: API バージョン 32.0

以降では、capabilities プロパティを使用します。

23.0フィード項目にコンテンツ機能またはリ

メッセージ本文の説明。本文には 25 文字まで使用できます。フィード項目を共有するための originalFeedItemId を


ンク機能がある場合を除き、必須




capabilities

24.0 ～ 31.0省略可能新しいフィード項目をユーザのためにブックマークするか


550




(true)、否か (false) を指定します。デフォルト値は、false です。


以降では、capabilities.bookmarks.isBookmarkedByCurrentUser


31.0必須項目この入力が表すフィード要素の種別。有効な値は FeedItemのみです。




フィード要素の18 文字の IDです。

メモ: このパラメータは、他のすべてのパラメータよりも優先されます。たとえば、投稿を共有し、さらにファイルのアップロードも試みる場合、生成されたフィード項目には共有された投稿のみが含まれます。1 つの POST 内では、投稿の共有かファイルのアップロードのどちらか 1 つのみ (両方ではなく) を行う必要があります。

24.0 ～ 31.0省略可能このフィード項目が共有されている場合、これは元の


フィード項目の18 文字の IDです。


以降では、

551




originalFeedElementId



StringsubjectId

ザ、グループ、レコードのID、またはコンテキストユーザを示す文字列 me になります。

552





Stringvisibility



デフォルト値は、次のとおりです。• 外部ユーザの場合、デフォ

ルト値は AllUsers です。外部ユーザが投稿を表示するには、この値を使用する必要があります。

• 内部ユーザの場合、デフォルト値は InternalUsers

です。内部ユーザは、この値を受け入れるか、値AllUsersを使用して外部ユーザに投稿の表示を許可します。


553


関連トピック:

フィード項目を投稿するフィード要素を投稿し、Salesforce のファイルを含める@メンションを投稿する複数の @メンションを投稿するアクションリンクを定義し、フィード要素を使用して投稿するテンプレートのアクションリンクを定義し、フィード要素を使用して投稿するフィード項目を共有するグループに投稿する

Feed Item Topic Input

ルート XML タグ<feedItemTopic>

JSON


}

プロパティ







StringtopicName


Feed Poll Input

重要: このリクエストボディは、バージョン 32.0 以降では使用できません。バージョン 32.0 以降では、Poll

Capability Input を使用してください。ルート XML タグ

<feedPoll>

554

Feed Item Topic InputChatter REST API リクエストボディ

プロパティ



StringmyChoiceId


File Input

このリクエストボディでは、新しいファイル入力について説明します。ファイルをアップロードするには、name="fileData" のマルチパート/フォームデータボディパートにそのバイナリファイルを含める必要があります。「バイナリファイルのアップロード」を参照してください。

ルート XML タグ<fileInput>

JSON

{

"desc":"Employee Survey Results",

"title":"emp_surv_results"

}

プロパティ



説明型名前




Stringdesc

31.0省略可能ファイルが Salesforce Files Sync と同期されている場合は true、同期されていない場合は false。


31.0省略可能ファイルがメジャーバージョンの場合はtrue、ファイルがマイナー


バージョンの場合は false。メ

555

File InputChatter REST API リクエストボディ



説明型名前

ジャーバージョンを置き換えることはできません。





File Shares Input

ルート XML タグ<fileShares>

JSON の例{

"message": "I shared a document with you.",

"shares": [

{ "id": "005D0000001Az4l", "sharingType": "V" },

{ "id": "005D0000001B2ny", "sharingType": "C" }

]

}

プロパティ


説明型名前

30.0受信者に送信される非公開のメッセージ本文。Salesforce Communitiesが有効な場合、非公

Stringmessage

開メッセージではなくメールが送信されます。

30.0Share Input リクエストボディのコレクション。Share Input[]shares

556

File Shares InputChatter REST API リクエストボディ

Folder Input

ルート XML タグ<folderInput>

JSON の例{

"path" : "my_documents/my_folder"

}

プロパティ


説明型名前

33.0フォルダおよびこのフォルダ内のすべてのフォルダが Salesforce Files Syncと同期されてい


る場合は true、同期されていない場合はfalse。isInMyFileSync 設定は、ルートフォルダでのみ有効です。一度 trueに設定すると、isInMyFileSync を false に設定することはできません。

30.0フォルダの名前。path または name のいずれかが必要です。両方を指定すると、pathが使用され、name

が無視されます。

Stringname

30.0親フォルダの ID。parentFolderId または path のいずれかが必要です。両方を含めることはできません。

StringparentFolderId

30.0フォルダのパス。たとえば、my

documents/folder です。Stringpath

Folder Item Input

ルート XML タグ<folderItem>

557

Folder InputChatter REST API リクエストボディ

JSON の例{

"file" :

{

"desc" : "Yearly Report for Universal Containers Box Division",

"title" : "Yearly.txt"

},

"type" : "File"

}

プロパティ



30.0File の POST では必須項目。フォルダ内のファイル。

File Inputfile

30.0Folderの POST では必須項目。フォルダ内フォルダ。Folder Inputfolder

30.0必須項目項目の種別。次のいずれかの値にします。

Stringtype

• File

• Folder

Following Input

ルート XML タグ<following>

558

Following InputChatter REST API リクエストボディ

プロパティ


23.0


フォローする対象の ID。たとえば、ユーザ ID、レコード ID、ファイル ID、トピック ID などがあります。

StringsubjectId

メモ: グループにメンバーを追加する場合には Group

Member Input を使用します。

関連トピック:

レコードをフォローする

Generic Batch Collection Input

ルート XML タグ<batch>

JSON

{

"batchRequests" : [

{

"method" : "Get",


},

{

"method" : "Get",


}

]

}

559

Generic Batch Collection InputChatter REST API リクエストボディ

プロパティ


説明型名前

28.0実行するサブ要求の URL を含む、Batch

Request Input リクエストボディのコレクション。

Generic Batch Input[]batchRequests

28.0デフォルト値は、false です。値が falseで、バッチ内のサブ要求が完了しない場合、Salesforce は、バッチ

BooleanhaltOnError

内の後続のサブ要求を実行しようと試みます。値が true で、HTTP 応答 400 番台または 500 番台のエラーが含まれるためにバッチ内のサブ要求が完了しない場合、Salesforceは実行を停止します。バッチ内にある後続のサブ要求の実行は試みず、後続のサブ要求ごとに HTTP 412

状況コードと前の要求が失敗したことを示す BATCH_PROCESSING_HALTED

エラーメッセージを返します。/connect/batchへの最上位要求は、HTTP 200 を返し、応答内のhasErrorsプロパティが trueに設定されます。

関連トピック:

フィード項目にいいね! と言い、いいね! の総数を返す

Generic Batch Input

ルート XML タグ<request>

JSON

{

"method" : "Get",


}

560

Generic Batch InputChatter REST API リクエストボディ

プロパティ


説明型名前

28.0マルチパート要求のバイナリパートの名前。1 つのバッチ要求で複数のバイナリパートがアップロードされると、この値が

StringbinaryPartName

要求とバイナリパートの対応付けに使用されます。名前の競合を防止するために、バッチ要求内の各binaryPartNameプロパティには一意の値を使用します。このプロパティは省略可能です。この値が存在する場合、binaryPartNameAlias値も存在する必要があります。

28.0バイナリボディパートのContent-Disposition ヘッダーの nameパラ

StringbinaryPartNameAlias

メータ。リソースごとに異なる値を使用します。「バイナリファイルのアップロード」を参照してください。このプロパティは省略可能です。この値が存在する場合、binaryPartName

値も存在する必要があります。

28.0次のいずれかの HTTP メソッド。Stringmethod

• HttpDelete — 成功した場合は HTTP

204 を返します。レスポンスボディまたは出力クラスは空です。

• HttpGet — 成功した場合は HTTP 200

を返します。• HttpHead — 成功した場合は HTTP

200 を返します。レスポンスボディまたは出力クラスは空です。

• HttpPatch — 成功した場合は HTTP

200 を返し、レスポンスボディまたは出力クラスが空の場合は HTTP 204

を返します。• HttpPost — 成功した場合は HTTP

201 を返し、レスポンスボディまた

561



説明型名前

は出力クラスが空の場合は HTTP 204

を返します。例外は、成功時に HTTP

200 を返すバッチ投稿リソースおよびメソッドです。

• HttpPut — 成功した場合は HTTP 200

を返し、レスポンスボディまたは出力クラスが空の場合は HTTP 204 を返します。

28.0要求の入力ボディ。型は urlプロパティに指定された要求に応じて異なります。

richInput

このプロパティは省略可能です。

28.0要求するChatter APIリソース。この値はサブ要求と呼ばれます。サブ要求 URL は次のように開始できます。

Stringurl

• /services/data/version (例:/services/data/v34.0

/chatter/users/me)。• /version (例: /v34.0/chatter

/users/me)。バージョン番号は、/connect/batch要求 URL に指定された要求のバージョン以下にする必要があります。

サブ要求に関する追加情報は、次のとおりです。• URL には、サブ要求がサポートする

クエリ文字列パラメータを含めることができます。クエリ文字列は、URL 符号化されている必要があります。

• パラメータを使用して、レスポンスボディの絞り込みを行うことができます。

• サブ要求レベルでヘッダーを適用することはできません。

562


Group Chatter Settings Input

ルート XML タグ<groupChatterSettings>

プロパティユーザの Chatter 設定。


説明型名前

27.0グループメンバーがグループからメールを受信する頻度。有効な値は、次のとおりです。


• EachPost

• DailyDigest

• WeeklyDigest

• Never


Group Information Input

JSON

{

"text" : "Post questions about the API.",

"title" : "API Questions"

}

プロパティ


説明型名前

28.0グループの [情報] セクション内のテキスト。HTML はサポートされてい

Stringtext

563

Group Chatter Settings InputChatter REST API リクエストボディ


説明型名前

ません。最大文字数は 4000 文字 (バイト) です。

28.0グループの [情報] セクションのタイトル。最大文字数は 240 文字 (バイト) です。

Stringtitle

Group Input

ルート XML タグ<group>

JSON

{




"information" : {



},




"owner" : "00590000000DmPw",


}

564

Group InputChatter REST API リクエストボディ

プロパティ


説明型名前

31.0お知らせ ID。お知らせは、削除されるか、別のお知らせで置き換えられない限り、そ

Stringannouncement

の表示期限の 11:59 p.m. までSalesforce

UI の指定の場所に表示されます。

29.0このグループで Chatter 顧客を許可している場合は true、それ以外の


場合は false。このプロパティをtrueに設定した後で、falseに設定することはできません。

29.0グループの [説明] セクションStringdescription

28.0グループの [情報] セクションWeb UI

では、[情報] セクションは [説明] セGroup Information Inputinformation

クションの上にあります。グループが非公開の場合は、[情報] セクションはメンバーにのみ表示されます。[説明] セクションは全員に表示されます。

29.0グループがアーカイブ済みの場合はtrue、それ以外の場合は false。デフォルトは false です。

BooleanisArchived

29.0グループの自動アーカイブが無効の場合は true、それ以外の場合は



29.0グループの名前Stringname


Stringowner

565

Group InputChatter REST API リクエストボディ


説明型名前


Stringvisibility




関連トピック:


Group Member Input

ルート XML タグ<member>

JSON の例{

"role" : "GroupManager",

"userId" : "005B0000000Ge16"

}

プロパティ



Stringrole

• GroupManager

• StandardMember

566

Group Member InputChatter REST API リクエストボディ



StringuserId

関連トピック:


Group Membership Request Update

ルート XML タグ<groupMembershipRequestUpdate>

プロパティ


27.0このプロパティを使用して、メンバーシップ要求が却下された場合にユーザ


に表示するメッセージを指定します。このプロパティの値は、statusプロパティの値が Declined の場合にのみ使用されます。最大文字数は 756 文字です。

27.0有効な値は次のとおりです。Stringstatus

• Accepted

• Declined

関連トピック:


Group Record Input

Chatter グループに追加するレコード。ルート XML タグ

<groupRecord>

JSON の例

{"recordId" : "001D000000Io9cD"}

567

Group Membership Request UpdateChatter REST API リクエストボディ

プロパティ



説明型名前

34.0必須項目レコードの ID。StringrecordId

Link Capability Input

フィード要素に添付されたリンクを作成または更新します。ルート XML タグ

<linkCapability>

<url>http://www.example.com</url>

<urlName>Example</urlName>

</linkCapability>

JSON の例{

"url": "http://www.example.com",

"urlName": "Example"

}

プロパティ



説明型名前

32.0必須項目リンクの URL。Stringurl

32.0省略可能リンクの名前。StringurlName

Managed Topic Input

管理トピック。ルート XML タグ

<managedTopic>

568

Link Capability InputChatter REST API リクエストボディ

JSON の例{

"managedTopicType" :"Featured",

"recordId" :"0TOD00000000cwk"

}

プロパティ



説明型名前

32.0必須項目管理トピックの種別。StringmanagedTopicType • Featured — コミュニティホー



1 つのトピックは最大 2 つの種別の管理トピックに関連付けることができるため、1 つのトピックをFeatured トピックとNavigationalトピックの両方にすることができます。managedTopicTypeにつき、最大25 個の管理トピックを作成できます。

32.0新規トピックでは必須name またはrecordId を指


定する必要があります。両方を指定することはできません。

569

Managed Topic InputChatter REST API リクエストボディ



説明型名前




StringrecordId

ていない場合、既存のトピックに必要です。name またはrecordId を指定する必要があります。両方を指定することはできません。

Managed Topic Position Collection Input

管理トピックの相対位置のコレクション。ルート XML タグ

<managedTopicPositionCollection>

JSON の例{

"managedTopicPositions" : [

{


"position" :"0"

},

{

"managedTopicId" :"0mtD0000000002qIAA",

"position" :"2"

}

]

}

570

Managed Topic Position Collection InputChatter REST API リクエストボディ

プロパティ



説明型名前

32.0必須項目Managed Topic Position リクエストボディのコレクション。このコレク

Managed TopicPosition Input[]

managedTopicPositions

ションには、Featured およびNavigational管理トピックを含めることができます。また、すべての管理トピックを含める必要はありません。managedTopicPositionsにすべての管理トピックを含めない場合、管理トピックはmanagedTopicPositionsで指示された位置に従って並び替えられ、managedTopicPositionsに含まれない管理トピックは次に空いている位置まで順序を下げられます。「管理トピックの並び替えの例」を参照してください。

管理トピックの並び替えの例次の管理トピックがあるとします。

位置Managed Topic

0ManagedTopicA

1ManagedTopicB

2ManagedTopicC

3ManagedTopicD

4ManagedTopicE

Managed Topic Position Collection Input に次の情報を含めて管理トピックを並び替えます。


0ManagedTopicD

2ManagedTopicE

571

Managed Topic Position Collection InputChatter REST API リクエストボディ



0ManagedTopicD

1ManagedTopicA

2ManagedTopicE

3ManagedTopicB

4ManagedTopicC

Managed Topic Position Input

管理トピックの相対位置。ルート XML タグ

<managedTopicPosition>

JSON の例{


"position" :"0"

}

プロパティ



説明型名前

32.0必須項目既存の管理トピックの ID。StringmanagedTopicId

32.0必須項目管理トピックの相対的位置。ゼロから開始する昇順の整数でインデックスが付けられます。

Integerposition

Message Body Input


23.0種別に基づくメッセージセグメントのコレクショ

Segments[]messageSegments

ン。セグメントは次のいずれかになります。

572

Managed Topic Position InputChatter REST API リクエストボディ


• Message Segment Input:Hash Tag

• Message Segment Input:Link

• Message Segment Input:Mention

• Message Segment Input:Text

Message Segment Input: Hash Tag

インラインハッシュタグを表します。ハッシュタグもテキストセグメントから解析されるため、このセグメントの使用は省略可能です。


23.0

複数語のハッシュタグは、バージョン 28.0 で使用できます。

ハッシュタグを除いたハッシュタグのテキスト。

Stringtag

メモ: ハッシュタグテキストでは、閉じる角括弧 ( ] ) はサポートされていません。テキストに閉じる角括弧 ( ] ) が含まれていると、ハッシュタグはその括弧で終了します。

23.0値は Hashtag です。Stringtype

Message Segment Input: Link

URL へのインラインリンクを表します。先頭に空白テキストのないリンクが入力として指定された場合、空白が挿入されます。末尾に空白テキストのないリンクが入力として指定された場合も、空白が挿入されます。リンクもテキストセグメントから解析されるため、このセグメントの使用は省略可能です。


23.0値は Link です。Stringtype

23.0リンクに使用する URL。URLurl

573

Message Segment Input: Hash TagChatter REST API リクエストボディ

Message Segment Input: Mention

ユーザまたはグループのインラインメンションを表します。ユーザまたはグループの ID を指定する必要があります。空白は追加されません。フィード項目またはコメントを作成する場合、最大 25 個のメンションを含めることができます。


23.0

グループは 29.0 で使用できます。

メンションされるユーザまたはグループの ID。

Stringid

23.0値は MentionStringtype

Message Segment Input: Text

プレーンインラインテキストを表します。リンクのような外見で、前後に空白のあるテキストは、リンクセグメントに変換されます。プレフィックスとしてハッシュが付加され、前後が角括弧 ([]) で囲まれたテキストは、ハッシュタグセグメントに変換されます。複数語のハッシュタグは、バージョン 28.0 以上で使用できます。


23.0このセグメントのプレーンテキスト。

Stringtext

23.0値は Text のみ。Stringtype

Moderation Flag Input

ルート XML タグ<moderationFlag>

JSON

{


}

574

Message Segment Input: MentionChatter REST API リクエストボディ

プロパティ


説明型名前


Stringvisibility



Photo Input

写真入力について説明します。ルート XML タグ

<photo>


"cropX" : "0",

"cropY" : "0",

"fileId" : "069D00000001IOh"

}

プロパティ




トリミングする四角形の任意の境界の長さ (ピクセル単位)。

IntegercropSize



画像の左端を起点とした、トリミングする四角形の開始位

IntegercropX

575

Photo InputChatter REST API リクエストボディ






画像の上端を起点とした、トリミングする四角形の開始位

IntegercropY




既存のファイルの 18 文字のID。キープレフィックスは069、ファイルサイズは 2 MB 未満にする必要があります。

StringfileId


25.0省略可能既存のファイルのバージョン番号。指定されていない場合、


最新のバージョンが使用されます。

関連トピック:

グループの写真を更新およびトリミングするユーザの写真を更新およびトリミングする

Poll Capability Input

フィード要素に添付されたアンケートの作成、更新、または投票を行います。XML の例

<pollCapability>

<pollChoices>

<choice>Monday</choice>

<choice>Tuesday</choice>

</pollChoices>

576

Poll Capability InputChatter REST API リクエストボディ

</pollCapability>

JSON の例{

"choices" : [

"Monday", "Tuesday"

]

}

プロパティ



説明型名前

32.0アンケートの作成では必須

新しいアンケートの作成に使用する選択肢。アンケートには 2 個から 10 個のアンケート選択肢を指定する必要があります。

String []choices

32.0アンケートへの投票では必須

フィードアンケートの既存の選択肢の ID。既存のアンケートに投票するために使用されます。

StringmyChoiceId

Push Notification Input

転送通知。ルート XML タグ

<pushNotification>

JSON の例{ "appName" : "TestApp",

"namespace" : "abc",

"userIds" : ["005x00000013dPK", "005x00000013dPL"],

"payload" : "{'aps':{'alert':'test', 'badge':0, 'sound':'default'}}"

}

577

Push Notification InputChatter REST API リクエストボディ

プロパティ



説明型名前


StringappName



Stringnamespace



Question and Answers Capability Input

質問フィード要素を作成するか、既存の質問フィード要素の最良の回答を設定します。ルート XML タグ

<questionAndAnswersCapability>

<bestAnswerId>0D7D00000000lMAKAY</bestAnswerId>

</questionAndAnswersCapability>

JSON の例{

"bestAnswerId": "0D7D00000000lMAKAY"

}

プロパティ



説明型名前

32.0フィード要素のPATCH では必須です。POST 要求ではサポートされていません。

質問フィード要素の最良の回答として使用するコメント ID。最良の回答コメントは、質問フィード要素にすでに存在する必要があります。

StringbestAnswerId

578

Question and Answers Capability InputChatter REST API リクエストボディ



説明型名前

32.0フィード要素のPOST では必須です。PATCH 要求ではサポートされていません。

質問フィード要素のタイトル。StringquestionTitle

Recommendation Definition Input

おすすめ定義。JSON の例

{






プロパティ



説明型名前

33.0おすすめ定義を作成する場合は必須です。既存のおすすめ定義を更新する

おすすめに基づいて行動するための URL （グループに参加するための URL など）。

StringactionUrl

場合は省略可能です。


ユーザインターフェースのアクション URL のテキストラベル("Launch" など)。

StringactionUrlName

579

Recommendation Definition InputChatter REST API リクエストボディ



説明型名前



おすすめの説明 (本文)。Stringexplanation



おすすめ定義の名前。この名前が[設定] に表示されます。

Stringname



Request Header Input

HTTP 要求ヘッダー名と値のペア。JSON の例

{

"name": "Content-Type",

"value": "application/json"

}

プロパティ



説明型名前

33.0必須項目要求ヘッダーの名前。Stringname

33.0必須項目要求ヘッダーの値。Stringvalue

580

Request Header InputChatter REST API リクエストボディ

Scheduled Recommendation Input

スケジュール済みおすすめ。新しいスケジュール済みおすすめを作成する JSON の例

{

"rank" : "2",



プロパティ



説明型名前


Booleanenabled

合、おすすめが有効になり、コミュニティに表示されます。falseの場合、Salesforce1 モバイルブラウザアプリケーションでのフィードのおすすめは削除されませんが、新しいおすすめは表示されなくなります。Summer '15 以降のバージョンの Napili テンプレートを使用したコミュニティでは、無効にしたおすすめは表示されなくなります。


Integerrank


が 1 つずつ下がります。「スケジュール済みおすすめにランクを付ける場合の例」を参照してください。

581

Scheduled Recommendation InputChatter REST API リクエストボディ



説明型名前

指定された rank がリストのサイズよりも大きい場合は、スケジュール済みおすすめがリストの末尾に配置されます。スケジュール済みおすすめの rank には、指定された値の代わりにリストのサイズが指定されます。rankが指定されていない場合は、スケジュール済みおすすめがリストの末尾に配置されます。






スケジュール済みおすすめにランクを付ける場合の例次のようなスケジュール済みおすすめがあり、

ランクスケジュール済みおすすめ

1ScheduledRecommendationA

2ScheduledRecommendationB

3ScheduledRecommendationC

Scheduled Recommendation Input に次の情報を含めるとします。


2ScheduledRecommendationD

582

Scheduled Recommendation InputChatter REST API リクエストボディ



1ScheduledRecommendationA

2ScheduledRecommendationD

3ScheduledRecommendationB

4ScheduledRecommendationC

Share Input

JSON の例{

"id": "005D0000001Az4l",

"sharingType": "V"

}

プロパティ


説明型名前

30.0ファイルの共有先のユーザ IDStringid

30.0コラボレータの場合は C、閲覧者の場合は VStringsharingType

Topic Assignment Input

フィード項目またはレコードに割り当てるトピックを表します。ユーザがオブジェクト種別のレコードにトピックを追加できるようにするには、事前にシステム管理者がそのオブジェクトでトピックを有効化しておく必要があります。ルート XML タグ

<topicAssignment>

JSON

次の例では、トピックをレコードに割り当てます。{ "topicId": "0TOD0000000090r"

}

583

Share InputChatter REST API リクエストボディ

プロパティ






新規または既存のトピックの名前。

StringtopicName


Topic Endorsement Input

トピックに関する知識のあるユーザを支持します。ルート XML タグ

<topicEndorsement>

JSON

{

"userId" : "005B0000000Ge16"

}

プロパティ



30.0必須項目指定したトピックについて支持されるユーザの ID。

StringuserId

Topic Input

ルート XML タグ<topic>

JSON

{

"description" : "World Wide Web Consortium (W3C) is the main international standards

584

Topic Endorsement InputChatter REST API リクエストボディ

organization for the Web."

"name" : "W3C"}

プロパティ


28.0トピックのテキストによる説明

Stringdescription


String []idsToMerge

メモ: トピックのマージはベータ版で、既知の制限があります。IdeaExchange でフィードバックをお寄せください。

28.0トピックの名前トピック名の大文字、小文字、スペースのみを変

Stringname

更するには、このプロパティを使用します。

User Chatter Settings Input

ユーザのグローバル Chatter 設定。ルート XML タグ

<userChatterSettings>

プロパティ


説明型名前

27.0ユーザが参加するグループからメールを受信するデフォルトの頻度。有効な値は、次のとおりです。


• EachPost

• DailyDigest

• WeeklyDigest

585

User Chatter Settings InputChatter REST API リクエストボディ



説明型名前

• Never


User Input

ルート XML タグ<user>

プロパティ



StringaboutMe


文字です。このプロパティが、コミュニティまたは組織のすべてのメンバーに表示されるユーザプロファイルの [自己紹介] セクションに入力されます。

JSON の例{

"aboutMe": "Staff Technical Writer responsible for the Connect API and Connect inApex documentation."

}

関連トピック:

ユーザプロファイルを更新する

586

User InputChatter REST API リクエストボディ

User Message

ルート XML タグ<message>

プロパティ


23.0メッセージ本文のテキスト

Stringbody

23.0このメッセージが含まれる会話を識別する既存の

StringinReplyTo

メッセージの ID。recipients またはinReplyTo を指定する必要があります。両方ではなく、どちらか一方を指定する必要があります。

23.0目的のメッセージ受信者であるユーザ (最大 9 人)

User Message Recipient ListInput

recipients

のリスト。ユーザ ID のカンマ区切りのリスト。recipients またはinReplyTo を指定する必要があります。両方ではなく、どちらか一方を指定する必要があります。

XML 形式の例:

<message>

<body>Text of the message</body>

<recipients>



</recipients>

<inReplyTo>messageID</inReplyTo>

587

User MessageChatter REST API リクエストボディ

</message>

JSON 形式の例:

{

"body": "Text of the message",

"recipients": ["userID","userID"],

"inReplyTo": "messageID"

}

関連トピック:


User Message Recipient Input

ルート XML タグ<recipient>

プロパティ


23.0メッセージを受信するユーザの 18 文字の ID。

Stringrecipient

User Message Recipient List Input

ルート XML タグ<message>

プロパティ


23.0メッセージを受信する受信者のコレクション。

User Message Recipient Input[]recipients

588

User Message Recipient InputChatter REST API リクエストボディ

User Status Input

メモ: User Status Input を使用したユーザ状況の設定は、バージョン 25.0 以降使用できなくなります。代わりに、Feed Item Input を使用してフィードにフィード項目を post 送信してください。

ルート XML タグ<userStatus>

プロパティ


23.0 ～ 24.0メッセージ本文の説明。Message Body Inputbody

User Stream (Conversation) Input

ルート XML タグ<conversation>

プロパティ




Booleanread

589

User Status InputChatter REST API リクエストボディ

第 7 章 Chatter REST API レスポンスボディ

Chatter REST API リソースへの要求の実行が成功すると、JSON または XML 形式でレスポンスボディが返される場合があります。Chatter REST API リソースへの要求では、要求が成功したかどうかに関係なく、常に HTTP 応答コードが返されます。

Action Link Definition

アクションリンクの定義。この情報を参照するには、アクションリンク定義の作成時に使用した接続アプリケーションを要求で使用する必要があります。



説明型プロパティ名

33.0Small、33.0アクションリンクの URL。たとえば、Uiアクションリンク URL は Web

StringactionUrl

ページになります。Downloadアクションリンク URL は、ダウンロードするファイルへのリンクになります。Uiおよび Downloadアクションリンク URL がクライアントに提供されます。Api または ApiAsync

アクションリンク URL は REST リソースになります。Api およびApiAsyncアクションリンク URL はクライアントに提供されません。Salesforceへのリンクは、相対リンクにすることができます。他のすべてのリンクは、https://で始まる絶対リンクにする必要があります。

33.0Small、33.0ISO 8601 形式の日付文字列 (例:

2011-02-25T18:24:31.000Z)。DatecreatedDate

33.0Small、33.0アクションの実行から除外する単一ユーザの ID。excludedUserId

StringexcludedUserId

を指定した場合、userIdを指定できません。

33.0Small、33.0このアクションがアクションリンクグループのデフォルトアクショ

BooleangroupDefault

ンリンクである場合は true、それ

590




以外の場合は false。各アクションリンクグループに含めることができるデフォルトアクションリンクは 1 つだけです。Salesforce UI では、デフォルトアクションリンクには区別しやすいスタイルが適用されます。

33.0Big、33.0Api および ApiAsync アクションリンク種別の要求ヘッダー。

Request Header[]headers

33.0Small、33.0アクションリンク定義の 18 文字のID。

Stringid

34.0Small、34.0アクションリンクボタンに表示するカスタムの表示ラベル。label

Stringlabel

値は、アクションリンクテンプレートでのみ設定できます。アクションリンクには、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

Action Link DefinitionChatter REST API レスポンスボディ




33.0Small、33.0ユーザインターフェースに表示される表示ラベルのセットのキー。

StringlabelKey

セットには、NewStatus、PendingStatus、SuccessStatus、FailedStatus の状態の表示ラベルが含まれます。たとえば、Approve

キーを使用する場合、[承認]、[待機中]、[承認済み]、[失敗] の表示ラベルが含まれます。「アクションリンクの表示ラベル」を参照してください。

33.0Medium、33.0HTTP メソッド。次のいずれかの値にします。

Stringmethod

• 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





33.0Small、33.0ISO8601 の日付文字列 (例:

2011—02—25T18:24:31.000Z)。DatemodifiedDate

33.0Big、33.0Api および ApiAsync アクションリンク種別のリクエストボディ。

StringrequestBody

33.0Small、33.0ユーザにアクションを確認するように要求する場合は true、それ以外の場合は false。

BooleanrequiresConfirmation

33.0Medium、33.0このアクションリンクのインスタンス化に使用されたアクションリ

StringtemplateId

ンクテンプレートの ID。アクションリンクがテンプレートに関連付けられていない場合、値は null です。

33.0Small、33.0アクションリンクの種別を定義します。値は次のとおりです。

Stringtype

• Api — アクションリンクは、アクション URL で同期 API をコールします。Salesforce は、サーバから返された HTTP 状況コードに基づいて状況をSuccessfulStatus またはFailedStatusに設定します。

• ApiAsync — アクションリンクは、アクション URL で非同期 API

をコールします。アクションは、非同期操作の完了時にサードパーティが/connect/action-links/actionLinkId

への要求を行って状況をSuccessfulStatus またはFailedStatus に設定するまで、PendingStatus 状態のままになります。



593





33.0Small、33.0アクションを実行できるユーザのID。指定しない場合や null の場

StringuserId

合、すべてのユーザがアクションを実行できます。userIdを指定した場合、excludedUserId を指定できません。

Action Link Diagnostic

アクションリンクが実行されたときに REST エンドポイントから返された診断情報。診断情報は、アクションリンクにアクセスできるユーザに対してのみ提供されます。




33.0Small、33.0アクションリンクが実行されたときに REST エンドポイントから返さ

StringdiagnosticInfo

れた診断情報。診断情報は、アクションリンクにアクセスできるユーザに対してのみ提供されます。

33.0Small、33.0このアクションリンク診断情報のChatter REST API URL。

Stringurl

Action Link Group Definition

アクションリンクグループの定義。すべてのアクションリンクはグループに属している必要があります。1 つのグループ内のアクションリンクは、相互排他的で、同じプロパティを共有します。各自のアクショングループでスタンドアロンアクションを定義します。




33.0Medium、33.0アクションリンクグループを構成するアクションリンク定義のコレクション。アクションリンクグループ内では、アクションリンクは、Action Link

Action LinkDefinition[]

actionLinks

Group Definition Input リクエストボディの actionLinksプロパティにリストされる順序で表示されます。

594

Action Link DiagnosticChatter REST API レスポンスボディ




フィード項目内では、アクションリンクグループは、Associated Actions

Capability Input リクエストボディのactionLinkGroupIdsプロパティに指定された順序で表示されます。

33.0Medium、33.0アクションリンクの優先度および位置を示します。値は次のとおりです。

Stringcategory


• Overflow — アクションリンクグループは、フィード要素のオーバーフローメニューに表示されます。

33.0Small、33.0ISO8601 の日付文字列 (例:2011-02-25T18:24:31.000Z)

DatecreatedDate

33.0Medium、33.0アクションリンクを実行できる回数を定義します。値は次のとおりです。

StringexecutionsAllowed

• Once — アクションリンクは、すべてのユーザで 1 回のみ実行できます。

• OncePerUser — アクションリンクは、各ユーザで 1 回のみ実行できます。

• Unlimited — アクションリンクは、各ユーザで無制限に実行できます。アクションリンクのactionType が Api またはApiAsync の場合、この値を使用できません。

33.0Medium、33.0このアクショングループの有効期限が切れて実行できなくなる日時

DateexpirationDate

を表す ISO 8601 日付文字列 (例:

2011-02-25T18:24:31.000Z)。値が null

の場合、有効期限はありません。

595

Action Link Group DefinitionChatter REST API レスポンスボディ




33.0Small、33.0アクションリンクグループ定義の18 文字の ID

Stringid


DatemodifiedDate

33.0Medium、33.0このアクションリンクグループをインスタンス化するアクションリ

StringtemplateId

ンクグループテンプレートの ID。または、このグループがテンプレートに関連付けられていない場合はnull。

33.0Small、33.0このアクションリンクグループ定義の Chatter REST API URL。

Stringurl

Address




23.0Small、29.0市区郡の名前Stringcity

23.0Small、29.0国の名前Stringcountry

25.0Small、29.0ロケールに従って書式設定された住所StringformattedAddress

23.0Small、29.0都道府県などの名前Stringstate

23.0Small、29.0町名・番地Stringstreet

23.0Small、29.0郵便番号Stringzip

Announcement

お知らせは、削除されるか、別のお知らせで置き換えられない限り、その表示期限の 11:59 p.m. までSalesforce UI

の指定の場所に表示されます。




31.0Small、31.0別のお知らせが最初に投稿されていない限り、この日付の 11:59 p.m.

DateexpirationDate

596

AddressChatter REST API レスポンスボディ




まで Salesforce UI にお知らせが表示されます。Salesforce UI では、expirationDate の時間値は無視されます。ただし、時間値を使用して各自の UI で独自の表示ロジックを作成することはできます。

31.0Small、31.0お知らせの本文およびそれに関連するコメントやいいね! などを含むフィード要素。

Feed ItemfeedElement

31.0Small、31.0お知らせの 18 文字の ID。Stringid

33.0Small、33.0お知らせへの URL。Stringurl

Announcement Page

Announcement レスポンスボディのページ設定されたコレクション。




31.0Small、31.0Announcement レスポンスボディのコレクション。お知らせは、削除さ

Announcement[]announcements

れるか、別のお知らせで置き換えられない限り、その表示期限の 11:59

p.m. までSalesforce UI の指定の場所に表示されます。

31.0Medium、31.0現在のページを識別するChatter REST

API URL。StringcurrentPageUrl

31.0Small、31.0次のページを識別する Chatter REST

API URL。次のページがない場合はStringnextPageUrl

null。別のページを取得する前に、この値が nullであるかどうかを確認します。ページが存在しない場合は、ConnectApi.NotFoundException

エラーが返されます。31.0Medium、31.0前のページを識別する Chatter REST

API URL。前のページがない場合はnull。

StringpreviousPageUrl

597

Announcement PageChatter REST API レスポンスボディ

Approval Capability

フィード要素にこの機能がある場合、承認に関する情報が含まれています。




32.0Small、32.0作業項目 ID。承認レコードに関連付けられた保留中の作業項目がない場合、作業項目 ID は null です。

Stringid

32.0Small、32.0承認投稿テンプレート項目の詳細。Approval PostTemplate Field[]

postTemplateFields

32.0Small、32.0プロセスインスタンスステップ ID。関連付けられたレコードが承認プ

StringprocessInstanceStepId

ロセスの 1 つのステップを表します。

32.0Small、32.0承認の状況。次のいずれかの値にします。

Stringstatus

• Approved

• Fault

• Held

• NoResponse

• Pending

• Reassigned

• Rejected

• Removed

• Started

Approval Post Template Field

承認投稿テンプレート項目の説明。




28.0Small、29.0項目名StringdisplayName

28.0Small、29.0項目値。項目が nullに設定されている場合は null。

StringdisplayValue

598

Approval CapabilityChatter REST API レスポンスボディ




28.0Small、29.0レコード ID

レコードが存在しない場合、または参照がnull の場合、この値は null になります。

Referencerecord

Article Item

質問および回答の検索結果に含まれる記事項目。




32.0Small、32.0記事 ID。Stringid

32.0Small、32.0記事の評価。Doublerating

32.0Small、32.0記事のタイトル。Stringtitle

32.0Small、32.0記事のリンク URL。StringurlLink

32.0Small、32.0記事への投票数。IntegerviewCount

Associated Actions Capability

フィード要素にこの機能がある場合、フィード要素にプラットフォームアクションが関連付けられています。




33.0Medium、33.0フィード要素に関連付けられたプラットフォームアクショングルー

Platform ActionGroup[]

platformActionGroups

プ。プラットフォームアクショングループは、Associated Actions

Capability Input リクエストボディに指定された順序で返されます。

Banner Capability

このフィード要素にこの機能がある場合、フィード要素にバナーのモチーフとスタイルが含まれます。

599

Article ItemChatter REST API レスポンスボディ




31.0Small、31.0バナーのモチーフ。Motifmotif

31.0Small、31.0色とアイコンセットでフィード項目を装飾します。

Stringstyle

• Announcement — お知らせは、削除されるか、別のお知らせで置き換えられない限り、その表示期限の 11:59 p.m. まで Salesforce

UI の指定の場所に表示されます。

Batch Result Item




Small、29.0バッチの種別によって異なります。値は次のいずれかになる可能性があります。

種別は、バッチのオブジェクト種別によって異なります。

result

• /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

Batch Result ItemChatter REST API レスポンスボディ




• Motif

/connect/motifs/batch/

idOrPrefixList

(v27.0)

• User Detail

/chatter/users/batch/

userIds

(v23.0)

• /connect/batchの場合、値はバッチ内のサブ要求に応じて、どのレスポンスボディにもなる可能性があります。(v28.0)

23.0Small、29.0バッチ内のこの個別要求の状況を示す HTTP

状況コードIntegerstatusCode

Batch Results




28.0Small、29.0結果セットに HTTP 状況コードが 400 番台または 500 番台の結果が 1 つ以上ある場合はtrue、それ以外の場合は false

BooleanhasErrors

23.0Small、29.0バッチの結果項目のコレクションBatch Result Item[]results

Bookmarks Capability

フィード要素にこの機能がある場合、コンテキストユーザがそのフィード要素をブックマークできます。




32.0Small、32.0現在のユーザがフィード要素をブックマークしているか (true )、否か(false) を示します。


601

Batch ResultsChatter REST API レスポンスボディ

Case Comment Capability

フィード要素にこの機能がある場合、ケースフィードにケースコメントが含まれます。




32.0Small、32.0コメントを行ったユーザの種別を示します。

StringactorType

• Customer — Chatter 顧客がコメントを行った場合

• CustomerService — サービス担当者がコメントを行った場合

32.0Small、32.0コメントを作成したユーザに関する情報。

User Detail またはUser Summary

createdBy



32.0Small、32.0ケースフィードのコメントのイベントタイプを示します。

StringeventType

• NewInternal — 新しく「社内のみ」とマークされたケースコメント。

• NewPublished — 新しく公開されたケースコメント。

• NewPublishedByCustomer —

新しく公開された、顧客によるケースコメント。

• PublishExisting — 再公開された既存のケースコメント。

• PublishExistingByCustomer

— 再公開された、顧客による既存のケースコメント。

• UnpublishExistingByCustomer

— 非公開にされた、顧客による既存のケースコメント。

• UnpublishExsiting — 非公開にされた既存のケースコメント。

メモ: この入力ミスは、ドキュメントではなくコードに含まれています。コード

602

Case Comment CapabilityChatter REST API レスポンスボディ




でこのスペルを使用してください。

32.0Small、32.0ケースコメントの 18 文字の ID。Stringid

32.0Small、32.0コメントが公開されたかどうかを示します。

Booleanpublished

32.0Small、32.0ケースコメントのテキスト。Stringtext

Canvas Capability

フィード要素にこの機能がある場合、キャンバスアプリケーションが表示されます。




32.0Small、32.0キャンバスアプリケーションの説明。最大サイズは 255 文字です。

Stringdescription

32.0Small、32.0接続アプリケーションの API 名 (開発者名)。

StringdeveloperName

32.0Small、32.0キャンバスアプリケーションの高さ (ピクセル単位)。

Stringheight

32.0Small、32.0キャンバスアプリケーションのアイコン。

ConnectApi.Iconicon

32.0Small、32.0キャンバスアプリケーションの一意の名前空間プレフィックス。


32.0Small、32.0キャンバスアプリケーションに渡される JSON パラメータ。

Stringparameters

32.0Small、32.0プレビュー画像へのサムネイルURL。最大サムネイルサイズは、120

× 120 ピクセルです。

StringthumbnailUrl

32.0Small、32.0キャンバスリンクのタイトル。Stringtitle

603

Canvas CapabilityChatter REST API レスポンスボディ

Chatter Activity




23.0Small、29.0ユーザが行った組織またはコミュニティ内のコメントの合計数

IntegercommentCount

23.0Small、29.0ユーザが受け取った組織またはコミュニティ内のコメントの合計数

IntegercommentReceivedCount

23.0Small、29.0ユーザが受け取った組織またはコミュニティ内の投稿とコメントに対するいいね! の合計数

IntegerlikeReceivedCount

23.0Small、29.0ユーザが行った組織またはコミュニティ内の投稿の合計数

IntegerpostCount

Chatter Directory




24.0Small、29.0組織のフィードの一般リソースへの URL を返します。

Stringfeeds

24.0Small、29.0組織のグループの一般リソースへの URL を返します。

Stringgroups

24.0 ～ 26.0Stringorganizationメモ: このプロパティは、バージョン26.0 以降、使用できなくなります。代わりに、Connect Directory でorganizationプロパティを使用します。

接続組織の一般リソースへの URL を返します。

24.0Small、29.0組織のユーザの一般リソースへの URL を返します。

Stringusers

604

Chatter ActivityChatter REST API レスポンスボディ

Chatter Influence




24.0Small、29.0組織またはコミュニティ内でのユーザの影響度ランクを示すパーセント値

Stringpercentile

24.0Small、29.0組織またはコミュニティ内の他の全ユーザに対するユーザの相対的な影響度ランクを示す数値

Integerrank

Chatter Likes Capability

フィード要素にこの機能がある場合、コンテキストユーザがいいね! と言うことができます。既存のいいね! に関する情報が公開されます。




32.0Small、32.0現在のユーザがフィード要素にいいね! と言っているか (true)、否か(false) を示します。

BooleanisLikedByCurrentUser

32.0Small、32.0このフィード要素のいいね! 情報。Like Pagepage

32.0Small、32.0フィード要素にいいね! と言ったユーザを説明するメッセージ本文。

Like Message BodylikesMessage

32.0Medium、32.0コンテキストユーザがフィード要素にいいね! と言った場合はこのプ

ReferencemyLike

ロパティがその特定のいいね! への参照になり、それ以外の場合はnull になります。

ClientInfo




23.0Small、29.0認証に使用される接続アプリケーションの名前詳細は、「接続アプリケーションについて」を参照してください。

StringapplicationName

605

Chatter InfluenceChatter REST API レスポンスボディ




23.0Small、29.0認証に使用される接続アプリケーションの[情報 URL] 項目の値

StringapplicationUrl

Comment




24.0 ～ 31.0Medium、29.0コメントに添付ファイルが含まれないか、添付ファイルが使用できない場合、nullを返

コメントの種別によって異なる

attachment

します。それ以外の場合は、Feed Item

Attachment: Content を返します。


23.0Small、29.0コメントのメッセージ本文Feed Item Bodybody

32.0Medium、32.0コメントに関連付けられた機能。CommentCapabilities

capabilities

23.0Medium、29.0接続の認証に使用される接続アプリケーションに関する情報

ClientInfoclientInfo


StringcreatedDate

32.0Medium、32.0コメントが投稿されたフィード要素。ReferencefeedElement

23.0 ～ 31.0Medium、29.0コメントが投稿されたフィード項目。ReferencefeedItem

重要: バージョン 32.0 以降では、feedElement プロパティを使用します。

23.0Small、29.0コメントの 18 文字の IDStringid

23.0 ～ 24.0BooleanisDeletableメモ: このプロパティは、バージョン25.0 以降、使用できなくなります。代わりに、isDeleteRestricted プロパティを使用してください。

606

CommentChatter REST API レスポンスボディ




コンテキストユーザがコメントを削除できるかどうかを示します。

25.0Medium、29.0コンテキストユーザがコメントを削除できない場合は true を返します。false が返さ

BooleanisDeleteRestricted

れた場合は、コンテキストユーザがコメントを削除できる可能性があります。

24.0Medium、29.0コメントに関連付けられたいいね! のページLike Pagelikes

27.0Medium、29.0コメントにいいね! と言ったユーザを説明するメッセージ本文


23.0Medium、29.0コンテキストユーザがコメントにいいね! と言った場合は、そのいいね! への参照を返します。それ以外の場合は nullを返します。

ReferencemyLike

23.0Big、29.0このコメントに関連付けられたフィード項目の親に関する情報

Referenceparent

28.0Medium、29.0相対的なローカライズされた文字列として書式設定された作成日 (「17 分前」、「昨日」など)

StringrelativeCreatedDate

24.0Small、29.0コメントの種別を示します。有効な値は、次のとおりです。

Stringtype

• ContentComment — コメントに添付ファイルが含まれる

• TextComment — コメントにテキストのみが含まれる

23.0Small、29.0このコメントへの URLStringurl

23.0Small、29.0コメント作成者に関する情報User Summaryuser

Comment Capabilities

コメントに含めることができるすべての機能のコンテナ。

607

Comment CapabilitiesChatter REST API レスポンスボディ




32.0Small、32.0このフィード要素に関連付けられたコンテンツ (添付ファイルなど)。フィード要素からコンテンツが削除された場合、またはアクセス権

Content Capabilitycontent

が非公開に変更された場合、ほとんどの Content Capability プロパティは null になります。

34.0Small、34.0コメントにこの機能がある場合、権限を持つユーザはコメントを編集できます。

Edit Capabilityedit

Comment Page




23.0 ～ 31.0Small、29.0コメントのコレクションComment[]comments


23.0Medium、29.0コメントの現在のページ、つまり最新のコメントの URL。デフォルトの 1 ページあたりのコメント数は 25 個です。

StringcurrentPageUrl

32.0Small、32.0コメントのコレクションComment[]items

23.0Small、29.0コメントの次のページ、つまり以前のコメントへの URL。デフォルトの 1 ページあたりのコメント数は 25 個です。

StringnextPageUrl

23.0Small、29.0親フィード項目の全ページのコメント合計数Integertotal

Comments Capability

フィード要素にこの機能がある場合、コンテキストユーザはコメントを追加できます。

608

Comment PageChatter REST API レスポンスボディ




32.0Small、32.0このフィード要素のコメント情報。Comment Pagepage

Community




31.0Small、31.0ゲストユーザがログインせずにコミュニティの公開グループにアクセスできるかどうかを指定します。

BooleanallowChatterAccessWithoutLogin

30.0Small、30.0コミュニティのメンバーがコンテンツにフラグを設定できるかどうかを指定します。

BooleanallowMembersToFlag

26.0Small、29.0コミュニティの説明Stringdescription

26.0Small、29.0コミュニティの 18 文字の IDStringid

26.0Small、29.0コミュニティのメンバーが他のメンバーをコミュニティに招待できるかどうかを示しま

BooleaninvitationsEnabled

す。できる場合は true、できない場合はfalse となります。

30.0Small、30.0トピックについて、知識のあるユーザと支持を使用できるか (true)、否か (false) を指定します。

BooleanknowledgeableEnabled

26.0Small、29.0コミュニティ名Stringname

32.0Small、32.0コミュニティでニックネームを表示するかどうかを指定します。

BooleannicknameDisplayEnabled

30.0Small、30.0同じコミュニティのメンバー同士が互いに非公開のメッセージを送受信できるか (true)、否か (false) を指定します。

BooleanprivateMessagesEnabled

31.0Small、31.0コミュニティのメンバーに対する評価が計算および表示されるかどうかを指定します。

BooleanreputationEnabled

26.0Small、29.0お知らせメールが自動的に生成されて、新しいメンバーに送信されるかどうかを示しま

BooleansendWelcomeEmail

す。メールが送信される場合は true、送信されない場合は false となります。

609

CommunityChatter REST API レスポンスボディ




26.0Small、29.0お知らせメールが自動的に生成されて、新しいメンバーに送信されるかどうかを示しま

BooleansendWelcomeEmail

す。メールが送信される場合は true、送信されない場合は false となります。

30.0Small、30.0コミュニティのサイト URL (カスタムドメイン + URL プレフィックス)。

StringsiteUrl

28.0Small、29.0コミュニティの状況。値は次のとおりです。Stringstatus

• Live

• Inactive

• UnderConstruction

26.0Small、29.0コミュニティに固有の URL プレフィックスStringurlPathPrefix

26.0Small、29.0コミュニティへのフル URLStringurl

Community Page




26.0Small、29.0現在のユーザが使用できるコミュニティのリスト

Community[]communities

26.0Small、29.0コミュニティの合計数Integertotal

Connect Directory




26.0Small、29.0現在の組織内のコミュニティのリストCommunity[]communities

25.0Small、29.0Chatter 組織への URLStringorganization

610

Community PageChatter REST API レスポンスボディ

Content Capability

フィード要素にこの機能がある場合、添付ファイルがあります。投稿されたフィード要素からコンテンツが削除された場合、またはコンテンツへのアクセス権が非公開に変更された場合、Content Capability は存在しますが、そのプロパティのほとんどが null になります。




32.0Small、32.0ファイルの MD5 チェックサム。Stringchecksum

32.0Small、32.0このファイルに関連付けられた外部データソース、または、外部ファ

Files Connect リポジトリ

contentHubRepository

イルを指し示していない場合はnull。

32.0Small、32.0リンクおよび Google ドキュメントのコンテンツの URL。

StringcontentUrl

32.0Small、32.0添付ファイルの説明。Stringdescription

32.0Small、32.0コンテンツへの URL。StringdownloadUrl

32.0Small、32.0このファイルが指し示す外部 URL、または、外部ファイルを指し示していない場合は null。

StringexternalDocumentUrl

32.0Small、32.0ファイルの拡張子。StringfileExtension

32.0Small、32.0ファイルのサイズ (バイト)。サイズを判定できない場合は、Unknown

を返します。

StringfileSize

32.0Small、32.0ファイルの種類。StringfileType

32.0Medium、32.0ファイルで PDF プレビューを使用できる場合は true。それ以外の場合は false。

BooleanhasPdfPreview

32.0Small、32.0コンテンツの 18 文字の ID。Stringid

32.0Small、32.0ファイルが Salesforce Files Syncと同期されている場合は true、同期されていない場合は false。


32.0Small、32.0ファイルの MIME タイプ。StringmimeType

32.0Small、32.0ファイルの変換リソースへの URL。変換は非同期で処理され、ファイ

StringrenditionUrl

ルのアップロード直後は使用できない場合があります。

611

Content CapabilityChatter REST API レスポンスボディ




32.0Small、32.0ファイルの 240×180 サイズの変換リソースへの URL。変換は非同期で処

StringrenditionUrl240By180

理され、ファイルのアップロード直後は使用できない場合があります。

32.0Small、32.0ファイルの 720 × 480 サイズの変換リソースへの URL。変換は非同期で


処理され、ファイルのアップロード直後は使用できない場合があります。

32.0Small、32.0外部リポジトリファイルのプロパティへのアクセスを提供するChatter

StringrepositoryFileUrl

REST APIリソースの URL。このファイルが外部ファイルを参照していない場合は null。

32.0Big、32.0可能な場合はファイルのテキストプレビュー、それ以外の場合は

StringtextPreview

null です。最大文字数は 200 文字です。

32.0Medium、32.0ファイルの 120×90 ピクセルサイズのプレビュー画像の表示状況。

Stringthumb120By90RenditionStatus

Processing (処理中)、Failed (失敗)、Success (成功)、NA (使用不可の場合)

のいずれかになります。32.0Medium、32.0ファイルの 240 × 180 ピクセルサイ

ズのプレビュー画像の表示状況。Stringthumb240By180

RenditionStatus


のいずれかになります。32.0Medium、32.0ファイルの 720 × 480 ピクセルサイ

ズのプレビュー画像の表示状況。Stringthumb720By480

RenditionStatus


のいずれかになります。32.0Small、32.0ファイルのタイトル。Stringtitle

32.0Medium、32.0ファイルのバージョン ID。StringversionId

612

Content CapabilityChatter REST API レスポンスボディ

Conversation Detail




23.0Medium、29.0会話の 18 文字の IDStringconversationId

23.0Small、29.0会話詳細ページへの URLStringconversationUrl

23.0Small、29.0この会話に参加しているユーザのコレクション

UserSummary[]

members

23.0Small、29.0この会話に含まれるメッセージMessageCollection

messages

23.0Small、29.0この会話内にコンテキストユーザが未読のメッセージがあるかどうか

Booleanread

Conversation Summary




23.0Small、29.0会話の 18 文字の IDStringid

23.0Small、29.0この会話の最新メッセージメッセージlatestMessage

23.0Small、29.0会話に参加しているユーザのコレクションUser Summary[]members

23.0Small、29.0この会話内にコンテキストユーザが未読のメッセージがあるかどうか

Booleanread

23.0Small、29.0会話詳細ページへの URLStringurl

Conversation Summary Collection




23.0Small、29.00 個以上の会話のコレクションConversationSummary[]

conversations

23.0Medium、29.0会話の現在のページへの URLStringcurrentPageUrl

613

Conversation DetailChatter REST API レスポンスボディ




23.0Small、29.0会話の次のページ、つまり、以前の会話へのURL

StringnextPageUrl

Conversation Unread Count




23.0Small、29.0実際の未読会話数が 50 を超えている場合はtrue、50 以下の場合は false

BooleanhasMore

23.0Small、29.0未読会話、つまり未読メッセージを含む会話の数。未読会話数が 50 以下の場合は正確な

IntegerunreadCount

値が返され、50 を超えている場合は 50 が返されます。

Dashboard Component Snapshot

ダッシュボードコンポーネント値がしきい値を超えたときに受信する、ダッシュボードコンポーネントスナップショットとアラートの両方を表します。




32.0Small、32.0ダッシュボードコンポーネントの18 文字の ID。

StringcomponentId

32.0Small、32.0ダッシュボードコンポーネント名。StringcomponentName

32.0Small、32.0このテキストをフィード要素のアクターの横に表示します。このテ

StringdashboardBodyText

キストは、デフォルトの本文テキストの代わりに使用します。

32.0Small、32.0ダッシュボードの 18 文字の ID。StringdashboardId

32.0Small、32.0ダッシュボード名。StringdashboardName

32.0Small、32.0スナップショットのフルサイズ画像を取得するためのソース URL。こ

StringfullSizeImageUrl

614

Conversation Unread CountChatter REST API レスポンスボディ




の URL には、OAuth ログイン情報でアクセスします。

32.0Small、32.0このダッシュボードコンポーネントの最終更新日を示す ISO-8601 形式の日付。

DatelastRefreshDate

32.0Small、32.0最終更新日の表示テキスト (「最終更新 2013 年 10 月 31 日」など)。

StringlastRefreshDateDisplayText

32.0Small、32.0スナップショットが投稿された時点のダッシュボードの実行ユーザ。

User SummaryrunningUser

この値は、nullになる場合があります。各ダッシュボードには実行ユーザがおり、そのユーザのセキュリティ設定によってダッシュボードに表示されるデータが決まります。

32.0Small、32.0スナップショットのサムネイル画像を取得するためのソース URL。こ

StringthumbnailUrl

の URL には、OAuth ログイン情報でアクセスします。

Dashboard Component Snapshot Capability

フィード要素にこの機能がある場合、ダッシュボードコンポーネントスナップショットがあります。スナップショットとは、特定の時点でのダッシュボードコンポーネントの静的な画像です。




32.0Small、32.0ダッシュボードコンポーネントのスナップショット。

DashboardComponentSnapshot

dashboardComponentSnapshot

Datacloud Company

Data.com会社レコード。会社レコードを所有している場合は、すべての項目が表示されます。会社レコードを所有していない場合は、一部の項目が非表示になりアスタリスク (***) が示されます。

615

Dashboard Component Snapshot CapabilityChatter REST API レスポンスボディ




32.0Small、32.0会社の有効な取引先責任者の数。

IntegeractiveContacts

32.0Small、32.0会社の住所。ConnectApi.Addressaddress

32.0Small、32.0会社の 1 年間の売上。DoubleannualRevenue

32.0Small、32.0会社の一意の数値識別子。StringcompanyId

32.0Small、32.0会社の説明。Stringdescription

32.0Small、32.0一意の事業所を識別するために Dun & Bradstreet (D&B) が割り

StringdunsNumber

当てる、ランダムに生成された 9 桁の数値。

32.0Small、32.0会社が事業を行っている重点領域の説明。

Stringindustry

32.0Small、32.0会社情報がもはや正確ではないか (true)、最新の情報か(false)。

BooleanisInactive

32.0Small、32.0自分または所属する組織によって会社が購入されたか(true)、否か (false)。

BooleanisOwned

32.0Small、32.0North American Industry

Classification System (NAICS) コーStringnaicsCode

ドは、企業のサービス指向の詳細を示すために作成されました。このコードの説明は、業務内容に焦点が絞られています。

32.0Small、32.0NAICS 分類の説明。StringnaicsDescription

32.0Small、32.0会社名。Stringname

32.0Small、32.0会社の従業員数。IntegernumberOfEmployees

32.0Small、32.0会社形態の種別。Stringownership

• 公開• 非公開• 政府機関• その他

616

Datacloud CompanyChatter REST API レスポンスボディ




32.0Small、32.0会社の代表電話番号を含む数値文字列。

ConnectApi.PhoneNumberphoneNumbers

32.0Small、32.0Standard Industrial Codes (SIC) は、会社が提供するサービス種別を示す採番規則。

Stringsic

32.0Small、32.0SIC 分類の説明。StringsicDescription

32.0Small、32.0会社の所在地の種類 (「本社」など)。

Stringsite

32.0Small、32.0公開証券取引所で取引される、会社を一意に識別する記号。

StringtickerSymbol

32.0Small、32.0公開証券取引所で取引される、会社を一意に識別する記号。

StringtradeStyle

32.0Small、32.0この会社の情報の最終更新日。

DateupdatedDate

32.0Small、32.0会社の Web サイトへの URL。Stringwebsite

32.0Small、32.0会社の創立年。StringyearStarted

Datacloud Company Collection

特定の注文で購入されたすべての会社の購入の詳細。




32.0Small、32.0特定の注文のすべての会社のリスト。

ConnectApi.DatacloudCompanycompanies

32.0Medium、32.0会社の現在のページへの URL。StringcurrentPageUrl

32.0Small、32.0会社の次のページへの URL。次のページがない場合、値はnull です。

StringnextPageUrl

617

Datacloud Company CollectionChatter REST API レスポンスボディ




32.0Medium、32.0会社の前のページへの URL。前のページがない場合、値はnull です。


32.0Small、32.0注文に含まれる会社数。ユーザは、1 ページにつき何件の会

Integertotal

社を表示するかを設定できます。デフォルトのページサイズは 25 です。

Datacloud Contact

Data.comの取引先責任者に関する情報。取引先責任者を所有している場合は、すべての項目が表示されます。取引先責任者を所有していない場合は、一部の項目が非表示になりアスタリスク (***) が示されます。




32.0Small、32.0この取引先責任者が勤務する会社の郵送先住所。

ConnectApi.Address[]address

32.0Small、32.0取引先責任が勤務する会社の一意の数値識別子。

StringcompanyId

32.0Small、32.0取引先責任者が勤務する会社の名前。

StringcompanyName

32.0Small、32.0取引先責任者の一意の数値識別子。

StringcontactId

32.0Small、32.0取引先責任者が所属する部門の名前。

Stringdepartment

32.0Small、32.0この取引先責任者のメールアドレス。

Stringemail

32.0Small、32.0取引先責任者の名。StringfirstName

32.0Small、32.0true または false の応答。true はレコードがもう有効で

BooleanisInactive

はないことを示します。false

は、取引先責任者がまだ有効であることを示します。

618

Datacloud ContactChatter REST API レスポンスボディ




32.0Small、32.0組織がこの取引先責任者を所有しているかどうかを示します。

BooleanisOwned

32.0Small、32.0取引先責任者の姓。StringlastName

32.0Small、32.0会社での人の役職レベルを指定する人事の表示ラベル。

Stringlevel

32.0Small、32.0取引先責任者の直通電話番号を含む数値文字列。

ConnectApi.PhoneNumber[]phoneNumbers

32.0Small、32.0取引先責任者の役職。Stringtitle

32.0Small、32.0この取引先責任者の情報の更新日。

DateupdatedDate

Datacloud Contact Collection

特定の注文で購入されたすべての取引先責任者の購入の詳細。




32.0Small、32.0特定の orderIdのすべての取引先責任者のリスト。

ConnectApi.DatacloudContact[]contacts

32.0Medium、32.0取引先責任者の現在のページ。

StringcurrentPageUrl

32.0Small、32.0取引先責任者の次のページへの URL。取引先責任者に 1 ペー

StringnextPageUrl

ジしかない場合、値は null です。

32.0Medium、32.0取引先の前のページへの URL。取引先責任者に 1 ページしかない場合、値は null です。


32.0Small、32.0この注文に関連付けられた取引先責任者の数。取引先責任

Integertotal

者の総数は、1 ページに表示される取引先責任者の数よりも多くなる可能性があります。

619

Datacloud Contact CollectionChatter REST API レスポンスボディ

Datacloud Order

購入した Data.com レコードに関する情報と購入の詳細。




32.0Small、32.0特定の注文で購入されたレコードのリストへの URL。

StringentityUrl

32.0Small、32.0特定の注文を識別する orderId。Stringid

32.0Small、32.0この注文で購入されたレコードの数。

IntegerpurchaseCount

32.0Small、32.0レコードが購入された日付。DatepurchaseDate

32.0Small、32.0特定の注文の注文情報への URL。Stringurl

Datacloud Purchase Usage

組織のData.com購入利用状況に関する情報。月次ユーザおよびリストプールユーザの使用済みのクレジットおよび使用可能なクレジットを示します。




32.0Small、32.0リストプールグループのすべてのユーザが使用できるリストプールクレジット。

IntegerlistpoolCreditsAvailable

32.0Small、32.0リストプールグループのすべてのユーザによって使用されたリストプールクレジット。

IntegerlistpoolCreditsUsed

32.0Small、32.0特定のユーザに割り当てられた 1 か月あたりのクレジット。

IntegermonthlyCreditsAvailable

32.0Small、32.0特定のユーザによって 1 か月間に使用されたクレジット。

IntegermonthlyCreditsUsed

Edit Capability

フィード要素またはコメントにこの機能がある場合、権限を持つユーザはフィード要素またはコメントを編集できます。

620

Datacloud OrderChatter REST API レスポンスボディ




34.0Small、34.0このフィード要素またはコメントの編集が制限されているかどうか

BooleanisEditRestricted

を指定します。trueの場合、コンテキストユーザはこのフィード要素またはコメントを編集できません。false の場合、コンテキストユーザにこのフィード要素またはコメントを編集する権限がある場合とない場合があります。コンテキストユーザがフィード要素またはコメントを編集できるかどうかを判別するには、Feed Elements,

Editability または Comment Capability,

Editability リソースを使用します。34.0Medium、34.0コンテキストユーザがこのフィー

ド要素またはコメントを編集できStringisEditable

ByMeUrl

るかどうかをチェックするためのURL。

34.0Small、34.0このフィード要素またはコメントを最後に編集したユーザ。

User DetaillastEditedBy

34.0Small、34.0このフィード要素またはコメントの最終編集日。

DatelastEditedDate

34.0Small、34.0このフィード要素またはコメントの最新リビジョン。

IntegerlatestRevision

34.0Small、34.0相対的な最終編集日 (「2 時間前」など)。

StringrelativeLastEditedDate

Email Address

ケースフィードのケースレコードから送信されたメールメッセージのメールアドレス。




29.0Small、29.0メールアドレスの表示名StringdisplayName

29.0Small、29.0メールアドレスStringemailAddress

621

Email AddressChatter REST API レスポンスボディ

Email Message Capability

フィード要素にこの機能がある場合、ケースからのメールメッセージが含まれます。




32.0Small、32.0メールメッセージの方向。値は次のとおりです。

Stringdirection

• Inbound — インバウンドメッセージ (顧客が送信)。

• Outbound — アウトバウンドメッセージ (サポートエージェントが顧客に送信)。

32.0Small、32.0メールメッセージの ID。StringemailMessageId

32.0Small、32.0メールメッセージの件名。Stringsubject

32.0Big、32.0メールメッセージの本文。StringtextBody

32.0Small、32.0メールメッセージの宛先アドレス。Email Address[]toAddresses

Enhanced Link Capability

フィード要素にこの機能がある場合、アイコン、タイトル、説明などの補足情報を表示するリンクがあります。




32.0Small、32.0最大 500 文字の説明。Stringdescription

32.0Small、32.0アイコン。Iconicon

32.0Small、32.0リンク URL がSalesforceレコードを参照する場合に、そのリンクに関連付けられた ID。

StringlinkRecordId

32.0Small、32.0使用可能なコンテンツをインライン表示できない場合の詳細ページへのリンク URL。

StringlinkUrl

32.0Small、32.0詳細ページのタイトル。Stringtitle

622

Email Message CapabilityChatter REST API レスポンスボディ

Error Message




23.0Small、29.0エラーに関する情報を示すエラーコード(INSUFFICIENT_PRIVILEGES など)

StringerrorCode

23.0Small、29.0エラーの説明Stringmessage

Error with Output




27.0Small、29.0エラーの説明Stringmessage

27.0Small、29.0要求されたリソースで記述されるレスポンスボディ。たとえば、要求に成功すると Like レ

任意のレスポンスボディ

output

スポンスボディが返され、エラーが発生すると Error with Output レスポンスボディが返される場合、output プロパティの値は Like レスポンスボディになります。

Explanation Details

一部のおすすめの詳細説明を表します。




24.0Small、29.0おすすめの詳細情報。typeプロパティの値によって返される内容が異なります。

不特定data

• UserFollowsSameUsers — ユーザとおすすめユーザの両方がフォローしている人。「User Summary」を参照してください。

• GroupMembersFollowed — おすすめグループのメンバーのうち、ユーザがフォローしている人。「User Summary」を参照してください。

623

Error MessageChatter REST API レスポンスボディ




• UserViewingSameRecords — ユーザとおすすめユーザが最近表示したレコード。「Record Summary」を参照してください。

• RecordParentOfFollowed — おすすめレコードの子レコードのうち、ユーザがフォローしているレコード。「Record

Summary」を参照してください。

24.0Small、29.0おすすめの概要説明。Stringsummary

24.0Small、29.0おすすめの理由を示します。Stringtype

• Custom — カスタムのおすすめ。• FilePopular — フォロワー数または参

照数の多いファイル• FileViewedTogether — コンテキスト

ユーザが参照している他のファイルと同時に参照されることが多いファイル

• FollowedTogetherWithFollowees —

コンテキストユーザがフォローしているユーザと共にフォローされることが多いユーザ

• GroupMembersFollowed — コンテキストユーザがフォローしているメンバーのグループ

• GroupNew — 最近作成されたグループ• GroupPopular — 多くの有効なメンバー

がいるグループ• ItemViewedTogether — コンテキスト

ユーザが参照している他のレコードと同時に参照されることが多いレコード

• PopularApp — 人気のあるアプリケーション

• RecordOwned — コンテキストユーザが所有するレコード

• RecordParentOfFollowed — コンテキストユーザがフォローしているレコードの親レコード

624

Explanation DetailsChatter REST API レスポンスボディ




• RecordViewed — コンテキストユーザが最近参照したレコード

• UserDirectReport — コンテキストユーザの直属の部下

• UserFollowedTogether — コンテキストユーザがフォローしている他のユーザと同時にフォローされることが多いユーザ

• UserFollowsSameUsers — コンテキストユーザと同じユーザをフォローしているユーザ

• UserManager — コンテキストユーザのマネージャ

• UserNew — 最近作成されたユーザ• UserPeer — コンテキストユーザと同じ

マネージャに直属するユーザ• UserPopular — フォロワー数の多いユー

ザ• UserViewingSameRecords — コンテキ

ストユーザと同じレコードを参照しているユーザ

Explanation Summary

おすすめの概要説明を表します。




24.0Small、29.0説明の詳細の URL。おすすめに詳細説明がない場合は null。

StringdetailsUrl

23.0Small、29.0おすすめの概要説明。Stringsummary

24.0Small、29.0おすすめの理由を示します。Stringtype

• Custom — カスタムのおすすめ。• FilePopular — フォロワー数または参

照数の多いファイル

625

Explanation SummaryChatter REST API レスポンスボディ




• FileViewedTogether — コンテキストユーザが参照している他のファイルと同時に参照されることが多いファイル

• FollowedTogetherWithFollowees —

コンテキストユーザがフォローしているユーザと共にフォローされることが多いユーザ

• GroupMembersFollowed — コンテキストユーザがフォローしているメンバーのグループ

• GroupNew — 最近作成されたグループ• GroupPopular — 多くの有効なメンバー

がいるグループ• ItemViewedTogether — コンテキスト

ユーザが参照している他のレコードと同時に参照されることが多いレコード

• PopularApp — 人気のあるアプリケーション

• RecordOwned — コンテキストユーザが所有するレコード

• RecordParentOfFollowed — コンテキストユーザがフォローしているレコードの親レコード

• RecordViewed — コンテキストユーザが最近参照したレコード

• UserDirectReport — コンテキストユーザの直属の部下

• UserFollowedTogether — コンテキストユーザがフォローしている他のユーザと同時にフォローされることが多いユーザ

• UserFollowsSameUsers — コンテキストユーザと同じユーザをフォローしているユーザ

• UserManager — コンテキストユーザのマネージャ

• UserNew — 最近作成されたユーザ

626

Explanation SummaryChatter REST API レスポンスボディ




• UserPeer — コンテキストユーザと同じマネージャに直属するユーザ

• UserPopular — フォロワー数の多いユーザ

• UserViewingSameRecords — コンテキストユーザと同じレコードを参照しているユーザ

Favorite




26.0Medium、29.0コミュニティに関する情報。デフォルトのコミュニティにお気に入りが存在するか、コ

Referencecommunity

ミュニティが無効である場合は、nullが返されます。

24.0Medium、29.0お気に入りの最初の作成者に関する情報User SummarycreatedBy

24.0Small、29.0このお気に入りのフィード項目への URLStringfeedUrl

24.0Small、29.0お気に入りの 18 文字の IDStringid

24.0Medium、29.0ISO8601 の日付文字列 (例:2011-02-25T18:24:31.000Z)

StringlastViewDate

24.0Small、29.0お気に入りの名前Stringname

24.0Medium、29.0お気に入りが検索に基づく場合は検索テキストが含まれ、それ以外の場合は nullになります。

StringsearchText

28.0Small、29.0該当する場合はトピックへの参照、それ以外の場合は null

Referencetarget

24.0Small、29.0次のいずれかの値になります。Stringtype

• ListView

• Search

• Topic

24.0Small、29.0このお気に入りへの URLStringurl

627

FavoriteChatter REST API レスポンスボディ




24.0Medium、29.0このお気に入りを保存したユーザに関する情報

User Summaryuser

Favorites Page




24.0Small、29.01 つ以上のお気に入りのコレクションFavorite[]favorites

24.0Small、29.0お気に入りの合計数Integertotal

Features

コンテキストユーザが使用できる機能。機能が無効な場合は、その機能に関連付けられたリソースを使用できず、オブジェクトの機能に関連する一部のプロパティが null に設定されます。




27.0Small、29.0組織で Chatter が有効になっているかどうかを指定します。

Booleanchatter

24.0Small、29.0ユーザの詳細に Chatter 活動に関する情報が含まれるかどうかを示します。

BooleanchatterActivity

29.0Small、29.0Chatter アンサーが有効になっているかどうかを示します。

BooleanchatterAnswers

24.0Small、29.0ユーザの詳細にグローバル Chatter 活動が含まれるかどうかを示します。

BooleanchatterGlobalInfluence

33.0Small、33.0Chatter グループにレコードを関連付けられるかどうかを指定します。

BooleanchatterGroupRecords

33.0Small、33.0Chatter レコードがグループに追加されたとき、そのレコードがグループメンバー間で暗黙的に共有されるかどうかを指定します。

BooleanchatterGroupRecordSharing

24.0Small、29.0Chatterメッセージが組織で有効になっているかどうかを示します。

BooleanchatterMessages

628

Favorites PageChatter REST API レスポンスボディ




28.0Small、29.0Chatterトピックが有効かどうかを示します。BooleanchatterTopics

31.0Small、31.0Salesforce Communitiesが有効になっているかどうかを示します。

BooleancommunitiesEnabled

29.0Small、29.0この組織でコミュニティモデレーションが有効になっているかどうかを示します。

BooleancommunityModeration

32.0Small、32.0この組織のコミュニティで評価が有効になっているかどうかを示します。

BooleancommunityReputation

24.0Small、29.0ユーザがダッシュボードコンポーネントスナップショットを投稿できるかどうかを示します。

BooleandashboardComponentSnapshots

28.0Small、29.0デフォルト通貨の ISO コード。multiCurrency が false に設定されている場合のみ有効です。

StringdefaultCurrencyIsoCode

24.0Small、29.0is-modified リソースが Chatter REST APIで有効かどうかを示します。

BooleanfeedPolling

24.0Small、29.0ファイルが Chatter REST API のリソースとして機能できるかどうかを示します。

Booleanfiles

24.0Small、29.0ファイルをコメントに添付できるかどうかを示します。

BooleanfilesOnComments

28.0 ～ 29.0Small、29.0将来の使用のために予約されています。BooleangroupsCanFollow

29.0Small、29.0アイデアが有効になっているかどうかを示します。

Booleanideas

32.0Small、32.0コミュニティホームフィードと管理トピックフィードへのアクセスを示します。

BooleanmanagedTopicsEnabled

29.0Small、29.0将来の使用のために予約されています。BooleanmobileNotificationsEnabled

28.0Small、29.0ユーザの組織がマルチ通貨を使用するか(true)、否か (false) を示します。falseの

BooleanmultiCurrency

場合、defaultCurrencyIsoCodeはデフォルト通貨の ISO コードを示します。

28.0Small、29.0パブリッシャーアクションが有効かどうかを示します。

BooleanpublisherActions

629

FeaturesChatter REST API レスポンスボディ




30.0Small、30.0Salesforce1 ダウンロード可能アプリケーションがモバイルデバイス上の安全な永続スト

BooleanstoreDataOnDevicesEnabled レージを使用してデータをキャッシュできる

かどうかを示します。24.0Small、29.0トピックのトレンドが有効かどうかを示しま

す。BooleantrendingTopics

24.0Small、29.0既存の Chatter ユーザが同僚を Chatter に招待できるかどうかを示します。

BooleanviralInvitesAllowed

Feed




31.0Small、31.0この件名に対するフィード要素を投稿するための URL

HTTP ヘッダー X-Connect-Bearer-Urls:

trueを含む要求によって返される場合、URL

StringfeedElementPostUrl

にベアラートークンが含まれます。このベアラートークン URL を使用して、POST 要求を実行します。

31.0Small、31.0フィード要素の URLStringfeedElementsUrl

23.0 ～ 31.0Small、29.0フィード項目の URLStringfeedItemsUrl

23.0Small、29.0フィードがいつ最終更新されたのかが記述された不透明トークンを含む since 要求パラ

StringisModifiedUrl

メータがあるNews Feed Is-Modifiedリソース。フィードがニュースフィードではない場合はnull を返します。

630

FeedChatter REST API レスポンスボディ

Feed Directory




24.0Small、29.0コンテキストユーザが保存したお気に入りのコレクション。

Favorite[]favorites

23.0Small、29.0コンテキストユーザに表示が許可されているフィードディレクトリ項目のコレクション。

Feed Directory Item[]feeds

Feed Directory Item

フィードの定義。




31.0Small、31.0特定のフィードのフィード要素のリソースへの URL。次に例を示します。/chatter/feeds/files/me/feed-elements

StringfeedElementsUrl

23.0 ～ 31.0Small、29.0特定のフィードのフィード項目のリソースへの URL。次に例を示します。/chatter/feeds/files/me/feed-elements

StringfeedItemsUrl

30.0Big、30.0フィード種別。次のいずれかの値にします。StringfeedType

• Bookmarks — コンテキストユーザがブックマークとして保存したすべてのフィード項目が含まれます。

• Company — 種別 TrackedChange のフィード項目を除くすべてのフィード項目が含まれます。ユーザがフィード項目を表示するには、親への共有アクセス権が必要です。

• Files — コンテキストユーザがフォローしている人またはグループによって投稿されたファイルを含むすべてのフィード項目が含まれます。

• Filter — 指定したオブジェクト種別の親を持つフィード項目を含むように絞り

631

Feed DirectoryChatter REST API レスポンスボディ




込まれたニュースフィードが含まれます。

• Groups — コンテキストユーザが所有するか、メンバーであるすべてのグループのすべてのフィード項目が含まれます。

• Home — コミュニティの管理トピックに関連付けられたすべてのフィード項目が含まれます。

• Moderation — モデレーション用にフラグが設定されたすべてのフィード項目が含まれます。このコミュニティモデレーションフィードは、「コミュニティフィードのモデレート」権限を持つユーザのみが使用できます。

• News — コンテキストユーザがフォローする人、ユーザがメンバーとなっているグループ、およびユーザがフォローするファイルとレコードからのすべての更新が含まれます。また、親がコンテキストユーザであるレコード、およびコンテキストユーザをメンションするかコンテキストユーザがメンバーとなっているグループをメンションするすべてのフィード項目とコメントのすべての更新も含まれます。

• People — コンテキストユーザがフォローしているすべての人によって投稿されたすべてのフィード項目が含まれます。

• Record — 親が指定したレコードであるすべてのフィード項目が含まれます。レコードは、グループ、ユーザ、オブジェクト、ファイル、その他の標準またはカスタムオブジェクトの場合があります。レコードがグループの場合、フィードにはそのグループにメンションしているフィード項目も含まれます。レコードがユーザの場合、フィードにはそのユーザに対するフィード項目のみが含まれます。

632

Feed Directory ItemChatter REST API レスポンスボディ




• To — コンテキストユーザのメンションを含むすべてのフィード項目、コンテキストユーザがコメントしたフィード項目、コンテキストユーザが作成し、コメントされたフィード項目が含まれます。

• Topics — 指定したトピックを含むすべてのフィード項目が含まれます。

• UserProfile — フィードで追跡可能なレコードをユーザが変更したときに作成されたフィード項目、親がユーザであるフィード項目、およびユーザに @メンションしているフィード項目が含まれます。このフィードは、グループ更新など、より多くのフィード項目を返すニュースフィードとは異なります。

23.0Small、29.0特定のフィードのリソースへの URL。次に例を示します。/services/data/v34.0/

chatter/feeds/files/me

StringfeedUrl

30.0Big、30.0条件フィードの場合、この値は、このフィードの絞り込みに使用されるエンティティ種別

StringkeyPrefix

に関連付けられたキープレフィックスです。このフィードのすべてのフィード項目では、親のエンティティ種別がこのキープレフィックス値と一致します。条件以外のフィードの場合、この値は null です。キープレフィックスは、レコード ID の先頭3 文字で、エンティティ種別を示します。

23.0Small、29.0グループ、人、会社など、フィードの名前Stringlabel

Feed Element Capabilities

フィード要素に含めることができるすべての機能のコンテナ。API バージョン 30.0 以前では、各フィード項目にコメント、いいね!、トピックなどを含めることができました。バージョン 31.0 以降では、各フィード項目 (およびフィード要素) に一意の機能セットを含めることができま

633

Feed Element CapabilitiesChatter REST API レスポンスボディ

す。フィード要素に機能プロパティが存在する場合、機能プロパティに値がなくてもその機能を使用できます。たとえば、ChatterLikes機能プロパティがフィード要素に存在している場合、(値の有無に関係なく) コンテキストユーザはそのフィード要素にいいね! と言うことができます。機能プロパティが存在しない場合、そのフィード要素にいいね! と言うことはできません。機能には、関連データを含めることもできます。たとえば、Moderation 機能には、モデレーションフラグに関するデータが含まれます。




32.0Small、32.0フィード要素にこの機能がある場合、承認に関する情報が含まれています。

Approval Capabilityapproval

31.0Small、31.0フィード要素にこの機能がある場合、フィード要素にプラット

Associated ActionsCapability

associatedActions

フォームアクションが関連付けられています。

31.0Small、31.0このフィード要素にこの機能がある場合、フィード要素にバナーの

Banner Capabilitybanner

モチーフとスタイルが含まれます。

31.0Small、31.0フィード要素にこの機能がある場合、コンテキストユーザがその

BookmarksCapability

bookmarks

フィード要素をブックマークできます。

31.0Small、31.0フィード要素にこの機能がある場合、フィード要素は 1 つのフィー

Generic BundleCapability

または

bundle

ド要素に集約された他のフィード要素のグループとなることができます。

Tracked ChangeBundle Capability

32.0Small、32.0フィード要素にこの機能がある場合、キャンバスアプリケーションを表示します。

Canvas Capabilitycanvas

32.0Small、32.0フィード要素にこの機能がある場合、ケースフィード上にケースコメントがあります。

Case CommentCapability

caseComment

31.0Small、31.0フィード要素にこの機能がある場合、コンテキストユーザはいいね!

Chatter LikesCapability

chatterLikes

と言うことができます。既存のいいね! に関する情報が公開されます。

634





31.0Small、31.0フィード要素にこの機能がある場合、コンテキストユーザはコメントを追加できます。

CommentsCapability

comments

32.0Small、32.0フィード要素にこの機能がある場合、添付ファイルがあります。フィード要素からコンテンツが削除された場合、またはアクセス権

Content Capabilitycontent

が非公開に変更された場合、ほとんどの Content Capability プロパティは null になります。

32.0Small、32.0フィード要素にこの機能がある場合、ダッシュボードコンポーネン

DashboardComponentSnapshot Capability

dashboardComponentSnapshot

トのスナップショットがあります。スナップショットとは、特定の時点でのダッシュボードコンポーネントの静的な画像です。

34.0Small、34.0フィード要素にこの機能がある場合、権限を持つユーザはフィード要素を編集できます。

Edit Capabilityedit

32.0Small、32.0フィード要素にこの機能がある場合、ケースからのメールメッセージがあります。

Email MessageCapability

emailMessage

32.0Small、32.0フィード要素にこの機能がある場合、このフィード要素には、アイ

Enhanced LinkCapability

enhancedLink

コン、タイトル、説明などの補足情報が表示されるリンクがあります。

32.0Small、32.0フィード要素にこの機能がある場合、リンクがあります。

Link Capabilitylink

31.0Small、31.0フィード要素にこの機能がある場合、コミュニティのユーザは

ModerationCapability

moderation

フィード要素にモデレーションフラグを設定できます。このレスポンスボディには、フラグが設定されたコンテンツに関する情報も含まれます。

635





31.0Small、31.0フィード要素にこの機能がある場合、フィード要素に投票のアンケートを含めることができます。

Poll Capabilitypoll

33.0Small、33.0フィード要素にこの機能がある場合、そのフィード要素はフィード

Origin Capabilityorigin

アクションによって作成されています。

31.0Small、31.0フィード要素にこの機能がある場合、質問があり、フィード要素の

Question andAnswers Capability

questionAndAnswers

コメントはその質問への回答です。

32.0Small、32.0フィード要素にこの機能がある場合、おすすめがあります。

RecommendationsCapability

recommendations

32.0Small、32.0フィード要素にこの機能がある場合、1 つのレコード作成イベントに

Record SnapshotCapability

recordSnapshot

ついて、レコードのスナップショットとして取得された項目すべてが含まれます。

31.0Small、31.0フィード要素にこの機能がある場合、コンテキストユーザはトピッ

Topics Capabilitytopics

クを追加できます。トピックは、ユーザが会話を整理して検索するために役立ちます。

32.0Small、32.0フィード要素にこの機能がある場合、1 つの変更追跡イベントについ

Tracked ChangesCapability

trackedChanges

て、レコードへのすべての変更が含まれます。

Feed Element Page

ページ設定された結果を含むフィード要素のコンテナ。




31.0Medium、31.0現在のページを識別するChatter

REST API URL。StringcurrentPageUrl

636

Feed Element PageChatter REST API レスポンスボディ




31.0Small、31.0フィード要素のコレクション。フィード要素は次のいずれかになります。

elements

• 汎用フィード要素• Feed Item

31.0Medium、31.0ニュースフィードがいつ最終更新されたのかを記述する不透明

StringisModifiedToken

ポーリングトークン。これは、/chatter/feeds/news/me/feed-elements/is-modified

リソースの since要求パラメータの値として使用します。

31.0Medium、31.0フィードがいつ最終更新されたのかが記述された不透明トーク

StringisModifiedUrl

ンを含む since 要求パラメータがある Chatter REST API URL。フィードがニュースフィードでない場合は null を返します。この URL は、ニュースフィードをポーリングして更新する場合に使用します。

31.0Small、31.0次のページを識別するトークン。次のページがない場合はnull。

StringnextPageToken

31.0Small、31.0次のページを識別する Chatter

REST API URL。次のページがないStringnextPageUrl

場合は null。別のページを取得する前に、この値が null であるかどうかを確認します。ページが存在しない場合は、ConnectApi.NotFoundException

エラーが返されます。31.0Big、31.0updatedSinceパラメータで使

用するトークン。使用できないStringupdatesToken

場合は null です。ニュースフィードがいつ最終更新されたのかを記述する不透明ポーリングトークン。これ

637

Feed Element PageChatter REST API レスポンスボディ




は、/chatter/feeds/news/me/feed-elementsリソースの updatedSince 要求パラメータの値として使用します。

31.0Big、31.0フィードの更新以降に更新されたフィード要素を含む

StringupdatesUrl


リソース。フィードが更新のポーリングをサポートしていない場合、値は null です。

Feed Entity Is Editable

コンテキストユーザがフィード要素またはコメントを編集できるかどうかを示します。




34.0Small、34.0フィード要素またはコメントのURL。

StringfeedEntityUrl

34.0Small、34.0コンテキストユーザがフィード要素またはコメントを編集できる場

BooleanisEditableByMe

合は true、それ以外の場合はfalse。

Feed Item

フィードは、フィード要素で構成されます。フィード項目は、フィード要素の種類の 1 つです。




Small、29.0フィード項目を作成したエンティティ。値は次のとおりです。

親によって異なる

actor

• Record Summary — レコードの場合 (23.0)

• User Summary — ユーザの場合 (23.0)

638

Feed Entity Is EditableChatter REST API レスポンスボディ




• Unauthenticated User — Chatter 顧客の場合(24.0)

メモ: アクターがユーザである場合、User Summary レスポンスボディが返され、ユーザ種別の Record Summary は返されません。

Medium、29.0添付ファイルの type 値によって異なります。次のような値があります。

種別によって異なる

attachment

• 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プロパティを使用します。

23.0Small、29.0フィード項目に関する情報。API バージョン 28.0 以前では、/body/text

プロパティをテキスト表示のデフォルトケー

Feed Item Bodybody

スとして使用します。API バージョン 29.0 ～

639

Feed ItemChatter REST API レスポンスボディ




30.0 では、/preamble/textプロパティをテキスト表示のデフォルトケースとして使用します。API バージョン 31.0 以降では、/header/text プロパティをテキスト表示のデフォルトケースとして使用します。

31.0Medium、31.0フィード要素に関する補助情報。フィード要素の特性は、これらの機能で構成されます。

Feed ElementCapabilities

capabilities

27.0Medium、29.0フィード項目を共有できる場合は true、それ以外の場合は false

BooleancanShare

23.0Medium、29.0接続の認証に使用される接続アプリケーションに関する情報

ClientInfoclientInfo

23.0 ～ 31.0Small、29.0このフィード項目へのコメント。Comment Pagecomments

重要: API バージョン 32.0 以降では、capabilities.comments.pageプロパティを使用します。


StringcreatedDate

23.0 ～ 24.0ReferencecurrentUserLikeメモ: このプロパティは、バージョン24.0 以降、使用できなくなります。代わりに、myLike プロパティを使用してください。

該当する場合は Like オブジェクトへの参照、それ以外の場合は null。

23.0Medium、29.0フィード項目が行動の変更によって作成された場合は true、それ以外の場合は false

Booleanevent

31.0Small、31.0フィード要素は、フィードに含まれる最上位のオブジェクトです。フィード要素の種類


は、このフィード要素の特徴を記述します。次のいずれかの値にします。• Bundle — フィード要素のコンテナ。バ

ンドルには、メッセージセグメントを構成する本文も含まれます。メッセージセグメントは、テキストのみの値に常に適切に分解できます。

640





• FeedItem — フィード項目には 1 つの親があり、その範囲は 1 つのコミュニティまたはすべてのコミュニティになります。フィード項目にはブックマーク、キャンバス、コンテンツ、コメント、リンク、アンケートなどの機能を設定できます。フィード項目には、メッセージセグメントを構成する本文が含まれます。メッセージセグメントは、テキストのみの値に常に適切に分解できます。

• Recommendation — おすすめは、おすすめ機能を備えたフィード要素です。おすすめは、コンテキストユーザに、フォローするレコード、参加するグループ、または役に立つアプリケーションを推奨します。

31.0Medium、31.0ヘッダーは投稿のタイトルです。このプロパティには、メッセージのすべてのセグメント

Feed Item Bodyheader

に対する表示可能なプレーンテキストが含まれます。クライアントでフィード要素の種類の表示方法がわからない場合、このテキストが表示されます。

23.0Small、29.0フィード項目の 18 文字の IDStringid

24.0 ～ 31.0Medium、29.0現在のユーザがこのフィード項目をブックマークしている場合は true、それ以外の場合は false。


重要: API バージョン 32.0 以降では、capabilities.bookmarks.isBookmarkedByCurrentUser


25.0Medium、29.0コンテキストユーザがフィード項目を削除できない場合は true を返します。false が

BooleanisDeleteRestricted

返された場合、コンテキストユーザがコメントを削除できる可能性があります。

641





23.0 ～ 31.0Medium、29.0現在のユーザがこのフィード項目にいいね!

と言った場合は true、それ以外の場合はfalse。

BooleanisLikedByCurrentUser

重要: API バージョン 32.0 以降では、capabilities.chatterLikes.isLikedByCurrentUser


23.0 ～ 31.0Medium、29.0このフィード項目へのいいね!。Like Pagelikes

重要: API バージョン 32.0 以降では、capabilities.chatterLikes.page


27.0 ～ 31.0Small、29.0フィード項目にいいね! と言ったユーザを説明するメッセージ本文。


重要: API バージョン 32.0 以降では、capabilities.chatterLikes.likesMessage



StringmodifiedDate

29.0 ～ 31.0Big、29.0このフィード項目のフラグ。コミュニティモデレータは、フラグ付き項目を表示したり、

Moderation FlagsmoderationFlags

フラグ付き項目に対してアクションを実行したりできます。Features レスポンスボディのcommunityModeration プロパティがfalse の場合、このプロパティは null になります。

重要: API バージョン 32.0 以降では、capabilities.moderation.moderationFlags


23.0 ～ 31.0Medium、29.0コンテキストユーザがコメントにいいね! と言った場合はその特定のいいね! への参照、それ以外の場合は null。

ReferencemyLike

重要: API バージョン 32.0 以降では、capabilities.chatterLikes.myLike


642





24.0Small、29.0このフィード項目が共有フィード項目の場合は、元のフィード項目への参照、それ以外の場合は null

ReferenceoriginalFeedItem

24.0Medium、29.0値は元のフィード項目の種別によって異なります。値は次のとおりです。


originalFeedItemActor

• Record Summary – 元のフィード項目がレコードの場合

• User Summary – 元のフィード項目がユーザの場合

• Unauthenticated User — 元のフィード項目がChatter 顧客からのものである場合

• このフィード項目が共有フィード項目ではない場合は null

23.0Medium、29.0値は親の種別によって異なります。値は次のとおりです。


parent

• File Summary – 親がファイルの場合• Group – 親がグループの場合• Record Summary – 親がレコードの場合• User Summary – 親がユーザの場合

メモ: 親がユーザである場合、User

Summary レスポンスボディが返され、ユーザ種別の Record Summary は返されません。グループとファイルの両方についても同様です。

23.0Medium、29.0フィード項目に関連付けられた写真の URLStringphotoUrl

27.0 ～ 30.0Medium、29.0preamble は投稿のタイトルです。このプロパティには、「App Builders - Pam Jones」など、

Feed Item PreambleMessage Body

preamble

メッセージのすべてのセグメントに対する表示可能なプレーンテキストが含まれます。API バージョン 28.0 以前では、/body/text

プロパティをテキスト表示のデフォルトケースとして使用します。API バージョン 29.0 ～30.0 では、/preamble/textプロパティをテキスト表示のデフォルトケースとして使用します。API バージョン 31.0 以降で

643





は、/header/text プロパティをテキスト表示のデフォルトケースとして使用します。


StringrelativeCreatedDate

28.0 ～ 31.0Medium、29.0このフィード項目のトピック。Feed Items Topicstopics

重要: API バージョン 32.0 以降では、capabilities.topics.items プロパティを使用します。

23.0Small、29.0typeプロパティは、API バージョンに関係なく、常にすべての種別を返します。ただし、

Stringtype

すべての API バージョンですべての種別が有効なわけではありません。

重要: API バージョン 32.0 以降では、capabilitiesプロパティを使用してフィード項目の機能を判断できます。「機能」を参照してください。

値は次のとおりです。• ActivityEvent — フィードが有効になっ

ている親レコードに関連付けられた行動または ToDo が作成または更新されるときに、ケースフィードに生成されるフィード項目。

• AdvancedTextPost — 高度に書式設定されたフィード項目 (グループへのお知らせの投稿など)。

• ApprovalPost — 承認機能のあるフィード項目。承認者は、フィード項目の親で操作を実行できます。

• AttachArticleEvent — ケースフィードのケースに記事が添付されているときに生成されるフィード項目。

• BasicTemplateFeedItem — 拡張リンク機能のあるフィード項目。

• CallLogPost — ケースフィードのケースに活動ログが保存されたときに生成されるフィード項目。

644





• CanvasPost — パブリッシャーのキャンバスアプリケーションまたは Chatter REST

APIまたはChatter in Apexによって生成されるフィード項目。投稿自体は、キャンバスアプリケーションへのリンクです。

• CaseCommentPost — ケースフィードにケースコメントが保存されたときに生成されるフィード項目。

• ChangeStatusPost — ケースの状況がケースフィードで変更されたときに生成されるフィード項目。

• ChatTranscriptionPost — Live Agent

チャットのトランスクリプトがケースに保存されたときにケースフィードで生成されるフィード項目。

• CollaborationGroupCreated — 新しい公開グループが作成されたときに生成されるフィード項目。新しいグループへのリンクが含まれます。

• CollaborationGroupUnarchived — 非推奨。アーカイブされたグループが有効化されたときに生成されるフィード項目。

• ContentPost — コンテンツ機能のあるフィード項目。

• CreateRecordEvent — パブリッシャーで作成されたレコードを説明するフィード項目。

• DashboardComponentAlert — ダッシュボードアラートのあるフィード項目。

• DashboardComponentSnapshot — ダッシュボードコンポーネントスナップショット機能のあるフィード項目。

• EmailMessageEvent — ケースフィードのケースからメールが送信されたときに生成されるフィード項目。

• FacebookPost — 非推奨。ケースフィードのケースから Facebook 投稿が作成されたときに生成されるフィード項目。

645





• LinkPost — いいね! 機能のあるフィード項目。

• MilestoneEvent — ケースマイルストンが完了したか、違反状況になったときに生成されるフィード項目。ケースマイルストンへのリンクが含まれます。

• PollPost —アンケート機能のあるフィード項目。フィード項目の閲覧者がアンケートの選択肢に投票できます。

• ProfileSkillPost — スキルがユーザのプロファイルに追加されたときに生成されるフィード項目。

• QuestionPost — 質問が行われたときに生成されるフィード項目。API バージョン 33.0 以降では、この種別のフィード項目には、コンテンツ機能とリンク機能を設定できます。

• ReplyPost — Chatter アンサーの返信によって生成されるフィード項目。

• RypplePost — ユーザが感謝を投稿したときに生成されるフィード項目。

• SocialPost — ケースフィードのケースからソーシャル投稿が作成されたときに生成されるフィード項目。

• TextPost — テキストのみを含むフィード項目。

• TrackedChange — レコードの 1 つ以上の項目が変更されたときに作成されるフィード項目。

• UserStatus — 非推奨。ユーザ自身のプロファイルへの投稿。

23.0Small、29.0このフィード項目への URLStringurl

26.0Small、29.0このフィード項目を表示できるユーザ。値は次のとおりです。

Stringvisibility

• InternalUsers — コミュニティが有効な場合は、デフォルトの内部コミュニ

646





ティのメンバーに対してのみフィード項目を表示できます。


Feed Item Attachment: Approval

承認添付ファイル。

重要: このレスポンスボディは、バージョン 32.0 以降では使用できません。バージョン 32.0 以降では、Approval Capability が使用されます。




27.0 ～ 31.0Small、29.0作業項目 IDStringid

30.0 ～ 31.0Small、30.0プロセスインスタンスステップ ID。関連付けられたレコードが承認プロセスの 1 つのステップを表します。

StringprocessInstanceStepId

27.0 ～ 31.0Small、29.0承認の状況。値は次のとおりです。Stringstatus

• Approved

• Fault

• Held

• NoResponse

• Pending

• Reassigned

• Rejected

• Removed

• Started

28.0 ～ 31.0Small、29.0承認投稿テンプレート項目のコレクションApproval PostTemplate Field[]

postTemplateFields

27.0 ～ 31.0Small、29.0ApprovalStringtype

647

Feed Item Attachment: ApprovalChatter REST API レスポンスボディ

Feed Item Attachment: Basic Template

重要: このレスポンスボディは、バージョン 32.0 以降では使用できません。バージョン 32.0 以降では、Enhanced Link Capability が使用されます。




27.0 ～ 31.0Small、29.0最大 500 文字の説明 (省略可能)Stringdescription

27.0 ～ 31.0Small、29.0アイコン (省略可能)Iconicon

28.0 ～ 31.0Small、29.0linkURL が Salesforce レコードを参照する場合、linkRecordId にはそのレコードの ID

が含まれます。

StringlinkRecordId

27.0 ～ 31.0Small、29.0使用可能なコンテンツをインライン表示できない場合の詳細ページへのリンクの URL (省略可能)

StringlinkUrl

27.0 のみこのプロパティは 28.0

Big、29.0基本テンプレートのフィード項目に関連付けられたサブタイプ。値は次のとおりです。

Stringsubtype

• CollaborationGroupCreated

で廃止され、それより前のバージョンのクライアントには常にNone を返します。

27.0 ～ 31.0Small、29.0詳細ページのタイトル (省略可能)Stringtitle

27.0 ～ 31.0Small、29.0BasicTemplateStringtype

Feed Item Attachment: Canvas Template

重要: このレスポンスボディは、バージョン 32.0 以降では使用できません。バージョン 32.0 以降では、Canvas Capability が使用されます。

648

Feed Item Attachment: Basic TemplateChatter REST API レスポンスボディ




29.0 ～ 31.0Small、29.0省略可能。キャンバスアプリケーションの説明。この項目の文字数は 500 文字までです。

Stringdescription

29.0 ～ 31.0Small、29.0キャンバスアプリケーションの開発者名 (API

名)

StringdeveloperName

29.0 ～ 31.0Small、29.0省略可能。キャンバスアプリケーションの高さ (ピクセル単位)。デフォルトの高さは 200

ピクセルです。

Stringheight

29.0 ～ 31.0Small、29.0キャンバスアプリケーションのアイコンIconicon

29.0 ～ 31.0Small、29.0省略可能。キャンバスアプリケーションが作成された Developer Edition 組織の名前空間プレフィックス。


29.0 ～ 31.0Small、29.0省略可能。キャンバスアプリケーションに渡される JSON 形式のパラメータ。例:

{'isUpdated'='true'}

Stringparameters

29.0 ～ 31.0Small、29.0省略可能。キャンバスアプリケーションのサムネイル画像の URL。最大サイズは 120x120

ピクセルです。

StringthumbnailUrl

29.0 ～ 31.0Small、29.0キャンバスアプリケーションのコールに使用されるリンクのタイトル。

Stringtitle

29.0 ～ 31.0Small、29.0CanvasStringtype

Feed Item Attachment: Case Comment

重要: このレスポンスボディは、バージョン 32.0 以降では使用できません。バージョン 32.0 以降では、Case

Comment Capability が使用されます。




24.0 ～ 31.0Small、29.0コメントを行ったユーザの種別を示します。有効な値は、次のとおりです。

StringactorType

• Customer — Chatter顧客がコメントを行った場合

649

Feed Item Attachment: Case CommentChatter REST API レスポンスボディ




• CustomerService — サービス担当者がコメントを行った場合

24.0 ～ 31.0Small、29.0コメントを作成したユーザに関する情報User SummarycreatedBy

24.0 ～ 31.0Small、29.0ISO8601 の日付文字列 (例:2011-02-25T18:24:31.000Z)

StringcreatedDate

29.0 ～ 31.0Small、29.0ケースフィードのコメントのイベントタイプを示します。次のいずれかの値にします。

StringeventType

• NewInternal — 新しく「社内のみ」とマークされたケースコメント。

• NewPublished — 新しく公開されたケースコメント。

• NewPublishedByCustomer — 新しく公開された、顧客によるケースコメント。

• PublishExisting — 再公開された既存のケースコメント。

• PublishExistingByCustomer — 再公開された、顧客による既存のケースコメント。

• UnpublishExistingByCustomer — 非公開にされた、顧客による既存のケースコメント。

• UnpublishExsiting — 非公開にされた既存のケースコメント。

メモ: この入力ミスは、ドキュメントではなくコードに含まれています。コードでこのスペルを使用してください。

24.0 ～ 31.0Small、29.0ケースコメントの 18 文字の IDStringid

24.0 ～ 31.0Small、29.0コメントが公開されたかどうかを示します。Booleanpublished

24.0 ～ 31.0Small、29.0ケースコメントのテキストStringtext

27.0 ～ 31.0Small、29.0CaseCommentStringtype

650

Feed Item Attachment: Case CommentChatter REST API レスポンスボディ

Feed Item Attachment: Content

フィード項目コンテンツ添付ファイルの説明。

重要: このレスポンスボディは、バージョン 32.0 以降では使用できません。バージョン 32.0 以降では、Content Capability が使用されます。




26.0 ～ 31.0Small、29.0ファイルの MD5 チェックサムStringcheckSum

31.0 ～ 31.0Small、31.0リンクファイルおよび Google ドキュメントの URL。それ以外の場合、値は null です。

StringcontentUrl

23.0 ～ 31.0Small、29.0添付ファイルの説明Stringdescription

23.0 ～ 31.0Small、29.0ファイルの URL。コンテンツがリンクまたはGoogle ドキュメントの場合、この値は null

です。

StringdownloadUrl

26.0 ～ 31.0Small、29.0ファイルの拡張子StringfileExtension

23.0 ～ 31.0Small、29.0ファイルのサイズ (バイト)。サイズを判定できない場合は、unknown を返します。

StringfileSize

23.0 ～ 31.0Small、29.0ファイルの種類StringfileType

23.0 ～ 29.0Small、29.0ファイルでプレビュー画像を使用できる場合は true、それ以外の場合は false

BooleanhasImagePreview

23.0 ～ 31.0Small、29.0ファイルで PDF プレビューを使用できる場合は true、それ以外の場合は false

BooleanhasPdfPreview

23.0 ～ 31.0Small、29.0コンテンツの 18 文字の IDStringid

26.0 ～ 31.0Small、29.0ファイルが Salesforce Files Syncと同期されている場合は true、同期されていない場合はfalse。


23.0 ～ 31.0Small、29.0ファイルの MIME タイプのコンテンツStringmimeType

26.0 ～ 31.0Small、29.0ファイルの変換リソースへの URL。共有ファイルの場合、変換はアップロード後に非同期

StringrenditionUrl

で処理されます。非公開ファイルの場合、変換は最初にファイルプレビューが要求されたときに処理されるため、ファイルのアップロード直後は使用できません。

30.0 ～ 31.0Small、30.0ファイルの 240×180 の変換リソースへの URL。共有ファイルの場合、変換はアップロード後


651

Feed Item Attachment: ContentChatter REST API レスポンスボディ




に非同期で処理されます。非公開ファイルの場合、変換は最初にファイルプレビューが要求されたときに処理されるため、ファイルのアップロード直後は使用できません。

30.0 ～ 31.0Small、30.0ファイルの 720×480 の変換リソースへの URL。共有ファイルの場合、変換はアップロード後


に非同期で処理されます。非公開ファイルの場合、変換は最初にファイルプレビューが要求されたときに処理されるため、ファイルのアップロード直後は使用できません。

30.0 ～ 31.0Big、30.0可能な場合はファイルのテキストプレビュー、それ以外の場合は null です。

StringtextPreview

30.0 ～ 31.0Medium、30.0ファイルの 120×90 プレビュー画像の表示状況を示します。次のいずれかの値にします。


• Processing — 画像を表示しています。• Failed — 表示プロセスが失敗しました。• Success — 表示プロセスが成功しまし

た。• Na — この画像は表示できません。









23.0 ～ 31.0Small、29.0ファイルのタイトルStringtitle

652

Feed Item Attachment: ContentChatter REST API レスポンスボディ




27.0 ～ 31.0Small、29.0ContentStringtype

23.0 ～ 31.0Medium、29.0コンテンツのこのバージョンの 18 文字の IDStringversionId

Feed Item Attachment: Dashboard

重要: このレスポンスボディは、バージョン 32.0 以降では使用できません。バージョン 32.0 以降では、Dashboard Component Snapshot Capability が使用されます。




24.0 ～ 31.0Small、29.0コンポーネントの 18 文字の IDStringcomponentId

24.0 ～ 31.0Small、29.0コンポーネントの名前。コンポーネントと一緒に名前が保存されていない場合、ローカラ

StringcomponentName

イズされた文字列 "タイトル未定のコンポーネント" を返します。

24.0 ～ 31.0Small、29.0フィード項目の本文でアクターの横に表示するテキスト。これは、デフォルトの本文テキ

StringdashboardBodyText

ストの代わりに使用されます。テキストが指定されておらず、デフォルトの本文テキストもない場合、null を返します。

24.0 ～ 31.0Small、29.0ダッシュボードの 18 文字の IDStringdashboardId

24.0 ～ 31.0Small、29.0ダッシュボードの名前StringdashboardName

24.0 ～ 31.0Small、29.0実寸大のダッシュボード画像の URLStringfullSizeImageUrl

24.0 ～ 31.0Small、29.0このダッシュボードの最終更新日の ISO8601

の日付文字列 (例: 2011-02-25T18:24:31.000Z)

StringlastRefreshDate

24.0 ～ 31.0Small、29.0最終更新日の表示テキスト ("最終更新 2011 年10 月 31 日" など)。

StringlastRefreshDateDisplayText

24.0 ～ 31.0Small、29.0ダッシュボードを実行しているユーザUser SummaryrunningUser

24.0 ～ 31.0Small、29.0サムネイルサイズのダッシュボード画像のURL

StringthumbnailUrl

27.0 ～ 31.0Small、29.0DashboardComponentStringtype

653

Feed Item Attachment: DashboardChatter REST API レスポンスボディ

Feed Item Attachment: Email Message

ケースフィードのケースレコードから送信されるメールメッセージ。

重要: このレスポンスボディは、バージョン 32.0 以降では使用できません。バージョン 32.0 以降では、Email Message Capability が使用されます。




29.0 ～ 31.0Small、29.0メールメッセージの方向。次のいずれかの値にします。

Stringdirection

• Inbound — インバウンドメッセージ (顧客が送信)。

• Outbound — アウトバウンドメッセージ(サポートエージェントが顧客に送信)。

29.0 ～ 31.0Small、29.0メールメッセージの IDStringemailMessageId

29.0 ～ 31.0Small、29.0メールメッセージの件名Stringsubject

29.0 ～ 31.0Big、29.0メールメッセージの本文StringtextBody

29.0 ～ 31.0Small、29.0メールメッセージを受信するアドレスのコレクション

Email Address[]toAddresses

27.0 ～ 31.0Small、29.0EmailmessageStringtype

Feed Item Attachment: Link

重要: このレスポンスボディは、バージョン 32.0 以降では使用できません。バージョン 32.0 以降では、Link

Capability が使用されます。




23.0 ～ 31.0Small、29.0リンクの説明Stringtitle

27.0 ～ 31.0Small、29.0LinkStringtype

23.0 ～ 31.0Small、29.0フィード項目 (外部項目の可能性もある) に添付された URL

Stringurl

654

Feed Item Attachment: Email MessageChatter REST API レスポンスボディ

Feed Item Attachment: Poll

重要: このレスポンスボディは、バージョン 32.0 以降では使用できません。バージョン 32.0 以降では、Poll

Capability が使用されます。




26.0 ～ 31.0Small、29.0投票を構成するフィードのアンケート選択肢のコレクション

Feed Poll Choice[]choices

26.0 ～ 31.0Small、29.0このアンケートにおいて現在のユーザが投票したアンケート選択肢の 18 文字の ID。現在

StringmyChoiceId

のユーザが投票しなかった場合は、nullが返されます。

26.0 ～ 31.0Small、29.0フィードアンケート項目に投じられた投票の合計数

IntegertotalVoteCount

27.0 ～ 31.0Small、29.0PollStringtype

Feed Item Attachment: Record Snapshot

重要: このレスポンスボディは、バージョン 32.0 以降では使用できません。バージョン 32.0 以降では、Record Snapshot Capability が使用されます。




29.0 ～ 31.0Small、29.0レコードの表現。Record ViewrecordView

29.0 ～ 31.0Small、29.0RecordSnapshotStringtype

Feed Item Attachment: Tracked Change

重要: このレスポンスボディは、バージョン 32.0 以降では使用できません。バージョン 32.0 以降では、Tracked Changes Capability が使用されます。

655

Feed Item Attachment: PollChatter REST API レスポンスボディ




29.0 ～ 31.0Small、29.0フィード追跡変更のコレクション。Feed TrackedChange[]

changes

29.0 ～ 31.0Small、29.0TrackedChangeStringtype

Feed Item Body




23.0Medium、29.0種別に基づくメッセージセグメントのコレクション。セグメントは次のいずれかになる可能性があります。

Segment[]messageSegments

• 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

23.0Small、29.0表示可能な状態のメッセージテキスト。メッセージセグメントを処理しない場合は、このテキストを使用します。

Stringtext

Feed Item Page

重要: このレスポンスボディは、バージョン 32.0 以降では使用できません。バージョン 32.0 以降では、Feed

Element Page が使用されます。




23.0 ～ 31.0Medium、29.0フィード項目の現在のページへの URLStringcurrentPageUrl

656

Feed Item BodyChatter REST API レスポンスボディ




27.0 ～ 31.0Medium、29.0ニュースフィードがいつ最終更新されたのかを記述する不透明ポーリングトークン。この


値は、News Feed Is-Modifiedリソースの since

要求パラメータとして使用します。

23.0 ～ 31.0Medium、29.0フィードがいつ最終更新されたのかが記述された不透明トークンを含む since 要求パラ

StringisModifiedUrl

メータがあるNews Feed Is-Modifiedリソース。フィードがニュースフィードではない場合はnull を返します。

23.0 ～ 31.0Small、29.01 つ以上のフィード項目のコレクションFeed Item[]items

23.0 ～ 31.0Small、29.0フィード項目の次のページへの URLStringnextPageUrl

30.0 ～ 31.0Big、30.0updatedSince パラメータで使用するトークン。使用できない場合は null です。

StringupdatesToken

30.0 ～ 31.0Big、30.0updatesToken プロパティの値を含むクエリ文字列を持つ Chatter REST API リソース。こ

StringupdatesUrl

のリソースは、最後の要求以降に更新されたフィード項目を返します。URL を変更せずにそのまま使用します。使用できない場合、プロパティは null です。

Feed Item Preamble Message Body








27.0Small、29.0preamble は投稿のタイトルです。このプロパティには、「App Builders - Pam Jones」など、

Stringtext

メッセージのすべてのセグメントに対する表示可能なプレーンテキストが含まれます。

657

Feed Item Preamble Message BodyChatter REST API レスポンスボディ

Feed Items Topics

重要: このレスポンスボディは、バージョン 32.0 以降では使用できません。バージョン 32.0 以降では、Topics Capability が使用されます。




28.0 ～ 31.0Small、29.0トピックをフィード項目に割り当て可能な場合は true、それ以外の場合は false

BooleancanAssignTopics

28.0 ～ 31.0Small、29.0トピックのコレクションTopic[]topics

Feed Modified Info




23.0Small、29.0ニュースフィードが最後にポーリングされた後に変更されている場合は true、それ以外

BooleanisModified

の場合はfalse。フィードがニュースフィードではない場合は null を返します。

27.0Small、29.0ニュースフィードがいつ最終更新されたのかを記述する不透明ポーリングトークン。この


値は、News Feed Is-Modifiedリソースの since

要求パラメータとして使用します。23.0Small、29.0フィードがいつ最終更新されたのかが記述さ

れた不透明トークンを含む since 要求パラStringnextPollUrl

メータがあるNews Feed Is-Modifiedリソース。フィードがニュースフィードではない場合はnull を返します。Feed または Feed Item Page

レスポンスボディで isModifiedUrlリソースに対して要求した後で、このリソースに要求します。

658

Feed Items TopicsChatter REST API レスポンスボディ

Feed Poll Choice




26.0Small、29.0アンケート選択肢の 18 文字の IDStringid

26.0Small、29.0このアンケート選択肢があるアンケート内の場所。最初のアンケート選択肢は 1 から開始します。

Integerposition

26.0Small、29.0アンケート選択肢に関連付けられた表示ラベルテキスト。

Stringtext

26.0Small、29.0このアンケート選択肢の投票合計数。IntegervoteCount

26.0Small、29.0このアンケートに投じられたすべての投票数に対するこのアンケート選択肢への合計投票

DoublevoteCountRatio

数の割合。この割合を 100 で乗算して、このアンケート選択肢の投票数のパーセントを出します。

Feed Tracked Change




29.0Small、29.0更新された項目の名前。StringfieldName

29.0Small、29.0項目の新しい値または null (項目の長さが長い場合、または空の場合)。

StringnewValue

29.0Small、29.0項目の古い値または null (項目の長さが長い場合、または空の場合)。

StringoldValue

File Detail

File Summary レスポンスボディのすべてと次の追加項目が含まれます。

659

Feed Poll ChoiceChatter REST API レスポンスボディ




24.0Medium、29.0Flash 変換をサポートするドキュメントのページ数、またはプレゼンテーションのスライド

IntegerpageCount

数。Flash 変換が失敗した場合、またはファイルの種類でサポートされていない場合は 0

を返します。

関連トピック:

File Summary

File Share Link

リンクとして共有されるファイルの説明。




30.0Small、30.0ファイルの表示とダウンロードが可能なURL。この値は、ファイル共有リンクとも呼ばれます。

StringfileViewUrl

30.0Small、30.0共有の権限レベル。値は次のとおりです。StringsharingType

• C — コラボレータ• I — 共有権限は場所によって決まりま

す。これは一般に、共有権限がファイルではなくライブラリに設定されている場合に発生します。この値は、コンテキストユーザがファイルの所有者である場合にも使用されます。

• N — アクセス権限なし• V — 閲覧者

660

File Share LinkChatter REST API レスポンスボディ

File Shares Page




24.0Medium、29.0ファイル共有の現在のページの URLStringcurrentPageUrl

30.0Small、30.0ファイル共有リンクの URLFile Share LinklinkShare

24.0Small、29.01 つ以上のファイル共有のコレクションShares[]shares

24.0Small、29.0ファイル共有の次のページの URLStringnextPageUrl

24.0Medium、29.0ファイル共有の前のページの URLStringpreviousPageUrl

File Summary

ファイルの説明。すべての変換プロパティについて、次のことに注意してください。共有ファイルの場合、変換はアップロード後に非同期で処理されます。非公開ファイルの場合、変換は最初にファイルプレビューが要求されたときに処理されるため、ファイルのアップロード直後は使用できません。




26.0Big、29.0ファイルの MD5 チェックサムStringcheckSum

24.0Small、29.0ファイルのサイズ (バイト)IntegercontentSize

32.0Small、32.0このファイルに関連付けられた外部データソース、または、外部ファイルを指し示していない場合は null。


contentHubRepository


2011-02-25T18:24:31.000Z)。名前変更などの直接Datecontent

ModifiedDate

的なファイル操作でのみ更新されるファイル固有の変更日です。Salesforce以外からのファイルの変更により、この日付が更新される場合があります。

24.0Small、29.0ファイルがリンクの場合は URL を返し、それ以外の場合は文字列 "null" を返します。

StringcontentUrl

24.0Medium、29.0ファイルの説明Stringdescription

26.0Small、29.0ファイルへの URLStringdownloadUrl

661

File Shares PageChatter REST API レスポンスボディ




32.0Small、32.0このファイルが指し示す外部 URL。外部ファイルを指し示していない場合は null。


24.0Big、29.0ファイルの Flash プレビューバージョンが表示されたかどうかを示します。

StringflashRenditionStatus

26.0Small、29.0ファイルの拡張子StringfileExtension

24.0Medium、29.0ファイルの種類 (PDF、PowerPoint など)StringfileType

24.0Small、29.0ファイルの 18 文字の IDStringid

26.0Medium、29.0ファイルが Salesforce Files Syncと同期されている場合は true、同期されていない場合はfalse。


31.0Medium、31.0ファイルがメジャーバージョンの場合はtrue、ファイルがマイナーバージョンの場


合は false。メジャーバージョンを置き換えることはできません。

26.0Medium、29.0ファイルの MIME タイプStringmimeType

30.0Big、30.0このファイルのフラグ。コミュニティモデレータは、フラグ付き項目を表示したり、フ


ラグ付き項目に対してアクションを実行したりできます。Features レスポンスボディのcommunityModeration プロパティがfalse の場合、このプロパティは null になります。


2011-02-25T18:24:31.000Z)。Salesforce 内からのDatemodifiedDate

ファイルの変更により、この日付が更新されます。

27.0Small、29.0オブジェクトがファイルであることを示す小、中、大のアイコン。motif にはオブジェクトのベース色を含めることもできます。このアイコンは、ファイルのプレビューではありません。

Motifmotif

23.0Medium、29.0コンテキストユーザがこのファイルをフォローしている場合は、登録に関する情報が含


662

File SummaryChatter REST API レスポンスボディ




まれます。それ以外の場合は、nullを返します。

24.0Small、29.0ファイルの名前Stringname

24.0Big、29.0ファイルソースを示します。有効な値は、次のとおりです。

Stringorigin

• Chatter — ファイルソースが Chatter の場合

• Content — ファイルソースがコンテンツの場合

• FileField — ファイルソースがレコードやその他の形式の場合

24.0Small、29.0ファイルの所有者User Summaryowner

28.0Small、29.0親フォルダへの参照。ReferenceparentFolder

24.0Big、29.0ファイルの PDF プレビューバージョンが表示されたかどうかを示します。

StringpdfRenditionStatus

29.0Small、29.0ファイルの公開状況。次のいずれかの値にします。

StringpublishStatus

• PendingAccess — ファイルは公開を待機中です。

• PrivateAccess — ファイルは非公開です。

• PublicAccess — ファイルは公開されています。

26.0Medium、29.0ファイルの変換リソースへの URL。共有ファイルの場合、変換はアップロード後に非同期

StringrenditionUrl

で処理されます。非公開ファイルの場合、変換は最初にファイルプレビューが要求されたときに処理されるため、ファイルのアップロード直後は使用できません。

29.0Medium、29.0ファイルの 240×180 ピクセルサイズ変換へのURL (使用可能な場合)。共有ファイルの場合、


変換はアップロード後に非同期で処理されます。非公開ファイルの場合、変換は最初にファイルプレビューが要求されたときに処理

663





されるため、ファイルのアップロード直後は使用できません。

29.0Medium、29.0ファイルの 720×480 ピクセルサイズ変換へのURL (使用可能な場合)。共有ファイルの場合、


変換はアップロード後に非同期で処理されます。非公開ファイルの場合、変換は最初にファイルプレビューが要求されたときに処理されるため、ファイルのアップロード直後は使用できません。

32.0Small、32.0外部リポジトリファイルのプロパティへのアクセスを提供する Chatter REST API リソースの

StringrepositoryFileUrl

URL。このファイルが外部ファイルを参照していない場合は null。

29.0Medium、29.0ファイルの共有ロール。次のいずれかの値にします。

StringsharingRole

• Admin — 所有者権限ですが、ファイルは所有していません。

• Collaborator — 閲覧者権限に加えて、権限の編集および変更を行ったり、新しいバージョンのファイルをアップロードしたりできます。

• Owner — コラボレータ権限に加えて、ファイルを非公開にしたり、ファイルを削除したりできます。

• Viewer — ファイルを表示、ダウンロード、共有できます。

• WorkspaceManaged — ライブラリで制御される権限。

30.0Big、30.0可能な場合はファイルのテキストプレビュー、それ以外の場合は null です。

StringtextPreview

24.0Small、29.0ファイルの 120×90 プレビュー画像の表示状況を示します。次のいずれかの値にします。



た。

664





• Na — この画像は表示できません。









24.0Small、29.0ファイルのタイトルStringtitle

24.0Small、29.0ContentDocumentStringtype

24.0Small、29.0ファイルの URLStringurl

24.0Medium、29.0ファイルのバージョン番号StringversionNumber

File Summary Page




24.0Medium、29.0ファイルの現在のページの URLStringcurrentPageUrl

24.0Small、29.01 つ以上のファイルのコレクションFile Summary[]files

24.0Small、29.0ファイルの次のページの URLStringnextPageUrl

24.0Medium、29.0ファイルの前のページの URLStringpreviousPageUrl

665

File Summary PageChatter REST API レスポンスボディ

Files Connect Provider Type

Files Connect プロバイダに関する情報。




32.0Small、32.0プロバイダタイプのローカライズされた表示ラベル。

Stringlabel

32.0Small、32.0プロバイダタイプ。次のいずれかの値にします。

Stringtype

• ContentHubCmis

• ContentHubGoogleDrive

• ContentHubSharepoint

• ContentHubSharepointOffice365

• SimpleUrl


Files Connect リポジトリに関する情報。




32.0Small、32.0リポジトリの機能。Files ConnectRepositoryFeatures

features

32.0Small、32.0外部データソースの 18 文字の ID。Stringid

32.0Small、32.0リポジトリの表示ラベル。Stringlabel

32.0Small、32.0motif プロパティには、Salesforce レコードタイプを示す小、中、大のアイコン

Motifmotif

への URL があります。一般的なレコードタイプは、ファイル、ユーザ、グループですが、すべてのレコードタイプに一連の motif アイコンがあります。カスタムオブジェクトレコードでは、タブスタイルアイコンが使用されます。認証されていないユーザでもすべてのア

666

Files Connect Provider TypeChatter REST API レスポンスボディ




イコンを使用できるため、たとえば、motif アイコンをメールで表示することができます。motif にはレコードタイプのベース色を含めることもできます。

32.0Medium、32.0コンテキストユーザがこのレコードをフォローしている場合は、登録に関す


る情報が含まれます。それ以外の場合は、null を返します。

32.0Small、32.0リポジトリ名。Stringname

32.0Small、32.0リポジトリプロバイダタイプ。Files ConnectProvider Type

providerType

32.0Small、32.0リポジトリのルートフォルダ項目へのURL。リポジトリで参照がサポートされていない場合は null。

StringrootFolderItemsUrl

32.0Small、32.0レコード ContentHubRepository のタイプ。

Stringtype

32.0Small、32.0Files Connect リポジトリの Chatter REST API

リソース URL。Stringurl

Files Connect Repository Collection

Files Connect リポジトリのコレクション。









エラーが返されます。

667

Files Connect Repository CollectionChatter REST API レスポンスボディ




32.0Medium、32.0前のページを識別する Chatter REST



32.0Small、32.0リポジトリのコレクション。Files ConnectRepository[]

repositories

Files Connect Repository Features

Files Connect リポジトリの機能に関する情報。




32.0Small、32.0リポジトリのフォルダ階層を参照できるか (true)、否か (false) を示します。

BooleancanBrowse

32.0Small、32.0リポジトリを検索できるか (true)、否か (false) を示します。

BooleancanSearch

Flat Feed




25.0 ～ 26.0Medium、29.0項目の現在のページの URLStringcurrentPageUrl

25.0 ～ 26.0Small、29.01 つ以上のフラットフィード項目のコレクション

Flat Feed Item[]items

25.0 ～ 26.0Small、29.0項目の次のページの URLStringnextPageUrl

668

Files Connect Repository FeaturesChatter REST API レスポンスボディ

Flat Feed Item




25.0 ～ 26.0Small、29.0typeの値に応じたフラットフィード項目。有効な値は、次のとおりです。

typeによって異なる

item

• type が Comment の場合 — Comment

• type が FeedItem の場合 — Feed Item

25.0 ～ 26.0Small、29.0項目の種別。有効な値は、次のとおりです。Stringtype

• Comment

• FeedItem

Folder

フォルダの説明。




30.0Small、30.0フォルダの作成日を指定する ISO-8601 形式の日付文字列。

DatecreatedDate

30.0Small、30.0フォルダの 18 文字の ID。Stringid

33.0Small、33.0フォルダおよびこのフォルダ内のすべてのフォルダが Salesforce Files Syncと同期されてい


る場合は true、同期されていない場合はfalse。

30.0Small、30.0フォルダの最終変更日を指定する ISO-8601 形式の日付文字列。

DatemodifiedDate

30.0Small、30.0レコードタイプを示す小、中、大アイコン。motif にはレコードタイプのベース色を含めることもできます。

Motifmotif

30.0Medium、30.0コンテキストユーザがこのレコードをフォローしている場合、このプロパティには登録


に関する情報が含まれます。それ以外の場合は、このプロパティが null になります。

30.0Small、30.0フォルダ名。Stringname

669

Flat Feed ItemChatter REST API レスポンスボディ




30.0Small、30.0親フォルダへの参照。ReferenceparentFolder

30.0Small、30.0フォルダへのパス。Stringpath

30.0Small、30.0FolderStringtype

30.0Small、30.0このリソースへの Chatter REST API URL。Stringurl

Folder Item

フォルダ内の項目 (ファイルまたはフォルダ) の説明。




30.0Small、30.0ファイル表現File Summaryfile

30.0Small、30.0フォルダ表現Folderfolder

30.0Small、30.0項目の種別。有効な値は、次のとおりです。Stringtype

• File

• Folder

Folder Item Page

ページが設定された Folder Item レスポンスボディのコレクション。




30.0Medium、30.0現在のページを識別するChatter REST API URL。StringcurrentPageUrl

30.0Small、30.0フォルダ項目のコレクション。Folder Item[]items

30.0Small、30.0次のページを識別するChatter REST API URL。次のページがない場合は null。別のページを

StringnextPageUrl

取得する前に、この値が nullであるかどうかを確認します。ページが存在しない場合は、ConnectApi.NotFoundException エラーが返されます。

670

Folder ItemChatter REST API レスポンスボディ




30.0Medium、30.0前のページを識別するChatter REST API URL。前のページがない場合は null。


Follower Page




23.0Medium、29.0現在のページの URLStringcurrentPageUrl

23.0Small、29.0レコードをフォローしている人の 1 つ以上の登録のコレクション

Subscription[]followers

23.0 ～ 24.0ReferencemySubscriptionメモ: この項目は、バージョン 24.0 以降、使用できなくなります。

コンテキストユーザがこのユーザをフォローしている場合は、登録に関する情報が含まれます。それ以外の場合は、null を返します。


StringnextPageUrl




23.0Small、29.0フォローされている人の合計数Integertotal

Following Counts




23.0Small、29.0ユーザがフォローしている人の数Integerpeople

671

Follower PageChatter REST API レスポンスボディ




23.0Small、29.0ユーザがフォローしているレコードの数トピックは、バージョン 29.0 以降でフォロー可能なレコードタイプです。

Integerrecords

23.0Small、29.0ユーザがフォローしている項目の合計数Integertotal

Following Page




23.0Medium、29.0現在のページへの URLStringcurrentPageUrl

23.0Small、29.01 つ以上の登録のコレクションSubscription[]following

23.0Small、29.0次のページの URLStringnextPageUrl

23.0Medium、29.0前のページの URLStringpreviousPageUrl

23.0Small、29.0フォローされているレコードの合計数Integertotal

Generic Bundle Capability

フィード要素にこの機能がある場合、フィード要素は 1 つのフィード要素に集約された他のフィード要素のグループとなることができます。





31.0Small、31.0バンドルの種別を指定します。値は GenericBundle です。

StringbundleType

31.0Small、31.0フィード要素のコレクション。Feed Element Pagepage

31.0Small、31.0このバンドルで集約するフィード要素の合計数。

IntegertotalElements

672

Following PageChatter REST API レスポンスボディ

汎用フィード要素

汎用フィード要素。


検索条件とバージョン


22.0Small、22.0フィード要素に関する情報。Feed Item Bodybody

31.0Medium、31.0フィード要素に含めることができるすべての機能のコンテナ。

Feed ElementCapabilities

capabilities



31.0Small、31.0フィード要素は、フィードに含まれる最上位のオブジェクトです。


フィード要素の種類は、このフィード要素の特徴を記述します。次のいずれかの値にします。• Bundle — フィード要素のコン

テナ。バンドルには、メッセージセグメントを構成する本文も含まれます。メッセージセグメントは、テキストのみの値に常に適切に分解できます。

• FeedItem — フィード項目には1 つの親があり、その範囲は 1 つのコミュニティまたはすべてのコミュニティになります。フィード項目にはブックマーク、キャンバス、コンテンツ、コメント、リンク、アンケートなどの機能を設定できます。フィード項目には、メッセージセグメントを構成する本文が含まれます。メッセージセグメントは、テキストのみの値に常に適切に分解できます。

• Recommendation — おすすめは、おすすめ機能を備えたフィード要素です。おすすめは、コンテキストユーザに、フォローするレコード、参加す

673

汎用フィード要素Chatter REST API レスポンスボディ




るグループ、または役に立つアプリケーションを推奨します。

31.0Medium、31.0ヘッダーは投稿のタイトルです。このプロパティには、メッセージ

Feed Item Bodyheader

のすべてのセグメントに対する表示可能なプレーンテキストが含まれます。クライアント側でフィード要素の種類の表示方法が不明の場合、このテキストが表示されます。

22.0Small、22.0フィード要素の ID。Stringid


2011-02-25T18:24:31.000Z)。DatemodifiedDate

28.0Medium、29.0フィード要素の親。次のいずれかのレスポンスボ

parent

ディになります。• File Detail

• File Summary

• Group

• Group Detail

• RecordSummary

• Record View

• User Detail

• User Summary

31.0Small、29.0相対的なローカライズされた文字列として書式設定された作成日(「17 分前」、「昨日」など)

DaterelativeCreatedDate

22.0Small、29.0このフィード要素への Chatter REST

API URL。Stringurl

674

汎用フィード要素Chatter REST API レスポンスボディ

Group




30.0Small、30.0グループの追加表示ラベル。たとえば、「アーカイブ済み」、「非公開」、「非公


開、顧客を含む」などがあります。追加表示ラベルがない場合、値は null です。

31.0Big、31.0グループのお知らせ。Announcementannouncement

23.0Small、29.0このグループで Chatter 顧客を許可している場合は true、それ以外の場合は false


26.0Medium、29.0コミュニティに関する情報。デフォルトのコミュニティにグループが存在するか、コミュ

Referencecommunity

ニティが無効である場合は、nullが返されます。

23.0Big、29.0グループに関するテキストのみの説明Stringdescription

30.0Medium、30.0このグループにメールで投稿するためのグループのメールアドレス。Chatterメールと、メールによるChatterへの投稿がどちらも組織で有効ではない場合は、null を返します。

StringemailToChatterAddress

29.0Big、29.0グループがアーカイブされているか (true)、否か (false) を示します。

BooleanisArchived

29.0Big、29.0グループの自動アーカイブが無効になっているか (true)、否か (false) を示します。


24.0 ～ 27.0

fileCount

プロパティ

Big、29.0このグループに投稿されたファイルの数IntegerfileCount

は Group

Detail レスポンスボディに含まれます。

23.0Small、29.0グループの 18 文字の IDStringid

31.0Big、31.0グループに投稿された最新のフィード要素の日付

DatelastFeedElementPostDate

675

GroupChatter REST API レスポンスボディ




24.0 ～ 30.0Big、29.0グループに投稿された最新のフィード項目の日付。API バージョン 30.0 より後のバージョンでは、lastFeedElementPostDateを使用します。

DatelastFeedItemPostDate

23.0Small、29.0グループメンバーの合計数IntegermemberCount

27.0Small、29.0オブジェクトがグループであることを示す小、中、大のアイコン。motif にはレコードタイプのベース色を含めることもできます。このアイコンは、グループの写真ではありません。

Motifmotif

23.0Small、29.0値は次のとおりです。StringmyRole

• GroupOwner

• GroupManager

• NotAMember

• NotAMemberPrivateRequested

• StandardMember

23.0Medium、29.0コンテキストユーザがこのグループのメンバーである場合は、登録に関する情報が含ま


れます。それ以外の場合、null を返します。

23.0Small、29.0グループの名前Stringname

24.0Medium、29.0グループの所有者に関する情報User Summaryowner

23.0Small、29.0グループの写真に関する情報Photophoto

23.0Small、29.0CollaborationGroupStringtype

23.0Small、29.0グループへの相対 URL 文字列Stringurl

23.0Small、29.0値は次のとおりです。Stringvisibility



676

GroupChatter REST API レスポンスボディ





Group Chatter Settings

特定のグループのユーザの Chatter 設定です。




27.0Small、29.0グループメンバーがグループからメールを受信する頻度。次のいずれかの値になります。


• EachPost

• DailyDigest

• WeeklyDigest

• Never

• UseDefault

値が UseDefaultの場合、User Chatter Settings

に定義されたユーザのデフォルトのグローバル設定が使用されます。コミュニティでは、グループメンバーが 10,000 人を超えると [各投稿のメール] オプションが無効になります。このオプションを選択したすべてのメンバーは、自動的に [毎日のダイジェスト] に切り替わります。

Group Detail




30.0Small、30.0グループの追加表示ラベル。たとえば、「アーカイブ済み」、「非公開」、「非公


開、顧客を含む」などがあります。追加表示ラベルがない場合、値は null です。

677

Group Chatter SettingsChatter REST API レスポンスボディ




31.0Big、31.0このグループの現在のお知らせ。Announcementannouncement

23.0Small、29.0このグループで Chatter 顧客を許可している場合は true、それ以外の場合は false


26.0Medium、29.0コミュニティに関する情報。デフォルトのコミュニティにグループが存在するか、コミュ

Referencecommunity

ニティが無効である場合は、nullが返されます。

23.0Big、29.0グループに関するテキストのみの説明Stringdescription

30.0Medium、30.0このグループにメールで投稿するためのグループのメールアドレス。Chatterメールと、メールによるChatterへの投稿がどちらも組織で有効ではない場合は、null を返します。

StringemailToChatterAddress

28.0Big、29.0このグループに投稿されたファイルの数IntegerfileCount

23.0Small、29.0グループの 18 文字の IDStringid

28.0Big、29.0グループの [情報] セクション。Web UI では、このセクションは [説明] セクションの上にあ

Group Informationinformation

ります。グループが非公開の場合は、このセクションはメンバーにのみ表示されます。コンテキストユーザがグループのメンバーでない場合や、コンテキストユーザに「すべてのデータの編集」権限または「すべてのデータの参照」権限がない場合は、値が nullになります。

31.0Big、31.0グループに投稿された最新のフィード要素の日付

StringlastFeedElementPostDate

24.0 ～ 30.0Big、29.0グループに投稿された最新のフィード項目の日付。API バージョン 30.0 より後のバージョンでは、lastFeedElementPostDateを使用します。

StringlastFeedItemPostDate

23.0Small、29.0グループメンバーの合計数IntegermemberCount

678

Group DetailChatter REST API レスポンスボディ




27.0Small、29.0オブジェクトがグループであることを示す小、中、大のアイコン。motif にはレコードタイプのベース色を含めることもできます。このアイコンは、グループの写真ではありません。

Motifmotif

23.0Small、29.0値は次のとおりです。StringmyRole

• GroupOwner

• GroupManager

• NotAMember


• StandardMember

23.0Medium、29.0コンテキストユーザがこのグループのメンバーである場合は、登録に関する情報が含ま


れます。それ以外の場合、null を返します。

23.0Small、29.0グループの名前Stringname

24.0Medium、29.0グループの所有者に関する情報User Summaryowner

29.0Medium、29.0非公開グループへの待機中の参加要求数。公開グループの場合、値は null です。

IntegerpendingRequests

23.0Small、29.0グループの写真に関する情報Photophoto

23.0Small、29.0CollaborationGroupStringtype

23.0Small、29.0グループへの相対 URL 文字列Stringurl

23.0Small、29.0値は次のとおりです。Stringvisibility




679

Group DetailChatter REST API レスポンスボディ

Group Information

グループの [情報] セクションを説明します。グループのメンバー、写真、および組織内のグループなど、グループに関する情報。グループの作成および削除、グループへのメンバーの追加、グループの写真の変更を行います。




28.0Small、29.0グループの [情報] セクションのテキストStringtext

28.0Small、29.0グループの [情報] セクションのタイトルStringtitle

Group Member




23.0Small、29.0グループメンバーシップの 18 文字の IDStringid

31.0Small、31.0グループメンバーが最後にグループフィードにアクセスした日時。

DatelastFeedAccessDate

23.0Small、29.0値は次のとおりです。Stringrole

• GroupOwner

• GroupManager

• NotAMember


• StandardMember

23.0Small、29.0このメンバーシップへの URLStringurl

23.0Small、29.0このグループに登録しているユーザに関する情報

User Summaryuser

Group Member Page




23.0Medium、29.0メンバーのこのページへの URLStringcurrentPageUrl

680

Group InformationChatter REST API レスポンスボディ




23.0Small、29.0グループメンバーのコレクションGroup Member[]members

23.0Medium、29.0コンテキストユーザがこのグループのメンバーである場合はメンバーシップに関する情

ReferencemyMembership

報を返し、それ以外の場合は nullを返します。

23.0Small、29.0メンバーの次のページへの URLStringnextPageUrl

23.0Medium、29.0メンバーの前のページへの URLStringpreviousPageUrl

23.0Small、29.0グループメンバーの合計数IntegertotalMemberCount

Group Membership Request




27.0Big、29.0メンバーシップ要求の日付を指定する ISO 形式の日付文字列

StringcreatedDate

27.0Small、29.0グループメンバー要求オブジェクトの IDStringid

27.0Small、29.0要求の最終更新日を指定する ISO 形式の日付文字列

StringlastUpdateDate

27.0Big、29.0ユーザが参加を要求しているグループに関する情報

ReferencerequestedGroup

27.0Big、29.0メンバーシップ要求が却下された場合にユーザに表示するメッセージ。このプロパティの


値は、statusプロパティの値が Declined

の場合にのみ使用されます。最大文字数は 756 文字です。

27.0Small、29.0非公開グループへの参加要求の状況。値は次のとおりです。

Stringstatus

• Accepted

• Declined

• Pending

681

Group Membership RequestChatter REST API レスポンスボディ




27.0Small、29.0このグループメンバー要求オブジェクトのURL

Stringurl

27.0Small、29.0グループのメンバーシップを要求しているユーザに関する情報

User Summaryuser

Group Membership Request Collection




27.0Small、29.0非公開グループへのすべての参加要求に関する情報

Group MembershipRequest

requests

27.0Small、29.0非公開グループへの参加要求総数Integertotal

Group Page




23.0Medium、29.0グループのこのページへの URLStringcurrentPageUrl

23.0Small、29.0グループ詳細のコレクションGroup Detail[]groups

23.0Small、29.0グループの次のページへの URLStringnextPageUrl

23.0Medium、29.0グループの前のページへの URLStringpreviousPageUrl

Group Record

グループに関連付けられたレコード。




33.0Small、33.0グループに関連付けられたレコードの18 文字の ID。

Stringid

682

Group Membership Request CollectionChatter REST API レスポンスボディ




33.0Small、33.0グループに関連付けられたレコードに関する情報。

Record SummaryUser Summary

record

33.0Small、33.0グループに関連付けられたレコードへのURL。

Stringurl

Group Record Page

グループに関連付けられたレコードのページ設定されたリスト。





33.0Small、3.0次のページへの URL。次のページがない場合、null を返します。

StringnextPageUrl

33.0Medium、3.0前のページへの URL。前のページがない場合、null を返します。


33.0Small、33.0グループに関連付けられたレコードのコレクション。

Group Record[]records

33.0Small、33.0グループに関連付けられたレコードの総数。IntegertotalRecordCount

Icon




27.0Small、29.0アイコンの高さ (ピクセル単位)Integerheight

27.0Small、29.0アイコンの幅 (ピクセル単位)Integerwidth

27.0Small、29.0アイコンの URL。この URL は、認証されていないユーザが使用できます。URL の有効期限が切れることはありません。

Stringurl

683

Group Record PageChatter REST API レスポンスボディ

Influence Thresholds




24.0Small、29.0インフルエンサーカテゴリの説明。例:Active Influencer

Stringname

24.0Small、29.0このインフルエンサーカテゴリの下限しきい値を定義する、未加工のパーセントとして表

Doublethreshold

された数値。たとえば、0.25 は、Active

Influencer カテゴリの下限値です。つまり、影響度ランクが 25% 以上で次に高いカテゴリしきい値未満のユーザがこのカテゴリに含まれます。

Knowledgeable People

指定されたトピックに関する知識のあるユーザを表します。




30.0Small、30.0コンテキストユーザが、トピックについてこの知識のあるユーザを支持している場合は

BooleanisEndorsedByMe

true、それ以外の場合は falseを指定します。

30.0Small、30.0知識のあるレコードの IDStringknowledgeableId

30.0Medium、30.0トピックについて知識のあるユーザが受け取った支持の数

IntegernumEndorsements

30.0Medium、30.0ユーザがトピックに関する知識があるとみなされる理由を指定します。有効な値は、次のとおりです。

Stringreasons

• Influential — ユーザは、トピックを含む投稿か投稿へのコメントでメンションされたか、トピックを含む投稿へのコメントでいいね! を受信しました。

• Endorsed — ユーザは、トピックについて別のユーザから支持を受け取りました。

684

Influence ThresholdsChatter REST API レスポンスボディ




30.0Small、30.0トピックに関する知識のあるユーザUser Summaryuser

Knowledgeable People Collection

Knowledgeable People レスポンスボディのコレクション。





30.0Small、30.0Knowledgeable People レスポンスボディのコレクション。

KnowledgeablePeople[]

knowledgeableUsers


StringnextPageUrl




Like


検索条件グループまたはバージョン


23.0Small、29.0いいね! の 18 文字の IDStringid

27.0Medium、29.0いいね! と言われたコメントまたはフィード要素への参照

ReferencelikedItem

23.0Small、29.0このいいね! への URLStringurl

23.0Small、29.0このコメントまたはフィード要素にいいね!

と言ったユーザに関する情報User Summaryuser

685

Knowledgeable People CollectionChatter REST API レスポンスボディ

Like Message Body







• Message Segment: Resource Link


27.0Small、29.0フィード項目またはコメントにいいね! と言ったユーザのテキストサマリー。たとえば、

Stringtext

「あなたがいいね! と言っています。」または「Renee Moreau さん、Gordon Johnson さん、および Pam Jones さんがいいね! と言っています。」などがあります。

Like Page




23.0Medium、29.0いいね! の現在のページへの URLStringcurrentPageUrl

32.0Small、32.0いいね! のコレクションLike[]items

23.0 ～ 31.0Small、29.0いいね! のコレクションLike[]likes

重要: API バージョン 32.0 以降では、items プロパティを使用します。

23.0 ～ 24.0ReferencemyLikeメモ: この項目は、バージョン 24.0 以降、使用できなくなります。

特定のいいね! への参照を返すか、nullを返します。

23.0Small、29.0いいね! の次のページへの URLStringnextPageUrl

23.0Medium、29.0いいね! の前のページへの URLStringpreviousPageUrl

23.0Small、29.0この項目のいいね! の合計数Integertotal

686

Like Message BodyChatter REST API レスポンスボディ

Link Capability

フィード要素にこの機能がある場合、リンクがあります。




32.0Small、32.0リンク URL。URL は外部サイトへのURL にできます。

Stringurl

32.0Small、32.0リンクの説明。StringurlName

List View Column

レコードの関連リストの単一列を記述します。列のレイアウト方法を記述し、列のデータは含みません。




29.0Medium、29.0この列の項目のオブジェクト種別。これは、REST API と SOAP API で使用されるオブジェクト種別です。

StringdataType

29.0Big、29.0完全修飾された API 項目 ID (Contact.Name

など)。StringfieldId

29.0Small、29.0この列のローカライズされた表示ラベル。Stringlabel

29.0Medium、29.0API 項目の短縮名 (Name など)。Stringname

List View Definition

レコードビューの関連リスト構造または検索リスト構造を定義します。リストにデータはありません。




29.0Big、29.0このリストビューに表示される項目の列。List View Column[]columns

29.0Small、29.0このリストビューのローカライズされた表示ラベル。

Stringlabel

29.0Medium、29.0このリストビューに含まれるオブジェクトの種別の定義。

List View ObjectobjectType

687

Link CapabilityChatter REST API レスポンスボディ




29.0Medium、29.0このリストビューのページあたりの最大オブジェクト数。この関連リストのすべてのオブ

IntegerrowLimit

ジェクトを表示するには、このサイズ以下のページ単位でデータを表示します。このdescribe から SOQL ステートメントを作成するには、その SOQL ステートメントにこの値と等しい LIMIT 値を含める必要があります。含めないと実行時にエラーが発生します。

29.0Medium、29.0このリストビューの並び替え基準になる列。並び替え列を優先度順に示します (1 番目の並び替え、2 番目の並び替え、以下同様)。

List View Sort[]sortColumns

List View Object

関連リストの行に表示されるレコードのタイプを定義します。




29.0Big、29.0親レコードを参照する API 項目 ID。たとえば、Account レコードに Contact レコードの関

StringfieldId

連リストがある場合、Account の Contact 関連リスト定義ではこの値は "Account"になることがあります。

29.0Small、29.0このオブジェクトのオブジェクト種別名。これは、REST API と SOAP API で使用されるオブジェクト種別です。

Stringtype

List View Record

レコードのリストビュー。

688

List View ObjectChatter REST API レスポンスボディ




30.0Medium、30.0このリストに表示されるレコードの項目と値。次のいずれかを含むコレクション。

fields

• 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

23.0Small、29.0オブジェクトの 18 文字の IDStringid

27.0Small、29.0オブジェクト種別を示す小、中、大アイコン。motif にはオブジェクトのベース色を含めることもできます。このアイコンは、ファイルのプレビューではありません。

Motifmotif

23.0Medium、29.0コンテキストユーザがこのファイルをフォローしている場合は、登録に関する情報が含



23.0Small、29.0このレコードのローカライズされた名前。Stringname

23.0Small、29.0このオブジェクトの固定の種別名。レスポンスボディの状態を判別するには、この値を調べます。

Stringtype

23.0Small、29.0このオブジェクトのChatter REST API URL リソース。

Stringurl

List View Sort

関連リストの並び替え順の序数を定義します。

689

List View SortChatter REST API レスポンスボディ




29.0Small、29.0並び替える関連リスト列の項目 ID。Stringcolumn

29.0Small、29.0列の並び替え順序。次のいずれかの値にします。

Stringorder

• Ascending — 昇順 (A から Z)。• Descending — 降順 (Z から A)。

Maintenance Information

組織の今後の定期メンテナンスに関する情報。




34.0Small、34.0メンテナンスの説明。Stringdescription

34.0Small、34.0メンテナンスのタイトル。StringMaintenanceTitle

34.0Small、34.0メンテナンスの種別を指定します。次のいずれかになります。

StringMaintenanceType

• Downtime — ダウンタイムメンテナンス。

• GenerallyAvailable — 正式リリースモードでのメンテナンス。

• MaintenanceWithDowntime —

ダウンタイムを伴う定期メンテナンス。

• ReadOnly — 参照のみモードでのメンテナンス。

34.0Small、34.0ユーザへのメンテナンスメッセージの表示開始日。

DatemessageEffectiveTime

34.0Small、34.0メンテナンスメッセージの有効期限。

DatemessageExpirationTime

34.0Small、34.0スケジュール設定されたダウンタイム終了日。

DatescheduledEndDowntime

GenerallyAvailable および

690

Maintenance InformationChatter REST API レスポンスボディ




ReadOnly メンテナンス種別の場合は null。

34.0Small、34.0定期メンテナンス終了日。Downtimeメンテナンス種別の場合は null。

DatescheduledEndMaintenanceTime

34.0Small、34.0スケジュール設定されたダウンタイム開始日。

DatescheduledStartDowntime

GenerallyAvailable およびReadOnly メンテナンス種別ではnull になります。

34.0Small、34.0定期メンテナンス開始日。Downtimeメンテナンス種別の場合は null。

DatescheduledStartMaintenanceTime

Managed Topic

コミュニティの管理トピックを表します。




32.0Small、32.0管理トピックの ID。Stringid

32.0Small、32.0管理トピックの種別。StringmanagedTopicType • Featured — コミュニティホー



32.0Small、32.0トピックに関する情報。Topictopic

32.0Small、32.0管理トピックへの Chatter REST API

URL。Stringurl

691

Managed TopicChatter REST API レスポンスボディ

Managed Topic Collection

コミュニティの管理トピックのコレクション。






32.0Small、32.0管理トピックのコレクション。Managed Topic[]managedTopics

Mention Completion

ユーザまたはグループの @メンションに使用できるレコードに関する情報。




29.0Big、29.0この補完で表されるレコードの追加の表示ラベル (存在する場合) (「(Customer)」や「(Acme

Corporation)」など)。


29.0Medium、29.0この補完で表されるレコードの説明。Stringdescription

29.0Small、29.0この補完で表されるレコードの名前Stringname

29.0Medium、29.0この補完で表されるレコードの写真またはアイコンの URL

StringphotoUrl

29.0Small、29.0この補完で表されるレコードの 18 文字の IDStringrecordId

30.0Medium、30.0この完了によって表されるレコードがユーザの場合、この値はそのユーザに関連付けられ

StringuserType

たユーザ種別になります。それ以外の場合は、null です。次のいずれかの値にします。• ChatterGuest — 非公開グループの外部

ユーザ。• ChatterOnly — Chatter Free ユーザ。• Guest — 認証されていないユーザ。• Internal — 標準組織メンバー。• Portal — カスタマーポータル、パート


692

Managed Topic CollectionChatter REST API レスポンスボディ






Mention Completion Page

Mention Completion レスポンスボディのページ設定されたリスト。




29.0Medium、29.0現在のページの URLStringcurrentPageUrl

29.0Small、29.0メンションで使用する Mention Completion レスポンスボディのコレクション。

MentionCompletion[]

mentionCompletions


StringnextPageUrl




Mention Validation

提案メンションがコンテキストユーザに有効かどうかに関する情報。




29.0Small、29.0メンションされたレコードの ID。StringrecordId

693

Mention Completion PageChatter REST API レスポンスボディ




29.0Small、29.0提案メンションの検証エラーの種類を示します (存在する場合)。次のいずれかの値にします。

StringvalidationStatus

• Disallowed — 提案メンションは無効であり、コンテキストユーザが許可されていない対象にメンションしようとしているため却下されます。たとえば、非公開グループのメンバーでないユーザが非公開グループにメンションしようとしている場合などです。

• Inaccessible — 提案メンションは許可されていますが、メンションされるユーザまたはレコードには議論されている親レコードへのアクセス権がないため、通知されません。

• Ok — 提案メンションに検証エラーはありません。

Mention Validations

メンションのセットがコンテキストユーザに有効かどうかに関する情報。




29.0Small、29.0提案メンションのうち、少なくとも 1 つにエラーがあるか (true)、否か (false) を示しま

BooleanhasErrors

す。たとえば、コンテキストユーザは自分が属していない非公開グループにメンションできません。そのようなグループがメンションの検証のリストに含まれていると、hasErrors は true になり、そのメンションの検証で Disallowed のvalidationStatus がグループに設定されます。

29.0Medium、29.0メンションのセットがコンテキストユーザに有効かどうかに関する情報。

Mention Validation[]mentionValidations

694

Mention ValidationsChatter REST API レスポンスボディ

Message




23.0Small、29.0このメッセージのテキストFeed Item Bodybody

23.0Big、29.0このメッセージが含まれる会話の 18 文字のID

StringconversationId

23.0Small、29.0このメッセージが含まれる会話への URLStringconversationUrl

23.0Small、29.0メッセージの 18 文字の IDStringid

23.0Small、29.01 人以上のメッセージ受信者のコレクションUser Summary[]recipients

メモ: Conversation Detail と Conversation

Summaryの会話の membersプロパティで会話の参加者は特定されるため、次のリソースのメール受信者のコレクションは空になっています。• /chatter/users/me/

conversations

• /chatter/users/me/conversations/conversationId


StringsentDate

23.0Small、29.0このメッセージを送信したユーザに関する情報

User Summarysender

32.0Medium、32.0メッセージの送信元のコミュニティに関する情報デフォルトのコミュニティの場合またはコミュニティが無効の場合は nullが返されます。

ReferencesendingCommunity

23.0Small、29.0このメッセージへの URLStringurl

695

MessageChatter REST API レスポンスボディ

Message Collection





23.0Small、29.01 つ以上のメッセージのコレクションMessage[]messages


StringnextPageUrl


Message Segment: Entity Link

ユーザまたはグループなどのエンティティを表します。




27.0Small、29.0エンティティ種別に対応する小、中、大の一連のアイコン motif には、エンティティ種別のベース色を含めることもできます。

Motifmotif

25.0Small、29.0エンティティに関する情報Referencereference

25.0Small、29.0このセグメントのプレーンテキスト出力Stringtext

25.0Small、29.0EntityLinkStringtype

Message Segment: Field Change

インライン項目変更を表します。

例: インライン項目変更の例として、"First Name from Bob to Joe" などがあります。次のセグメント例は、複数のセグメントで構成されています。[

Text("Owner from "),

FieldChangeValue("Bob Smith"),

696

Message CollectionChatter REST API レスポンスボディ

Text(" to "),

FieldChangeValue("Dave Jones")

]





Segments[]segments


• 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


23.0Small、29.0変更の書式設定済みテキスト。次に例を示します。"City from San Francisco to

New Orleans"

Stringtext

23.0Small、29.0値は FieldChangeStringtype

Message Segment: Field Change Name

項目変更のインライン項目名を表します ("Name" や "Description" など)。これを別個のセグメントにすることで、名前項目を太字にするなど、項目名に対して特殊なユーザインターフェース処理を行うことができます。

697

Message Segment: Field Change NameChatter REST API レスポンスボディ




23.0Small、29.0変更の書式設定済みテキスト。値には、次のものがあります。

Stringtext

• 項目の以前の名前• 項目の新しい名前

23.0Small、29.0値は FieldChangeNameStringtype

Message Segment: Field Change Value

項目変更のインライン値を表します ("1" や "Bob Smith" など)。これを別個のセグメントにすることで、値をアンカータグで囲むなど、特殊なコーディングを追加できます。




29.0Big、29.0値の型。次のいずれかの値にします。StringvalueType

• NewValue — 項目変更の新しい値。• OldValue — 項目変更の以前の値。

23.0Small、29.0変更の書式設定済みテキスト。値には、次のものがあります。

Stringtext

• a blank value という語

メモ: このテキストはローカライズされます。

• 項目の以前の値• 項目の新しい値

23.0Small、29.0値は FieldChangeValueStringtype

23.0Small、29.0項目変更が URL 項目 (Web アドレスなど) に対するものである場合、URL 値

Stringurl

Message Segment: Hashtag

インラインハッシュタグを表します。

698

Message Segment: Field Change ValueChatter REST API レスポンスボディ




23.0Small、29.0ハッシュ記号 (#) を除いたハッシュタグのテキスト

Stringtag

23.0Small、29.0ハッシュ記号 (#) 付きのハッシュタグのテキスト

Stringtext

28.0Small、29.0次の形式のトピックの URL:

/services/data/.../topics?exactMatch=true&q=tag

StringtopicUrl

23.0Small、29.0値は HashtagStringtype

23.0Small、29.0次の形式のタグの URL 検索:

services/data/.../feed-elements?q=tag

Stringurl

Message Segment: Link

URL へのインラインリンクを表します。




23.0Small、29.0このセグメントのフィード項目の書式設定済みテキスト

Stringtext

23.0Small、29.0値は LinkStringtype

23.0Small、29.0リンクの URL 値Stringurl

Message Segment: Mention

インラインの @メンションを表します。




23.0Small、29.0メンションされたユーザまたはグループがメンションを表示できるか (true)、否か(false) を示します。

Booleanaccessible

699

Message Segment: LinkChatter REST API レスポンスボディ




23.0Small、29.0メンションされたユーザまたはグループの名前

Stringname

23.0Small、29.0このセグメントのフィード項目の書式設定済みテキスト

Stringtext

23.0Small、29.0値は MentionStringtype

29.0Small、29.0メンションされたユーザまたはグループに関する情報。次のいずれかのレスポンスボディになります。

record

• Group

• User Detail

• User Summary

23.0 ～ 28.0

29.0 より前のバージョ

なしメンションされたユーザに関する情報。コンテキストユーザにアクセス権がない場合はnull。

User Summaryuser

ンでは、メ重要: バージョン 29.0 以降では、record プロパティを使用します。ンションが

ユーザでない場合、メンションはMessageSegment: Text

レスポンスボディに含まれます。

Message Segment: More Changes




29.0Big、29.0フィード項目の追跡変更の完全なコレクション。

Message Segment:Field Change[]

moreChanges

23.0Small、29.0変更の数IntegermoreChangesCount

700

Message Segment: More ChangesChatter REST API レスポンスボディ




23.0Small、29.0変更数の書式設定済みテキスト。例: "2other changes"

Stringtext

メモ: この値はローカライズされます。

23.0Small、29.0値は MoreChangesStringtype

Message Segment: Resource Link




23.0Small、29.0このセグメントの書式設定済みテキストStringtext

23.0Small、29.0値は "ResourceLink"Stringtype

27.0Small、29.0リソースリンクの URL 値Stringurl

Message Segment: Text

プレーンインラインテキストを表します。




23.0Small、29.0項目に関連付けられた書式設定済みテキスト。値には、次のものがあります。

Stringtext

• コメントの書式設定済みテキスト• from という語を使用して示される、変

更された項目の名前

23.0Small、29.0値は TextStringtype

Moderation Capability

フィード要素にこの機能がある場合、コミュニティのユーザはフィード要素にモデレーションフラグを設定できます。このレスポンスボディには、フラグが設定されたコンテンツに関する情報も含まれます。

701

Message Segment: Resource LinkChatter REST API レスポンスボディ




31.0Big、31.0このフィード要素のフラグ。コミュニティモデレータは、フラグ付き


項目を表示したり、フラグ付き項目に対してアクションを実行したりできます。

Moderation Flags

Moderation flags は、組織で Salesforce Communities が有効になっていて、コミュニティ管理者がコミュニティ設定時に [メンバーにコンテンツのフラグの設定を許可] を選択した場合に使用できます。




29.0Small、29.0コンテキストユーザがコミュニティモデレータの場合、投稿、コメント、またはファイル

IntegerflagCount

のフラグの総数を示します。コンテキストユーザがコミュニティモデレータでない場合は、値が null になります。ファイルのフラグは、バージョン 30.0 以降で使用できます。

29.0Small、29.0投稿、コメント、またはファイルにコンテキストユーザがフラグを設定したか (true)、否か (false) を示します。ファイルのフラグは、バージョン 30.0 以降で使用できます。

BooleanflaggedByMe

Motif

motif プロパティには、Salesforceレコードタイプを示す小、中、大のアイコンへの URL があります。一般的なレコードタイプは、ファイル、ユーザ、グループですが、すべてのレコードタイプに一連の motif アイコンがあります。カスタムオブジェクトレコードでは、タブスタイルアイコンが使用されます。認証されていないユーザでもすべてのアイコンを使用できるため、たとえば、motif アイコンをメールで表示することができます。motif にはレコードタイプのベース色を含めることもできます。

702

Moderation FlagsChatter REST API レスポンスボディ

例:

メモ: 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",



"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

MotifChatter REST API レスポンスボディ

"color": "1797C0",



"smallIconUrl": "/img/icon/files16.png",

"svgIconUrl": null

},

メモ: 前の例のアイコンを表示するには、URL を https://instance_name で置き換えます。たとえば、https://instance_name/img/icon/profile64.png に保存されます。




29.0Small、29.0レコードタイプのベース色を表す 16 進値または null。

Stringcolor

27.0Small、29.0レコードタイプを示す大アイコンStringlargeIconUrl

27.0Small、29.0レコードタイプを示す中アイコンStringmediumIconUrl

27.0Small、29.0レコードタイプを示す小アイコンStringsmallIconUrl

34.0Small、34.0レコードタイプを示す SVG 形式のアイコン、またはアイコンが存在しない場合は null。

StringsvgIconUrl

Non-Entity Recommendation

Salesforce 以外のエンティティ (アプリケーションなど) のおすすめを表します。このレスポンスボディは、バージョン 34.0 以降では使用できません。バージョン 34.0 以降では、すべてのおすすめに Recommendation レスポンスボディが使用されます。




32.0Small、32.0非エンティティオブジェクトのローカライズされた表示ラベル。

StringdisplayLabel

23.0Big、29.0おすすめの説明。ExplanationSummary

explanation

32.0Small、32.0非エンティティオブジェクトのMotif。

Motifmotif

704

Non-Entity RecommendationChatter REST API レスポンスボディ




32.0Small、32.0おすすめされるレコードのタイプを示します。

StringrecommendationType

• apps

• files

• groups

• records

• users

Organization




24.0Small、29.0この時間を過ぎると、何も操作を行っていないユーザに対し、ログアウトするか操作を続

IntegeraccessTimeout

行するかを選択させるポップアップウィンドウが表示されます。

24.0Small、29.0組織またはコミュニティで使用可能な機能に関する情報

Featuresfeatures

34.0Medium、34.0組織で今後予定されているメンテナンスのリストに関する情報。

MaintenanceInformation[]

maintenanceInfo

26.0Small、29.0組織名Stringname

24.0Small、29.0組織の 18 文字の IDStringorgId

24.0Small、29.0ユーザの組織権限に関する情報User SettingsuserSettings

Origin Capability

フィード要素にこの機能がある場合、そのフィード要素はフィードアクションによって作成されています。




33.0Small、33.0フィードアクションを実行したユーザ。

User Summaryactor

705

OrganizationChatter REST API レスポンスボディ




33.0Small、33.0フィードアクションが含まれるフィード要素への参照。

ReferenceoriginRecord

Phone Number

電話番号。




30.0Small、30.0電話の種別を示すローカライズされた文字列Stringlabel

23.0 ～ 26.0なしStringnumberメモ: このプロパティは、バージョン26.0 以降では使用できません。代わりに、phoneNumber プロパティを使用してください。

電話番号27.0Small、29.0電話番号StringphoneNumber

30.0Small、30.0電話の種別。次のいずれかの値にします。StringphoneType

• Fax

• Mobile

• Work

これらの値はローカライズされません。

23.0 ～ 29.0Small、29.0Stringtypeメモ: このプロパティは、バージョン29.0 以降では使用できません。代わりに、phoneTypeプロパティを使用してください。

値は次のとおりです。• Fax

• Mobile

• Work

706

Phone NumberChatter REST API レスポンスボディ

Photo




27.0Medium、29.030 日後に有効期限が切れる大きなプロファイル写真への一時的な URL。この URL は、認証されていないユーザが使用できます。

StringfullEmailPhotoUrl

23.0Medium、29.0大きなプロファイル写真への URL。デフォルトの幅は 200 ピクセルです。長さは、元の画像の比率が維持されるように設定されます。

StringlargePhotoUrl

24.0Small、29.0そのバージョンの写真の 18 文字の IDStringphotoVersionId

23.0Small、29.0小さいプロファイル写真への URL。デフォルトのサイズは 64x64 ピクセルです。

StringsmallPhotoUrl

27.0Small、29.030 日後に有効期限が切れる小さいプロファイル写真への一時的な URL。この URL は、認証されていないユーザが使用できます。

StringstandardEmailPhotoUrl

27.0Small、29.0Photo レスポンスボディを返すリソースの URL(/services/data/v34.0

Stringurl

/chatter/users/005D0000001LL8OIAW/photo

など)

Platform Action

コンテキストユーザの状態情報を含むプラットフォームアクションインスタンス。アクションリンクは、プラットフォームアクションの種別の 1 つなので、Platform Action レスポンスボディとして表されます。




33.0Medium、33.0subtype Ui または Download のアクションリンクの場合、このリ

StringactionUrl

ンクからユーザにダウンロードやUI アクセスを行わせます。Salesforce

は次の形式でリンクの Javascript リダイレクトを発行します:/action-link-redirect/communityId/actionLinkId?_bearer=bearerToken

707

PhotoChatter REST API レスポンスボディ




Api および ApiAsync アクションリンク、およびすべてのプラットフォームアクションの場合、この値は null になります。Salesforce により、Api およびApiAsync アクションリンクへのコールアウトが処理されます。/connect/action-links/actionLinkId

リソースに対して PATCH 要求を実行し、statusを PendingStatusに設定して、Api または ApiAsync

アクションリンクをコールすることもできます。

33.0Medium、33.0API 名。この値は null になることがあります。

StringapiName

33.0Medium、33.0このアクションに確認が必要で、状況が NewStatusの場合は、この

StringconfirmationMessage

プロパティがローカライズされたデフォルトのメッセージになり、このアクションを呼び出す前にエンドユーザに表示されます。それ以外の場合は、この値が nullになります。

33.0Medium、33.0このアクションがコンテキストユーザによって呼び出された後にその

Record Summary[]createdRecords

アクションによって作成されたレコードのコレクションです。コンテキストユーザがアクションを実行していない場合、またはアクションによってレコードが作成されていない場合、このコレクションは空になります。コンテキストユーザによって作成されたレコードのみが表示されます。

33.0Medium、33.0プラットフォームアクションの実行を開始したユーザ。

User SummaryexecutingUser

33.0Small、33.0このプラットフォームアクションがプラットフォームアクショング

BooleangroupDefault

708

Platform ActionChatter REST API レスポンスボディ




ループのデフォルトまたはプライマリのプラットフォームアクションの場合は true、それ以外の場合は false。デフォルトプラットフォームアクションはプラットフォームアクショングループごとに 1 つのみです。

33.0Medium、33.0プラットフォームアクションのアイコンの URL。この値は、null になる場合があります。

StringiconUrl

33.0Small、33.0プラットフォームアクションの ID。type が QuickAction で、subtype が Create の場合、この値は null になります。

Stringid

33.0Small、33.0このプラットフォームアクションのローカライズされた表示ラベル。

Stringlabel


DatemodifiedDate

33.0Small、33.0このプラットフォームアクションを含むプラットフォームアクショングループへの参照。

ReferenceplatformActionGroup

33.0Small、33.0プラットフォームアクションの実行状況。値は次のとおりです。

Stringstatus


• NewStatus — アクションリンクの実行の準備が整っています。Download および Ui アクションリンクでのみ使用できます。

• PendingStatus — アクションリンクが実行されています。この値を選択すると、Api およびApiAsync アクションリンクのAPI コールがトリガされます。

709






アクションリンクに限り、/connect/action-links/actionLinksIdリソースに対して PATCH 要求を実行することによって、statusを更新できます。

33.0Small、33.0プラットフォームアクションのサブタイプまたは null。typeプロパティが ActionLinkの場合、使用できる値は次のとおりです。

Stringsubtype

• Api — アクションリンクは、アクション URL で同期 API をコールします。Salesforce は、サーバから返された HTTP 状況コードに基づいて状況をSuccessfulStatus またはFailedStatusに設定します。

• ApiAsync — アクションリンクは、アクション URL で非同期 API

をコールします。アクションは、非同期操作の完了時にサードパーティが/connect/action-links/actionLinkId

への要求を行って状況をSuccessfulStatus またはFailedStatus に設定するまで、PendingStatus 状態のままになります。



710





33.0Small、33.0プラットフォームアクションの種別。値は次のとおりです。

Stringtype

• ActionLink — API、Web ページ、またはファイルを指す、フィード要素上のインジケータで、Salesforce Chatter フィード UI

のボタンによって表されます。• ProductivityAction — 生産

性アクションは Salesforce によって事前定義され、限られたオブジェクトのセットに適用されます。生産性アクションを編集または削除することはできません。

• CustomButton — クリックすると、ウィンドウ内で URL またはVisualforce ページが開くか、JavaScript が実行されます。

• QuickAction — グローバルアクションまたはオブジェクト固有のアクション。

• StandardButton — 事前定義されたSalesforceボタン ([新規]、[編集]、[削除] など)。

33.0Small、33.0プラットフォームアクションのChatter REST API リソース URL。type が QuickAction で、subtype が Create の場合、この値は null になります。

Stringurl

Platform Action Group

コンテキストユーザに適した状態のプラットフォームアクショングループインスタンス。アクションリンクグループは、プラットフォームアクショングループの種別の 1 つなので、Platform Action Group

レスポンスボディとして表されます。

711

Platform Action GroupChatter REST API レスポンスボディ




33.0Medium、33.0プラットフォームアクションの優先度および相対位置を示します。値は次のとおりです。

Stringcategory


• Overflow — アクションリンクグループは、フィード要素のオーバーフローメニューに表示されます。

33.0Small、33.0プラットフォームアクショングループの 18 文字の ID か、不透明な文字列の ID。プラットフォームアクションのtype が QuickAction で、

Stringid

subtype が Create の場合、この値は null になります。


2011—02—25T18:24:31.000Z)。DatemodifiedDate

33.0Medium、33.0このグループのプラットフォームアクションインスタンス。アクションリンクグループ内では、アクションリンクは、Action Link

Platform Action[]platformActions

Group Definition Input リクエストボディの actionLinksプロパティにリストされる順序で表示されます。フィード項目内では、アクションリンクグループは、Associated Actions

Capability Input リクエストボディのactionLinkGroupIdsプロパティに指定された順序で表示されます。

33.0Small、33.0プラットフォームアクショングループの Chatter REST API リソース URL。プラットフォームアクションのtype が QuickAction で、

Stringurl

subtype が Create の場合、この値は null になります。

712

Platform Action GroupChatter REST API レスポンスボディ

Poll Capability

フィード要素にこの機能がある場合、フィード要素に投票のアンケートを含めることができます。




32.0Small、32.0アンケートを構成するアンケート選択肢のコレクション。

Feed Poll Choice[]choices

32.0Small、32.0このアンケートで現在のユーザが投票した選択肢の 18 文字の ID。現

StringmyChoiceId

在のユーザが投票していない場合は、null を返します。

32.0Small、32.0フィードアンケート要素に投じられた投票の合計数。

StringtotalVoteCount

Question and Answers Capability

フィード要素にこの機能がある場合、質問があり、フィード要素のコメントはその質問への回答です。




32.0Small、32.0質問の最良の回答として選択されたコメント。

CommentbestAnswer

32.0Small、32.0質問の最良の回答を選択したユーザ。

User SummarybestAnswerSelectedBy

32.0Small、32.0現在のユーザが最良の回答を選択または削除できるか (true)、否か(false) を示します。

BooleancanCurrentUserSelectOrRemoveBestAnswer

33.0Medium、33.0質問の投稿がエスカレーションされた場合、これがエスカレーション先ケースになります。

ReferenceescalatedCase

32.0Small、32.0質問のタイトル。StringquestionTitle

Question and Answers Suggestion Collection

質問および回答の提案の検索結果。

713

Poll CapabilityChatter REST API レスポンスボディ




32.0Small、32.0記事のコレクション。Article Item[]articles

32.0Small、32.0質問のコレクション。質問は次のいずれかになります。

questions

• 汎用フィード要素• Feed Item

Recommendation

おすすめを表します。




23.0Small、29.0ユーザ、ファイル、グループ、およびレコード entity 種別の場合、この Chatter REST URL

StringactOnUrl

を POST 要求に使用して、おすすめのユーザ、ファイル、またはレコードをフォローするか、おすすめのグループに参加します。次に例を示します。/services/data/v34.0/chatter/users/005D0000001AzOAIA0/following

?subjectId=005D0000001B4CvIAK

カスタムのおすすめなど、おすすめのオブジェクト entity種別の場合、Platform Action

レスポンスボディの actionUrlプロパティを使用しておすすめに対応します。

Small、29.0おすすめに対して実行するアクションを指定します。値は次のとおりです。

Stringaction

• follow (V23.0)

• join (V23.0)

• view (V25.0)

32.0Small、32.0受信者がアクションを実行することをすすめられたエンティティ。

File Summary

グループentity

714

RecommendationChatter REST API レスポンスボディ




Recommended

Object (バージョン 34.0 以降)

Record Summary

User Summary

23.0Big、29.0おすすめの説明。ExplanationSummary

explanation

23.0 ～ 31.0Small、29.0受信者がアクションを実行することをすすめられたオブジェクト。

File Summary

グループobject

重要: バージョン 32.0 以降では、entity プロパティを使用します。

Record Summary

User Summary

34.0Small、34.0コンテキストユーザに適した状態のプラットフォームアクショングループインスタンス。

Platform ActionGroup

platformActionGroup

32.0Small、32.0おすすめされるレコードのタイプを示します。

StringrecommendationType

• apps

• files

• groups

• records

• users

23.0 ～ 23.0バージョン 23.0 以降では使用できません。Stringtype

34.0Small、34.0おすすめへの URL。Stringurl

Recommendation Definition

カスタムおすすめ定義を表します。




33.0Small、33.0このおすすめに基づいて行動するための URL。

StringactionUrl

34.0Small、34.0ユーザインターフェースでのアクション URL のテキストラベル。

StringactionUrlName

715

Recommendation DefinitionChatter REST API レスポンスボディ




33.0Medium、33.0おすすめ定義の説明。Stringexplanation

33.0Small、33.0おすすめ定義の 18 文字の ID。Stringid

33.0Medium、33.0おすすめ定義の名前。この名前が[設定] に表示されます。

Stringname

33.0Medium、33.0おすすめ定義の写真。Photophoto

33.0Small、33.0おすすめ定義のタイトル。Stringtitle

33.0Small、33.0おすすめ定義の Chatter REST API リソースへの URL。

Stringurl

Recommendation Definition Collection

おすすめ定義のリストを表します。




33.0Small、33.0おすすめ定義のリスト。RecommendationDefinition[]

recommendationDefinitions

33.0Small、33.0おすすめ定義コレクションのChatter

REST API リソースへの URL。Stringurl

Recommendations

推奨事項のリスト。




23.0Small、29.0推奨事項のコレクション。Recommendation[]recommendations

Recommendations Capability

フィード要素にこの機能がある場合、おすすめがあります。

716

Recommendation Definition CollectionChatter REST API レスポンスボディ




32.0Small、32.0おすすめのコレクション。次のレスポンスボディからなる

items

コレクションです。• Non-Entity

Recommendation

このレスポンスボディは、バージョン34.0 以降では使用できません。バージョン 34.0 以降では、すべてのおすすめにRecommendation

レスポンスボディが使用されます。

• Recommendation

Recommended Object

カスタムのおすすめや静的なおすすめなど、おすすめのオブジェクト。




34.0Small、34.0カスタムのおすすめの、おすすめ定義の ID。

StringidOrEnum

34.0Small、34.0おすすめのオブジェクトの Motif。Motifmotif

22.0Small、29.0おすすめのオブジェクトの名前。Stringname

22.0Small、29.0RecommendedObjectStringtype

Record Field

表示ラベルおよびテキスト値を含む汎用レコード項目。

717

Recommended ObjectChatter REST API レスポンスボディ




29.0Small、29.0レコード項目を説明するローカライズされた文字列。

Stringlabel

29.0Small、29.0レコード項目のテキスト値。すべてのレコード項目にテキスト値があります。すべてのク

Stringtext

ライアントが新しいコンテンツを使用できることを確認するために、レコード項目のtypeプロパティを調べます。認識されない場合は、デフォルトケースとしてテキスト値を表示します。

29.0Small、29.0有効な値は、次のとおりです。Stringtype

• Boolean

• Email

• Number

• Phone

• Text

Record Field: Blank

項目のグリッドにプレースホルダとして表示されるレコード項目。




29.0Small、29.0BlankStringtype

Record Field: Compound

サブ項目で構成されるレコード項目。




29.0Big、29.0複合項目を構成するサブ項目のコレクション。次のレスポンスボディからなるコレクションです。

fields

• Record Field

718

Record Field: BlankChatter REST API レスポンスボディ













Stringlabel


Stringtext



• Address

• Compound

• Location

• Name

Record Field: Currency

通貨値を含むレコード項目。





Stringlabel


Stringtext

ライアントが新しいコンテンツを使用できる

719

Record Field: CurrencyChatter REST API レスポンスボディ




ことを確認するために、レコード項目のtypeプロパティを調べます。認識されない場合は、デフォルトケースとしてテキスト値を表示します。通貨は、組織のデフォルトの通貨の形式になります。

29.0Small、29.0CurrencyStringtype

Record Field: Date

日付を含むレコード項目。




29.0Medium、29.0機械可読の日付。DatedateValue


Stringlabel


Stringtext



• Date

• DateTime

• Time

Record Field: Percent

パーセント値を含むレコード項目。

720

Record Field: DateChatter REST API レスポンスボディ




29.0Medium、29.0パーセントの値。Doublevalue


Stringlabel


Stringtext


29.0Small、29.0PercentStringtype

Record Field: Picklist

列挙値を含むレコード項目。





Stringlabel


Stringtext


29.0Small、29.0PicklistStringtype

Record Field: Reference

別のオブジェクトへの参照を含むレコード項目。

721

Record Field: PicklistChatter REST API レスポンスボディ





Stringlabel

29.0Medium、29.0レコード項目によって参照されるオブジェクト。

Referencereference


Stringtext


29.0Small、29.0ReferenceStringtype

Record Field: Reference with Date

特定の時刻に動作した参照されるオブジェクトを含むレコード項目 (「作成者」など)。




29.0Medium、29.0参照されるオブジェクトが動作した時刻。DatedateValue


Stringlabel

29.0Medium、29.0レコード項目によって参照されるオブジェクト。

Referencereference


Stringtext



• CreatedBy

• LastModifiedBy

722

Record Field: Reference with DateChatter REST API レスポンスボディ

Record Snapshot Capability

フィード要素にこの機能がある場合、1 つのレコード作成イベントについて、レコードのスナップショットとして取得された項目すべてが含まれます。




32.0Small、32.0メタデータとデータを含むレコード表現で、レコードを簡単に表示できるようになります。

Record ViewrecordView

Record Summary




23.0Small、29.0レコードの 18 文字の IDStringid

27.0Small、29.0レコードのタブスタイルを示す小、中、大のアイコン。motif にはレコードタイプのベース色を含めることもできます。

Motifmotif

24.0Medium、29.0コンテキストユーザがこのレコードをフォローしている場合は、登録に関する情報が含



23.0Small、29.0ローカライズされた名前Stringname

23.0Small、29.0レポートタイプ (CustomObject やContentDocument など)

Stringtype

23.0Small、29.0このレコードの相対 URLStringurl

Record Summary List

組織のレコード (カスタムオブジェクトを含む) のコレクションに関するサマリー情報。

723

Record Snapshot CapabilityChatter REST API レスポンスボディ




30.0Small、30.0レコードのコレクション。コレクションには、次のレスポンスボディのいずれかが含まれる場合があります。

records

• File Summary

• Group

• Record Summary

• User Summary

30.0Small、30.0このレコードのコレクションへの URL。Stringurl

Record View

組織のレコード (カスタムオブジェクトレコードを含む) のビュー。このオブジェクトは、レコードタイプで特殊なオブジェクト (User や ChatterGroup など) を使用できない場合に使用されます。データとメタデータが含まれるため、レコードを 1 つの応答で表示できます。




23.0Small、29.0オブジェクトの 18 文字の IDStringid

27.0Small、29.0オブジェクト種別を示す小、中、大アイコン。motif にはオブジェクトのベース色を含めることもできます。このアイコンは、ファイルのプレビューではありません。

Motifmotif

23.0Medium、29.0

コンテキストユーザがこのファイルをフォローしている場合は、登録に関する情報が含まれます。それ以外の場合は、null を返します。


29.0Small、29.0ローカライズされた名前Stringname

29.0Medium、29.0

このオブジェクトの関連リスト定義 (メタデータ)。これらのリスト定義には、関連リストデータは含まれません。

List View Definition[]relatedListDefinitions

29.0Small、29.0レコードビューセクションのリスト。Record View Section[]sections

724

Record ViewChatter REST API レスポンスボディ




23.0Small、29.0このオブジェクトの固定の種別名。レスポンスボディの状態を判別するには、この値を調べます。

Stringtype

23.0Small、29.0このオブジェクトのChatter REST API URL リソース。

Stringurl

Record View Section

レコード詳細のレコード項目と値のセクション。




29.0Small、29.0レコードセクションに項目をレイアウトするために使用する列の数。

StringcolumnCount

29.0Small、29.0レコードセクションに項目をレイアウトするために fields プロパティで使用する項目の順序。

StringcolumnOrder

• LeftRight — 項目は左から右に表示されます。

• TopDown — 項目は上から下に表示されます。

29.0Small、29.0このセクションに含まれるレコードの項目と値。次のレスポンスボディからなるコレクションです。

fields

• Record Field









725

Record View SectionChatter REST API レスポンスボディ




29.0Small、29.0この項目のセクションを表示するときに使用するローカライズされた表示ラベル。

Stringheading

29.0Small、29.0このセクションを折りたたんですべての項目を非表示にできるか (true)、否か (false) を示します。

BooleanisCollapsible

Reference

レコードへの参照。




23.0Small、29.0参照するレコードの ID。18 文字の ID または他の文字列 ID を指定できます。

Stringid

23.0Small、29.0リソースエンドポイントへの URL。Stringurl

Repository File Detail

リポジトリファイルの詳細な説明。Repository File Detail レスポンスボディには、Repository File Summary レスポンスボディのすべてが含まれます。

Repository File Summary

リポジトリファイルの説明。




32.0Small、32.0ファイルのチェックインコメント。StringcheckinComment

32.0Small、32.0ファイルのコンテンツの長さ (バイト単位)。

IntegercontentSize

32.0Small、32.0ファイルを作成したユーザの名前。StringcreatedBy

32.0Small、32.0ファイルの作成日。DatecreatedDate

32.0Small、32.0ファイルの説明。Stringdescription

726

ReferenceChatter REST API レスポンスボディ




32.0Small、32.0リポジトリファイルコンテンツへの URL。

StringdownloadUrl

32.0Small、32.0外部システムにおけるこのファイルのコンテンツの URL。

StringexternalContentUrl

32.0Small、32.0外部システムにおけるこのファイルの URL。


32.0Small、32.0ファイルの ID。Stringid

32.0Small、32.0ファイルの MIME タイプ。StringmimeType

32.0Small、32.0ファイルを最後に変更したユーザの名前。

StringmodifiedBy

32.0Small、32.0ファイルの変更日。DatemodifiedDate

32.0Small、32.0ファイルの Motif。Motifmotif

32.0Small、32.0ファイルの名前。Stringname

32.0Small、32.0ファイルの外部リポジトリ。Referencerepository

32.0Small、32.0ファイルのタイトル。Stringtitle

32.0Small、32.0レコードタイプ file。Stringtype

32.0Small、32.0このファイルのChatter REST API URL。Stringurl

32.0Small、32.0外部システムにおけるファイルバージョンの ID。

StringversionId

Repository Folder Item

フォルダ項目の説明。




32.0Small、32.0このフォルダ項目がファイルを表す場合は、ファイルのサマリー。

Repository FileSummary

file

このフォルダ項目がフォルダを表す場合は、null。

32.0Small、32.0このフォルダ項目がフォルダを表す場合は、フォルダのサマリー。

Repository FolderSummary

folder

727

Repository Folder ItemChatter REST API レスポンスボディ




このフォルダ項目がファイルを表す場合は、null。

32.0Small、32.0フォルダ項目の種別 (folder または file)。

Stringtype

Repository Folder Items Collection

リポジトリフォルダ項目のコレクション。






32.0Small、32.0リポジトリフォルダ内の項目のコレクション。

Repository FolderItem[]

items




エラーが返されます。32.0Medium、32.0前のページを識別する Chatter REST



Repository Folder Summary

リポジトリフォルダの説明。




32.0Small、32.0フォルダを作成したユーザの名前。StringcreatedBy

32.0Small、32.0フォルダの作成日。DatecreatedDate

32.0Small、32.0フォルダの説明。Stringdescription

728

Repository Folder Items CollectionChatter REST API レスポンスボディ




32.0Small、32.0外部システムにおけるこのフォルダの Chatter REST API URL。

StringexternalFolderUrl

32.0Small、32.0このフォルダ内のファイルとフォルダをリストする Chatter REST API

URL。

StringfolderItemsUrl

32.0Small、32.0フォルダの ID。Stringid

32.0Small、32.0フォルダを最後に変更したユーザの名前。

StringmodifiedBy

32.0Small、32.0フォルダの変更日。DatemodifiedDate

32.0Small、32.0フォルダの Motif。Motifmotif

32.0Small、32.0フォルダの名前。Stringname

32.0Small、32.0外部システムにおけるフォルダの絶対パス。

Stringpath

32.0Small、32.0フォルダの外部リポジトリ。Referencerepository

32.0Small、32.0レコードタイプ folder。Stringtype

32.0Small、32.0このフォルダのChatter REST API URL。Stringurl

評価

ユーザの評価。




32.0Small、32.0ユーザの評価レベル。Reputation LevelreputationLevel

32.0Small、32.0ユーザの評価ポイント。評価ポイントは、コミュニティでさまざま

DoublereputationPoints

な活動を行うことによって獲得できます。

32.0Small、32.0評価への Chatter REST API URL。Stringurl

Reputation Level

ユーザの評価レベル。

729

評価Chatter REST API レスポンスボディ




32.0Small、32.0評価レベル画像への URL。StringlevelImageUrl

32.0Small、32.0評価レベルの名前。StringlevelName

32.0Small、32.0評価レベル番号。レベルの数値ランクで、最低レベルは 1 です。管理

IntegerlevelNumber

者が、評価レベルのポイント範囲を定義します。

Request Header

HTTP 要求ヘッダー名と値のペア。




33.0Small、33.0要求ヘッダーの名前。Stringname

33.0Small、33.0要求ヘッダーの値。Stringvalue

スケジュール済みおすすめ

スケジュール済みおすすめを表します。




34.0Small、34.0スケジュールが有効になっているかどうかを示します。true の場

Booleanenabled


33.0Small、33.0スケジュール済みおすすめの 18 文字の ID。

Stringid

730

Request HeaderChatter REST API レスポンスボディ




33.0Small、33.0このスケジュール済みおすすめの順序を決めるランク。

Integerrank

33.0Small、33.0このスケジュール済みおすすめによってスケジュールされるおすすめ定義。

RecommendationDefinition

recommendationDefinitionRepresentation

33.0Small、33.0スケジュール済みおすすめのChatter

REST API リソースへの URL。Stringurl

Scheduled Recommendation Collection

スケジュール済みおすすめのリストを表します。




33.0Small、33.0スケジュール済みおすすめのリスト。

ScheduledRecommendation[]

scheduledRecommendations

33.0Small、33.0スケジュール済みおすすめコレクションの Chatter REST API リソースへの URL。

Stringurl

Shares




24.0Small、29.0ファイルが共有されているユーザ、レコード、またはグループに関する情報を返します。値は次のいずれかになります。

共有方法によって異なる

entity

• Group

• Record Summary

• User Summary

24.0Small、29.0共有の権限レベル。値は次のとおりです。StringsharingType

• C — コラボレータ• I — 共有権限は場所によって決まりま

す。これは一般に、共有権限がファイル

731

Scheduled Recommendation CollectionChatter REST API レスポンスボディ




ではなくライブラリに設定されている場合に発生します。この値は、コンテキストユーザがファイルの所有者と同じ場合にも使用されます。

• N — アクセス権限なし• V — 閲覧者

Subscription




26.0Medium、29.0コミュニティに関する情報。デフォルトのコミュニティに登録が存在するか、コミュニ

Referencecommunity

ティが無効である場合は、nullが返されます。

23.0Small、29.0登録の 18 文字の IDStringid

Small、29.0親、つまりフォロー対象のものまたは人に関する情報。有効な値は、次のとおりです。

状況によるsubject

• Group (23.0)

• Record Summary (23.0)

• Topic (29.0)

• User Summary (23.0)

23.0Small、29.0登録者、つまりこの項目をフォローしている人に関する情報。有効な値は、次のとおりです。

状況によるsubscriber

• Group

• User Summary

23.0Small、29.0この特定の登録への相対 URLStringurl

732

SubscriptionChatter REST API レスポンスボディ

Subscription Page




23.0Medium、29.0登録の現在のページを返します。StringcurrentPageUrl

23.0Small、29.0登録の次のページを返します。次のページがない場合、文字列 "null" を返します。

StringnextPageUrl

23.0Medium、29.0登録に関する情報を返します。コンテキストユーザが登録されていない場合は nullを返します。


23.0Medium、29.0登録の前のページを返します。前のページがない場合、文字列 "null" を返します。


23.0Small、29.0登録のコレクションSubscription[]subscriptions

23.0Small、29.0登録の合計数Integertotal

Time Zone

Salesforceの [私の設定] で選択されたユーザのタイムゾーン。この値には、デバイスの現在位置は反映されません。




30.0Small、30.0GMT との符号付き時差DoublegmtOffset

30.0Small、30.0このタイムゾーンの表示名Stringname

Topic




28.0Big、29.0ISO8601 の日付文字列 (例:2011-02-25T18:24:31.000Z)

StringcreatedDate

28.0Big、29.0トピックの説明Stringdescription

28.0Small、29.0トピックの 18 文字の IDStringid

733

Subscription PageChatter REST API レスポンスボディ




32.0Medium、32.0トピックに関連付けられた画像Topic Imagesimages

33.0Small、33.0トピックを現在削除中の場合は true、それ以外の場合は false。トピックが削除された後、トピックを取得しようとすると、応答は404: Not Foundになります。

BooleanisBeingDeleted

24.0Small、29.0トピックの名前Stringname

28.0Medium、29.0トピックの追加やトピックを含む投稿に対するコメントなどの要素に基づいた、過去 2 か月間にこのトピックに言及したユーザの数

IntegertalkingAbout

29.0Small、29.0トピックの詳細ページの URLStringurl

Topic Collection




29.0Medium、32.0

Small、29.0

～ 31.0

トピックの現在のページを返します。StringcurrentPageUrl

29.0Small、29.0トピックの次のページを返します。次のページがない場合、文字列 "null" を返します。

StringnextPageUrl

24.0Small、29.0トピックのコレクションTopic[]topics

Topic Endorsement

1 つのトピックについて他のユーザを支持する 1 人のユーザを表します。




30.0Small、30.0支持されているユーザUser Summaryendorsee

30.0Small、30.0支持レコードの IDStringendorsementId

734

Topic CollectionChatter REST API レスポンスボディ




30.0Small、30.0支持しているユーザUser Summaryendorser

30.0Small、30.0ユーザが支持されているトピックTopictopic

30.0Small、30.0支持レコードの Chatter REST API リソース URLStringurl

Topic Endorsement Collection

Topic Endorsement レスポンスボディのコレクション。





30.0Small、30.0Topic Endorsement レスポンスボディのコレクション

Topic Endorsement[]topicEndorsements


StringnextPageUrl




Topic Images

トピックに関連付けられた画像。




32.0Small、32.0トピックページに表示される、トピックの表紙画像への URL。トピッ

StringcoverImageUrl

クと管理トピックの両方に、表紙画像を設定できます。

32.0Small、32.0管理トピックの主要画像への URL。主要画像は、指定した場所であれ

StringfeaturedImageUrl

735

Topic Endorsement CollectionChatter REST API レスポンスボディ




ば、どこにでも表示されます (コミュニティホームページなど)。

Topic Opt Out

トピックからの「除外」。ユーザがトピックに関して知識があると識別されることを望まないことを示します。




30.0Small、30.0Topic Opt Out レコードの IDStringid

30.0Small、30.0トピックからユーザを除外する理由。有効な値は topicInfluenceHide のみです。

Stringreason

30.0Small、30.0ユーザが除外されるトピックTopictopic

30.0Small、30.0Topic Opt Out の Chatter REST API リソース URLStringurl

30.0Small、30.0トピックから除外するユーザUser Summaryuser

Topic Opt Out Collection

Topic Opt Out レスポンスボディのコレクション。





30.0Small、30.0Topic Opt Out レスポンスボディのコレクション。

Topic Opt Out[]topicOptOuts

736

Topic Opt OutChatter REST API レスポンスボディ

Topic Suggestion




28.0Small、29.0すでに存在するトピック、または新規トピックの場合は null

TopicexistingTopic

28.0Small、29.0トピックの名前Stringname

Topic Suggestion Collection




28.0Small、29.0Topic Suggestion レスポンスボディのコレクション

Topic Suggestion[]topicSuggestions

Topics Capability

フィード要素にこの機能がある場合、コンテキストユーザはトピックを追加できます。トピックは、ユーザが会話を整理して検索するために役立ちます。




32.0Small、32.0トピックをフィード要素に割り当て可能な場合は true、それ以外の場合は false。

BooleancanAssignTopics

32.0Small、32.0このフィード要素に関連付けられたトピックのコレクション。

Topic[]items

Topics People Are Knowledgeable About

指定されたユーザが知識のあるトピックを表します。

737

Topic SuggestionChatter REST API レスポンスボディ




30.0Small、30.0コンテキストユーザが、トピックについてこの知識のあるユーザを支持している場合は

BooleanisEndorsedByMe

true、それ以外の場合は falseを指定します。

30.0Small、30.0知識のあるレコードの IDStringknowledgeableId

30.0Medium、30.0トピックについて知識のあるユーザが受け取った支持の数

IntegernumEndorsements

30.0Medium、30.0ユーザがトピックに関する知識があるとみなされる理由を指定します。有効な値は、次のとおりです。

Stringreasons

• Influential — ユーザは、トピックを含む投稿か投稿へのコメントでメンションされたか、トピックを含む投稿へのコメントでいいね! を受信しました。

• Endorsed — ユーザは、トピックについて別のユーザから支持を受け取りました。

30.0Small、30.0ユーザが知識のあるトピック。Topictopic

Topics People Are Knowledgeable About Collection

Topics People Are Knowledgeable About レスポンスボディのコレクション。





30.0Small、30.0Topics People Are Knowledgeable About レスポンスボディのコレクション。

Topics People AreKnowledgeableAbout[]

knowledgeableAboutTopic


StringnextPageUrl


738

Topics People Are Knowledgeable About CollectionChatter REST API レスポンスボディ






Tracked Change Bundle Capability

フィード要素にこの機能がある場合、バンドルと呼ばれる 1 つのフィード要素に集約された他のフィード要素のグループがあります。この種別のバンドルは、フィード追跡変更を集約します。





31.0Small、31.0フィード追跡変更のコレクション。

Feed TrackedChange[]

changes

31.0Small、31.0バンドルの種別を指定します。値は TrackedChanges です。

StringbundleType

31.0Small、31.0フィード要素のコレクション。Feed Element Pagepage

31.0Small、31.0このバンドルで集約するフィード要素の合計数。

IntegertotalElements

Tracked Changes Capability

フィード要素にこの機能がある場合、1 つの変更追跡イベントについて、レコードへのすべての変更が含まれます。




32.0Small、32.0フィード追跡変更のコレクション。Feed TrackedChange[]

changes

739

Tracked Change Bundle CapabilityChatter REST API レスポンスボディ

Unauthenticated User




24.0Small、29.0ソースメールの [差出人] 項目の名前か、ソースメールのメールアドレス

Stringname

24.0Small、29.0UnauthenticatedUserStringtype

User Capabilities




29.0Small、29.0コンテキストユーザが件名ユーザと共にChatter Messenger を使用できるか (true)、否か (false) を示します。

BooleancanChat

29.0Small、29.0コンテキストユーザが件名ユーザに直接メッセージを送信できるか (true)、否か (false)

を示します。

BooleancanDirectMessage

29.0Small、29.0コンテキストユーザが件名ユーザの取引先を編集できるか (true)、否か (false) を示します。

BooleancanEdit

29.0Small、29.0コンテキストユーザが件名ユーザのフィードをフォローできるか (true)、否か (false) を示します。

BooleancanFollow

29.0Small、29.0コンテキストユーザが件名ユーザのフィードを表示できるか (true)、否か (false) を示します。

BooleancanViewFeed

29.0Small、29.0コンテキストユーザが件名ユーザの完全なプロファイルを表示できるか (true)、または制

BooleancanViewFullProfile

限されたプロファイルのみを表示できるか(false) を示します。

29.0Small、29.0件名ユーザが Chatter モデレータまたは管理者か (true)、否か (false) を示します。

BooleanisModerator

740

Unauthenticated UserChatter REST API レスポンスボディ

User Chatter Settings

ユーザのグローバル Chatter 設定。




27.0Small、29.0ユーザが参加するグループからメールを受信するデフォルトの頻度。値は次のとおりです。


• EachPost

• DailyDigest

• WeeklyDigest

• Never

コミュニティでは、グループメンバーが10,000 人を超えると [各投稿のメール] オプションが無効になります。このオプションを選択したすべてのメンバーは、自動的に [毎日のダイジェスト] に切り替わります。

User Detail

コンテキストユーザにプロパティを表示する権限がない場合、プロパティは null に設定されます。




23.0Big、29.0ユーザのプロファイルから取得したテキストStringaboutMe




23.0Big、29.0住所Addressaddress

23.0Big、29.0Chatter 活動統計Chatter ActivitychatterActivity

23.0Big、29.0ユーザの影響度ランクChatter InfluencechatterInfluence


23.0Small、29.0会社名StringcompanyName

741

User Chatter SettingsChatter REST API レスポンスボディ




23.0 ～ 25.0User StatuscurrentStatusメモ: このプロパティは、バージョン25.0 以降、使用できなくなります。

ユーザの現在の状況32.0Small、32.0コミュニティで表示されるユーザの名前。

ニックネームが有効な場合は、ニックネームStringdisplayName


23.0Medium、29.0ユーザのメールアドレスStringemail


23.0Big、29.0このユーザをフォローしているユーザの数IntegerfollowersCount

23.0Big、29.0ユーザがフォローしている項目に関する情報Following CountsfollowingCounts

23.0Big、29.0ユーザがフォローしているグループの数IntegergroupCount

31.0Small、31.0ユーザに Chatter へのアクセス権がある場合は true、それ以外の場合は false

BooleanhasChatter

23.0Small、29.0ユーザの 18 文字の IDStringid

23.0Small、29.0ユーザが有効な場合は true、それ以外の場合は false

BooleanisActive

23.0 ～ 25.0BooleanisChatterGuestメモ: このプロパティは、バージョン26.0 以降、使用できなくなります。代わりに、userType プロパティを使用してください。






23.0Big、29.0ユーザのマネージャの 18 文字の IDStringmanagerId

23.0Big、29.0ロケールに基づいて連結されたマネージャの姓と名

StringmanagerName

742

User DetailChatter REST API レスポンスボディ





Motifmotif




23.0Small、29.0ロケールに基づいて連結されたユーザの姓と名

Stringname

23.0Big、29.0ユーザの電話番号のコレクションPhone Number[]phoneNumbers



評価reputation

29.0Big、29.0ユーザが受け取った感謝の数。IntegerthanksReceived




24.0Small、29.0ユーザのユーザ名 ([email protected]

など)

Stringusername

743

User DetailChatter REST API レスポンスボディ





StringuserType






関連トピック:

User Summary

User Group Page

ユーザがメンバーであるグループのページ設定されたコレクション。





23.0Small、29.0ユーザのグループのコレクションGroup[]groups

23.0Small、29.0次のページへの URL。次のページがない場合は文字列 "null" を返します。

StringnextPageUrl

23.0Medium、29.0前のページへの URL。前のページがない場合は文字列 "null" を返します。


23.0Small、29.0ユーザがメンバーであるグループの総数。この数値は、要求が検索で応答に総数のサブセットが含まれる場合でも、常にユーザがメンバーであるグループの総数です。

Integertotal

744

User Group PageChatter REST API レスポンスボディ

User Page





23.0Small、29.0次のページへの URL。次のページがない場合は null を返します。

StringnextPageUrl

23.0Medium、29.0前のページへの URL。前のページがない場合は null を返します。


24.0Small、29.0ユーザ詳細情報のコレクション。User Detail[]users

User Profile




29.0Medium、29.0件名ユーザのプロファイルに固有のコンテキストユーザの機能

User Capabilitiescapabilities

29.0Small、29.0プロファイルに添付されるユーザの IDStringid

29.0Big、29.0そのユーザ種別でコンテキストユーザに表示されるタブ

User Profile Tab[]tabs

29.0Small、29.0ユーザのプロファイルの URLStringurl

29.0Small、29.0プロファイルに添付されるユーザに関する詳細情報

User DetailuserDetail

User Profile Tab




29.0Small、29.0タブの一意の識別子 (18 文字の ID)Stringid

29.0Small、29.0ユーザプロファイルをクリックしたときにタブが最初に表示されるか (true)、否か(false) を示します。

BooleanisDefault

745

User PageChatter REST API レスポンスボディ




29.0Small、29.0ユーザプロファイルタブの種別を示します。StringtabType

• CustomVisualForce — Visualforceページからのデータを表示するタブ。

• CustomWeb — 外部の Web ベースのアプリケーションまたは Web ページからのデータを表示するタブ。

• Element — 汎用コンテンツをインラインで表示するタブ。

• Feed — Chatterフィードを表示するタブ。• Overview — ユーザの詳細を表示するタ

ブ。

29.0Small、29.0現在のタブのコンテンツ URL (組み込み以外のタブの種類の場合)

StringtabUrl

User Settings

ユーザ固有の設定。




27.0Small、29.0ユーザは、Chatter投稿からワークフローを承認できるかどうか。

BooleanapprovalPosts

24.0Small、29.0コンテキストユーザにフォローが許可されているかどうか。

BooleancanFollow

24.0Small、29.0ユーザに「すべてのデータの編集」権限があるかどうか。

BooleancanModifyAllData

24.0Small、29.0ユーザはグループを所有できるかどうか。BooleancanOwnGroups

24.0Small、29.0ユーザに「すべてのデータの参照」権限があるかどうか。

BooleancanViewAllData

24.0Small、29.0ユーザに「すべてのグループの参照」権限があるかどうか。

BooleancanViewAllGroups

24.0Small、29.0ユーザに「すべてのユーザの参照」権限があるかどうか。

BooleancanViewAllUsers

746

User SettingsChatter REST API レスポンスボディ




34.0Small、34.0ユーザにコミュニティ切り替えメニューが表示されるかどうか。

BooleancanViewCommunitySwitcher

24.0Small、29.0ユーザが他のユーザの Chatter プロファイルを表示できるかどうか。

BooleancanViewFullUserProfile

24.0Small、29.0ユーザが公開とマークされたすべてのファイルを表示できるかどうか。

BooleancanViewPublicFiles

28.0Small、29.0通貨の値を表示するために使用する通貨記号。Features レスポンスボディの

StringcurrencySymbol

multiCurrency プロパティが false の場合のみ該当します。

24.0Small、29.0ユーザが Chatter 顧客であるかどうか。BooleanexternalUser

32.0Small、32.0ユーザが同期できるファイルの最大数。IntegerfileSyncLimit

29.0Small、29.0同期済みファイルのための最大ストレージ(MB)

IntegerfileSyncStorageLimit

32.0Small、32.0ユーザが同期できるフォルダの最大数。IntegerfolderSyncLimit

26.0Small、29.0ユーザが、社内組織のメンバーであるかどうか。

BooleanhasAccessToInternalOrg

31.0Small、31.0ユーザには Chatter へのアクセス権があります。

BooleanhasChatter

26.0Small、29.0ユーザに「ファイルを同期」権限があるかどうか。

BooleanhasFileSync

34.0Small、34.0ユーザの組織のシステム管理者が File Sync クライアントの自動更新を許可するかどうか。

BooleanhasFileSyncManagedClientAutoUpdate

29.0Small、29.0ユーザに REST API へのアクセス権があるかどうか。

BooleanhasRestDataApiAccess

30.0Small、30.0Salesforceの [私の設定] で選択されたユーザのタイムゾーン。この値には、デバイスの現在位置は反映されません。

Time ZonetimeZone

28.0Small、29.0デフォルト通貨の ISO コード。Features レスポンスボディの multiCurrency プロパティが true の場合のみ該当します。

StringuserDefaultCurrencyIsoCode

24.0Small、29.0ユーザの 18 文字の IDStringuserId

747

User SettingsChatter REST API レスポンスボディ




24.0Small、29.0ユーザのロケールStringuserLocale

User Status




23.0 ～ 25.0Small、29.0投稿の本文Feed Item Body[]body

23.0 ～ 25.0Small、29.018 文字の IDStringparentId

23.0 ～ 25.0Small、29.0このユーザ状況の投稿の URLStringurl

User Summary

User Summary レスポンスボディは、User Detail レスポンスボディのサブセットです。








23.0Small、29.0会社の名前StringcompanyName

32.0Small、32.0コミュニティで表示されるユーザの名前。ニックネームが有効な場合は、ニックネーム

StringdisplayName



23.0Small、29.018 文字の IDStringid

25.0Small、29.0ユーザが有効な場合は true、それ以外の場合は false。

BooleanisActive

748

User StatusChatter REST API レスポンスボディ




23.0 ～ 26.0BooleanisChatterGuest メモ: このプロパティは、バージョン

26.0 以降、使用できなくなります。代わりに、userType プロパティを使用してください。







Motifmotif




23.0Small、29.0ロケールに基づいて連結された姓と名Stringname



評価reputation





StringuserType


749

User SummaryChatter REST API レスポンスボディ








例:

メモ: ユーザの名前が Chatter Expert で、戻り値のほとんどが null 値の場合、Chatter Expert ユーザが管理者によって無効化または引き継ぎされたか、あるいは、Salesforceに Chatter Expert ユーザが導入される前に組織が作成されたことを示します。Chatter Expert は、Chatterの使用を開始するユーザに、ヒント、使用方法、およびサンプル投稿を提供する特殊なユーザです。

関連トピック:

User Detail

Zone

Chatter アンサーのゾーン。




29.0Big、29.0ゾーンの説明Stringdescription

29.0Small、29.0ゾーン IDStringid

29.0Small、29.0ゾーンが有効であることを示します。BooleanisActive

29.0Small、29.0ゾーンが Chatter アンサーで使用できることを示します。

BooleanisChatterAnswers

29.0Small、29.0ゾーンの名前Stringname

30.0Small、30.0ゾーンの Chatter REST API リソース URLStringurl

750

ZoneChatter REST API レスポンスボディ




29.0Small、29.0ゾーンの表示種別。次のいずれかの値にします。

Stringvisibility

• Community — コミュニティで使用できます。

• Internal — 内部でのみ使用できます。• Portal — ポータルで使用できます。

29.0Small、29.0ゾーンがポータルまたはコミュニティで使用できる場合、このプロパティにはそのポータ

StringvisibilityId

ルまたはコミュニティの ID が含まれます。ゾーンがすべてのポータルで使用できる場合、このプロパティには All の値が含まれます。

Zone Page

Chatter アンサーのゾーンのページ。




29.0Small、29.01 つ以上のゾーンのコレクションZone[]zones



StringnextPageUrl


Zone Search Page

Chatter アンサーのゾーン内の検索結果のページ。

751

Zone PageChatter REST API レスポンスボディ




29.0Medium、29.0現在のページを識別するトークン。StringcurrentPageToken


29.0Small、29.0検索結果のコレクションZone Search Result[]items

29.0Small、29.0次のページを識別するトークン。次のページがない場合は null。

StringcurrentPageToken


StringnextPageUrl


Zone Search Result

Chatter アンサーのゾーン内の検索結果。




29.0Small、29.0検索結果に最良の回答が含まれているかどうかを示します。

BooleanhasBestAnswer

29.0Small、29.0検索結果の ID。検索結果は、質問または記事になります。

Stringid

29.0Small、29.0検索結果のタイトルStringtitle

29.0Small、29.0検索結果の種別。次のいずれかの値にします。

Stringtype

• Article — 検索結果には記事のみが含まれます。

• Question — 検索結果には質問のみが含まれます。

29.0Small、29.0検索結果への投票数StringvoteCount

752

Zone Search ResultChatter REST API レスポンスボディ

第 8 章 Chatter REST API の付録

この章には、付録資料があります。


アクションリンクの表示ラベルアクションリンクボタンには次の表示ラベルを使用します。

アクションリンクの表示ラベル

アクションリンクボタンには次の表示ラベルを使用します。アクションリンクは、フィード要素上のボタンです。アクションリンクをクリックすると、ユーザを特定のWeb ページに移動したり、ファイルダウンロードを開始したり、Salesforce または外部サーバへの API コールを呼び出したりできます。アクションリンクには、URL と HTTP メソッドが含まれ、リクエストボディとヘッダー情報 (認証用の OAuth トークンなど) を含めることができます。アクションリンクを使用して Salesforce およびサードパーティサービスをフィードに統合することで、ユーザはアクションを実行して生産性を高め、イノベーションを促進できます。Action Link Definition Input リクエストボディの labelKey プロパティでキーを指定します。アクションリンクが表示されるときに UI には、[新規]、[待機中]、[成功]、[失敗] 状態の表示ラベルが必要に応じて使用されます。

失敗成功待機中新規キー

Acceptance FailedAcceptedAcceptance PendingAcceptAccept

Activation FailedActivatedActivation PendingActivateActivate

Add FailedAddedAdd PendingAddAdd

Add to Calendar FailedAdded to CalendarAdd to Calendar PendingAdd to CalendarAdd to Calendar

Add FailedAddedAdd PendingAdd to CartAdd to Cart

Agree FailedAgreeAgree PendingAgreeAgree

Alert FailedAlertedAlert PendingAlertAlert

Answer FailedAnsweredAnswer PendingAnswerAnswer

Approval FailedApprovedApproval PendingApproveApprove

Assign FailedAssignedAssign PendingAssignAssign

Assistance FailedAssistedAssistance PendingAssistAssist

Attach FailedAttachedAttach PendingAttachAttach

Authorization FailedAuthorizedAuthorization PendingAuthorizeAuthorize

753


Begin FailedStartedBegin PendingBeginBegin

Book FailedBookedBook PendingBookBook

Buy FailedBoughtBuy PendingBuyBuy

Call FailedCalledCall PendingCallCall

Call FailedCall SucceededCall PendingCall MeCall Me

Certification FailedCertifiedCertifcation PendingCertifyCertify

Change FailedChangedChange PendingChangeChange

Chat FailedChat CompletedChat PendingChatChat

Check FailedCheckedCheck PendingCheckCheck

Clear FailedClearClear PendingClearClear

Clone FailedClonedClone PendingCloneClone

Close FailedClosedClose PendingCloseClose

Confirmation FailedConfirmedConfirmation PendingConfirmConfirm

Convert FailedConvertedConvert PendingConvertConvert

Lead Conversion FailedLead ConvertedLead Conversion PendingConvert a LeadConvert a Lead

Create FailedCreatedCreate PendingCreateCreate

Deactivation FailedDeactivatedDeactivation PendingDeactivateDeactivate

Decline FailedDeclinedDecline PendingDeclineDecline

Delete FailedDeletedDelete PendingDeleteDelete

Denial FailedDeniedDenial PendingDenyDeny

Detach FailedDetachedDetach PendingDetachDetach

Disagree FailedDisagreeDisagree PendingDisagreeDisagree

Dislike FailedDislikedDislike PendingDislikeDislike

Dismissal FailedDismissedDismissal PendingDismissDismiss

Do Response FailedDoDo Response PendingDoDo

Donation FailedDonatedDonation PendingDonateDonate

Down Response FailedDownDown Response PendingDownDown

Download FailedDownloadedDownload PendingDownloadDownload

Edit FailedEditedEdit PendingEditEdit

End FailedEndedEnd PendingEndEnd

754

アクションリンクの表示ラベルChatter REST API の付録


Endorsement FailedEndorsedEndorsement PendingEndorseEndorse

Enter FailedEnteredEnter PendingEnterEnter

Escalation FailedEscalatedEscalation PendingEscalateEscalate

Estimate FailedEstimateEstimate PendingEstimateEstimate

Exclude FailedExcludedExclude PendingExcludeExclude

Exit FailedExitedExit PendingExitExit

Export FailedExportedExport PendingExportExport

File FailedFiledFile PendingFileFile

Fill FailedFilledFill PendingFillFill

Finish FailedFinishedFinish PendingFinishFinish

Flag FailedFlaggedFlag PendingFlagFlag

Flip FailedFlippedFlip PendingFlipFlip

Follow FailedFollowedFollow PendingFollowFollow

Generate FailedGeneratedGenerate PendingGenerateGenerate

Give FailedGivenGive PendingGiveGive

Help FailedHelpedHelp PendingHelpHelp

Hide FailedHiddenHide PendingHideHide

High Response FailedHighHigh Response PendingHighHigh

Hold FailedHold SucceededHold PendingHoldHold

Import FailedImportedImport PendingImportImport

Include FailedIncludedInclude PendingIncludeInclude

Join FailedJoinedJoin PendingJoinJoin

Launch FailedLaunchedLaunch PendingLaunchLaunch

Leave FailedLeftLeave PendingLeaveLeave

Like FailedLikedLike PendingLikeLike

List FailedListedList PendingListList

Log FailedLoggedLog PendingLogLog

Log a Call FailedLogged a CallLog a Call PendingLog a CallLog a Call

Low Response FailedLowLow Response PendingLowLow

Mark FailedMarkedMark PendingMarkMark

755



Maybe Response FailedMaybeMaybe Response PendingMaybeMaybe

Medium Response FailedMediumMedium ResponsePending

MediumMedium

Meet FailedMeetMeet PendingMeetMeet

Message FailedMessageMessage PendingMessageMessage

Move FailedMovedMove PendingMoveMove

Negative Response FailedNegativeNegative ResponsePending

NegativeNegative

New FailedNewNew PendingNewNew

No Response FailedNoNo Response PendingNoNo

OK Response FailedOKOK Response PendingOKOK

Open FailedOpenedOpen PendingOpenOpen

Order FailedOrderedOrder PendingOrderOrder

Positive Response FailedPositivePositive ResponsePending

PositivePositive

Post FailedPostedPost PendingPostPost

Post FailedPostedPost PendingPost ReviewPost Review

Process FailedProcessedProcess PendingProcessProcess

Provide FailedProvidedProvide PendingProvideProvide

Purchase FailedPurchasedPurchase PendingPurchasePurchase

Quote FailedQuotedQuote PendingQuoteQuote

Receive FailedReceivedReceive PendingReceiveReceive

Recommend FailedRecommendedRecommend PendingRecommendRecommend

Redo Response FailedRedoRedo Response PendingRedoRedo

Refresh FailedRefreshedRefresh PendingRefreshRefresh

Rejection FailedRejectedRejection PendingRejectReject

Release FailedReleasedRelease PendingReleaseRelease

Reminder FailedRemindedReminder PendingRemindRemind

Removal FailedRemovedRemoval PendingRemoveRemove

Repeat FailedRepeatedRepeat PendingRepeatRepeat

Report FailedReportedReport PendingReportReport

756



Request FailedRequestedRequest PendingRequestRequest

Reservation FailedReservedReservation PendingReserveReserve

Resolve FailedResolvedResolve PendingResolveResolve

Response FailedRespondedResponse PendingRespondRespond

Restore FailedRestoredRestore PendingRestoreRestore

Review FailedReviewedReview PendingReviewReview

Revision FailedRevisedRevision PendingReviseRevise

Save FailedSavedSave PendingSaveSave

Schedule FailedScheduledSchedule PendingScheduleSchedule

Sell FailedSoldSell PendingSellSell

Send FailedSentSend PendingSendSend

Send Email FailedEmail SentSend Email PendingSend EmailSend Email

Share FailedSharedShare PendingShareShare

Shipment FailedShippedShipment PendingShipShip

Show FailedShownShow PendingShowShow

Start FailedStartedStart PendingStartStart

Stop FailedStoppedStop PendingStopStop

Submit FailedSubmittedSubmit PendingSubmitSubmit

Subscribe FailedSubscribedSubscribe PendingSubscribeSubscribe

Test FailedTestedTest PendingTestTest

Thanks FailedThankedThanks PendingThankThank

Unauthorization FailedUnauthorizedUnauthorization PendingUnauthorizeUnauthorize

Uncheck FailedUncheckedUncheck PendingUncheckUncheck

Undo Response FailedUndoUndo Response PendingUndoUndo

Unflag FailedUnflaggedUnflag PendingUnflagUnflag

Unfollow FailedUnfollowedUnfollow PendingUnfollowUnfollow

Unlike FailedUnlikedUnlike PendingUnlikeUnlike

Unmark FailedUnmarkedUnmark PendingUnmarkUnmark

Unsubscribe FailedUnsubscribedUnsubscribe PendingUnsubscribeUnsubscribe

Up Response FailedUpUp Response PendingUpUp

757



Update FailedUpdatedUpdate PendingUpdateUpdate

Validate FailedValidatedValidate PendingValidateValidate

Verify FailedVerifiedVerify PendingVerifyVerify

View FailedViewedView PendingViewView

Visit FailedVisit SuccessfulVisit PendingVisitVisit

Yes Response FailedYesYes Response PendingYesYes

758

Documents

Chatter REST API 開発者ガイドresources.docs.salesforce.com/198/0/ja-jp/sfdc/pdf/sales...第 1 章: Chatter REST API の概要. . . . . . . . . . . . . . . . . . . . . . .