relation・タグ について（タイムライン投稿）

relation （タイムライン投稿）について

relationを指定することで、任意のアプリ（顧客・案件・商品など）とタイムライン投稿の関連付ができます。

投稿登録API のリクエストボディ内に、以下のように relation 情報を含めることで、投稿と任意アプリを紐付けることが可能です。

No.	プロパティ名	項目名	タイプ	備考
1	relation	紐づき先各アプリ	array(object)
2	- sheetName	アプリ名	string	拡張アプリもしくは 「businesscard/customer/businessplan/activity/product/deal/task/milestone」のいずれかを指定
3	- entityId	対象 ID	number

リクエスト例

"relation": [
    {
        "sheetName": "product",
        "entityId": 30550971743911,
        "entityName": "サンプル商品"
    }
]

画面での relation 表示

例えば、投稿を作成する際に商品と紐づけると、[タイムライン]画面に投稿され、紐づけられた[商品]情報が設定されます。

[タイムライン]画面では relation が表示されます。(bodyの下)

relation による自動タグ付与

relation 情報が設定された投稿には、以下の 2 つのタグが自動付与されます。 これらはリクエスト内に記載不要で、投稿登録時にシステム側で自動付与されます。

種類	内容	例
App 種別タグ	#{アプリ種別}形式。relation で指定したアプリ種別	#customer
固定タグ	常に#manual_post に固定する	#manual_post

付与されたタグは、投稿作成 API のレスポンス内で確認可能

{
  "relation": [
    {
      "sheetName": "product",
      "entityId": 30550971743911,
      "entityName": "サンプル商品"
    }
  ],
  "tag": ["#product", "#manual_post"]
}

relation 対応アプリ一覧とタグマッピング

No.	プロパティ名
customer	#customer
product	#product
deal	#deal
activity	#activity_report
schedule	#schedule
task	#task
milestone	#milestone
businessplan	#businessplan
businesscard	#businesscard
拡張アプリ	#{拡張アプリ}

タグによる投稿フィルター機能

タイムライン画面では、投稿一覧の右上にあるタグフィルターで投稿を絞り込み可能です。