案件(businessplan)
案件に関する情報の登録・更新・取得・削除ができます。
レコードのidの取得にはSearch APIが使用できます。
案件取得
必要な権限
案件参照
Request
URL
https://gateway-esm.softbrain.com/sheet-fs/{tenant}/pub/esms/v1/sheet/businessplan/{id}
HTTP Method
GET
Parameter
Path Parameter
| No. | パラメータ | 必須 | タイプ | デフォルト値 | 説明 |
|---|---|---|---|---|---|
| 1 | tenant | ○ | string | - | テナントID |
| 2 | id | ○ | string | - | 対象レコードID |
案件登録
必要な権限
案件登録
Request
URL
https://gateway-esm.softbrain.com/sheet-fs/{tenant}/pub/esms/v1/sheet/businessplan
HTTP Method
POST
Parameter
Path Parameter
| No. | パラメータ | 必須 | タイプ | デフォルト値 | 説明 |
|---|---|---|---|---|---|
| 1 | tenant | ○ | string | - | テナントID |
Request Body
| No. | プロパティ名 | 必須 | 項目名 | タイプ | 備考 |
|---|---|---|---|---|---|
| 1 | businessplans.businessplan.businessplan_name | 案件名 | string | ||
| 2 | businessplans.businessplan.businessplan_name_other | 案件名(呼称) | string | ||
| 3 | businessplans.businessplan.business_type | 業務タイプ | string | 業務タイプマスタの選択肢名。マスタの選択肢取得方法 | |
| 4 | businessplans.businessplan.relational_customer | 紐づき顧客 | number | ||
| 5 | businessplans.businessplan.continue_or_terminate_flg | 案件状態(継続/終了) | string | "継続", "終了"のいずれか | |
| 6 | businessplans.businessplan.order_price | 受注(予定)金額 | number | ||
| 7 | businessplans.businessplan.address | 住所 | object | ||
| - zipcode | 郵便番号 | string | |||
| - country | 国 | string | |||
| - street | 番地 | string | |||
| - building | 建物 | string | |||
| 8 | businessplans.businessplan.memo | 詳細内容 | string | ||
| 9 | businessplans.businessplan.progress | 進捗状況(BS項目) | string | 進捗マスタの選択肢名。マスタの選択肢取得方法 | |
| 10 | businessplans.businessplan.relational_milestone | 紐づき案件シナリオ | array(number) | ||
| 11 | businessplans.businessplan.relational_business_card_info | 案件コンタクト先 | array(object) | ||
| - businessplans.businessplan.relational_business_card_info @business_cards.business_card_info.id | 案件コンタクト先ID | number | 新規登録の場合はnull、更新の場合は値指定 | ||
| - businessplans.businessplan.relational_business_card_info @business_cards.business_card_info.contact_master | コンタクト先 | string | コンタクト先マスタの設定値 | ||
| - businessplans.businessplan.relational_business_card_info @business_cards.business_card_info.relational_businesscard | 紐づき名刺ID | number | テキスト名刺に値を設定する場合は、項目自体不要 | ||
| - businessplans.businessplan.relational_business_card_info @business_cards.business_card_info.remarks | 備考 | string | |||
| - businessplans.businessplan.relational_business_card_info @business_cards.business_card_info.text_business_card_name | テキスト名刺 | string | 紐づき名刺IDに値を設定する場合は、項目自体不要 | ||
| - businessplans.businessplan.relational_business_card_info @business_cards.business_card_info.position | 立ち位置 | string | 立ち位置マスタの選択肢名。マスタの選択肢取得方法 | ||
| - businessplans.businessplan.relational_business_card_info @business_cards.business_card_info.motivation | 意欲 | string | 意欲マスタの選択肢名。マスタの選択肢取得方法 | ||
| - businessplans.businessplan.relational_business_card_info @business_cards.business_card_info.counter | 窓口 | boolean | |||
| 12 | businessplans.businessplan.relational_trading_product | 紐づき商品情報 | array(number) | ||
| 13 | businessplans.businessplan.charge_employee @businessplans.charge_employee.main_charge | 主担当者ID | number | 社員IDを指定。 | |
| 14 | businessplans.businessplan.charge_employee @businessplans.charge_employee.target_employee @employees.employee.id | 自社担当者である社員ID | array(number) | 社員IDを指定。主担当者も含む。 | |
| 15 | businessplans.businessplan.charge_department @businessplans.charge_department.main_charge | 主担当部署ID | number | 部署IDを指定。 | |
| 16 | businessplans.businessplan.charge_department @businessplans.charge_department.target_department @employees.department.id | 自社担当部署である部署ID | array(number) | 部署IDを指定。主担当部署も含む。 | |
| 17 | businessplans.businessplan.charge_group @businessplans.charge_group.main_charge | 主担当グループID | number | グループIDを指定。 | |
| 18 | businessplans.businessplan.charge_group @businessplans.charge_group.target_group @employees.group.id | 自社担当グループであるグループID | array(number) | グループIDを指定。主担当グループも含む。 | |
| 19 | 拡張項目の項目名は、システムで設定するitem_idを設定する。item_idの確認方法 | 拡張項目 | any() | 拡張項目を追加する際、アイテムタイプ別定義のページを参照する |
Example
{
"businessplans.businessplan.businessplan_name": "一般対応",
"businessplans.businessplan.businessplan_name_other": "般対",
"businessplans.businessplan.business_type": "一般対応",
"businessplans.businessplan.relational_customer": 123,
"businessplans.businessplan.continue_or_terminate_flg": "継続",
"businessplans.businessplan.order_price": 99999,
"businessplans.businessplan.address": {
"street": "東京都中央区銀座6-18-2",
"country": "JPN",
"zipcode": "03-6779-98",
"building": "野村不動産銀座ビル 11階"
},
"businessplans.businessplan.memo": "メモ",
"businessplans.businessplan.progress": "提案",
"businessplans.businessplan.relational_milestone": [
123
],
"businessplans.businessplan.relational_business_card_info": [
{
"businessplans.businessplan.relational_business_card_info@business_cards.business_card_info.id": null,
"businessplans.businessplan.relational_business_card_info@business_cards.business_card_info.contact_master": "キーマン",
"businessplans.businessplan.relational_business_card_info@business_cards.business_card_info.remarks": "メモ",
"businessplans.businessplan.relational_business_card_info@business_cards.business_card_info.text_business_card_name": null,
"businessplans.businessplan.relational_business_card_info@business_cards.business_card_info.counter": true,
"businessplans.businessplan.relational_business_card_info@business_cards.business_card_info.position": "決裁者",
"businessplans.businessplan.relational_business_card_info@business_cards.business_card_info.motivation": "前向き",
"businessplans.businessplan.relational_business_card_info@business_cards.business_card_info.relational_businesscard": 123
}
],
"businessplans.businessplan.relational_trading_product": [
123
],
"businessplans.businessplan.charge_employee@businessplans.charge_employee.main_charge": 123,
"businessplans.businessplan.charge_employee@businessplans.charge_employee.target_employee@employees.employee.id": [
123,
456
],
"businessplans.businessplan.charge_department@businessplans.charge_department.main_charge": 123,
"businessplans.businessplan.charge_department@businessplans.charge_department.target_department@employees.department.id": [
123,
456
],
"businessplans.businessplan.charge_group@businessplans.charge_group.main_charge": 123,
"businessplans.businessplan.charge_group@businessplans.charge_group.target_group@employees.group.id": [
123,
456
]
}
案件更新
必要な権限
案件変更
Request
URL
https://gateway-esm.softbrain.com/sheet-fs/{tenant}/pub/esms/v1/sheet/businessplan/{id}
HTTP Method
PUT
Parameter
Path Parameter
| No. | パラメータ | 必須 | タイプ | デフォルト値 | 説明 |
|---|---|---|---|---|---|
| 1 | tenant | ○ | string | - | テナントID |
| 2 | id | ○ | string | - | 対象レコードID |
Request Body
| No. | プロパティ名 | 必須 | 項目名 | タイプ | 備考 |
|---|---|---|---|---|---|
| 1 | businessplans.businessplan.businessplan_name | 案件名 | string | ||
| 2 | businessplans.businessplan.businessplan_name_other | 案件名(呼称) | string | ||
| 3 | businessplans.businessplan.business_type | 業務タイプ | string | 業務タイプマスタの選択肢名。マスタの選択肢取得方法 | |
| 4 | businessplans.businessplan.relational_customer | 紐づき顧客 | number | ||
| 5 | businessplans.businessplan.continue_or_terminate_flg | 案件状態(継続/終了) | string | "継続", "終了"のいずれか | |
| 6 | businessplans.businessplan.order_price | 受注(予定)金額 | number | ||
| 7 | businessplans.businessplan.address | 住所 | object | ||
| - zipcode | 郵便番号 | string | |||
| - country | 国 | string | |||
| - street | 番地 | string | |||
| - building | 建物 | string | |||
| 8 | businessplans.businessplan.memo | 詳細内容 | string | ||
| 9 | businessplans.businessplan.progress | 進捗状況(BS項目) | string | 進捗マスタの選択肢名。マスタの選択肢取得方法 | |
| 10 | businessplans.businessplan.relational_milestone | 紐づき案件シナリオ | array(number) | ||
| 11 | businessplans.businessplan.relational_business_card_info | 案件コンタクト先 | array(object) | ||
| - businessplans.businessplan.relational_business_card_info @business_cards.business_card_info.id | 案件コンタクト先ID | number | |||
| - businessplans.businessplan.relational_business_card_info @business_cards.business_card_info.contact_master | コンタクト先 | string | コンタクト先マスタの選択肢名。マスタの選択肢取得方法 | ||
| - businessplans.businessplan.relational_business_card_info @business_cards.business_card_info.relational_businesscard | 紐づき名刺ID | number | テキスト名刺に値を設定する場合は、項目自体不要 | ||
| - businessplans.businessplan.relational_business_card_info @business_cards.business_card_info.valid_contact_date | 有効接触日 | string | "yyyy/mm/dd"形式の日付 | ||
| - businessplans.businessplan.relational_business_card_info @business_cards.business_card_info.remarks | 備考 | string | |||
| - businessplans.businessplan.relational_business_card_info @business_cards.business_card_info.text_business_card_name | テキスト名刺 | string | 紐づき名刺IDに値を設定する場合は、項目自体不要 | ||
| - businessplans.businessplan.relational_business_card_info @business_cards.business_card_info.position | 立ち位置 | string | 立ち位置マスタの選択肢名。マスタの選択肢取得方法 | ||
| - businessplans.businessplan.relational_business_card_info @business_cards.business_card_info.motivation | 意欲 | string | 意欲マスタの選択肢名。マスタの選択肢取得方法 | ||
| - businessplans.businessplan.relational_business_card_info @business_cards.business_card_info.counter | 窓口 | boolean | |||
| 12 | businessplans.businessplan.relational_trading_product | 紐づき商品情報 | array(number) | ||
| 13 | businessplans.businessplan.charge_employee @businessplans.charge_employee.main_charge | 主担当者ID | number | 社員IDを指定。 | |
| 14 | businessplans.businessplan.charge_employee @businessplans.charge_employee.target_employee @employees.employee.id | 自社担当者である社員ID | array(number) | 社員IDを指定。主担当者も含む。 | |
| 15 | businessplans.businessplan.charge_department @businessplans.charge_department.main_charge | 主担当部署ID | number | 部署IDを指定。 | |
| 16 | businessplans.businessplan.charge_department @businessplans.charge_department.target_department @employees.department.id | 自社担当部署である部署ID | array(number) | 部署IDを指定。主担当部署も含む。 | |
| 17 | businessplans.businessplan.charge_group @businessplans.charge_group.main_charge | 主担当グループID | number | グループIDを指定。 | |
| 18 | businessplans.businessplan.charge_group @businessplans.charge_group.target_group @employees.group.id | 自社担当グループであるグループID | array(number) | グループIDを指定。主担当グループも含む。 | |
| 19 | 拡張項目の項目名は、システムで設定するitem_idを設定する。item_idの確認方法 | 拡張項目 | any() | 拡張項目を追加する際、アイテムタイプ別定義のページを参照する |
Example
{
"businessplans.businessplan.businessplan_name": "一般対応",
"businessplans.businessplan.businessplan_name_other": "般対",
"businessplans.businessplan.business_type": "一般対応",
"businessplans.businessplan.relational_customer": [
123
],
"businessplans.businessplan.continue_or_terminate_flg": "継続",
"businessplans.businessplan.order_price": 99999,
"businessplans.businessplan.address": {
"street": "東京都中央区銀座6-18-2",
"country": "JPN",
"zipcode": "03-6779-98",
"building": "野村不動産銀座ビル 11階"
},
"businessplans.businessplan.memo": "メモ",
"businessplans.businessplan.progress": "提案",
"businessplans.businessplan.relational_milestone": [
123
],
"businessplans.businessplan.relational_business_card_info": [
{
"businessplans.businessplan.relational_business_card_info@business_cards.business_card_info.id": null,
"businessplans.businessplan.relational_business_card_info@business_cards.business_card_info.contact_master": "キーマン",
"businessplans.businessplan.relational_business_card_info@business_cards.business_card_info.remarks": "メモ",
"businessplans.businessplan.relational_business_card_info@business_cards.business_card_info.text_business_card_name": null,
"businessplans.businessplan.relational_business_card_info@business_cards.business_card_info.counter": true,
"businessplans.businessplan.relational_business_card_info@business_cards.business_card_info.position": "決裁者",
"businessplans.businessplan.relational_business_card_info@business_cards.business_card_info.motivation": "前向き",
"businessplans.businessplan.relational_business_card_info@business_cards.business_card_info.relational_businesscard": 123
}
],
"businessplans.businessplan.relational_trading_product": [
123
],
"businessplans.businessplan.charge_employee@businessplans.charge_employee.main_charge": 123,
"businessplans.businessplan.charge_employee@businessplans.charge_employee.target_employee@employees.employee.id": [
123,
456
],
"businessplans.businessplan.charge_department@businessplans.charge_department.main_charge": 123,
"businessplans.businessplan.charge_department@businessplans.charge_department.target_department@employees.department.id": [
123,
456
],
"businessplans.businessplan.charge_group@businessplans.charge_group.main_charge": 123,
"businessplans.businessplan.charge_group@businessplans.charge_group.target_group@employees.group.id": [
123,
456
]
}
案件削除
必要な権限
案件削除・案件一括削除
Request
URL
https://gateway-esm.softbrain.com/sheet-fs/{tenant}/pub/esms/v1/sheet/businessplan/{id}
HTTP Method
DELETE
Parameter
Path Parameter
| No. | パラメータ | 必須 | タイプ | デフォルト値 | 説明 |
|---|---|---|---|---|---|
| 1 | tenant | ○ | string | - | テナントID |
| 2 | id | ○ | string | - | 対象レコードID |
Response
Response Body
Response Bodyはこちらの共通仕様に則っています。
| No. | プロパティ名 | 項目名 | タイプ | 備考 |
|---|---|---|---|---|
| 1 | businessplans.businessplan.id | 案件ID | number | |
| 2 | businessplans.businessplan.businessplan_name | 案件名 | string | |
| 3 | businessplans.businessplan.businessplan_name_other | 案件名(呼称) | string | |
| 4 | businessplans.businessplan.business_type | 業務タイプ | string | 業務タイプマスタの値 |
| 5 | businessplans.businessplan.relational_customer | 紐づき顧客 | array(number) | |
| 6 | businessplans.businessplan.continue_or_terminate_flg | 案件状態(継続/終了) | string | "継続", "終了"のいずれか |
| 7 | businessplans.businessplan.order_price | 受注(予定)金額 | number | |
| 8 | businessplans.businessplan.address | 住所 | object | |
| - zipcode | 郵便番号 | string | ||
| - country | 国 | string | ||
| - street | 番地 | string | ||
| - building | 建物 | string | ||
| 9 | businessplans.businessplan.memo | 詳細内容 | string | |
| 10 | businessplans.businessplan.progress | 進捗状況(BS項目) | string | 進捗マスタの値 |
| 11 | businessplans.businessplan.relational_milestone | 紐づき案件シナリオ | array(number) | |
| 12 | businessplans.businessplan.relational_business_card_info | 案件コンタクト先 | array(object) | |
| - businessplans.businessplan.relational_business_card_info @business_cards.business_card_info.id | 案件コンタクト先ID | number | ||
| - businessplans.businessplan.relational_business_card_info @business_cards.business_card_info.contact_master | コンタクト先 | string | コンタクト先マスタの設定値 | |
| - businessplans.businessplan.relational_business_card_info @business_cards.business_card_info.relational_businesscard | 紐づき名刺ID | number | ||
| - businessplans.businessplan.relational_business_card_info @business_cards.business_card_info.valid_contact_date | 有効接触日 | string | "yyyy/mm/dd"形式の日付 | |
| - businessplans.businessplan.relational_business_card_info @business_cards.business_card_info.remarks | 備考 | string | ||
| - businessplans.businessplan.relational_business_card_info @business_cards.business_card_info.text_business_card_name | テキスト名刺 | string | ||
| - businessplans.businessplan.relational_business_card_info @business_cards.business_card_info.position | 立ち位置 | string | 立ち位置マスタの設定値 | |
| - businessplans.businessplan.relational_business_card_info @business_cards.business_card_info.motivation | 意欲 | string | 意欲マスタの設定値 | |
| - businessplans.businessplan.relational_business_card_info @business_cards.business_card_info.counter | 窓口 | boolean | ||
| 13 | businessplans.businessplan.relational_trading_product | 紐づき商品情報 | array(number) | |
| 14 | businessplans.businessplan.charge_employee @businessplans.charge_employee.main_charge | 主担当者ID | number | |
| 15 | businessplans.businessplan.charge_employee @businessplans.charge_employee.target_employee @employees.employee.id | 自社担当者である社員ID | array(number) | 主担当者はこちらにも含まれる。 |
| 16 | businessplans.businessplan.charge_department @businessplans.charge_department.main_charge | 主担当部署ID | number | |
| 17 | businessplans.businessplan.charge_department @businessplans.charge_department.target_department @employees.department.id | 自社担当部署である部署ID | array(number) | 主担当部署はこちらにも含まれる。 |
| 18 | businessplans.businessplan.charge_group @businessplans.charge_group.main_charge | 主担当グループID | number | |
| 19 | businessplans.businessplan.charge_group @businessplans.charge_group.target_group @employees.group.id | 自社担当グループであるグループID | array(number) | 主担当グループはこちらにも含まれる。 |
| 20 | system_reg_date | 登録日 | string | "yyyy/mm/dd hh:MM"形式 ※取得のみ |
| 21 | system_reg_user | 登録ユーザ | number | 登録者ユーザID ※取得のみ |
| 22 | system_reg_employee | 登録社員 | number | 登録社員ID ※取得のみ |
| 23 | system_upd_date | 更新日 | string | "yyyy/mm/dd hh:MM"形式 ※取得のみ |
| 24 | system_upd_user | 最終更新ユーザ | number | 最終更新者ユーザID ※取得のみ |
| 25 | system_upd_employee | 最終更新社員 | number | 最終更新者社員ID ※取得のみ |
| 26 | 拡張項目の項目名は、システムで設定するitem_idを設定する。item_idの確認方法 | 拡張項目 | any() | 拡張項目を追加する際、アイテムタイプ別定義のページを参照する |
Example
{
"businessplans.businessplan.id": 123,
"businessplans.businessplan.businessplan_name": "一般対応",
"businessplans.businessplan.businessplan_name_other": "般対",
"businessplans.businessplan.business_type": "一般対応",
"businessplans.businessplan.relational_customer": [
123
],
"businessplans.businessplan.continue_or_terminate_flg": "継続",
"businessplans.businessplan.order_price": 99999,
"businessplans.businessplan.address": {
"street": "東京都中央区銀座6-18-2",
"country": "JPN",
"zipcode": "03-6779-98",
"building": "野村不動産銀座ビル 11階"
},
"businessplans.businessplan.memo": "メモ",
"businessplans.businessplan.progress": "提案",
"businessplans.businessplan.relational_milestone": [
123
],
"businessplans.businessplan.relational_business_card_info": [
{
"businessplans.businessplan.relational_business_card_info@business_cards.business_card_info.id": null,
"businessplans.businessplan.relational_business_card_info@business_cards.business_card_info.contact_master": "キーマン",
"businessplans.businessplan.relational_business_card_info@business_cards.business_card_info.remarks": "メモ",
"businessplans.businessplan.relational_business_card_info@business_cards.business_card_info.text_business_card_name": null,
"businessplans.businessplan.relational_business_card_info@business_cards.business_card_info.counter": true,
"businessplans.businessplan.relational_business_card_info@business_cards.business_card_info.position": "決裁者",
"businessplans.businessplan.relational_business_card_info@business_cards.business_card_info.motivation": "前向き",
"business_cards.business_card_info.relational_businesscard": 123
}
],
"businessplans.businessplan.relational_trading_product": [
123
],
"businessplans.businessplan.charge_employee@businessplans.charge_employee.main_charge": 123,
"businessplans.businessplan.charge_employee@businessplans.charge_employee.target_employee@employees.employee.id": [
123,
456
],
"businessplans.businessplan.charge_department@businessplans.charge_department.main_charge": 123,
"businessplans.businessplan.charge_department@businessplans.charge_department.target_department@employees.department.id": [
123,
456
],
"businessplans.businessplan.charge_group@businessplans.charge_group.main_charge": 123,
"businessplans.businessplan.charge_group@businessplans.charge_group.target_group@employees.group.id": [
123,
456
],
"system_reg_date": "2024/01/01 00:00",
"system_reg_user": 123,
"system_reg_employee": 456,
"system_upd_date": "2024/01/02 00:00",
"system_upd_user": 123,
"system_upd_employee": 456
}