Developers

共通グループ(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.パラメータ必須タイプデフォルト値説明
1tenant○string-テナントID
2id○string-対象レコードID

共通グループ登録

必要な権限

共通グループ登録

Request

URL

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

HTTP Method

POST

Parameter

Path Parameter
No.パラメータ必須タイプデフォルト値説明
1tenant○string-テナントID
2id○string-対象レコードID
Request Body
No.プロパティ名必須項目名タイプ備考
1employees.common_group.common_group_nameグループ名string
2employees.common_group.auto_update_flg自動更新フラグboolean
3employees.common_group.overwrite_auto_update_flg上書き自動更新フラグboolean
4employees.common_group.search_condition検索条件array(object)
- condition検索条件array(object)
-- column検索条件対象アイテムキーstring設定する項目はtargetへの指定が必須
-- operator演算子string演算子（「=, <, >, <=, >=, !=, in, like」）
-- value検索条件に設定する値string/array(string)検索条件の比較右辺（「in」「like」演算子の場合の場合リスト形式も許容）
-- connection結合演算子stringOR,AND のいずれかで指定。（無指定の場合はAND）
-- conditions結合検索条件array(object)conditionの配列で指定
- searchTargetLists検索対象のリストarray(object)
5employees.common_group.relational_employee紐づき社員array(number)
6employees.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
  ],
  "employees.common_group.search_condition": [
    {
      "condition": [
        {
          "column": "employees.employee.name",
          "operator": "=",
          "value": "営業太郎"
        }
      ]
    }
  ]
}

共通グループ更新

必要な権限

共通グループ変更

Request

URL

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

HTTP Method

PUT

Parameter

Path Parameter
No.パラメータ必須タイプデフォルト値説明
1tenant○string-テナントID
2id○string-対象レコードID
Request Body
No.プロパティ名必須項目名タイプ備考
1employees.common_group.common_group_nameグループ名string
2employees.common_group.auto_update_flg自動更新フラグboolean
3employees.common_group.overwrite_auto_update_flg上書き自動更新フラグboolean
4employees.common_group.search_condition検索条件array(object)
- condition検索条件array(object)
-- column検索条件対象アイテムキーstring設定する項目はtargetへの指定が必須
-- operator演算子string演算子（「=, <, >, <=, >=, !=, in, like」）
-- value検索条件に設定する値string/array(string)検索条件の比較右辺（「in」「like」演算子の場合の場合リスト形式も許容）
-- connection結合演算子stringOR,AND のいずれかで指定。（無指定の場合はAND）
-- conditions結合検索条件array(object)conditionの配列で指定
- searchTargetLists検索対象のリストarray(object)
5employees.common_group.relational_employee紐づき社員array(number)
6employees.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
  ],
  "employees.common_group.search_condition": [
    {
      "condition": [
        {
          "column": "employees.employee.name",
          "operator": "=",
          "value": "営業太郎"
        }
      ]
    }
  ]
}

共通グループ削除

必要な権限

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

Request

URL

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

HTTP Method

DELETE

Parameter

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

Response

Response Body

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

No.プロパティ名項目名タイプ備考
1employees.common_group.idグループIDnumber
2employees.common_group.common_group_nameグループ名string
3employees.common_group.auto_update_flg自動更新フラグboolean
4employees.common_group.overwrite_auto_update_flg上書き自動更新フラグboolean
5employees.common_group.sync_datetime同期日時string"yyyy/mm/dd hh:MM"形式
6employees.common_group.search_condition検索条件array(object)
- condition検索条件array(object)
-- column検索条件対象アイテムキーstring設定する項目はtargetへの指定が必須
-- operator演算子string演算子（「=, <, >, <=, >=, !=, in, like」）
-- value検索条件に設定する値string/array(string)検索条件の比較右辺（「in」「like」演算子の場合の場合リスト形式も許容）
-- connection結合演算子stringOR,AND のいずれかで指定。（無指定の場合はAND）
-- conditions結合検索条件array(object)conditionの配列で指定
- searchTargetLists検索対象のリストarray(object)
7employees.common_group.relational_employee紐づき社員array(number)
8employees.common_group.updating_flg更新中フラグboolean
9employees.common_group.owner_employee_idオーナー社員IDnumber
10system_reg_date登録日string"yyyy/mm/dd hh:MM"形式 ※取得のみ
11system_reg_user登録ユーザnumber登録者ユーザID ※取得のみ
12system_reg_employee登録社員number登録社員ID ※取得のみ
13system_upd_date更新日string"yyyy/mm/dd hh:MM"形式 ※取得のみ
14system_upd_user最終更新ユーザnumber最終更新者ユーザID ※取得のみ
15system_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.search_condition": [
        {
            "condition": [
                {
                    "value": "営業太郎",
                    "column": "employees.employee.name",
                    "operator": "="
                }
            ]
        }
    ],
    "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
    ]
}