マイグループ(my_group)

マイグループに関する情報の登録・更新・取得・削除ができます。

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

マイグループ取得

必要な権限

マイグループ参照

Request

URL

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

HTTP Method

POST

Parameter

Path Parameter

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

Request Body

No.	プロパティ名	必須	項目名	タイプ	備考
1	employees.my_group.my_group_name		グループ名	string
2	employees.my_group.auto_update_flg		自動更新フラグ	boolean
3	employees.my_group.overwrite_auto_updating_flg		上書き自動更新フラグ	boolean
4	employees.my_group.relational_employee		紐づき社員	array(number)
5	employees.my_group.owner_employee_id		オーナー社員ID	number

Example

{
  "employees.my_group.owner_employee_id": 123,
  "employees.my_group.auto_update_flg": true,
  "employees.my_group.my_group_name": "営業グループ",
  "employees.my_group.overwrite_auto_updating_flg": false,
  "employees.my_group.relational_employee": [
    123
  ]
}

マイグループ更新

必要な権限

マイグループ変更

Request

URL

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

HTTP Method

PUT

Parameter

Path Parameter

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

Request Body

No.	プロパティ名	必須	項目名	タイプ	備考
1	employees.my_group.my_group_name		グループ名	string
2	employees.my_group.auto_update_flg		自動更新フラグ	boolean
3	employees.my_group.overwrite_auto_updating_flg		上書き自動更新フラグ	boolean
4	employees.my_group.relational_employee		紐づき社員	array(number)
5	employees.my_group.owner_employee_id		オーナー社員ID	number

Example

{
  "employees.my_group.owner_employee_id": 123,
  "employees.my_group.auto_update_flg": true,
  "employees.my_group.my_group_name": "営業グループ",
  "employees.my_group.overwrite_auto_updating_flg": false,
  "employees.my_group.relational_employee": [
    123
  ]
}

マイグループ削除

必要な権限

マイグループ削除・マイグループ一括削除

Request

URL

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

HTTP Method

DELETE

Parameter

Path Parameter

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

Response

Response Body

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

No.	プロパティ名	項目名	タイプ	備考
1	employees.my_group.id	グループID	number
2	employees.my_group.my_group_name	グループ名	string
3	employees.my_group.auto_update_flg	自動更新フラグ	boolean
4	employees.my_group.overwrite_auto_updating_flg	上書き自動更新フラグ	boolean
5	employees.my_group.sync_datetime	同期日時	string	"yyyy/mm/dd hh:MM"形式
6	employees.my_group.relational_employee	紐づき社員	array(number)
7	employees.my_group.updating_flg	更新中フラグ	boolean
8	employees.my_group.owner_employee_id	オーナー社員ID	number
9	system_reg_date	登録日	string	"yyyy/mm/dd hh:MM"形式 ※取得のみ
10	system_reg_user	登録ユーザ	number	登録者ユーザID ※取得のみ
11	system_reg_employee	登録社員	number	登録社員ID ※取得のみ
12	system_upd_date	更新日	string	"yyyy/mm/dd hh:MM"形式 ※取得のみ
13	system_upd_user	最終更新ユーザ	number	最終更新者ユーザID ※取得のみ
14	system_upd_employee	最終更新社員	number	最終更新社員ID ※取得のみ

Example

  {
  "employees.my_group.id": 123,
  "employees.my_group.my_group_name": "営業グループ",
  "employees.my_group.auto_update_flg": true,
  "employees.my_group.overwrite_auto_update_flg": true,
  "employees.my_group.sync_datetime": "2023/07/24 19:28",
  "employees.my_group.relational_employee": [
    123
  ],
  "employees.my_group.updating_flg": true,
  "employees.my_group.owner_employee_id": 123,
  "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
}