ID による指定

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

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

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

Hexabase の ID には 2 つの種類があります。 管理画面から設定できる「画面 ID/画面項目 ID」(display_id)と、ID システム内部で識別している「内部 ID」(internal_id)です。

画面 ID は、開発者が指定できる ID です。同一ワークスペースでユニークな値を指定しますが、異なるワークスペース間では、ID が同一であっても構いません。ステージング環境と本番環境で、同一の ID を指定するには、この画面 ID を利用します。

内部 ID は、Hexabase が自動的に割り当てる ID です。ステージング環境と本番環境で、同一の値が指定される保証は有りません。

ほとんどの API は、どちらの ID を利用可能です。

しかし、内部 ID で操作対象を指定すると、ステージング環境で動作していたプログラムが、本番環境では動作しなくなります。

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

識別対象

画面 ID

内部 ID

ワークスペース

(なし)

w_id

アプリケーション

アプリケーション設定画面から設定 同一ワークスペース内でユニークな値を指定

p_id

データベース

データベース設定画面から設定 同一アプリケーション内でユニークな値を指定

d_id

フィールド

フィールド設定画面から設定 同一データベース内でユニークな値

f_id

ステータス

ステータス設定画面から指定 同一データベース内でユニークな値

s_id

アクション

アクション設定画面から指定 同一データベース内でユニークな値

a_id

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

画面 ID(display_id)は、HexabaseUI の管理画面で設定・確認できます。現状では、設定する場所が分散しているため、設計時に ID を入れ込んでおくと、コードを書く人が楽になります。 (将来は CLI コマンドで設定できるよう準備中)

Tips:REST URL で使用するため、display_id は、英数字で記述します

※ 画面 ID によっては、開発者向け機能を利用するを有効にしておく必要があります。

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

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

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

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

画面項目 ID(Field ID)の設定・確認

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

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

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

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

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