フィード項目またはコメントの本文でメンションするユーザおよびグループに関する情報。ユーザが選択できる提案メンションのリストを生成するには、このリソースを使用します。メンションは、ユーザ名またはグループ名の前にある「@」文字で示されます。ユーザまたはグループは、メンションされると通知を受け取ります。
- リソース
-
1/chatter/mentions/completions
1/connect/communities/communityId/chatter/mentions/completions
- 適用開始バージョン
- 29.0
- Chatter が必要かどうか
- はい
- HTTP メソッド
- GET、HEAD
- GET の要求パラメータ
-
| contextId |
String |
検索結果を絞り込むフィード項目 ID (コメント内のメンションの場合) またはフィード件名 ID (フィード項目内のメンションの場合) であり、最も的確な結果が最初に表示されます。顧客がメンションの補完結果に顧客を含めることができるグループのグループ ID を使用します。 |
省略可能 |
29.0 |
| page |
Integer |
返すページの数。番号付けは 0 から開始します。0 を渡すか、このプロパティを省略すると、最初のページが返されます。 結果が 500 件を超えるページを試行すると、空の応答が返されます。
|
省略可能 |
29.0 |
| pageSize |
Integer |
ページあたりの項目数。有効な値は 1 ～ 100 です。デフォルトサイズは 25 です。 500 件を超える結果を取得しようとすると、空の応答が返されます。
|
省略可能 |
29.0 |
| q |
String |
一致するユーザおよびグループの名前の検索語。グループの検索には 2 文字以上を指定する必要があります。ユーザの検索には最小文字数はありません。このパラメータではワイルドカードは使用できません。 |
必須 |
29.0 |
| type |
String |
メンションの補完の種類。次のいずれかの値にします。
-
All — メンションで参照するレコードタイプに無関係の、すべてのメンションの補完。
-
Group — グループのメンションの補完。
-
User — ユーザのメンションの補完。
デフォルト値は、All です。
|
省略可能 |
29.0 |
- GET のレスポンスボディ
- Mention Completion Page
- コメントのメンションの補完を取得する例
-
contextId パラメータでフィード項目 ID を指定し、フィード項目のコメントのメンションの補完を要求します。
1/chatter/mentions/completions?contextId=0D5D0000000Hwky&q=g
j