Datastore API
データストアとアクション、フィールドに関するAPI
注意
- 本API群では、display_id を指定することはできません。内部ID(p_id, d_idなど) を指定してください
データストア関連API
| No | API Name | API名 | Method | URI | 目的 | version | 画面ID(display_id)への対応 |
|---|---|---|---|---|---|---|---|
| 1 | GetDatastores | データストア一覧の取得 | GET | /api/v0/applications/:project-id/datastores | 指定したアプリケーション内のデータストアを取得します | v0 | - |
| 2 | GetStatuses | ステータス一覧の取得 | GET | /api/v0/datastores/:datastore-id/statuses | データストア内のステータス一覧を取得します | v0 | - |
アクション関連API
データストアを操作するアクションに関連したAPIです。
| No | API Name | API名 | Method | URI | 目的 | version | 画面ID(display_id)への対応 |
|---|---|---|---|---|---|---|---|
| 3 | GetActions | アクション一覧の取得 | GET | /api/v0/datastores/:datastore-id/actions | データストアで利用できるアクションボタン一覧を取得します | v0 | - |
| 4 | GetNewActions | 新規作成アクション一覧の取得 | GET | /api/v0/datastores/:datastore-id/new-actions | データストアで利用できる新規登録アクション一覧を取得します | v0 | - |
| 5 | GetUpdateActions | 更新アクション一覧の取得 | GET | /api/v0/datastores/:datastore-id/update-actions | データストアで利用できる更新アクション一覧を取得します | v0 | - |
フィールド関連API
Hexabaseでは、「アイテム」(テーブル)のカラムを「フィールド」または「画面項目」と呼びます。
| No | API Name | API名 | Method | URI | 目的 | version | 画面ID(display_id)への対応 |
|---|---|---|---|---|---|---|---|
| 6 | GetDatastoreFields | フィールド一覧 | GET | /api/v0/applications/:app-id/datastores/:datastore-id/fields | データストア内に定義されたフィールド一覧を取得します | v0 | ✓ |
| GetFieldSettings | フィールド設定を取得 | GET | /api/v0/applications/:app-id/datastores/:datastore-id/fields/:field-id | フィールドの設定を取得します | v0 | ✓ | |
| CreateField | フィールドを作成 | POST | /api/v0/applications/:app-id/datastores/:datastore-id/fields | data_typeを指定してフィールドを作成します | v0 | ✓ | |
| UpdateField | フィールド設定を更新 | PUT | /api/v0/applications/:app-id/datastores/:datastore-id/fields/:field-id | data_typeに合わせてフィールド設定を更新します | v0 | ✓ | |
| DeleteField | フィールドを削除 | DELETE | /api/v0/applications/:app-id/datastores/:datastore-id/fields/:field-id | フィールドを削除します | v0 | ✓ | |
| CreateFieldOptions | フィールドの選択オプションを作成 | POST | //api/v0/applications/:app-id/datastores/:datastore-id/fields/:field-id/options | 選択肢・ラジオ・チェックボックスフィールドのオプション項目を作成します | v0 | ✓ | |
| UpdateFieldOptions | フィールド一覧 | PUT | /api/v0/applications/:app-id/datastores/:datastore-id/fields/:field-id/options | 選択肢・ラジオ・チェックボックスフィールドのオプション項目を作成します | v0 | ✓ | |
| DeleteFieldOptions | フィールドの選択オプションを削除する | DELETE | /api/v0/applications/:app-id/datastores/:datastore-id/fields/:field-id/options | 選択肢・ラジオ・チェックボックスフィールドのオプション項目を削除します | v0 | ✓ |