REST API サーバに対応する

最終更新日: 2022年5月9日

REST API を有効にする

モデルの設定

モデルごとに、REST API を有効にするかどうかを指定します。標準では無効(REST APIは利用しない)となっています。

REST API を有効にする

いくつかの機能は、REST API を有効にする必要があります。詳細は各機能のマニュアルで説明されています。マニュアルの指示に従い、本設定を有効にしてください。

重要

開発環境で起動した Wagby アプリケーションに対して、外部からこの REST API を呼び出すことはできません。REST API 呼び出しは本番環境で起動している Wagby アプリケーションに対して行ってください。

※ このため、無料トライアル期間中は、外部から REST API を呼び出す機能をお試しいただくことはできません。

モデルIDを変更する

REST API を利用する場合、呼び出し側 (Wagbyの外部) は「モデルID」を指定する必要があります。標準では「"MODEL" + 数字」となっています。

このモデルIDを変更することができます。

モデルIDを変更する

モデルIDを変更した場合の影響範囲

モデルIDを変更するとアプリケーションの内部を構成する情報も同時に変更されます。

  • データベースのテーブル名 (必ず)
  • スクリプト (影響のあるスクリプトが存在した場合)

スクリプトが変更される場合、上図のように確認ダイアログが表示されますので "OK" としてください。

この変更によってアプリケーションの挙動が変わることはありません。

命名規則

モデルIDを変更する場合、次のルールに準拠してください。

  • モデルIDは2文字以上、30文字以内としてください。
  • 先頭は "A" から "Z" の文字を利用できます。
  • 2文字目以降は "A" から "Z" および "0" から "9" の数字を含めることができます。
  • 記号(アンダースコアなど)、英小文字、スペースを含めることはできません。
  • いくつかの文字列は Wagby 内部で予約されています。利用できない文字列であれば警告が出力されますので、別の名前に変えてください。

項目IDを変更する

REST API を利用する場合、呼び出し側 (Wagbyの外部) は「項目ID」を指定する必要があります。標準では「"ITEM" + 数字」となっています。

この項目IDを変更することができます。

項目IDを変更する

項目IDを変更した場合の影響範囲

項目IDを変更するとアプリケーションの内部を構成する情報も同時に変更されます。

  • データベースのテーブル名 (必ず)
  • スクリプト (影響のあるスクリプトが存在した場合)

スクリプトが変更される場合、上図のように確認ダイアログが表示されますので "OK" としてください。

この変更によってアプリケーションの挙動が変わることはありません。

命名規則

項目IDを変更する場合、次のルールに準拠してください。

  • 項目IDは2文字以上、30文字以内としてください。
  • 先頭は "A" から "Z" の文字を利用できます。
  • 2文字目以降は "A" から "Z" および "0" から "9" の数字を含めることができます。
  • 記号(アンダースコアなど)、英小文字、スペースを含めることはできません。
  • いくつかの文字列は Wagby 内部で予約されています。利用できない文字列であれば警告が出力されますので、別の名前に変えてください。