REST-API共通仕様

REST-APIは、esm APIの共通仕様に準じています。 そのうえで、REST-APIにおける共通仕様は下記のとおりです。

エンドポイント凡例

REST-APIにおけるエンドポイントは、REST原則に則り、CRUDそれぞれで共通の形をとっています。
リソース一覧のシートがリソースとして使用できます。

取得

https://gateway-esm.softbrain.com/{tenant}/pub/esms/v1/sheet/{シート名}/{id}

新規登録

https://gateway-esm.softbrain.com/{tenant}/pub/esms/v1/sheet/{シート名}

更新登録

https://gateway-esm.softbrain.com/{tenant}/pub/esms/v1/sheet/{シート名}/{id}

削除

https://gateway-esm.softbrain.com/{tenant}/pub/esms/v1/sheet/{シート名}/{id}

Request Body

Request Bodyについては、各シートごとに異なりますので、各シートのページをご覧ください。

Response Body

REST-APIにおけるResponse Bodyは以下の共通仕様に則っています。

登録, 更新は各シートごとに同じです。
取得のみ、登録/更新時のものに追加で下記項目が返却されます。

• 登録日
• 登録ユーザ
• 登録社員
• 更新日
• 最終更新ユーザ
• 最終更新社員

削除に関しては何も返却されません。

詳細なパラメータは各シートのページをご覧ください。

シートの紐づき関係についての説明

シートの紐づき関係についての説明はこちら

各種マスタの選択肢の確認

マスタ選択肢の確認はこちら