本ドキュメントは、Hexabaseプラットホームを外部から利用するAPIについて説明しています。
Version 0
HexabaseプラットホームのベースURIを確認します。ベースURIは、テナントごとに異なります
Hexabaseプラットホームでユーザー登録します
本APIでは、ログインAPIでユーザーを指定します。各APIは、このユーザが持つ権限に従って実行されます
本APIを使用するには、最初にログインAPIを実行して、トークンを取得します
ログインAPIを除く各APIの実行時には、HTTPリクエストヘッダに以下のようにトークンを指定します
Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX(発行したトークン)
画面ID(display_id)
画面ID(display_id)とは、Hexabase設定画面から指定可能なIDのことを指します。
画面ID(display_id)に対応しているAPIは、app-id, datastore-id, field-id など、URLやPayloadの一部に画面から入力したIDを指定することが可能です。
本APIを使用するには、最初にログインAPIを実行して、トークンを取得します
「ワークスペース」は、Hexabaseのアプリケーションをまとめる領域です。業務の種類や内容に合わせてワークスペースを用意して、複数の業務アプリケーションをまとめておきます。
No | API Name | API名 | Method | URI | 目的 | version | 画面ID(display_id)への対応 |
2 | ワークスペース一覧 | GET | /api/v0/workspaces | ワークスペースの一覧を取得する | v0 | - | |
3 | ワークスペース選択 | POST | /api/v0/workspaces/:workspace-id/select | 現在ワークスペースを選択する | v0 | - |
「グループ」は、ワークスペース内に1つツリー構造で存在するし、ユーザーを役割りに応じてまとめる機能です。グループへロールを付与することもできます。
No | API Name | API名 | Method | URI | 目的 | version | 画面ID(display_id)への対応 |
49 | GetGroup | グループ情報取得 | GET | /api/v0/groups/:group-id | 指定したグループ情報とその配下のグループ一覧を取得 | v0 | - |
4 | グループツリー情報取得 | GET | /api/v0/grouptree | ワークスペース内のグループ情報をJSONツリー形式で取得 | v0 | - |
No | API Name | API名 | Method | URI | 目的 | version | 画面ID(display_id)への対応 |
5 | 新規グループ作成 | POST | /api/v0/workspaces/:workspace-id/groups/:parent-group-id | 指定グループ配下に新規でグループを作成 | v0 | - | |
44 | 新規グループ作成(第1階層) | POST | /api/v0/workspaces/:workspace-id/groups | 第1階層に新規グループを作成 | v0 | - | |
6 | グループ更新 | PUT | /api/v0/groups/:group-id | 指定したグループ情報を更新する | v0 | - | |
7 | グループ削除 | DELETE | /api/v0/groups/:group-id | 指定したグループを削除する | v0 | - |
「ユーザー」はEmailアドレスをIDとした、ログイン可能なアカウントです。必ずワークスペース内のいずれかのグループに属します。Hexabaseへユーザーを追加するには、グループへユーザーを登録した後に、ワークスペースへ招待する必要があります。
ログインしているユーザーに関する情報を取得します。
No | API Name | API名 | Method | URI | 目的 | version | 画面ID(display_id)への対応 |
43 | ユーザー情報取得 | GET | /api/v0/userinfo | ユーザーの関連情報取得 | v0 | - | |
61 | ユーザー情報更新 | PUT | /api/v0/userinfo | ユーザー名、情報の更新 | v0 | - |
No | API Name | API名 | Method | URI | 目的 | version | 画面ID(display_id)への対応 |
56 | パスワード初期化リクエスト | POST | /api/v0/users/password/forgot | ログイン前、パスワード初期化 開始 | v0 | - | |
57 | パスワード再登録 | PUT | /api/v0/users/password/forgot | ログイン前、パスワード初期化 パスワードを変更 | v0 | - | |
58 | パスワード変更確認 | GET | /api/v0/users/password/validate | ログイン前、パスワード初期化 パスワー変更状態の確認 | v0 | - | |
59 | パスワード変更登録 | PUT | /api/v0/users/password | ログイン後、パスワード変更 | v0 | - |
No | API Name | API名 | Method | URI | 目的 | version | 画面ID(display_id)への対応 |
46 | グループ内ユーザー取得 | GET | /api/v0/groups/:group-id/users | 指定されたグループのユーザー一覧の取得 | v0 | - | |
50 | グループ内ユーザー取得 | GET | /api/v0/workspaces/:workspace-id/users | 指定されたワークスペースのユーザー一覧の取得 | (old) | - | |
10 | ワークスペース全ユーザー取得 | GET | /api/v0/users/all/g/:group-id | ワークスペース内全ユーザー一覧の取得 | v0 | - |
No | API Name | API名 | Method | URI | 目的 | version | 画面ID(display_id)への対応 |
47 | AddUser | ユーザー追加 | POST | /api/v0/users | グループに新規ユーザーを作成 | v0 | - |
51 | ユーザー削除 | DELETE | /api/v0/users | グループからユーザーを削除 | v0 | - |
ユーザーをワークスペースへ招待するには、登録されたユーザーに対して招待メールを送信(UserInvite)します。 受け取ったメールに含まれるリンクをクリックすることでユーザー登録の確認ページへ遷移させます。遷移先画面では確認ID(ConfirmID)をもとにユーザー情報を取得(ConfirmRegistration)し、ユーザー情報を登録する(RegisterUser)ことではじめてユーザーが作成されます。
No | API Name | API名 | Method | URI | 目的 | version | 画面ID(display_id)への対応 |
52 | ユーザー招待 | POST | /api/v0/userinvite | ユーザーを招待 | v0 | - | |
53 | 初回ユーザー登録 | POST | /api/v0/users/registration | ユーザーの初期登録用リクエスト | v0 | - | |
54 | ユーザー情報確認 | GET | /api/v0/users/registration/confirm | ConfirmIDからユーザーの初期登録情報の確認 | v0 | - | |
55 | ユーザー初期登録 | POST | /api/v0/users/registration/confirm | ユーザーの初期登録、パスワード登録 | v0 | - |
No | API Name | API名 | Method | URI | 目的 | version | 画面ID(display_id)への対応 |
9 | | POST | /api/v0/userimport | ユーザーをCSVで一括インポート | α版 | - |
Hexabaseでは、「アプリケーション」ごとに、データベース・データレポート・ダッシュボードなどをまとめています。新しくワークプレースを作成すると「新しいアプリケーション」という名前のアプリケーションが作成されています。 アプリケーション内には複数のデータベース(データテーブル)が存在します。
No | API Name | API名 | Method | URI | 目的 | version | 画面ID(display_id)への対応 |
11 | アプリケーションとデータベース一覧 | GET | /api/v0/workspaces/:workspace-id/applications | アプリケーション一覧のとデータストア一覧を取得 | v0 | - |
No | API Name | API名 | Method | URI | 目的 | version | 画面ID(display_id)への対応 |
No | API Name | API名 | Method | URI | 目的 | version | 画面ID(display_id)への対応 |
71 | ロールをもつユーザーの取得 | GET | /api/v0/applications/:app-id/roleusers/:role-id | 指定したロールを所有するユーザーを取得する | v0 | - | |
65 | ユーザーへロール付与 | POST | /api/v0/applications/:app-id/userroles | ユーザーにアプリケーションのロールを付与する | v0 | - | |
66 | ユーザからロールを削除 | DELETE | /api/v0/applications/:app-id/userroles | ユーザーからアプリケーションのロールを外す | v0 | - | |
63 | グループロール更新 | POST | /api/v0/grouproles/:group-id | グループにひも付くロールをすべて削除し、新規付与(洗い変え)する | v0 | - | |
64 | グループロール追加 | PUT | /api/v0/grouproles/:group-id | グループにロールを追加する | v0 | - |
Hexabaseでは、「アイテム」のカラムを「フィールド」または「画面項目」と呼びます。
No | API Name | API名 | Method | URI | 目的 | version | 画面ID(display_id)への対応 |
15 | フィールド一覧 | GET | /api/v0/applications/:app-id/datastores/:datastore-id/fields | フィールド一覧を取得 | v0 | ✓ |
Hexabaseでは、データベースの各データを「アイテム」と呼びます。表の横1行がアイテムになります。一般的なRDBのレコードに相当します。
No | API Name | API名 | Method | URI | 目的 | version | 画面ID(display_id)への対応 |
19 | ItemList | アイテム一覧 | POST | /api/v0/applications/:app-id/datastores/:datastore-id/items/search | アイテム一覧を取得 | v0 | ✓ |
68 | アイテム検索条件取得 | POST | /api/v0/applications/:app-id/datastores/:datastore-id/items/conditions | アイテムの検索条件を取得する | v0 | ✓ | |
70 | よく使う一覧の取得 | GET | /api/v0/applications/:app-id/queries | ユーザーごとに記憶された検索条件一覧を返す | v0 | ✓ | |
27 | アイテム詳細 | GET | /api/v0/applications/:app-id/datastores/:datastore-id/items/details/:item-id | アイテムの詳細情報、アクションリストを取得 | v0 | ✓ |
No | API Name | API名 | Method | URI | 目的 | version | 画面ID(display_id)への対応 |
69 | 自動採番 | POST | /api/v0/applications/:app-id/datastores/:datastore-id/fields/:field-id/autonum | アイテムへ登録時に任意利用できる番号を採番する | v0 | ✓ | |
20 | アイテム新規登録 | POST | /api/v0/applications/:app-id/datastores/:datastore-id/items/new | 新規アイテムを作成する | v0 | ✓ | |
21 | アイテム更新 | POST | /api/v0/applications/:app-id/datastores/:datastore-id/items/edit/:item-id | アイテムを編集する | v0 | ✓ | |
22 | アイテム削除 | DELETE | /api/v0/applications/:app-id/datastores/:datastore-id/items/delete/:item-id | 1アイテムを削除する | v0 | ✓ | |
23 | 条件指定してアイテム削除 | DELETE | /api/v0/applications/:app-id/datastores/:datastore-id/items/delete | 条件を指定してアイテムを一括削除する | v0 | ✓ |
No | API Name | API名 | Method | URI | 目的 | version | 画面ID(display_id)への対応 |
12 | 新規登録アクションの一覧 | GET | /api/v0/datastores/:datastore-id/new-action | 新規アイテム作成アクション一覧を取得 | v0 | - | |
48 | 新規アイテムID取得 | POST | /api/v0/datastores/:datastore-id/items/create-id | 新規アイテム作成用のaction_idを取得 | v0 | - | |
33 | item_idを指定して新規アイテムを作成 | POST | /api/v0/items/:item-id/new-actions/:action-id | action_idを指定して、新規作成アクションを実行(No.69の後に実行) | v0 | - | |
13 | アクション登録フォーム取得 | GET | /api/v0/datastores/:datastore-id/actions/:action-id/fields | アクションで利用可能なフィールド情報を取得する | v0 | - | |
62 | アクションの実行 | POST | /api/v0/applications/:app-id/datastores/:datastore-id/items/action/:action-id | 指定アクションを実行する | v0 | ✓ | |
31 | アクションの実行 | POST | /api/v0/items/:item-id/actions/:action-id | アクションを実行 | v0 | - | |
67 | 条件を指定してアクションを実行 | POST | /api/v0/applications/:app-id/datastores/:datastore-id/items/bulkaction/:action-id | 指定アクションを実行する | v0 | ✓ |
No | API Name | API名 | Method | URI | 目的 | version | 画面ID(display_id)への対応 |
28 | 関連アイテム取得 | GET | /api/v0/applications/:app-id/datastores/:datastore-id/items/links/:item-id | アイテムに関連するアイテム一覧を取得 | v0 | ✓ | |
24 | アイテムリンク作成 | POST | /api/v0/applications/:app-id/datastores/:datastore-id/items/addlink/:item-id | 関連アイテムとのリンクを追加 | v0 | ✓ | |
25 | アイテムリンク更新 | POST | /api/v0/applications/:app-id/datastores/:datastore-id/items/updatelink/:item-id | 関連アイテムとのリンクを更新 | v0 | ✓ | |
26 | アイテムリンク削除 | DELETE | /api/v0/applications/:app-id/datastores/:datastore-id/items/dellink/:item-id | 関連アイテムとのリンクを削除 | v0 | ✓ |
No | API Name | API名 | Method | URI | 目的 | version | 画面ID(display_id)への対応 |
29 | 添付ファイルUpload | POST | /api/v0/items/:item-id/fields/:field-id/attachments | 添付ファイルフィールドにファイルをアップロード | v0 | - | |
30 | 添付ファイル削除 | DELETE | /api/v0/items/:item-id/fields/:field-id/attachments/:file-id | 添付ファイルフィールドのファイルを削除 | v0 | - | |
35 | GetFile | ファイルデータの取得 | GET | /api/v0/files/:file-id | 添付ファイルデータを取得 | v0 | - |
No | API Name | API名 | Method | URI | 目的 | version | 画面ID(display_id)への対応 |
34 | アイテム履歴取得 | GET | /api/v0/datastores/:datastore-id/items/:item-id/histories | 履歴を取得 | v0 | - | |
45 | アイテムコメント投稿 | POST | /api/v0/datastores/:datastore-id/items/histories | コメント履歴を登録 | v0 | - |
No | API Name | API名 | Method | URI | 目的 | version | 画面ID(display_id)への対応 |
16 | アイテムCSVインポート | POST | /api/v0/applications/:app-id/datastores/:datastore-id/import | CSVデータをデータベースへインポート | v0 | ✓ | |
17 | インポート結果取得 | GET | /api/v0/datastores/:datastore-id/import/:id | CSVインポートの結果取得 | v0 | - |
No | API Name | API名 | Method | URI | 目的 | version | 画面ID(display_id)への対応 |
37 | データレポート取得 | GET | /api/v0/applications/:app-id/reports/:report-id | レポートデータの取得 | v0 | ✓ | |
38 | データレポート検索条件取得 | GET | /api/v0/applications/:app-id/reports/:report-id/conditions | レポートの検索条件を取得 | v0 | ✓ | |
39 | 条件指定してデータレポート取得 | POST | /api/v0/applications/:app-id/reports/:report-id/filter | 条件を指定してレポートデータを取得 | v0 | ✓ |
No | API Name | API名 | Method | URI | 目的 | version | 画面ID(display_id)への対応 |
40 | チャートデータ取得 | GET | /api/v0/applications/:app-id/charts/:chart-id | チャートデータの取得 | v0 | ✓ | |
41 | チャート検索条件取得 | GET | /api/v0/applications/:app-id/charts/:chart-id/conditions | チャートの検索条件を取得 | v0 | ✓ | |
42 | 条件指定してチャートデータ取得 | POST | /api/v0/applications/:app-id/charts/:chart-id/filter | 条件を指定してチャートデータを取得 | v0 | ✓ |