名刺(businesscard)
名刺に関する情報の登録・更新・取得・削除ができます。
レコードのidの取得にはSearch APIが使用できます。
名刺取得
必要な権限
名刺参照
Request
URL
https://gateway-esm.softbrain.com/sheet-fs/{tenant}/pub/esms/v1/sheet/businesscard/{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/businesscard
HTTP Method
POST
Parameter
Path Parameter
| No. | パラメータ | 必須 | タイプ | デフォルト値 | 説明 |
|---|---|---|---|---|---|
| 1 | tenant | ○ | string | - | テナントID |
Request Body
| No. | プロパティ名 | 必須 | 項目名 | タイプ | 備考 |
|---|---|---|---|---|---|
| 1 | business_cards.business_card.relational_customer | 紐づき顧客 | number | ||
| 2 | business_cards.business_card.business_card_full_name | 名刺氏名 | string | ||
| 3 | business_cards.business_card.business_card_full_name_kana | 名刺氏名(かな) | string | ||
| 4 | business_cards.business_card.department_name | 部署名 | string | ||
| 5 | business_cards.business_card.position_name | 役職名 | string | ||
| 6 | business_cards.business_card.address | 住所 | object | ||
| - zipcode | 郵便番号 | string | |||
| - country | 国 | string | |||
| - street | 番地 | string | |||
| - building | 建物 | string | |||
| 7 | business_cards.business_card.tel_no | 電話番号 | string | ||
| 8 | business_cards.business_card.mobile_tel_no | 携帯番号 | string | ||
| 9 | business_cards.business_card.mobile_email | 携帯mail | string | ||
| 10 | business_cards.business_card.email | string | |||
| 11 | business_cards.business_card.url | URL | string | ||
| 12 | business_cards.business_card.memo | メモ | string | ||
| 13 | business_cards.business_card.is_enrolled | 在職フラグ | string | "在職中"、"退職"のいずれか | |
| 14 | business_cards.business_card.businesscard_image | 名刺画像 | object | ||
| - fileid | ファイルID | string | 事前にcmsにアップロードしたfileIdを指定 | ||
| 15 | business_cards.business_card.receiver | 受取人 | array(object) | ||
| - business_cards.business_card.receiver @business_cards.receiver.id | 受取人ID | number | |||
| - business_cards.business_card.receiver @business_cards.receiver.received_date | 受取日 | string | |||
| - business_cards.business_card.receiver @business_cards.receiver.receiver_target_employee @employees.employee.id | 受取人である社員のID | number | |||
| 16 | business_cards.business_card.introduction_source | 紹介元 | array(object) | ||
| - business_cards.business_card.introduction_source @business_cards.introduction_source.id | 紹介元ID | number | |||
| - business_cards.business_card.introduction_source @business_cards.introduction_source.introduction_date | 紹介日 | string | |||
| - business_cards.business_card.introduction_source @business_cards.introduction_source.source_business_card_id | 紹介元である名刺ID | number | |||
| 17 | 拡張項目の項目名は、システムで設定するitem_idを設定する。item_idの確認方法 | 拡張項目 | any() | 拡張項目を追加する際、アイテムタイプ別定義のページを参照する |
Example
{
"business_cards.business_card.relational_customer": 123,
"business_cards.business_card.business_card_full_name": "営業太郎",
"business_cards.business_card.business_card_full_name_kana": "えいぎょうたろう",
"business_cards.business_card.department_name": "営業一部",
"business_cards.business_card.position_name": "係長",
"business_cards.business_card.address": {
"street": "東京都中央区銀座6-18-2",
"country": "JPN",
"zipcode": "03-6779-98",
"building": "野村不動産銀座ビル 11階"
},
"business_cards.business_card.tel_no": "77-7777-7777",
"business_cards.business_card.mobile_tel_no": "555-5555-5555",
"business_cards.business_card.mobile_email": "eigyo.taro.mobile@customer.com",
"business_cards.business_card.email": "eigyo.taro@customer.com",
"business_cards.business_card.url": "https://www.google.com",
"business_cards.business_card.note": "メモ",
"business_cards.business_card.is_enrolled": "在職中",
"business_cards.business_card.businesscard_image": {
"fileid": "cd234bbefe27496fa67be84bbd403de8"
},
"business_cards.business_card.receiver": [
{
"business_cards.business_card.receiver@business_cards.receiver.id": 517,
"business_cards.business_card.receiver@business_cards.receiver.received_date": "2024/10/10",
"business_cards.business_card.receiver@business_cards.receiver.receiver_target_employee@employees.employee.id": 123
}
],
"business_cards.business_card.introduction_source": [
{
"business_cards.business_card.introduction_source@business_cards.introduction_source.id": 516,
"business_cards.business_card.introduction_source@business_cards.introduction_source.source_business_card_id": 46,
"business_cards.business_card.introduction_source@business_cards.introduction_source.introduction_date": "2024/10/10"
}
]
}
名刺更新
必要な権限
名刺変更
Request
URL
https://gateway-esm.softbrain.com/sheet-fs/{tenant}/pub/esms/v1/sheet/businesscard/{id}
HTTP Method
PUT
Parameter
Path Parameter
| No. | パラメータ | 必須 | タイプ | デフォルト値 | 説明 |
|---|---|---|---|---|---|
| 1 | tenant | ○ | string | - | テナントID |
| 2 | id | ○ | string | - | 対象レコードID |
Request Body
| No. | プロパティ名 | 必須 | 項目名 | タイプ | 備考 |
|---|---|---|---|---|---|
| 1 | business_cards.business_card.relational_customer | 紐づき顧客 | number | ||
| 2 | business_cards.business_card.business_card_full_name | 名刺氏名 | string | ||
| 3 | business_cards.business_card.business_card_full_name_kana | 名刺氏名(かな) | string | ||
| 4 | business_cards.business_card.department_name | 部署名 | string | ||
| 5 | business_cards.business_card.position_name | 役職名 | string | ||
| 6 | business_cards.business_card.address | 住所 | object | ||
| - zipcode | 郵便番号 | string | |||
| - country | 国 | string | |||
| - street | 番地 | string | |||
| - building | 建物 | string | |||
| 7 | business_cards.business_card.tel_no | 電話番号 | string | ||
| 8 | business_cards.business_card.mobile_tel_no | 携帯番号 | string | ||
| 9 | business_cards.business_card.mobile_email | 携帯mail | string | ||
| 10 | business_cards.business_card.email | string | |||
| 11 | business_cards.business_card.url | URL | string | ||
| 12 | business_cards.business_card.memo | メモ | string | ||
| 13 | business_cards.business_card.is_enrolled | 在職フラグ | string | "在職中"、"退職"のいずれか | |
| 14 | business_cards.business_card.businesscard_image | 名刺画像 | object | ||
| - fileid | ファイルID | string | 事前にcmsにアップロードしたfileIdを指定 | ||
| 15 | business_cards.business_card.receiver | 受取人 | array(object) | ||
| - business_cards.business_card.receiver @business_cards.receiver.id | 受取人ID | number | 新規登録の場合はnull、更新の場合は値指定 | ||
| - business_cards.business_card.receiver @business_cards.receiver.received_date | 受取日 | string | |||
| - business_cards.business_card.receiver @business_cards.receiver.receiver_target_employee @employees.employee.id | 受取人である社員のID | number | |||
| 16 | business_cards.business_card.introduction_source | 紹介元 | array(object) | ||
| - business_cards.business_card.introduction_source @business_cards.introduction_source.id | 紹介元ID | number | 新規登録の場合はnull、更新の場合は値指定 | ||
| - business_cards.business_card.introduction_source @business_cards.introduction_source.introduction_date | 紹介日 | string | |||
| - business_cards.business_card.introduction_source @business_cards.introduction_source.source_business_card_id | 紹介元である名刺ID | number | |||
| 17 | 拡張項目の項目名は、システムで設定するitem_idを設定する。item_idの確認方法 | 拡張項目 | any() | 拡張項目を追加する際、アイテムタイプ別定義のページを参照する |
Example
{
"business_cards.business_card.relational_customer": 123,
"business_cards.business_card.business_card_full_name": "営業太郎",
"business_cards.business_card.business_card_full_name_kana": "えいぎょうたろう",
"business_cards.business_card.department_name": "営業一部",
"business_cards.business_card.position_name": "係長",
"business_cards.business_card.address": {
"street": "東京都中央区銀座6-18-2",
"country": "JPN",
"zipcode": "03-6779-98",
"building": "野村不動産銀座ビル 11階"
},
"business_cards.business_card.tel_no": "77-7777-7777",
"business_cards.business_card.mobile_tel_no": "555-5555-5555",
"business_cards.business_card.mobile_email": "eigyo.taro.mobile@customer.com",
"business_cards.business_card.email": "eigyo.taro@customer.com",
"business_cards.business_card.url": "https://www.google.com",
"business_cards.business_card.note": "メモ",
"business_cards.business_card.is_enrolled": "在職中",
"business_cards.business_card.businesscard_image": {
"fileid": "cd234bbefe27496fa67be84bbd403de8"
},
"business_cards.business_card.receiver": [
{
"business_cards.business_card.receiver@business_cards.receiver.id": 517,
"business_cards.business_card.receiver@business_cards.receiver.received_date": "2024/10/10",
"business_cards.business_card.receiver@business_cards.receiver.receiver_target_employee@employees.employee.id": 123
}
],
"business_cards.business_card.introduction_source": [
{
"business_cards.business_card.introduction_source@business_cards.introduction_source.id": 516,
"business_cards.business_card.introduction_source@business_cards.introduction_source.source_business_card_id": 46,
"business_cards.business_card.introduction_source@business_cards.introduction_source.introduction_date": "2024/10/10"
}
]
}
名刺削除
必要な権限
名刺削除・名刺一括削除
Request
URL
https://gateway-esm.softbrain.com/sheet-fs/{tenant}/pub/esms/v1/sheet/businesscard/{id}
HTTP Method
DELETE
Parameter
Path Parameter
| No. | パラメータ | 必須 | タイプ | デフォルト値 | 説明 |
|---|---|---|---|---|---|
| 1 | tenant | ○ | string | - | テナントID |
| 2 | id | ○ | string | - | 対象レコードID |
Response
Response Body
Response Bodyはこちらの共通仕様に則っています。
| No. | プロパティ名 | 項目名 | タイプ | 備考 |
|---|---|---|---|---|
| 1 | business_cards.business_card.id | 名刺ID | number | |
| 2 | business_cards.business_card.relational_customer | 紐づき顧客 | number | |
| 3 | business_cards.business_card.business_card_full_name | 名刺氏名 | string | |
| 4 | business_cards.business_card.business_card_full_name_kana | 名刺氏名(かな) | string | |
| 5 | business_cards.business_card.department_name | 部署名 | string | |
| 6 | business_cards.business_card.position_name | 役職名 | string | |
| 7 | business_cards.business_card.address | 住所 | object | |
| - zipcode | 郵便番号 | string | ||
| - country | 国 | string | ||
| - street | 番地 | string | ||
| - building | 建物 | string | ||
| 8 | business_cards.business_card.tel_no | 電話番号 | string | |
| 9 | business_cards.business_card.mobile_tel_no | 携帯番号 | string | |
| 10 | business_cards.business_card.mobile_email | 携帯mail | string | |
| 11 | business_cards.business_card.email | string | ||
| 12 | business_cards.business_card.url | URL | string | |
| 13 | business_cards.business_card.memo | メモ | string | |
| 14 | business_cards.business_card.is_enrolled | 在職フラグ | string | "在職中"、"退職"のいずれか |
| 15 | business_cards.business_card.businesscard_image | 名刺画像 | object | |
| - fileid | ファイルID | string | 取得したfileIdを使って、cmsからファイルをダウンロード可能 | |
| - filename | ファイル名 | string | ||
| 16 | business_cards.business_card.receiver | 受取人 | array(object) | |
| - business_cards.business_card.receiver @business_cards.receiver.id | 受取人ID | number | 新規登録の場合はnull、更新の場合は値指定 | |
| - business_cards.business_card.receiver @business_cards.receiver.received_date | 受取日 | string | ||
| - business_cards.business_card.receiver @business_cards.receiver.receiver_target_employee @employees.employee.id | 受取人である社員のID | number | ||
| 17 | business_cards.business_card.introduction_source | 紹介元 | array(object) | |
| - business_cards.business_card.introduction_source @business_cards.introduction_source.id | 紹介元ID | number | 新規登録の場合はnull、更新の場合は値指定 | |
| - business_cards.business_card.introduction_source @business_cards.introduction_source.introduction_date | 紹介日 | string | ||
| - business_cards.business_card.introduction_source @business_cards.introduction_source.source_business_card_id | 紹介元である名刺ID | number | ||
| 18 | system_reg_date | 登録日 | string | "yyyy/mm/dd hh:MM"形式 ※取得のみ |
| 19 | system_reg_user | 登録ユーザ | number | 登録者ユーザID ※取得のみ |
| 20 | system_reg_employee | 登録社員 | number | 登録社員ID ※取得のみ ※取得のみ |
| 21 | system_upd_date | 更新日 | string | "yyyy/mm/dd hh:MM"形式 ※取得のみ |
| 22 | system_upd_user | 最終更新ユーザ | number | 最終更新者ユーザID ※取得のみ |
| 23 | system_upd_employee | 最終更新社員 | number | 最終更新者社員ID ※取得のみ |
| 24 | 拡張項目の項目名は、システムで設定するitem_idを設定する。item_idの確認方法 | 拡張項目 | any() | 拡張項目を追加する際、アイテムタイプ別定義のページを参照する |
Example
{
"business_cards.business_card.relational_customer": 123,
"business_cards.business_card.business_card_full_name": "営業太郎",
"business_cards.business_card.business_card_full_name_kana": "えいぎょうたろう",
"business_cards.business_card.department_name": "営業一部",
"business_cards.business_card.position_name": "係長",
"business_cards.business_card.address": {
"street": "東京都中央区銀座6-18-2",
"country": "JPN",
"zipcode": "03-6779-98",
"building": "野村不動産銀座ビル 11階"
},
"business_cards.business_card.tel_no": "77-7777-7777",
"business_cards.business_card.mobile_tel_no": "555-5555-5555",
"business_cards.business_card.mobile_email": "eigyo.taro.mobile@customer.com",
"business_cards.business_card.email": "eigyo.taro@customer.com",
"business_cards.business_card.url": "https://www.google.com",
"business_cards.business_card.note": "メモ",
"business_cards.business_card.is_enrolled": "在職中",
"business_cards.business_card.businesscard_image": {
"fileid": "cd234bbefe27496fa67be84bbd403de8",
"filename": "file.jpg"
},
"business_cards.business_card.receiver": [
{
"business_cards.business_card.receiver@business_cards.receiver.id": 517,
"business_cards.business_card.receiver@business_cards.receiver.received_date": "2024/10/10",
"business_cards.business_card.receiver@business_cards.receiver.receiver_target_employee@employees.employee.id": 123
}
],
"business_cards.business_card.introduction_source": [
{
"business_cards.business_card.introduction_source@business_cards.introduction_source.id": 516,
"business_cards.business_card.introduction_source@business_cards.introduction_source.source_business_card_id": 46,
"business_cards.business_card.introduction_source@business_cards.introduction_source.introduction_date": "2024/10/10"
}
],
"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
}