拡張シート(appextender)

拡張シートに関する情報の登録・更新・取得・削除ができます。

シートのidの取得にはSearch APIが使用できます。

拡張シート取得

必要な権限

拡張シート参照

Request

URL

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

HTTP Method

GET

Parameter

Path Parameter

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

拡張シート登録

必要な権限

拡張シート登録

Request

URL

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

HTTP Method

POST

Parameter

Path Parameter

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

Request Body

No.	プロパティ名	項目名	タイプ	備考
1	appextender.{sheetName}.is_use	表示フラグ	boolean
2	appextender.{sheetName}.memo	メモ	string
3	appextender.{sheetName}.name	拡張シート名	string
4	appextender.{sheetName}.name_kana	拡張シート名_かな	string
5	拡張項目の項目名は、システムで設定するitem_idを設定する。item_idの確認方法	拡張項目	any()	拡張項目を追加する際、アイテムタイプ別定義のシートを参照する

Example

{
  "appextender,sheet_134.is_use": true,
  "appextender.sheet_134.memo": null,
  "appextender.sheet_134.name": "案件進捗管理",
  "appextender.sheet_134.name_kana": null
}

拡張シート更新

必要な権限

拡張シート変更

Request

URL

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

HTTP Method

PUT

Parameter

Path Parameter

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

Request Body

No.	プロパティ名	項目名	タイプ	備考
1	appextender.{sheetName}.is_use	表示フラグ	boolean
2	appextender.{sheetName}.memo	メモ	string
3	appextender.{sheetName}.name	拡張シート名	string
4	appextender.{sheetName}.name_kana	拡張シート名_かな	string
5	拡張項目の項目名は、システムで設定するitem_idを設定する。item_idの確認方法	拡張項目	any()	拡張項目を追加する際、アイテムタイプ別定義のシートを参照する

Example

{
  "appextender.sheet_134.is_use": true,
  "appextender.sheet_134.memo": null,
  "appextender.sheet_134.name": "案件進捗管理",
  "appextender.sheet_134.name_kana": null
}

拡張シート削除

必要な権限

拡張シート削除・拡張シート一括削除

Request

URL

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

HTTP Method

DELETE

Parameter

Path Parameter

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

Response

Response Body

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

No.	プロパティ名	項目名	タイプ	備考
1	appextender.{sheetName}.id	拡張シートID	number
2	appextender.{sheetName}.is_use	表示フラグ	boolean
3	appextender.{sheetName}.memo	メモ	string
4	appextender.{sheetName}.name	拡張シート名	string
5	appextender.{sheetName}.name_kana	拡張シート名_かな	string
6	system_reg_date	登録日	string	"yyyy/mm/dd hh:MM"形式 ※取得のみ
7	system_reg_user	登録ユーザ	number	登録者ユーザID ※取得のみ
8	system_reg_employee	登録社員	number	登録社員ID ※取得のみ ※取得のみ
9	system_upd_date	更新日	string	"yyyy/mm/dd hh:MM"形式 ※取得のみ
10	system_upd_user	最終更新ユーザ	number	最終更新者ユーザID ※取得のみ
11	system_upd_employee	最終更新社員	number	最終更新者社員ID ※取得のみ
12	拡張項目の項目名は、システムで設定するitem_idを設定する。item_idの確認方法	拡張項目	any()	拡張項目を追加する際、アイテムタイプ別定義のシートを参照する

Example

{
  "appextender.sheet_134.id": "34",
  "appextender.sheet_134.is_use": true,
  "appextender.sheet_134.memo": null,
  "appextender.sheet_134.name": "案件進捗管理",
  "appextender.sheet_134.name_kana": null,
  "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
}

拡張シート(appextender)のsheetNameの取得方法

下記の2通りの方法で取得できます。

・シート設定にて確認する。

システム設定をクリック
シート設定をクリック
オブジェクト名を確認。これがsheetNameとなる。

拡張シート名の説明.png

・拡張シート一覧や詳細画面にて、アドレスバーを確認する。

一覧画面での例:ホスト名/{tenant}/{sheetName}

アドレスバーでの拡張シート名の確認方法.png