共通グループ(common_group)

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

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

共通グループ取得

必要な権限

共通グループ参照

Request

URL

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

HTTP Method

POST

Parameter

Path Parameter

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

Request Body

No.	プロパティ名	項目名	タイプ	備考
1	employees.common_group.common_group_name	グループ名	string
2	employees.common_group.auto_update_flg	自動更新フラグ	boolean
3	employees.common_group.overwrite_auto_update_flg	上書き自動更新フラグ	boolean
4	employees.common_group.relational_employee	紐づき社員	array(number)
5	employees.common_group.sync_datetime	同期日時	string	"yyyy/MM/dd HH:mm" もしくは "yyyy/MM/dd HH:mm:ss"形式

Example

{
  "employees.common_group.common_group_name": "group name",
  "employees.common_group.sync_datetime": "2025/01/29 17:34",
  "employees.common_group.auto_update_flg": true,
  "employees.common_group.overwrite_auto_update_flg": true,
  "employees.common_group.relational_employee": [
    14852199188110
  ]
}

共通グループ更新

必要な権限

共通グループ変更

Request

URL

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

HTTP Method

PUT

Parameter

Path Parameter

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

Request Body

No.	プロパティ名	項目名	タイプ	備考
1	employees.common_group.common_group_name	グループ名	string
2	employees.common_group.auto_update_flg	自動更新フラグ	boolean
3	employees.common_group.overwrite_auto_update_flg	上書き自動更新フラグ	boolean
4	employees.common_group.relational_employee	紐づき社員	array(number)
5	employees.common_group.sync_datetime	同期日時	string	"yyyy/MM/dd HH:mm" もしくは "yyyy/MM/dd HH:mm:ss"形式

Example


{
  "employees.common_group.common_group_name": "group name",
  "employees.common_group.sync_datetime": "2025/01/29 17:34",
  "employees.common_group.auto_update_flg": true,
  "employees.common_group.overwrite_auto_update_flg": true,
  "employees.common_group.relational_employee": [
    14852199188110
  ]
}

共通グループ削除

必要な権限

共通グループ削除・共通グループ一括削除

Request

URL

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

HTTP Method

DELETE

Parameter

Path Parameter

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

Response

Response Body

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

No.	プロパティ名	項目名	タイプ	備考
1	employees.common_group.id	グループID	number
2	employees.common_group.common_group_name	グループ名	string
3	employees.common_group.auto_update_flg	自動更新フラグ	boolean
4	employees.common_group.overwrite_auto_update_flg	上書き自動更新フラグ	boolean
5	employees.common_group.sync_datetime	同期日時	string	"yyyy/mm/dd hh:MM"形式
6	employees.common_group.relational_employee	紐づき社員	array(number)
7	employees.common_group.updating_flg	更新中フラグ	boolean
8	employees.common_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

{
    "system_upd_date": "2025/01/29 17:45",
    "system_reg_date": "2025/01/29 17:45",
    "system_reg_employee": 100000000001,
    "employees.common_group.overwrite_auto_update_flg": true,
    "employees.common_group.favorite_common_group": [],
    "system_upd_user": -101,
    "system_upd_employee": 100000000001,
    "employees.common_group.common_group_name": "group name",
    "employees.common_group.sync_datetime": "2025/01/29 17:34",
    "system_reg_user": -101,
    "employees.common_group.updating_flg": false,
    "employees.common_group.auto_update_flg": true,
    "employees.common_group.id": 14852199188165,
    "employees.common_group.relational_employee": [
        14852199188110
    ]
}