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

Mentions Completions

フィード項目またはコメントの本文でメンシ��ンするユーザおよびグループに関する情報。ユーザが選択できる提案メンションのリストを生成するには、このリソースを使用します。メンションは、ユーザ名またはグループ名の前にある「@」文字で示されます。ユーザまたはグループは、メンションされると通知を受け取ります。

リソース

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	検索語。一致するユーザおよびグループの名前を検索します。ユーザを検索する場合、1 文字以上を指定する必要があります。グループを検索する場合、2 文字以上を指定する必要があります。このパラメータではワイルドカードは使用できません。	必須項目	29.0
`type`	String	メンションの補完の種類。次のいずれかの値にします。 `All` — メンションで参照するレコードタイプに無関係の、すべてのメンションの補完。 `Group` — グループのメンションの補完。 `User` — ユーザのメンションの補完。デフォルト値は、`All` です。	省略可能	29.0

GET のレスポンスボディ

Mention Completion Page

GET の例

この例では、contextId パラメータでフィード項目 ID を指定し、フィード項目のコメントのメンションの補完を要求します。

1GET /chatter/mentions/completions?contextId=0D5D0000000Hwky&q=g

これは、レスポンスボディです。

1{
2   "currentPageUrl": "/services/data/v39.0/chatter/mentions/completions?contextId=0D5D0000000Hwky&q=g",
3   "mentionCompletions": [
4      {
5         "additionalLabel": null,
6         "description": "VP Sales",
7         "name": "Gordon Johnson",
8         "photoUrl": "https://instance_name/profilephoto/729D00000000LJL/T",
9         "recordId": "005D0000001LLO1IAO"
10      },
11      {
12         "additionalLabel": null,
13         "description": "A place for constructive cr...",
14         "name": "Airing of Grievances",
15         "photoUrl": "https://instance_name/profilephoto/0F9/T",
16         "recordId": "0F9D00000000izfKAA"
17      }
18   ],
19   "nextPageUrl": null,
20   "previousPageUrl": null
21}

Chatter REST API 開発者ガイド

Mentions Completions

関連項目: