Datastore API
API for data stores, actions, and fields
Note
- In this API group, display_id cannot be specified. Please specify an internal ID (p_id, d_id, etc.)
Datastore related API
| No | API Name | API Name | Method | URI | Purpose | version | Support for display ID(display_id) |
|---|---|---|---|---|---|---|---|
| 1 | GetDatastores | Get datastore list | GET | /api/v0/applications/:project-id/datastores | Gets the datastore within the specified application | v0 | - |
| 2 | GetStatuses | Get status list | GET | /api/v0/datastores/:datastore-id/statuses | Get the status list in the datastore | v0 | - |
Action related API
APIs related to actions that manipulate datastores.
| No | API Name | API Name | Method | URI | Purpose | version | Support for display ID(display_id) |
|---|---|---|---|---|---|---|---|
| 3 | GetActions | Get action list | GET | /api/v0/datastores/:datastore-id/actions | Get a list of action buttons available in the datastore | v0 | - |
| 4 | GetNewActions | Get the list of newly created actions | GET | /api/v0/datastores/:datastore-id/new-actions | Get a list of new registration actions that can be used in the datastore | v0 | - |
| 5 | GetUpdateActions | Get update action list | GET | /api/v0/datastores/:datastore-id/update-actions | Get the list of update actions available in the datastore | v0 | - |
Field related API
In Hexabase, columns of an "item" (table) are called "fields" or "display items.
| No | API Name | API Name | Method | URI | Purpose | version | Support for display ID(display_id) |
|---|---|---|---|---|---|---|---|
| 6 | GetDatastoreFields | Field list | GET | /api/v0/applications/:app-id/datastores/:datastore-id/fields | Get the list of fields defined in the datastore | v0 | ✓ |
| GetFieldSettings | Get field settings | GET | /api/v0/applications/:app-id/datastores/:datastore-id/fields/:field-id | Get the settings of a field | v0 | ✓ | |
| CreateField | Create field | POST | /api/v0/applications/:app-id/datastores/:datastore-id/fields | Create a field by specifying data_type | v0 | ✓ | |
| UpdateField | Update field settings | PUT | /api/v0/applications/:app-id/datastores/:datastore-id/fields/:field-id | Update field settings to match data_type | v0 | ✓ | |
| DeleteField | Delete field | DELETE | /api/v0/applications/:app-id/datastores/:datastore-id/fields/:field-id | Delete the field | v0 | ✓ | |
| CreateFieldOptions | Create field selection options | POST | //api/v0/applications/:app-id/datastores/:datastore-id/fields/:field-id/options | Create option items for choice, radio, and checkbox fields | v0 | ✓ | |
| UpdateFieldOptions | Field list | PUT | /api/v0/applications/:app-id/datastores/:datastore-id/fields/:field-id/options | Create option items for choice, radio, and checkbox fields | v0 | ✓ | |
| DeleteFieldOptions | Delete field selection options | DELETE | /api/v0/applications/:app-id/datastores/:datastore-id/fields/:field-id/options | Delete option items in the choice, radio, and checkbox fields | v0 | ✓ |