Developers

拡張アプリ(appextender)

拡張アプリに関する情報の登録・更新・取得・削除ができます。

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

拡張アプリのレコード取得

必要な権限

拡張アプリのレコード参照

Request

URL

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

HTTP Method

GET

Parameter

Path Parameter
No.パラメータ必須タイプデフォルト値説明
1tenant○string-会社ID
2sheetName○string-拡張アプリ名
3id○string-対象レコードID

拡張アプリのレコード登録

必要な権限

拡張アプリのレコード登録

Request

URL

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

HTTP Method

POST

Parameter

Path Parameter
No.パラメータ必須タイプデフォルト値説明
1tenant○string-会社ID
2sheetName○string-拡張アプリ名
Request Body
No.プロパティ名必須項目名タイプ備考
1appextender.{sheetName}.is_use表示フラグboolean
2appextender.{sheetName}.memoメモstring
3appextender.{sheetName}.name拡張アプリのレコード名string
4appextender.{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/esm-api/{tenant}/pub/esms/v1/sheet/{sheetName}/{id}

HTTP Method

PUT

Parameter

Path Parameter
No.パラメータ必須タイプデフォルト値説明
1tenant○string-会社ID
2sheetName○string-拡張アプリ名
3id○string-対象レコードID

Request Body

No.プロパティ名必須項目名タイプ備考
1appextender.{sheetName}.is_use表示フラグboolean
2appextender.{sheetName}.memoメモstring
3appextender.{sheetName}.name拡張アプリのレコード名string
4appextender.{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/esm-api/{tenant}/pub/esms/v1/sheet/{sheetName}/{id}

HTTP Method

DELETE

Parameter

Path Parameter
No.パラメータ必須タイプデフォルト値説明
1tenant○string-会社ID
2sheetName○string-拡張アプリ名
3id○string-対象レコードID

Response

Response Body

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

No.プロパティ名項目名タイプ備考
1appextender.{sheetName}.id拡張アプリのレコードIDnumber
2appextender.{sheetName}.is_use表示フラグboolean
3appextender.{sheetName}.memoメモstring
4appextender.{sheetName}.name拡張アプリのレコード名string
5appextender.{sheetName}.name_kana拡張アプリのレコード名_かなstring
6system_reg_date登録日string"yyyy/MM/dd HH:mm"形式 ※取得のみ
7system_reg_user登録ユーザーnumber登録者ユーザーID ※取得のみ
8system_reg_employee登録社員number登録社員ID ※取得のみ ※取得のみ
9system_upd_date更新日string"yyyy/MM/dd HH:mm"形式 ※取得のみ
10system_upd_user最終更新ユーザーnumber最終更新者ユーザーID ※取得のみ
11system_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通りの方法で取得できます。

・アプリ設定にて確認する。

  1. システム設定をクリック
  2. アプリ設定をクリック
  3. オブジェクト名を確認。これがsheetNameとなる。

拡張アプリ名の説明.png

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

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

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