社員(employee)

社員に関する情報の登録・更新・取得ができます。

レコードのidの取得にはSearch APIが使用できます。

社員取得

必要な権限

社員参照

Request

URL

https://gateway-esm.softbrain.com/sheet-fs/{tenant}/pub/esms/v1/sheet/employee/{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/employee

HTTP Method

POST

Parameter

Path Parameter

No.	パラメータ	必須	タイプ	デフォルト値	説明
1	tenant	○	string	-	テナントID

Request Body

No.	プロパティ名	必須	項目名	タイプ	備考
1	employees.employee.administrator_authority		管理者権限	string	"あり"もしくは"なし
2	employees.employee.employee_name		社員氏名	string
3	employees.employee.name_kana		社員氏名(かな)	string
4	employees.employee.email		メールアドレス(PC)	string
5	employees.employee.position_master		役職名	string	役職マスタの選択肢名。マスタの選択肢取得方法
6	employees.employee.memo		メモ	string
7	employees.employee.address		住所	object
	- zipcode		郵便番号	string
	- country		国	string
	- street		番地	string
	- building		建物	string
8	employees.employee.tel_no		電話番号	string
9	employees.employee.relational_department	所属する部署ID	number
10	employees.employee.relational_my_group		所属するマイグループID	array(number)
11	employees.employee.relational_common_group		所属する共通グループID	array(number)
12	employees.employee.mobile_tel_no		電話番号	string
13	employees.employee.relational_manager		マネージャーの社員ID	number
14	employees.employee.employee_icon		写真	object
	- fileid		ファイルID	string	事前にcmsにアップロードしたfileIdを指定
15	employees.employee.charge_work @employees.charge_work.charge_work		担当業務タイプ	array(string)	業務タイプマスタの選択肢名。マスタの選択肢取得方法
16	employees.employee.charge_work @employees.charge_work.main_charge_work		主担当業務タイプ	string	業務タイプマスタの選択肢名。マスタの選択肢取得方法
17	employees.employee.license	ライセンス	array(string)	ライセンス名
18	拡張項目の項目名は、システムで設定するitem_idを設定する。item_idの確認方法		拡張項目	any()	拡張項目を追加する際、アイテムタイプ別定義のページを参照する

Example

  {
  "employees.employee.administrator_authority": "あり",
  "employees.employee.employee_name": "営業 太郎",
  "employees.employee.name_kana": "えいぎょう たろう",
  "employees.employee.email": "eigyo@eigyo.co.jp",
  "employees.employee.position_master": "部長",
  "employees.employee.memo": null,
  "employees.employee.address": {
    "street": "東京都中央区銀座6-18-2",
    "country": "JPN",
    "zipcode": "03-6779-98",
    "building": "野村不動産銀座ビル 11階"
  },
  "employees.employee.tel_no": "000-1111-2222",
  "employees.employee.mobile_tel_no": "000-1111-2222",
  "employees.employee.relational_manager": 123,
  "employees.employee.employee_icon": {
    "fileid": "6b1be1e8c8c14cf9a7b84948a70b1861"
  },
  "employees.employee.charge_work@employees.charge_work.charge_work": [
    "新規営業",
    "既存営業"
  ],
  "employees.employee.charge_work@employees.charge_work.main_charge_work": "新規営業",
  "employees.employee.license": [
    "Enterprise",
    "AIコンシェルジュ"
  ],
  "employees.employee.relational_department": 100000001,
  "employees.employee.relational_my_group": [
    100000001
  ],
  "employees.employee.relational_common_group": [
    100000001
  ]
}

社員更新

必要な権限

社員変更

Request

URL

https://gateway-esm.softbrain.com/sheet-fs/{tenant}/pub/esms/v1/sheet/employee/{id}

HTTP Method

PUT

Parameter

Path Parameter

No.	パラメータ	必須	タイプ	デフォルト値	説明
1	tenant	○	string	-	テナントID
2	id	○	string	-	対象レコードID

Request Body

No.	プロパティ名	必須	項目名	タイプ	備考
1	employees.employee.administrator_authority		管理者権限	string	"あり"もしくは"なし
2	employees.employee.employee_name		社員氏名	string
3	employees.employee.name_kana		社員氏名(かな)	string
4	employees.employee.email		メールアドレス(PC)	string	"まだ登録されていないメールアドレスを指定"
5	employees.employee.position_master		役職名	string	役職マスタの選択肢名。マスタの選択肢取得方法
6	employees.employee.memo		メモ	string
7	employees.employee.address		住所	object
	- zipcode		郵便番号	string
	- country		国	string
	- street		番地	string
	- building		建物	string
8	employees.employee.tel_no		電話番号	string
9	employees.employee.relational_department	所属する部署ID	number
10	employees.employee.relational_my_group		所属するマイグループID	array(number)
11	employees.employee.relational_common_group		所属する共通グループID	array(number)
12	employees.employee.mobile_tel_no		業務タイプ	string	携帯番号
13	employees.employee.relational_manager		マネージャーの社員ID	number
14	employees.employee.employee_icon		写真	object
	- fileid		ファイルID	string	事前にcmsにアップロードしたfileIdを指定
15	employees.employee.charge_work @employees.charge_work.charge_work		担当業務タイプ	array(string)	業務タイプマスタの選択肢名。マスタの選択肢取得方法
16	employees.employee.charge_work @employees.charge_work.main_charge_work		主担当業務タイプ	string	業務タイプマスタの選択肢名。マスタの選択肢取得方法
17	employees.employee.license	ライセンス	array(string)	ライセンス名
18	拡張項目の項目名は、システムで設定するitem_idを設定する。item_idの確認方法		拡張項目	any()	拡張項目を追加する際、アイテムタイプ別定義のページを参照する

Example

  {
  "employees.employee.administrator_authority": "あり",
  "employees.employee.employee_name": "営業 太郎",
  "employees.employee.name_kana": "えいぎょう たろう",
  "employees.employee.email": "eigyo@eigyo.co.jp",
  "employees.employee.position_master": "部長",
  "employees.employee.memo": null,
  "employees.employee.address": {
    "street": "東京都中央区銀座6-18-2",
    "country": "JPN",
    "zipcode": "03-6779-98",
    "building": "野村不動産銀座ビル 11階"
  },
  "employees.employee.tel_no": "000-1111-2222",
  "employees.employee.mobile_tel_no": "000-1111-2222",
  "employees.employee.relational_manager": 123,
  "employees.employee.employee_icon": {
    "fileid": "6b1be1e8c8c14cf9a7b84948a70b1861"
  },
  "employees.employee.charge_work@employees.charge_work.charge_work": [
    "新規営業",
    "既存営業"
  ],
  "employees.employee.charge_work@employees.charge_work.main_charge_work": "新規営業",
  "employees.employee.license": [
    "Enterprise",
    "AIコンシェルジュ"
  ],
  "employees.employee.relational_department": 100000001,
  "employees.employee.relational_my_group": [
    100000001
  ],
  "employees.employee.relational_common_group": [
    100000001
  ]
}

社員の退職

社員に関しては削除できないため、所属部署を退職部署に変更します。

必要な権限

社員変更

Request

URL

https://gateway-esm.softbrain.com/sheet-fs/{tenant}/pub/esms/v1/sheet/employee/{id}

HTTP Method

PUT

Parameter

Path Parameter

No.	パラメータ	必須	タイプ	デフォルト値	説明
1	tenant	○	string	-	テナントID
2	id	○	string	-	対象レコードID

Request Body

No.	プロパティ名	必須	項目名	タイプ	備考
1	employees.employee.relational_department		所属部署	number	退職部署は[-99]

{
  "employees.employee.relational_department": -99
}

Response

Response Body

Response Bodyはこちらの共通仕様に則っています。

No.	プロパティ名	項目名	タイプ	備考
1	employees.employee.administrator_authority	管理者権限	string	"あり"もしくは"なし
2	employees.employee.id	社員ID	number
3	employees.employee.employee_name	社員氏名	string
4	employees.employee.name_kana	社員氏名(かな)	string
5	employees.employee.email	メールアドレス(PC)	string
6	employees.employee.position_master	役職名	string	役職マスタの値
7	employees.employee.memo	メモ	string
8	employees.employee.address	住所	object
	- zipcode	郵便番号	string
	- country	国	string
	- street	番地	string
	- building	建物	string
9	employees.employee.tel_no	電話番号	string
10	employees.employee.relational_department	所属する部署ID	number
11	employees.employee.relational_my_group	所属するマイグループID	array(number)
12	employees.employee.relational_common_group	所属する共通グループID	array(number)
13	employees.employee.mobile_tel_no	業務タイプ	string	携帯番号
14	employees.employee.relational_manager	マネージャーの社員ID	number
15	employees.employee.employee_icon	写真	object
	- fileid	ファイルID	string	取得したfileIdを使って、cmsからファイルのダウンロード可能
	- filename	ファイル名	string
16	employees.employee.charge_work @employees.charge_work.charge_work	担当業務タイプ	array(string)	業務タイプマスタの値
17	employees.employee.charge_work @employees.charge_work.main_charge_work	主担当業務タイプ	string	業務タイプマスタの値
18	employees.employee.license	ライセンス	array(number)
19	employees.employee.import_email	メール取り込み用アドレス
20	拡張項目の項目名は、システムで設定するitem_idを設定する。item_idの確認方法	拡張項目	any()	拡張項目を追加する際、アイテムタイプ別定義のページを参照する

Example

  {
  "employees.employee.administrator_authority": "あり",
  "employees.employee.employee_name": "営業 太郎",
  "employees.employee.name_kana": "えいぎょう たろう",
  "employees.employee.email": "eigyo@eigyo.co.jp",
  "employees.employee.position_master": "部長",
  "employees.employee.memo": null,
  "employees.employee.address": {
    "street": "東京都中央区銀座6-18-2",
    "country": "JPN",
    "zipcode": "03-6779-98",
    "building": "野村不動産銀座ビル 11階"
  },
  "employees.employee.tel_no": "000-1111-2222",
  "employees.employee.mobile_tel_no": "000-1111-2222",
  "employees.employee.relational_manager": 123,
  "employees.employee.employee_icon": {
    "fileid": "6b1be1e8c8c14cf9a7b84948a70b1861",
    "filename": "file.jpg"
  },
  "employees.employee.charge_work@employees.charge_work.charge_work": [
    "新規営業",
    "既存営業"
  ],
  "employees.employee.charge_work@employees.charge_work.main_charge_work": "新規営業",
  "employees.employee.license": [
    "Enterprise",
    "AIコンシェルジュ"
  ],
  "employees.employee.import_email": "import@email.com",
  "employees.employee.relational_department": 100000001,
  "employees.employee.relational_my_group": [
    100000001
  ],
  "employees.employee.relational_common_group": [
    100000001
  ]
}