メインコンテンツまでスキップ

ID による指定

Hexabase は、アプリケーションやデータベース・フィールドなどをあらわす固有の ID を持っています。API を呼び出すとき、この ID で操作対象を指定します。ID は、管理画面で確認できます。

IDで、操作対象を指定する

画面項目 ID(display_id)と内部 ID​

IDには、次の2種類の値が設定されます。

  • 内部ID：デフォルトで登録されているID。ワークスペースやアプリケーションごとにユニーク。アプリを複製すると、自動的に違う値になる。
  • 画面項目ID：管理画面で任意に設定できるID。アプリを複製しても、共通の値になる。そのため、ワークスペースやアプリケーションごとに共通にできる

アプリケーションを開発環境から本番環境に移行したり、別のワークスペースにインポートするには、画面項目IDを登録しておく必要があります。

内部IDは、Hexabase が自動的に割り当てます。そのため、アプリを複製した場合、自動的に違う値になり、複製後に機能を呼び出せなくなります。画面項目IDは、開発者が登録したIDです。そのため、複製しても同一の値が保持されて、複製しても機能を呼出しできます。

操作対象には、画面項目IDを登録しておく

※ API から呼び出す操作対象は、画面項目IDを設定してアクセスします。

※ アプリケーション名やデータベース名などで機能を指定していると、言語(ロケール)が切り替わった際に名前も切り替わりアクセスできなくなります。

画面項目ID(display_id) を管理画面で登録・確認する​

※ 管理画面では、デフォルトで内部IDが表示されています。これを上書きすることで画面項目IDとして利用できます。

HexabaseのAPIは、RESTfulなAPIであるため、画面項目ID(display_id)は、英数字で記述します。

画面項目ID(display_id)は、HexabaseUI の管理画面で設定・確認できます。現状では、設定する場所が分散しているため、設計時に、どのような値を入力するかあらかじめ決めておくと、コードを書くときに楽になります。

※ 画面項目IDを設定するには、開発者向け機能を利用するをオンにしておく必要があります。

アプリケーショ ID の設定・確認​

IDで、操作対象を指定する

データベース(Datastore)ID の設定・確認​

IDで、操作対象を指定する

フィールドID(Field ID)の設定・確認​

IDで、操作対象を指定する

ステータスID の設定・確認​

IDで、操作対象を指定する

アクションID の設定・確認​

IDで、操作対象を指定する