部署(department)
部署に関する情報の登録・更新・取得・削除ができます。
レコードのidの取得にはSearch APIが使用できます。
部署取得
必要な権限
部署参照
Request
URL
https://gateway-esm.softbrain.com/sheet-fs/{tenant}/pub/esms/v1/sheet/department/{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/deparment
HTTP Method
POST
Parameter
Path Parameter
| No. | パラメータ | 必須 | タイプ | デフォルト値 | 説明 |
|---|---|---|---|---|---|
| 1 | tenant | ○ | string | - | テナントID |
Request Body
| No. | プロパティ名 | 必須 | 項目名 | タイプ | 備考 |
|---|---|---|---|---|---|
| 1 | employees.department.is_not_use | 使用可否 | boolean | ||
| 2 | employees.department.department_name | 部署名 | string | ||
| 3 | employees.department.charge_work @employees.charge_work.main_charge_work | 主担当業務 | string | 業務タイプマスタの選択肢名。マスタの選択肢取得方法 | |
| 4 | employees.department.charge_work @employees.charge_work.charge_work | 担当業務タイプ | array(string) | 業務タイプマスタの選択肢名。マスタの選択肢取得方法 | |
| 5 | employees.department.relational_employee | 紐づき社員 | array(number) | ||
| 6 | employees.department.relational_parent_department | 所属部署 | number | ||
| 7 | employees.department.relational_manager | マネージャー | number | ||
| 8 | employees.department.relational_my_group | 所属するマイグループID | array(number) | ||
| 9 | employees.department.relational_common_group | 所属する共通グループID | array(number) | ||
| 10 | employees.department.department_number | 部署番号 | string |
Example
{
"employees.department.is_not_use": false,
"employees.department.department_name": "営業部",
"employees.department.charge_work@employees.charge_work.charge_work": [
"新規営業",
"既存営業"
],
"employees.department.charge_work@employees.charge_work.main_charge_work": "新規営業",
"employees.department.relational_employee": [
123
],
"employees.department.relational_parent_department": 456,
"employees.department.relational_manager": 123,
"employees.department.department_number": "1"
}
部署更新
必要な権限
部署変更
Request
URL
https://gateway-esm.softbrain.com/sheet-fs/{tenant}/pub/esms/v1/sheet/department/{id}
HTTP Method
PUT
Parameter
Path Parameter
| No. | パラメータ | 必須 | タイプ | デフォルト値 | 説明 |
|---|---|---|---|---|---|
| 1 | tenant | ○ | string | - | テナントID |
| 2 | id | ○ | string | - | 対象レコードID |
Request Body
| No. | プロパティ名 | 必須 | 項目名 | タイプ | 備考 |
|---|---|---|---|---|---|
| 1 | employees.department.is_not_use | 使用可否 | boolean | ||
| 2 | employees.department.department_name | 部署名 | string | ||
| 3 | employees.department.charge_work @employees.charge_work.main_charge_work | 主担当業務 | string | 業務タイプマスタの選択肢名。マスタの選択肢取得方法 | |
| 4 | employees.department.charge_work @employees.charge_work.charge_work | 担当業務タイプ | array(string) | 業務タイプマスタの選択肢名。マスタの選択肢取得方法 | |
| 5 | employees.department.relational_employee | 紐づき社員 | array(number) | ||
| 6 | employees.department.relational_parent_department | 所属部署 | number | ||
| 7 | employees.department.relational_manager | マネージャー | number | ||
| 8 | employees.department.relational_my_group | 所属するマイグループID | array(number) | ||
| 9 | employees.department.relational_common_group | 所属する共通グループID | array(number) | ||
| 10 | employees.department.department_number | 部署番号 | string |
Example
{
"employees.department.is_not_use": false,
"employees.department.department_name": "営業部",
"employees.employee.charge_work@employees.charge_work.charge_work": [
"新規営業",
"既存営業"
],
"employees.employee.charge_work@employees.charge_work.main_charge_work": "新規営業",
"employees.department.relational_employee": [
123
],
"employees.department.relational_parent_department": 456,
"employees.department.relational_manager": 123,
"employees.department.department_number": "1"
}
部署削除
必要な権限
部署削除・部署一括削除
Request
URL
https://gateway-esm.softbrain.com/sheet-fs/{tenant}/pub/esms/v1/sheet/department/{id}
HTTP Method
DELETE
Parameter
Path Parameter
| No. | パラメータ | 必須 | タイプ | デフォルト値 | 説明 |
|---|---|---|---|---|---|
| 1 | tenant | ○ | string | - | テナントID |
| 2 | id | ○ | string | - | 対象レコードID |
Response
Response Body
Response Bodyはこちらの共通仕様に則っています。
| No. | プロパティ名 | 項目名 | タイプ | 備考 |
|---|---|---|---|---|
| 1 | employees.department.id | 部署ID | number | |
| 2 | employees.department.is_not_use | 使用可否 | boolean | |
| 3 | employees.department.department_name | 部署名 | string | |
| 4 | employees.department.charge_work @employees.charge_work.main_charge_work | 主担当業務 | string | 業務タイプマスタの設定値 |
| 5 | employees.department.charge_work @employees.charge_work.charge_work | 担当業務タイプ | array(string) | 業務タイプマスタの設定値 |
| 6 | employees.department.relational_employee | 紐づき社員 | array(number) | |
| 7 | employees.department.relational_parent_department | 所属部署 | number | |
| 8 | employees.department.relational_manager | マネージャー | number | |
| 9 | employees.department.relational_my_group | 所属するマイグループID | array(number) | |
| 10 | employees.department.relational_common_group | 所属する共通グループID | array(number) | |
| 11 | employees.department.department_number | 部署番号 | string | |
| 12 | system_reg_date | 登録日 | string | "yyyy/mm/dd hh:MM"形式 ※取得のみ |
| 13 | system_reg_user | 登録ユーザ | number | 登録者ユーザID ※取得のみ |
| 14 | system_reg_employee | 登録社員 | number | 登録社員ID ※取得のみ |
| 15 | system_upd_date | 更新日 | string | "yyyy/mm/dd hh:MM"形式 ※取得のみ |
| 16 | system_upd_user | 最終更新ユーザ | number | 最終更新者ユーザID ※取得のみ |
| 17 | system_upd_employee |
Example
{
"employees.department.id": 123,
"employees.department.is_not_use": false,
"employees.department.department_name": "営業部",
"employees.employee.charge_work@employees.charge_work.charge_work": [
"新規営業",
"既存営業"
],
"employees.employee.charge_work@employees.charge_work.main_charge_work": "新規営業",
"employees.department.relational_employee": [
123
],
"employees.department.relational_parent_department": 456,
"employees.department.relational_manager": 123,
"employees.department.department_number": "1",
"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
}