This document explains the basic usage of the Hexabase API.
Overview Hexabase API is an Application Programming Interface for controlling enterprise BaaS (Backend as a Service).
Version Basic operation Advance preparation Get API token In this API, users are specified using the login API. Each API will be executed according to the privileges this user has. To use this API, first run the login API to obtain a token. When executing each API except the login API, specify the token in the HTTP request header as follows Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX(Issued token) Display ID (display_id) Display ID (display_id) refers to the ID that can be specified from the Hexabase setting screen.
For APIs that support display IDs (display_id), you can specify the ID entered from the screen as part of the URL or payload, such as app-id, datastore-id, field-id, etc.
For more information, see Development guide > Features > Designation by ID .
Error code Returns an error code when an error occurs. Please refer here for error codes. API list To use this API, first run the login API to obtain a token.
No API Name API Name Method URI Purpose version Support for display ID(display_id) 1 Login Login POST /api/v0/login Login to the system v0 - 60 Logout Logout POST /api/v0/users/logout Logout from the system v0 -
Unauthorized API No API Name API name Method URI Purpose version Support for display ID(display_id) 1 UnauthorizedCall Execute target API without authentication token POST /api/v0/auth/unauthorized-call Use a whitelist to execute the target API without an authentication token v0 -
A "workspace" is an area where Hexabase applications are organized. Prepare a workspace according to the type and content of your business, and organize multiple business applications.
For workspace-related APIs, please refer here
"Group" is a function that exists in one tree structure in the workspace and organizes users according to their roles. Roles can also be assigned to groups.
Get group list No API Name API name Method URI Purpose version Support for display ID(display_id) 49 GetGroup Get group information GET /api/v0/groups/:group-id Get the specified group information and a list of groups under it v0 - 4 GetGroupTree Get group tree information GET /api/v0/grouptree Get group information in the workspace in JSON tree format v0 -
Register, modify, and delete groups No API Name API name Method URI Purpose version Support for display ID(display_id) 5 CreateGroup Create new group POST /api/v0/workspaces/:workspace-id/groups/:parent-group-id Create a new group under the specified group v0 - 44 CreateTopGroup Create a new group (Level 1) POST /api/v0/workspaces/:workspace-id/groups Create a new group on the first level v0 - 6 UpdateGroup Update Group PUT /api/v0/groups/:group-id Update specified group information v0 - 7 DeleteGroup Delete group DELETE /api/v0/groups/:group-id Delete the specified group v0 -
A "user" is an account that can be logged in using an email address as an ID. Must belong to one of the groups in the workspace. To add users to Hexabase, you need to register them in a group and then invite them to your workspace.
Inviting users - initial registration For initial user registration, please refer here
Login user API For APIs related to viewing and changing logged-in users, please refer here
User list No API Name API Name Method URI Purpose version Support for display ID(display_id) 46 GetUsersInGroup Get users in group GET /api/v0/groups/:group-id/users Get a list of users for a specified group v0 - 50 GetUsersInWorkspace Get users in group GET /api/v0/workspaces/:workspace-id/users Get the list of users in the specified workspace (old) - 10 GetAllUsersInWorkspace Get all users of workspace GET /api/v0/users/all/g/:group-id Get a list of all users in the workspace v0 -
Adding and deleting users No API Name API Name Method URI Purpose version Support for display ID(display_id) 47 AddUser Add user POST /api/v0/users Create new user in group v0 - 51 RemoveUser Remove user DELETE /api/v0/users Remove user from group v0 - 52 UserInvite User invitation POST /api/v0/userinvite Invite users v0 -
Bulk registration of users by CSV data No API Name API Name Method URI Purpose version Support for display ID(display_id) 9 UserImport POST /api/v0/userimport Bulk import users via CSV α版 -
Hexabase organizes databases, data reports, dashboards, etc. for each "application". When you create a new workplace, an application named "New Application" is created.
There are multiple databases (datastores) within an application.
No API Name API Name Method URI Purpose version Support for display ID(display_id) 11 GetApplicationsAndDatastores Application and database list GET /api/v0/workspaces/:workspace-id/applications Get application list and datastore list v0 -
No API Name API Name Method URI Purpose version Support for display ID(display_id) 71 GetRoleUsers Get a user with a role GET /api/v0/applications/:app-id/roleusers/:role-id Get the users who own the specified role v0 - 65 AddRoleToUser Add a role to the user POST /api/v0/applications/:app-id/userroles Add application roles to users v0 - 66 RemoveRoleFromUser Remove role from user DELETE /api/v0/applications/:app-id/userroles Remove application roles from users v0 - 63 UpdateGroupRoles Update group role POST /api/v0/grouproles/:group-id Delete all roles associated with the group and assign new roles (replace) v0 - 64 AddGroupRoles Add group role PUT /api/v0/grouproles/:group-id Add a role to the group v0 -
No API Name API Name Method URI Purpose version Support for display ID(display_id) ExecuteFunction Execute the registered function POST /api/v0/applications/:project-id/functions/:function-id Execute a function registered in the application v0 -
In Hexabase, each piece of data in the database is called an "item". One horizontal row of the table is an item. Corresponds to a general RDB record.
Search and display items No API Name API Name Method URI Purpose version Support for display ID(display_id) 19 ItemList Item List POST /api/v0/applications/:app-id/datastores/:datastore-id/items/search Get item list v0 ✓ 68 GetItemSearchConditions Get item search conditions POST /api/v0/applications/:app-id/datastores/:datastore-id/items/conditions Get item search conditions v0 ✓ 70 GetUserQueries Get frequently used list GET /api/v0/applications/:app-id/queries Returns a list of search conditions stored for each user v0 ✓ 27 GetItemDetails Item details GET /api/v0/applications/:app-id/datastores/:datastore-id/items/details/:item-id Get item details and an action list v0 ✓
Registering, updating, and deleting items No API Name API Name Method URI Purpose version Support for display ID(display_id) 69 GetAutoNumber Automatic numbering POST /api/v0/applications/:app-id/datastores/:datastore-id/fields/:field-id/autonum Assign a number that can be used arbitrarily when registering an item v0 ✓ UpdateAutoNumber Automatic numbering field update POST /api/v0/applications/:app-id/datastores/:datastore-id/fields/:field-id/autonum Update automatic numbering values for specific fields in a datastore v0 ✓ 20 CreateItem New item registration POST /api/v0/applications/:app-id/datastores/:datastore-id/items/new Create a new item v0 ✓ 21 UpdateItem Update item POST /api/v0/applications/:app-id/datastores/:datastore-id/items/edit/:item-id Edit item v0 ✓ 22 DeleteItem Delete item DELETE /api/v0/applications/:app-id/datastores/:datastore-id/items/delete/:item-id Delete 1 item v0 ✓ 23 DeleteItemByConditions Delete items by specifying conditions DELETE /api/v0/applications/:app-id/datastores/:datastore-id/items/delete Delete items in bulk by specifying conditions v0 ✓
Take action on item No API Name API Name Method URI Purpose version Support for display ID(display_id) 48 CreateNewItemID Create new item ID POST /api/v0/datastores/:datastore-id/items/create-id Get action_id for creating new item v0 - 33 CreateItemWithItemID Create a new item by specifying item_id POST /api/v0/items/:item-id/new-actions/:action-id Specify action_id and execute a newly created action(Execute after No.69) v0 - 13 GetInputFields Get action registration form GET /api/v0/datastores/:datastore-id/actions/:action-id/fields Get field information available in an action v0 - 62 ExecuteAction Executing an action POST /api/v0/applications/:app-id/datastores/:datastore-id/items/action/:action-id Execute specified action v0 ✓ 31 ExecuteActionByActionID Executing an action POST /api/v0/items/:item-id/actions/:action-id Execute action v0 - 67 ExecuteBulkAction Execute action by specifying conditions POST /api/v0/applications/:app-id/datastores/:datastore-id/items/bulkaction/:action-id Execute specified action v0 ✓
No API Name API Name Method URI Purpose version Support for display ID(display_id) 28 GetLinkedItems Get linked items GET /api/v0/applications/:app-id/datastores/:datastore-id/items/links/:item-id Get list of items related to item v0 ✓ 24 AddItemLink Create item link POST /api/v0/applications/:app-id/datastores/:datastore-id/items/addlink/:item-id Add links to related items v0 ✓ 25 UpdateItemLink Update item link POST /api/v0/applications/:app-id/datastores/:datastore-id/items/updatelink/:item-id Updated links with related items v0 ✓ 26 DeleteItemLink Delete item link DELETE /api/v0/applications/:app-id/datastores/:datastore-id/items/dellink/:item-id Delete links with related items v0 ✓
Item history No API Name API Name Method URI Purpose version Support for display ID(display_id) 34 GetItemHistories Get item history GET /api/v0/applications/:app-id/datastores/:datastore-id/items/histories/:item-id Get history v0 ✓ 45 PostItemComment Post item comment POST /api/v0/applications/:app-id/datastores/:datastore-id/items/histories/:item-id Register comment history v0 ✓ 72 UpdateItemComment Update item comment PUT /api/v0/applications/:app-id/datastores/:datastore-id/items/histories/:item-id/:history-id Edit comment history v0 ✓ 73 DeleteItemComment Delete item comment DELETE /api/v0/applications/:app-id/datastores/:datastore-id/items/histories/:item-id/:history-id Delete comment history v0 ✓
No API Name API Name Method URI Purpose version Support for display ID(display_id) 35 GetFile Get file data GET /api/v0/files/:file-id Get attachment data v0 - UploadFile Attachment Upload POST /api/v0/files Upload File and get accessible file_id v0 - DeleteFile Delete file DELETE /api/v0/items/:item-id/fields/:field-id/attachments/:file-id Delete the specified file v0 - 29 UploadItemFile Upload item file POST /api/v0/items/:item-id/fields/:field-id/attachments Upload file to attachment field v0 - 30 DeleteItemFile Delete item file DELETE /api/v0/items/:item-id/fields/:field-id/attachments/:file-id Delete file in attachment field v0 - GetRestrictedFile Get File Data with permissions GET /api/v0/files/:file-id Get attachment data v0 - UploadRestrictedFile Attachment upload with access permission POST /api/v0/items/:item-id/fields/:field-id/attachments Upload the file to the attachment field v0 - DeleteRestrictedFile Delete attachments you have access to DELETE /api/v0/items/:item-id/fields/:field-id/attachments/:file-id Delete the file in the attachment field v0 - GetPublicImages Obtain attachments (image data) that you do not have permission to access GET /api/v0/public/images/:file-id Get an attached image file that can be made public v0 -
No API Name API Name Method URI Purpose version Support for display ID(display_id) 16 ImportItems Item CSV import POST /api/v0/applications/:app-id/datastores/:datastore-id/import Import CSV data to database v0 ✓ 17 GetImportResults Get import results GET /api/v0/datastores/:datastore-id/import/:id Get result of CSV import v0 -
No API Name API Name Method URI Purpose version Support for display ID(display_id) 37 GetReportData Get data report GET /api/v0/applications/:app-id/reports/:report-id Get report data v0 ✓ 38 GetReportSearchConditions Get data report search conditions GET /api/v0/applications/:app-id/reports/:report-id/conditions Get report search criteria v0 ✓ 39 GetReportDataByConditions Acquire data report by specifying conditions POST /api/v0/applications/:app-id/reports/:report-id/filter Obtain report data by specifying conditions v0 ✓
No API Name API Name Method URI Purpose version Support for display ID(display_id) 40 GetChartData Chart data acquisition GET /api/v0/applications/:app-id/charts/:chart-id Get chart data v0 ✓ 41 GetChartSearchConditions Get chart search conditions GET /api/v0/applications/:app-id/charts/:chart-id/conditions チャートの検索条件を取得 v0 ✓ 42 GetChartDataByConditions Acquiring chart data by specifying conditions POST /api/v0/applications/:app-id/charts/:chart-id/filter Obtain chart data by specifying conditions v0 ✓
Other APIs No API Name API Name Method URI Purpose version Support for display ID(display_id) GetQueueList Check task processing status GET /api/v0/tasks Check the status of the target task from the queued task processing. v0 ✓
API Tips