Topics on Records リソース
レコードまたはフィード項目に割り当てられたトピックに関する情報を取得し、レコードまたはフィード項目のトピックを追加、削除、置換します。今後の推奨トピックを改善する目的で、レコードまたはフィード項目に割り当てるトピックのリストを任意に提案します。レコードまたはフィード項目からトピックを削除したり、レコードまたはフィード項目に既存のトピックを追加したりできるのは、「トピックの割り当て」権限を持つユーザのみです。レコードまたはフィード項目に新規のトピックを追加できるのは、「トピックの作成」権限を持つユーザのみです。ユーザがオブジェクト種別のレコードにトピックを追加できるようにするには、事前にシステム管理者がそのオブジェクトでトピックを有効化しておく必要があります。
- リソース
-
1/connect/records/recordId/topics1/connect/communities/communityId/records/recordId/topics - 適用開始バージョン
- 30.0
- Chatter が必要かどうか
- いいえ
- HTTP のメソッド
- GET、DELETE、POST、PUT
PUT はバージョン 35.0 以降でサポートされます。
- DELETE の要求パラメータ
-
パラメータ名 型 説明 必須項目/省略可能 使用可能なバージョン topicId String 既存のトピックの ID 必須項目 30.0 - DELETE のレスポンスボディ
- 204: Successful Delete
- POST のリクエストボディ
- POST の要求パラメータ
-
パラメータ名 型 説明 必須項目/省略可能 使用可能なバージョン topicId String 既存のトピックの ID topicName パラメータが使用されていない場合、既存のトピックに必要です。 30.0 topicName String 新規または既存のトピックの名前 新規のトピック、および topicId パラメータが使用されていない場合の既存のトピックに必要です。 30.0 - POST のレスポンスボディ
- Topic
- POST の例
- この例では、既存のトピックの ID を topidId パラメータで渡して商談レコードに関連付けます。
1POST /connect/records/006D000000CtYBc/topics?topicId=0TOD0000000090r - PUT のリクエストボディ
- PUT 要求は、レコードまたはフィード項目のすべてのトピックを再割り当てします。つまり、レコードまたはフィード項目のすべての割り当て済みトピックを異なるトピックで置換します。PUT 要求では、今後の推奨トピックを向上させる目的で、レコードまたはフィード項目に割り当てるトピックのリストを任意に提案できます。
-
- ルート XML タグ
- <topicNamesCollection>
- JSON の例
-
1{ "topicNames": ["API", "Chatter REST API", "ConnectApi"] 2} - プロパティ
-
名前 型 説明 必須項目/省略可能 使用可能なバージョン topicNames String [] フィード項目の最大 10 個のトピック名を含むリスト、またはレコードの最大 100 個のトピック名を含むリスト。 必須項目 35.0 topicSuggestions String [] 今後の推奨トピックを改善させる目的で、レコードまたはフィード項目に割り当てる推奨トピックのリスト。 省略可能 37.0
- PUT のレスポンスボディ
- Topic Collection