活動(activity)
活動に関する情報の登録・更新・取得・削除ができます。
レコードのidの取得にはSearch APIが使用できます。
活動取得
必要な権限
活動参照
Request
URL
https://gateway-esm.softbrain.com/esm-api/{tenant}/pub/esms/v1/sheet/activity/{id}
HTTP Method
GET
Parameter
Path Parameter
| No. | パラメータ | 必須 | タイプ | デフォルト値 | 説明 |
|---|---|---|---|---|---|
| 1 | tenant | ○ | string | - | 会社ID |
| 2 | id | ○ | string | - | 対象レコードID |
活動登録
必要な権限
活動登録
Request
URL
https://gateway-esm.softbrain.com/esm-api/{tenant}/pub/esms/v1/sheet/activity
HTTP Method
POST
Parameter
Path Parameter
| No. | パラメータ | 必須 | タイプ | デフォルト値 | 説明 |
|---|---|---|---|---|---|
| 1 | tenant | ○ | string | - | 会社ID |
Request Body
| No. | プロパティ名 | 必須 | 項目名 | タイプ | 備考 |
|---|---|---|---|---|---|
| 1 | activities.activity.visit_start_datetime | 活動開始時刻 | string | "yyyy/MM/dd HH:mm"形式 | |
| 2 | activities.activity.visit_end_datetime | 活動終了時刻 | string | "yyyy/MM/dd HH:mm"形式 | |
| 3 | activities.activity.action_time | 活動時間(分) | number | ||
| 4 | activities.activity.action | 活動内容 | string | 活動内容マスタの選択肢名 マスタ選択肢の取得方法 | |
| 5 | activities.activity.memo | メモ | string | ||
| 6 | activities.activity.business_type | 業務タイプ | string | 業務タイプマスタの選択肢名 マスタ選択肢の取得方法 | |
| 7 | activities.activity.target_customer | 活動対象顧客 | object | 顧客(customer)のカーボン指定 カーボン型について | |
| - activities.activity.target_customer @customers.customer.id | 活動対象顧客ID | number | |||
| - activities.activity.target_customer @customers.customer.customer_name | ユーザ設定 | 顧客名 | string | ||
| - activities.activity.target_customer @customers.customer.customer_type | ユーザ設定 | 顧客タイプ | string | 顧客タイプマスタの選択肢名 マスタ選択肢の取得方法 | |
| - activities.activity.target_customer @customers.customer.relational_parent_customer | ユーザ設定 | 親顧客 | number | 顧客IDを指定。 | |
| - activities.activity.target_customer @customers.customer.charge_employee @customers.charge_employee.main_charge | ユーザ設定 | 主担当者ID | number | 社員IDを指定。 | |
| - activities.activity.target_customer @customers.customer.charge_employee @customers.charge_employee.target_employee @employees.employee.id | ユーザ設定 | 自社担当者ID | array(number) | 社員IDを指定。主担当者はこちらにも指定必須。 | |
| - activities.activity.target_customer @customers.customer.charge_department @customers.charge_department.main_charge | ユーザ設定 | 主担当部署ID | number | 部署IDを指定。 | |
| - activities.activity.target_customer @customers.customer.charge_department @customers.charge_department.target_department @employees.department.id | ユーザ設定 | 自社担当部署ID | array(number) | 部署IDを指定。主担当部署はこちらにも指定必須。 | |
| - activities.activity.target_customer @customers.customer.charge_group @customers.charge_group.main_charge | ユーザ設定 | 主担当グループID | number | 共通グループIDを指定。 | |
| - activities.activity.target_customer @customers.customer.charge_group @customers.charge_group.target_group @employees.group.id | ユーザ設定 | 自社担当グループID | array(number) | 共通グループIDを指定。主担当グループはこちらにも指定必須。 | |
| 8 | activities.activity.target_businessplan | 活動対象案件 | object | 案件(businessplan)のカーボン指定 カーボン型について | |
| - activities.activity.target_businessplan @businessplans.businessplan.id | 活動対象案件ID | number | |||
| - activities.activity.target_businessplan @businessplans.businessplan.progress | ユーザ設定 | 進捗状況 | number | 進捗状況マスタの選択肢名 マスタ選択肢の取得方法 | |
| - activities.activity.target_businessplan @businessplans.businessplan.business_type | ユーザ設定 | 業務タイプ | string | 業務マスタの選択肢名 マスタ選択肢の取得方法 | |
| - activities.activity.target_businessplan @businessplans.businessplan.businessplan_name | ユーザ設定 | 案件名 | string | ||
| - activities.activity.target_businessplan @businessplans.businessplan.charge_employee @businessplans.charge_employee.main_charge | ユーザ設定 | 主担当者ID | number | 社員IDを指定。 | |
| - activities.activity.target_businessplan @businessplans.businessplan.charge_employee @businessplans.charge_employee.target_employee @employees.employee.id | ユーザ設定 | 自社担当者ID | array(number) | 社員IDを指定。主担当者はこちらにも指定必須。 | |
| - activities.activity.target_businessplan @businessplans.businessplan.charge_department @businessplans.charge_department.main_charge | ユーザ設定 | 主担当部署ID | number | 部署IDを指定。 | |
| - activities.activity.target_businessplan @businessplans.businessplan.charge_department @businessplans.charge_department.target_department @employees.department.id | ユーザ設定 | 自社担当部署ID | array(number) | 部署IDを指定。主担当部署はこちらにも指定必須。 | |
| - activities.activity.target_businessplan @businessplans.businessplan.charge_group @businessplans.charge_group.main_charge | ユーザ設定 | 主担当グループID | number | 共通グループIDを指定。 | |
| - activities.activity.target_businessplan @businessplans.businessplan.charge_group @businessplans.charge_group.target_group @employees.group.id | ユーザ設定 | 自社担当グループID | array(number) | 共通グループIDを指定。主担当グループはこちらにも指定必須。 | |
| 9 | activities.activity.target_employee | 報告者 | object | 社員(employee)のカーボン指定 カーボン型について | |
| - activities.activity.target_employee @employees.employee.id | 報告者ID | number | |||
| - activities.activity.target_employee @employees.employee.employee_name | ユーザ設定 | 社員氏名 | string | ||
| - activities.activity.target_employee @employees.employee.name_kana | ユーザ設定 | 社員氏名(かな) | string | ||
| - activities.activity.target_employee @employees.employee.relational_manager | ユーザ設定 | マネージャー | number | 社員IDを指定。 | |
| - activities.activity.target_employee @employees.employee.relational_department | ユーザ設定 | 部署ID | number | ||
| - activities.activity.target_employee @employees.employee.charge_workr @employees.charge_work.charge_work | ユーザ設定 | 担当業務タイプ | array(string) | 業務タイプマスタの選択肢名 マスタ選択肢の取得方法 | |
| - activities.activity.target_employee @employees.employee.charge_workr @employees.charge_work.main_charge_work | ユーザ設定 | 主担当業務タイプ | string | 業務タイプマスタの選択肢名 マスタ選択肢の取得方法 担当業務タイプから一つを選択 | |
| 10 | activities.activity.target_deal | 活動対象の取引商品 | array(object) | 取引商品(deal)のカーボン指定 カーボン型について | |
| - activities.activity.target_deal @deals.deal.id | ユーザ設定 | 活動対象の取引商品ID | number | ||
| - activities.activity.target_deal @deals.deal.reportable_flag | ユーザ設定 | 報告対象フラグ | bolean | ||
| - activities.activity.target_deal @deals.deal.memo | ユーザ設定 | メモ | string | ||
| - activities.activity.target_deal @deals.deal.amount | ユーザ設定 | 数量 | number | ||
| - activities.activity.target_deal @deals.deal.progress | ユーザ設定 | 進捗状況 | string | 進捗状況マスタの選択肢名 マスタ選択肢の取得方法 | |
| - activities.activity.target_deal @deals.deal.unit_price | ユーザ設定 | 金額（単価） | number | ||
| - activities.activity.target_deal @deals.deal.order_price | ユーザ設定 | 受注(予定)金額 | number | ||
| - activities.activity.target_deal @deals.deal.business_type | ユーザ設定 | 業務タイプ | string | 業務マスタの選択肢名 マスタ選択肢の取得方法 | |
| - activities.activity.target_deal @deals.deal.relational_product | ユーザ設定 | 商品ID | number | ||
| - activities.activity.target_deal @deals.deal.continue_or_terminate_flg | ユーザ設定 | 継続/終了 | string | "継続", "終了"のいずれか" | |
| - activities.activity.target_deal @deals.deal.charge_employee @deals.charge_employee.main_charge | ユーザ設定 | 主担当者ID | number | 社員IDを指定。 | |
| - activities.activity.target_deal @deals.deal.charge_employee @deals.charge_employee.target_employee @employees.employee.id | ユーザ設定 | 自社担当者ID | array(number) | 社員IDを指定。主担当者はこちらにも指定必須。 | |
| 11 | activities.activity.interviewer | 当日面談者 | object | ||
| - activities.activity.interviewer @activities.interviewer.id | ユーザ設定 | 当日面談者ID | number | 新規登録の場合はnull、更新の場合は値指定 | |
| - activities.activity.interviewer @activities.interviewer.target_businesscard | 当日面談者である名刺 | array(object) | |||
| --activities.activity.interviewer @activities.interviewer.target_businesscard @business_cards.business_card.id | 当日面談者名刺ID | number | |||
| --activities.activity.interviewer @activities.interviewer.target_businesscard @business_cards.business_card.business_card_full_name | string | ユーザ設定 | |||
| --activities.activity.interviewer @activities.interviewer.target_businesscard @business_cards.business_card.businesscard_image | object | ユーザ設定 | |||
| ---fileId | string | ||||
| --activities.activity.interviewer @activities.interviewer.target_businesscard @business_cards.business_card.position_name | string | ユーザ設定 | |||
| --activities.activity.interviewer @activities.interviewer.target_businesscard @business_cards.business_card.business_card_full_name_kana | string | ユーザ設定 | |||
| --activities.activity.interviewer @activities.interviewer.target_businesscard @business_cards.business_card.department_name | string | ユーザ設定 | |||
| 12 | activities.activity.next_task_date | ネクストアクション日付 | string | "yyyy/MM/dd"形式 | |
| 13 | activities.activity.next_task_date_task | ネクストアクションのタスクID | number | 入力する場合、ネクストアクション日時必須 | |
| 14 | activities.activity.next_schedule_date | 次回訪問日 | string | "yyyy/MM/dd"形式 | |
| 15 | activities.activity.next_schedule_date_schedule | 次回訪問日のスケジュールID | number | 入力する場合、次回訪問日必須 | |
| 16 | activities.activity.participant_name | 当日面談者名 | string | ||
| 17 | 拡張項目の項目名は、システムで設定するitem_idを設定する。item_idの確認方法 | 拡張項目 | any() | 拡張項目を追加する際、アイテムタイプ別定義のページを参照する |
Example
{
"activities.activity.visit_start_datetime": "2025/07/01 11:20",
"activities.activity.visit_end_datetime": "2025/07/01 11:25",
"activities.activity.action_time": 5,
"activities.activity.action": "訪問",
"activities.activity.memo": "メモ",
"activities.activity.business_type": "営業",
"activities.activity.target_customer": {
"activities.activity.target_customer@customers.customer.id": 47593743414019,
"activities.activity.target_customer@customers.customer.customer_name": "ソフトブレーン株式会社",
"activities.activity.target_customer@customers.customer.customer_type": "法人",
"activities.activity.target_customer@customers.customer.relational_parent_customer": null,
"activities.activity.target_customer@customers.customer.charge_employee@customers.charge_employee.main_charge": 14852199191504,
"activities.activity.target_customer@customers.customer.charge_employee@customers.charge_employee.target_employee@employees.employee.id": [
14852199191504,
14852199191505
],
"activities.activity.target_customer@customers.customer.charge_department@customers.charge_department.main_charge": 14852199191498,
"activities.activity.target_customer@customers.customer.charge_department@customers.charge_department.target_department@employees.department.id": [
14852199191498,
14852199191501
],
"activities.activity.target_customer@customers.customer.charge_group@customers.charge_group.main_charge": 14852199191496,
"activities.activity.target_customer@customers.customer.charge_group@customers.charge_group.target_group@employees.group.id": [
14852199191496,
14852199191497
]
},
"activities.activity.target_businessplan": {
"activities.activity.target_businessplan@businessplans.businessplan.id": 45960290034893,
"activities.activity.target_businessplan@businessplans.businessplan.progress": "アプローチ",
"activities.activity.target_businessplan@businessplans.businessplan.business_type": "営業",
"activities.activity.target_businessplan@businessplans.businessplan.businessplan_name": "営業戦略計画",
"activities.activity.target_businessplan@businessplans.businessplan.charge_employee@businessplans.charge_employee.main_charge": 14852199177819,
"activities.activity.target_businessplan@businessplans.businessplan.charge_employee@businessplans.charge_employee.target_employee@employees.employee.id": [
14852199177819
],
"activities.activity.target_businessplan@businessplans.businessplan.charge_department@businessplans.charge_department.main_charge": 14852199191498,
"activities.activity.target_businessplan@businessplans.businessplan.charge_department@businessplans.charge_department.target_department@employees.department.id": [
14852199191498
],
"activities.activity.target_businessplan@businessplans.businessplan.charge_group@businessplans.charge_group.main_charge": 14852199191496,
"activities.activity.target_businessplan@businessplans.businessplan.charge_group@businessplans.charge_group.target_group@employees.group.id": [
14852199191496
]
},
"activities.activity.target_employee": {
"activities.activity.target_employee@employees.employee.id": 14852199177819,
"activities.activity.target_employee@employees.employee.employee_name": "営業 太郎",
"activities.activity.target_employee@employees.employee.name_kana": "えいぎょう たろう",
"activities.activity.target_employee@employees.employee.relational_manager": 14852199191504,
"activities.activity.target_employee@employees.employee.relational_department": 100000000001,
"activities.activity.target_employee@employees.employee.charge_work@employees.charge_work.charge_work": [
"営業"
],
"activities.activity.target_employee@employees.employee.charge_work@employees.charge_work.main_charge_work": "営業"
},
"activities.activity.target_deal": [
{
"activities.activity.target_deal@deals.deal.id": null,
"activities.activity.target_deal@deals.deal.reportable_flag": true,
"activities.activity.target_deal@deals.deal.memo": "メモ",
"activities.activity.target_deal@deals.deal.amount": 100,
"activities.activity.target_deal@deals.deal.progress": "アプローチ",
"activities.activity.target_deal@deals.deal.unit_price": 5000,
"activities.activity.target_deal@deals.deal.order_price": 500000,
"activities.activity.target_deal@deals.deal.business_type": "営業",
"activities.activity.target_deal@deals.deal.relational_product": 30550971747309,
"activities.activity.target_deal@deals.deal.continue_or_terminate_flg": "継続",
"activities.activity.target_deal@deals.deal.charge_employee@deals.charge_employee.main_charge": 14852199191504,
"activities.activity.target_deal@deals.deal.charge_employee@deals.charge_employee.target_employee@employees.employee.id": [
14852199191504
]
}
],
"activities.activity.interviewer": [
{
"activities.activity.interviewer@activities.interviewer.id": null,
"activities.activity.interviewer@activities.interviewer.target_businesscard": [
{
"activities.activity.interviewer@activities.interviewer.target_businesscard@business_cards.business_card.id": 45262303348320,
"activities.activity.interviewer@activities.interviewer.target_businesscard@business_cards.business_card.business_card_full_name": "営業 次郎",
"activities.activity.interviewer@activities.interviewer.target_businesscard@business_cards.business_card.businesscard_image": {
"fileid": "904a968f683f444cbff2ed3c2fac725b"
},
"activities.activity.interviewer@activities.interviewer.target_businesscard@business_cards.business_card.position_name": "部長",
"activities.activity.interviewer@activities.interviewer.target_businesscard@business_cards.business_card.business_card_full_name_kana": "えいぎょう じろう",
"activities.activity.interviewer@activities.interviewer.target_businesscard@business_cards.business_card.department_name": "営業部"
}
]
}
],
"activities.activity.next_task_date": "2025/08/01",
"activities.activity.next_task_date_task": 30752703813727,
"activities.activity.next_schedule_date_schedule": 31268617262164,
"activities.activity.next_schedule_date": "2025/08/01",
"activities.activity.participant_name": "営業 花子"
}
活動更新
必要な権限
活動変更
Request
URL
https://gateway-esm.softbrain.com/esm-api/{tenant}/pub/esms/v1/sheet/activity/{id}
HTTP Method
PUT
Parameter
Path Parameter
| No. | パラメータ | 必須 | タイプ | デフォルト値 | 説明 |
|---|---|---|---|---|---|
| 1 | tenant | ○ | string | - | 会社ID |
| 2 | id | ○ | string | - | 対象レコードID |
Request Body
| No. | プロパティ名 | 必須 | 項目名 | タイプ | 備考 |
|---|---|---|---|---|---|
| 1 | activities.activity.visit_start_datetime | 活動開始時刻 | string | "yyyy/MM/dd HH:mm"形式 | |
| 2 | activities.activity.visit_end_datetime | 活動終了時刻 | string | "yyyy/MM/dd HH:mm"形式 | |
| 3 | activities.activity.action_time | 活動時間(分) | number | ||
| 4 | activities.activity.action | 活動内容 | string | 活動内容マスタの選択肢名 マスタ選択肢の取得方法 | |
| 5 | activities.activity.memo | メモ | string | ||
| 6 | activities.activity.business_type | 業務タイプ | string | 業務タイプマスタの選択肢名 マスタ選択肢の取得方法 | |
| 7 | activities.activity.target_customer | 活動対象顧客 | object | 顧客(customer)のカーボン指定 カーボン型について | |
| - activities.activity.target_customer @customers.customer.id | 活動対象顧客ID | number | |||
| - activities.activity.target_customer @customers.customer.customer_name | ユーザ設定 | 顧客名 | string | ||
| - activities.activity.target_customer @customers.customer.customer_type | ユーザ設定 | 顧客タイプ | string | 顧客タイプマスタの選択肢名 マスタ選択肢の取得方法 | |
| - activities.activity.target_customer @customers.customer.relational_parent_customer | ユーザ設定 | 親顧客 | number | 顧客IDを指定。 | |
| - activities.activity.target_customer @customers.customer.charge_group @customers.charge_group.main_charge | ユーザ設定 | 主担当グループID | number | 共通グループIDを指定。 | |
| - activities.activity.target_customer @customers.customer.charge_group @customers.charge_group.target_group @employees.group.id | ユーザ設定 | 自社担当グループID | array(number) | 共通グループIDを指定。主担当グループはこちらにも指定必須。 | |
| - activities.activity.target_customer @customers.customer.charge_employee @customers.charge_employee.main_charge | ユーザ設定 | 主担当者ID | number | 社員IDを指定。 | |
| - activities.activity.target_customer @customers.customer.charge_employee @customers.charge_employee.target_employee @employees.employee.id | ユーザ設定 | 自社担当者ID | array(number) | 社員IDを指定。主担当者はこちらにも指定必須。 | |
| - activities.activity.target_customer @customers.customer.charge_department @customers.charge_department.main_charge | ユーザ設定 | 主担当部署ID | number | 部署IDを指定。 | |
| - activities.activity.target_customer @customers.customer.charge_department @customers.charge_department.target_department @employees.department.id | ユーザ設定 | 自社担当部署ID | array(number) | 部署IDを指定。主担当部署はこちらにも指定必須。 | |
| 8 | activities.activity.target_businessplan | 活動対象案件 | object | 案件(businessplan)のカーボン指定 カーボン型について | |
| - activities.activity.target_businessplan @businessplans.businessplan.id | 活動対象案件ID | number | |||
| - activities.activity.target_businessplan @businessplans.businessplan.progress | ユーザ設定 | 進捗状況 | number | 進捗状況マスタの選択肢名 マスタ選択肢の取得方法 | |
| - activities.activity.target_businessplan @businessplans.businessplan.business_type | ユーザ設定 | 業務タイプ | string | 業務マスタの選択肢名 マスタ選択肢の取得方法 | |
| - activities.activity.target_businessplan @businessplans.businessplan.businessplan_name | ユーザ設定 | 案件名 | string | ||
| - activities.activity.target_businessplan @businessplans.businessplan.charge_employee @businessplans.charge_employee.main_charge | ユーザ設定 | 主担当者ID | number | ||
| - activities.activity.target_businessplan @businessplans.businessplan.charge_employee @businessplans.charge_employee.target_employee @employees.employee.id | ユーザ設定 | 自社担当者ID | array(number) | 主担当者はこちらにも含まれる。 | |
| - activities.activity.target_businessplan @businessplans.businessplan.charge_department @businessplans.charge_department.main_charge | ユーザ設定 | 主担当部署ID | number | ||
| - activities.activity.target_businessplan @businessplans.businessplan.charge_department @businessplans.charge_department.target_department @employees.department.id | ユーザ設定 | 自社担当部署ID | array(number) | 主担当部署はこちらにも含まれる。 ※１対Nの紐づけの更新時意事項 | |
| - activities.activity.target_businessplan @businessplans.businessplan.charge_group @businessplans.charge_group.main_charge | ユーザ設定 | 主担当グループID | number | ||
| - activities.activity.target_businessplan @businessplans.businessplan.charge_group @businessplans.charge_group.target_group @employees.group.id | ユーザ設定 | 自社担当グループID | array(number) | 主担当グループはこちらにも含まれる。 | |
| 9 | activities.activity.target_employee | 報告者 | object | ※カーボン型、社員(employee)のカーボン指定 カーボン型について | |
| - activities.activity.target_employee @employees.employee.id | 報告者ID | number | |||
| - activities.activity.target_employee @employees.employee.employee_name | ユーザ設定 | 社員氏名 | string | ||
| - activities.activity.target_employee @employees.employee.name_kana | ユーザ設定 | 社員氏名(かな) | string | ||
| - activities.activity.target_employee @employees.employee.relational_manager | ユーザ設定 | マネージャー | number | 社員IDを指定。 | |
| - activities.activity.target_employee @employees.employee.relational_department | ユーザ設定 | 部署ID | number | ||
| - activities.activity.target_employee @employees.employee.charge_workr @employees.charge_work.charge_work | ユーザ設定 | 担当業務タイプ | array(string) | 業務タイプマスタの選択肢名 マスタ選択肢の取得方法 | |
| - activities.activity.target_employee @employees.employee.charge_workr @employees.charge_work.main_charge_work | ユーザ設定 | 主担当業務タイプ | string | 業務タイプマスタの選択肢名 マスタ選択肢の取得方法 担当業務タイプから一つを選択 | |
| 10 | activities.activity.target_deal | 活動対象の取引商品 | array(object) | 取引商品(deal)のカーボン指定 カーボン型について | |
| - activities.activity.target_deal @deals.deal.id | ユーザ設定 | 活動対象の取引商品ID | number | ||
| - activities.activity.target_deal @deals.deal.reportable_flag | ユーザ設定 | 報告対象フラグ | bolean | ||
| - activities.activity.target_deal @deals.deal.memo | ユーザ設定 | メモ | string | ||
| - activities.activity.target_deal @deals.deal.amount | ユーザ設定 | 数量 | number | ||
| - activities.activity.target_deal @deals.deal.progress | ユーザ設定 | 進捗状況 | string | 進捗状況マスタの選択肢名 マスタ選択肢の取得方法 | |
| - activities.activity.target_deal @deals.deal.unit_price | ユーザ設定 | 金額（単価） | number | ||
| - activities.activity.target_deal @deals.deal.order_price | ユーザ設定 | 受注(予定)金額 | number | ||
| - activities.activity.target_deal @deals.deal.business_type | ユーザ設定 | 業務タイプ | string | 業務マスタの選択肢名 マスタ選択肢の取得方法 | |
| - activities.activity.target_deal @deals.deal.relational_product | ユーザ設定 | 商品ID | number | ||
| - activities.activity.target_deal @deals.deal.continue_or_terminate_flg | ユーザ設定 | 継続/終了 | string | "継続", "終了"のいずれか" | |
| - activities.activity.target_deal @deals.deal.charge_employee @deals.charge_employee.main_charge | ユーザ設定 | 主担当者ID | number | 社員IDを指定。 | |
| - activities.activity.target_deal @deals.deal.charge_employee @deals.charge_employee.target_employee @employees.employee.id | ユーザ設定 | 自社担当者ID | array(number) | 社員IDを指定。主担当者はこちらにも指定必須。 | |
| 11 | activities.activity.interviewer | 当日面談者 | object | ||
| - activities.activity.interviewer @activities.interviewer.id | ユーザ設定 | 当日面談者ID | number | 新規登録の場合はnull、更新の場合は値指定 | |
| - activities.activity.interviewer @activities.interviewer.target_businesscard | 当日面談者である名刺 | array(object) | |||
| --activities.activity.interviewer @activities.interviewer.target_businesscard @business_cards.business_card.id | 当日面談者名刺ID | number | |||
| --activities.activity.interviewer @activities.interviewer.target_businesscard @business_cards.business_card.business_card_full_name | string | ユーザ設定 | |||
| --activities.activity.interviewer @activities.interviewer.target_businesscard @business_cards.business_card.businesscard_image | object | ユーザ設定 | |||
| ---fileId | string | ||||
| --activities.activity.interviewer @activities.interviewer.target_businesscard @business_cards.business_card.position_name | string | ユーザ設定 | |||
| --activities.activity.interviewer @activities.interviewer.target_businesscard @business_cards.business_card.business_card_full_name_kana | string | ユーザ設定 | |||
| --activities.activity.interviewer @activities.interviewer.target_businesscard @business_cards.business_card.department_name | string | ユーザ設定 | |||
| 12 | activities.activity.next_task_date | ネクストアクション日付 | string | "yyyy/MM/dd"形式 | |
| 13 | activities.activity.next_task_date_task | ネクストアクションのタスクID | number | 入力する場合、ネクストアクション日時必須 | |
| 14 | activities.activity.next_schedule_date | 次回訪問日 | string | "yyyy/MM/dd"形式 | |
| 15 | activities.activity.next_schedule_date_schedule | 次回訪問日のスケジュールID | number | 入力する場合、次回訪問日必須 | |
| 16 | activities.activity.participant_name | 当日面談者名 | string | ||
| 17 | 拡張項目の項目名は、システムで設定するitem_idを設定する。item_idの確認方法 | 拡張項目 | any() | 拡張項目を追加する際、アイテムタイプ別定義のページを参照する |
Example
{
"activities.activity.visit_start_datetime": "2025/07/01 11:20",
"activities.activity.visit_end_datetime": "2025/07/01 11:25",
"activities.activity.action_time": 5,
"activities.activity.action": "訪問",
"activities.activity.memo": "メモ",
"activities.activity.business_type": "営業",
"activities.activity.target_customer": {
"activities.activity.target_customer@customers.customer.id": 47593743414019,
"activities.activity.target_customer@customers.customer.customer_name": "ソフトブレーン株式会社",
"activities.activity.target_customer@customers.customer.customer_type": "法人",
"activities.activity.target_customer@customers.customer.relational_parent_customer": null,
"activities.activity.target_customer@customers.customer.charge_group@customers.charge_group.main_charge": 14852199191496,
"activities.activity.target_customer@customers.customer.charge_group@customers.charge_group.target_group@employees.group.id": [
14852199191496,
14852199191497
],
"activities.activity.target_customer@customers.customer.charge_employee@customers.charge_employee.main_charge": 14852199191504,
"activities.activity.target_customer@customers.customer.charge_employee@customers.charge_employee.target_employee@employees.employee.id": [
14852199191504,
14852199191505
],
"activities.activity.target_customer@customers.customer.charge_department@customers.charge_department.main_charge": 14852199191498,
"activities.activity.target_customer@customers.customer.charge_department@customers.charge_department.target_department@employees.department.id": [
14852199191498,
14852199191501
]
},
"activities.activity.target_businessplan": {
"activities.activity.target_businessplan@businessplans.businessplan.id": 45960290034893,
"activities.activity.target_businessplan@businessplans.businessplan.progress": "案件化",
"activities.activity.target_businessplan@businessplans.businessplan.business_type": "営業",
"activities.activity.target_businessplan@businessplans.businessplan.businessplan_name": "営業戦略計画",
"activities.activity.target_businessplan@businessplans.businessplan.charge_employee@businessplans.charge_employee.main_charge": 14852199177819,
"activities.activity.target_businessplan@businessplans.businessplan.charge_employee@businessplans.charge_employee.target_employee@employees.employee.id": [
14852199177819
],
"activities.activity.target_businessplan@businessplans.businessplan.charge_department@businessplans.charge_department.main_charge": 14852199191498,
"activities.activity.target_businessplan@businessplans.businessplan.charge_department@businessplans.charge_department.target_department@employees.department.id": [
14852199191498
],
"activities.activity.target_businessplan@businessplans.businessplan.charge_group@businessplans.charge_group.main_charge": 14852199191496,
"activities.activity.target_businessplan@businessplans.businessplan.charge_group@businessplans.charge_group.target_group@employees.group.id": [
14852199191496
]
},
"activities.activity.target_employee": {
"activities.activity.target_employee@employees.employee.id": 14852199177819,
"activities.activity.target_employee@employees.employee.employee_name": "営業 太郎",
"activities.activity.target_employee@employees.employee.name_kana": "えいぎょう たろう",
"activities.activity.target_employee@employees.employee.relational_manager": 14852199191504,
"activities.activity.target_employee@employees.employee.relational_department": 100000000001,
"activities.activity.target_employee@employees.employee.charge_work@employees.charge_work.charge_work": [
"営業"
],
"activities.activity.target_employee@employees.employee.charge_work@employees.charge_work.main_charge_work": "営業"
},
"activities.activity.target_deal": [
{
"activities.activity.target_deal@deals.deal.id": null,
"activities.activity.target_deal@deals.deal.reportable_flag": true,
"activities.activity.target_deal@deals.deal.memo": "メモ",
"activities.activity.target_deal@deals.deal.amount": 100,
"activities.activity.target_deal@deals.deal.progress": "案件化",
"activities.activity.target_deal@deals.deal.unit_price": 5000,
"activities.activity.target_deal@deals.deal.order_price": 500000,
"activities.activity.target_deal@deals.deal.business_type": "営業",
"activities.activity.target_deal@deals.deal.relational_product": 30550971747309,
"activities.activity.target_deal@deals.deal.continue_or_terminate_flg": "継続",
"activities.activity.target_deal@deals.deal.charge_employee@deals.charge_employee.main_charge": 14852199191504,
"activities.activity.target_deal@deals.deal.charge_employee@deals.charge_employee.target_employee@employees.employee.id": [
14852199191504
]
}
],
"activities.activity.interviewer": [
{
"activities.activity.interviewer@activities.interviewer.id": null,
"activities.activity.interviewer@activities.interviewer.target_businesscard": [
{
"activities.activity.interviewer@activities.interviewer.target_businesscard@business_cards.business_card.id": 45262303348320,
"activities.activity.interviewer@activities.interviewer.target_businesscard@business_cards.business_card.business_card_full_name": "営業 次郎",
"activities.activity.interviewer@activities.interviewer.target_businesscard@business_cards.business_card.businesscard_image": {
"fileid": "904a968f683f444cbff2ed3c2fac725b"
},
"activities.activity.interviewer@activities.interviewer.target_businesscard@business_cards.business_card.position_name": "部長",
"activities.activity.interviewer@activities.interviewer.target_businesscard@business_cards.business_card.business_card_full_name_kana": "えいぎょう じろう",
"activities.activity.interviewer@activities.interviewer.target_businesscard@business_cards.business_card.department_name": "営業部"
}
]
}
],
"activities.activity.next_task_date": "2025/08/01",
"activities.activity.next_task_date_task": 30752703813727,
"activities.activity.next_schedule_date": "2025/08/01",
"activities.activity.next_schedule_date_schedule": 31268617262164,
"activities.activity.participant_name": "営業 花子"
}
活動削除
必要な権限
活動削除・活動一括削除
Request
URL
https://gateway-esm.softbrain.com/esm-api/{tenant}/pub/esms/v1/sheet/activity/{id}
HTTP Method
DELETE
Parameter
Path Parameter
| No. | パラメータ | 必須 | タイプ | デフォルト値 | 説明 |
|---|---|---|---|---|---|
| 1 | tenant | ○ | string | - | 会社ID |
| 2 | id | ○ | string | - | 対象レコードID |
Response
Response Body
Response Bodyはこちらの共通仕様に則っています。
| No. | プロパティ名 | 必須 | 項目名 | タイプ | 備考 |
|---|---|---|---|---|---|
| 1 | activities.activity.id | 活動id | number | ||
| 2 | activities.activity.visit_start_datetime | 活動開始時刻 | string | "yyyy/MM/dd HH:mm"形式 | |
| 3 | activities.activity.visit_end_datetime | 活動終了時刻 | string | "yyyy/MM/dd HH:mm"形式 | |
| 4 | activities.activity.action_time | 活動時間(分) | number | ||
| 5 | activities.activity.action | 活動内容 | string | 活動内容マスタの選択肢名 マスタ選択肢の取得方法 | |
| 6 | activities.activity.memo | メモ | string | ||
| 7 | activities.activity.business_type | 業務タイプ | string | 業務タイプマスタの選択肢名 マスタ選択肢の取得方法 | |
| 8 | activities.activity.target_customer | 活動対象顧客 | object | 顧客(customer)のカーボン指定 カーボン型について | |
| - activities.activity.target_customer @customers.customer.id | 活動対象顧客ID | number | |||
| - activities.activity.target_customer @customers.customer.customer_name | ユーザ設定 | 顧客名 | string | ||
| - activities.activity.target_customer @customers.customer.customer_type | ユーザ設定 | 顧客タイプ | string | 顧客タイプマスタの選択肢名 マスタ選択肢の取得方法 | |
| - activities.activity.target_customer @customers.customer.relational_parent_customer | ユーザ設定 | 親顧客 | number | ||
| - activities.activity.target_customer @customers.customer.charge_employee @customers.charge_employee.main_charge | ユーザ設定 | 主担当者ID | number | ||
| - activities.activity.target_customer @customers.customer.charge_employee @customers.charge_employee.target_employee @employees.employee.id | ユーザ設定 | 自社担当者ID | array(number) | 主担当者はこちらにも含まれる。 | |
| - activities.activity.target_customer @customers.customer.charge_department @customers.charge_department.main_charge | ユーザ設定 | 主担当部署ID | number | ||
| - activities.activity.target_customer @customers.customer.charge_department @customers.charge_department.target_department @employees.department.id | ユーザ設定 | 自社担当部署ID | array(number) | 主担当部署はこちらにも含まれる。 | |
| - activities.activity.target_customer @customers.customer.charge_group @customers.charge_group.main_charge | ユーザ設定 | 主担当グループID | number | ||
| - activities.activity.target_customer @customers.customer.charge_group @customers.charge_group.target_group @employees.group.id | ユーザ設定 | 自社担当グループID | array(number) | 主担当グループはこちらにも含まれる。 | |
| 9 | activities.activity.target_businessplan | 活動対象案件 | object | 案件(businessplan)のカーボン指定 カーボン型について | |
| - activities.activity.target_businessplan @businessplans.businessplan.id | 活動対象案件ID | number | |||
| - activities.activity.target_businessplan @businessplans.businessplan.progress | ユーザ設定 | 進捗状況 | number | 進捗状況マスタの選択肢名 マスタ選択肢の取得方法 | |
| - activities.activity.target_businessplan @businessplans.businessplan.business_type | ユーザ設定 | 業務タイプ | string | 業務マスタの選択肢名 マスタ選択肢の取得方法 | |
| - activities.activity.target_businessplan @businessplans.businessplan.businessplan_name | ユーザ設定 | 案件名 | string | ||
| - activities.activity.target_businessplan @businessplans.businessplan.charge_employee @businessplans.charge_employee.main_charge | ユーザ設定 | 主担当者ID | number | ||
| - activities.activity.target_businessplan @businessplans.businessplan.charge_employee @businessplans.charge_employee.target_employee @employees.employee.id | ユーザ設定 | 自社担当者ID | array(number) | 主担当者はこちらにも含まれる。 | |
| - activities.activity.target_businessplan @businessplans.businessplan.charge_department @businessplans.charge_department.main_charge | ユーザ設定 | 主担当部署ID | number | ||
| - activities.activity.target_businessplan @businessplans.businessplan.charge_department @businessplans.charge_department.target_department @employees.department.id | ユーザ設定 | 自社担当部署ID | array(number) | 主担当部署はこちらにも含まれる。 | |
| - activities.activity.target_businessplan @businessplans.businessplan.charge_group @businessplans.charge_group.main_charge | ユーザ設定 | 主担当グループID | number | ||
| - activities.activity.target_businessplan @businessplans.businessplan.charge_group @businessplans.charge_group.target_group @employees.group.id | ユーザ設定 | 自社担当グループID | array(number) | 主担当グループはこちらにも含まれる。 | |
| 10 | activities.activity.target_employee | 報告者 | object | ※カーボン型、社員(employee)のカーボン指定 カーボン型について | |
| - activities.activity.target_employee @employees.employee.id | 報告者ID | number | |||
| - activities.activity.target_employee @employees.employee.employee_name | ユーザ設定 | 社員氏名 | string | ||
| - activities.activity.target_employee @employees.employee.name_kana | ユーザ設定 | 社員氏名(かな) | string | ||
| - activities.activity.target_employee @employees.employee.relational_manager | ユーザ設定 | マネージャー | number | ||
| - activities.activity.target_employee @employees.employee.relational_department | ユーザ設定 | 部署ID | number | ||
| - activities.activity.target_employee @employees.employee.charge_workr @employees.charge_work.main_charge_work | ユーザ設定 | 主担当業務タイプ | string | 業務タイプマスタの値 | |
| - activities.activity.target_employee @employees.employee.charge_workr @employees.charge_work.charge_work | ユーザ設定 | 担当業務タイプ | array(string) | 業務タイプマスタの値 | |
| 11 | activities.activity.target_deal | 活動対象の取引商品 | array(object) | 取引商品(deal)のカーボン指定 カーボン型について | |
| - activities.activity.target_deal @deals.deal.id | ユーザ設定 | 活動対象の取引商品ID | number | ||
| - activities.activity.target_deal @deals.deal.memo | ユーザ設定 | メモ | string | ||
| - activities.activity.target_deal @deals.deal.amount | ユーザ設定 | 数量 | number | ||
| - activities.activity.target_deal @deals.deal.progress | ユーザ設定 | 進捗状況 | string | 進捗状況マスタの選択肢名 マスタ選択肢の取得方法 | |
| - activities.activity.target_deal @deals.deal.unit_price | ユーザ設定 | 金額（単価） | number | ||
| - activities.activity.target_deal @deals.deal.order_price | ユーザ設定 | 受注(予定)金額 | number | ||
| - activities.activity.target_deal @deals.deal.business_type | ユーザ設定 | 業務タイプ | string | 業務マスタの選択肢名 マスタ選択肢の取得方法 | |
| - activities.activity.target_deal @deals.deal.reportable_flag | ユーザ設定 | 報告対象フラグ | bolean | ||
| - activities.activity.target_deal @deals.deal.relational_product | ユーザ設定 | 商品ID | number | ||
| - activities.activity.target_deal @deals.deal.continue_or_terminate_flg | ユーザ設定 | 継続/終了 | string | "継続", "終了"のいずれか" | |
| - activities.activity.target_deal @deals.deal.charge_employee @deals.charge_employee.main_charge | ユーザ設定 | 主担当者ID | number | 社員IDを指定。 | |
| - activities.activity.target_deal @deals.deal.charge_employee @deals.charge_employee.target_employee @employees.employee.id | ユーザ設定 | 自社担当者ID | array(number) | 社員IDを指定。主担当者はこちらにも指定必須。 | |
| 12 | activities.activity.interviewer | 当日面談者 | object | ||
| - activities.activity.interviewer @activities.interviewer.id | ユーザ設定 | 当日面談者ID | number | 新規登録の場合はnull、更新の場合は値指定 | |
| - activities.activity.interviewer @activities.interviewer.target_businesscard | 当日面談者である名刺 | array(object) | |||
| --activities.activity.interviewer @activities.interviewer.target_businesscard @business_cards.business_card.id | 当日面談者名刺ID | number | |||
| --activities.activity.interviewer @activities.interviewer.target_businesscard @business_cards.business_card.business_card_full_name | string | ユーザ設定 | |||
| --activities.activity.interviewer @activities.interviewer.target_businesscard @business_cards.business_card.businesscard_image | object | ユーザ設定 | |||
| ---fileId | string | ||||
| --activities.activity.interviewer @activities.interviewer.target_businesscard @business_cards.business_card.position_name | string | ユーザ設定 | |||
| --activities.activity.interviewer @activities.interviewer.target_businesscard @business_cards.business_card.business_card_full_name_kana | string | ユーザ設定 | |||
| --activities.activity.interviewer @activities.interviewer.target_businesscard @business_cards.business_card.department_name | string | ユーザ設定 | |||
| 13 | activities.activity.next_task_date | ネクストアクション日付 | string | "yyyy/MM/dd"形式 | |
| 14 | activities.activity.next_task_date_task | ネクストアクションのタスクID | number | 入力する場合、ネクストアクション日時必須 | |
| 15 | activities.activity.next_schedule_date | 次回訪問日 | string | "yyyy/MM/dd"形式 | |
| 16 | activities.activity.next_schedule_date_schedule | 次回訪問日のスケジュールID | number | 入力する場合、次回訪問日必須 | |
| 17 | system_reg_date | 登録日 | string | "yyyy/MM/dd HH:mm"形式 ※取得のみ | |
| 18 | system_reg_user | 登録ユーザ | number | 登録者ユーザID ※取得のみ | |
| 19 | system_reg_employee | 登録社員 | number | 登録社員ID ※取得のみ | |
| 20 | system_upd_date | 更新日 | string | "yyyy/MM/dd HH:mm"形式 ※取得のみ | |
| 21 | system_upd_user | 最終更新ユーザ | number | 最終更新者ユーザID ※取得のみ | |
| 22 | system_upd_employee | 最終更新社員 | number | 最終更新社員ID ※取得のみ | |
| 24 | activities.activity.participant_name | 当日面談者名 | string | ||
| 25 | 拡張項目の項目名は、システムで設定するitem_idを設定する。item_idの確認方法 | 拡張項目 | any() | 拡張項目を追加する際、アイテムタイプ別定義のページを参照する |
Example
{
"activities.activity.id": 45279304330434,
"activities.activity.visit_start_datetime": "2025/07/01 11:20",
"activities.activity.visit_end_datetime": "2025/07/01 11:25",
"activities.activity.action_time": "5",
"activities.activity.action": "訪問",
"activities.activity.memo": "メモ",
"activities.activity.business_type": "営業",
"activities.activity.target_customer": {
"activities.activity.target_customer@customers.customer.id": 47593743414019,
"activities.activity.target_customer@customers.customer.customer_name": "ソフトブレーン株式会社",
"activities.activity.target_customer@customers.customer.customer_type": "法人",
"activities.activity.target_customer@customers.customer.relational_parent_customer": null,
"activities.activity.target_customer@customers.customer.charge_employee@customers.charge_employee.main_charge": 14852199191504,
"activities.activity.target_customer@customers.customer.charge_employee@customers.charge_employee.target_employee@employees.employee.id": [
14852199191504,
14852199191505
],
"activities.activity.target_customer@customers.customer.charge_department@customers.charge_department.main_charge": 14852199191498,
"activities.activity.target_customer@customers.customer.charge_department@customers.charge_department.target_department@employees.department.id": [
14852199191498,
14852199191501
],
"activities.activity.target_customer@customers.customer.charge_group@customers.charge_group.main_charge": 14852199191496,
"activities.activity.target_customer@customers.customer.charge_group@customers.charge_group.target_group@employees.group.id": [
14852199191496,
14852199191497
]
},
"activities.activity.target_businessplan": {
"activities.activity.target_businessplan@businessplans.businessplan.id": 45960290034893,
"activities.activity.target_businessplan@businessplans.businessplan.progress": "案件化",
"activities.activity.target_businessplan@businessplans.businessplan.business_type": "営業",
"activities.activity.target_businessplan@businessplans.businessplan.businessplan_name": "営業戦略計画",
"activities.activity.target_businessplan@businessplans.businessplan.charge_employee@businessplans.charge_employee.main_charge": 14852199177819,
"activities.activity.target_businessplan@businessplans.businessplan.charge_employee@businessplans.charge_employee.target_employee@employees.employee.id": [
14852199177819
],
"activities.activity.target_businessplan@businessplans.businessplan.charge_department@businessplans.charge_department.main_charge": "14852199191498",
"activities.activity.target_businessplan@businessplans.businessplan.charge_department@businessplans.charge_department.target_department@employees.department.id": [
"14852199191498"
],
"activities.activity.target_businessplan@businessplans.businessplan.charge_group@businessplans.charge_group.main_charge": 14852199191496,
"activities.activity.target_businessplan@businessplans.businessplan.charge_group@businessplans.charge_group.target_group@employees.group.id": [
14852199191496
]
},
"activities.activity.target_employee": {
"activities.activity.target_employee@employees.employee.id": 14852199177819,
"activities.activity.target_employee@employees.employee.employee_name": "営業 太郎",
"activities.activity.target_employee@employees.employee.name_kana": "えいぎょう たろう",
"activities.activity.target_employee@employees.employee.relational_manager": 14852199191504,
"activities.activity.target_employee@employees.employee.relational_department": 100000000001,
"activities.activity.target_employee@employees.employee.charge_work@employees.charge_work.main_charge_work": "営業",
"activities.activity.target_employee@employees.employee.charge_work@employees.charge_work.charge_work": [
"営業"
]
},
"activities.activity.target_deal": [
{
"activities.activity.target_deal@deals.deal.id": 30838994494195,
"activities.activity.target_deal@deals.deal.memo": "メモ",
"activities.activity.target_deal@deals.deal.amount": "100",
"activities.activity.target_deal@deals.deal.progress": "案件化",
"activities.activity.target_deal@deals.deal.unit_price": "5,000",
"activities.activity.target_deal@deals.deal.order_price": "500,000",
"activities.activity.target_deal@deals.deal.business_type": "営業",
"activities.activity.target_deal@deals.deal.reportable_flag": true,
"activities.activity.target_deal@deals.deal.relational_product": 30550971747309,
"activities.activity.target_deal@deals.deal.continue_or_terminate_flg": "継続",
"activities.activity.target_deal@deals.deal.charge_employee@deals.charge_employee.main_charge": "14852199191504",
"activities.activity.target_deal@deals.deal.charge_employee@deals.charge_employee.target_employee@employees.employee.id": [
"14852199191504"
]
}
],
"activities.activity.interviewer": [
{
"activities.activity.interviewer@activities.interviewer.id": 45279304330435,
"activities.activity.interviewer@activities.interviewer.target_businesscard": [
{
"activities.activity.interviewer@activities.interviewer.target_businesscard@business_cards.business_card.id": "45262303348320",
"activities.activity.interviewer@activities.interviewer.target_businesscard@business_cards.business_card.business_card_full_name": "営業 次郎",
"activities.activity.interviewer@activities.interviewer.target_businesscard@business_cards.business_card.businesscard_image": {
"fileid": "904a968f683f444cbff2ed3c2fac725b"
},
"activities.activity.interviewer@activities.interviewer.target_businesscard@business_cards.business_card.position_name": "部長",
"activities.activity.interviewer@activities.interviewer.target_businesscard@business_cards.business_card.business_card_full_name_kana": "えいぎょう じろう",
"activities.activity.interviewer@activities.interviewer.target_businesscard@business_cards.business_card.department_name": "営業部"
}
]
}
],
"activities.activity.participant_name": "営業 花子",
"activities.activity.next_task_date": "2025/08/01",
"activities.activity.next_task_date_task": 30752703813727,
"activities.activity.next_schedule_date": "2025/08/01",
"activities.activity.next_schedule_date_schedule": 31268617262164,
"system_reg_date": "2025/08/20 18:19",
"system_reg_user": -101,
"system_reg_employee": 100000000001,
"system_upd_date": "2025/08/20 18:19",
"system_upd_user": -101,
"system_upd_employee": 100000000001,
}