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

Chatter REST API 開発者ガイド

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
PDF

List of Groups

組織内のすべてのグループのリスト。グループに関する情報を取得するか、グループを作成します。
リソース
1/chatter/groups/
使用可能なバージョン
23.0
POST は 29.0 で使用可能
Chatter が必要かどうか
はい
HTTP メソッド
GET、HEAD、POST
GET の要求パラメータ
パラメータ名 型 説明 使用可能
archiveStatus String 指定のアーカイブ状況で絞り込まれたグループのリストを返します。
  • All — アーカイブ対象かどうかに関係なく、すべてのグループ。
  • Archived — アーカイブ対象のグループのみ。
  • NotArchived — アーカイブ対象外のグループのみ。

デフォルト値は、NotArchived です。

 29.0
page Integer 項目のページを指定する整数。デフォルト値は 0 で、最初のページを返します。 23.0
pageSize Integer ページあたりの項目数を指定します。有効な値は 1 ～ 250 です。デフォルト値は 25 です。 23.0
q String 検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。ワイルドカードについての詳細は、「ワイルドカード」を参照してください。 23.0
POST のリクエストボディ
ルート XML タグ
1<group>
JSON
1{
2   "announcement" : "0D5D0000000K4XT",
3   "canHaveChatterGuests" : "true",
4   "description" : "This group is building a powerful API.",
5   "information" : {
6      "text" : "Read this section before you post to the group.",
7      "title" : "Information"
8   },
9   "isArchived" : "false",
10   "isAutoArchiveDisabled" : "false",
11   "name" : "Chatter API",
12   "owner" : "00590000000DmPw",
13   "visibility" : "PublicAccess"
14}
プロパティ
名前 型 説明 使用可能なバージョン
announcement String お知らせ ID。

お知らせは、削除されるか、別のお知らせで置き換えられない限り、その表示期限の 11:59 p.m. まで Salesforce UI の指定の場所に表示されます。

 31.0
canHaveChatterGuests Boolean このグループで Chatter 顧客を許可している場合は true、それ以外の場合は false。このプロパティを true に設定した後で、false に設定することはできません。 29.0
description String グループの [説明] セクション 29.0
information Group Information Input グループの [情報] セクション Web UI では、[情報] セクションは [説明] セクションの上にあります。グループが非公開の場合は、[情報] セクションはメンバーにのみ表示されます。[説明] セクションは全員に表示されます。 28.0
isArchived Boolean グループがアーカイブ済みの場合は true、それ以外の場合は false。デフォルトは false です。 29.0
isAutoArchiveDisabled Boolean グループの自動アーカイブが無効の場合は true、それ以外の場合は false。デフォルトは false です。 29.0
name String グループの名前 29.0
owner String グループ所有者の ID。このプロパティは、PATCH 要求でのみ使用できます。 29.0
visibility String グループの表示種別を指定します。次のいずれかの値になります。
  • PrivateAccess — グループのメンバーのみが、このグループへの投稿を参照できます。
  • PublicAccess — コミュニティのすべてのユーザが、このグループへの投稿を参照できます。
  • Unlisted — 今後の使用のために予約されています。
29.0
POST の要求パラメータ
パラメータ名 型 説明 必須項目/省略可能 使用可能
canHaveChatterGuests Boolean このグループで Chatter 顧客を許可している場合は true、それ以外の場合は false。このプロパティを true に設定した後で、false に設定することはできません。 省略可能 29.0
description String グループの [説明] セクション 省略可能 29.0
informationText String グループの [情報] セクション内のテキスト 省略可能 29.0
informationTitle String グループの [情報] セクションのタイトル 省略可能 29.0
name String グループの名前 必須項目 29.0
visibility String グループの表示種別を指定します。次のいずれかになります。
  • PrivateAccess — グループのメンバーのみが、このグループへの投稿を参照できます。
  • PublicAccess — コミュニティのすべてのユーザが、このグループへの投稿を参照できます。
  • Unlisted — 今後の使用のために予約されています。
必須項目 29.0
GET のレスポンスボディ
Group Page
POST のレスポンスボディ
Group Detail
POST の例
次の要求で公開グループが作成されます。
1POST /chatter/groups?name=New+Group&visibility=PublicAccess