Skip to main content

Datastore API

データストアとアクション、フィールドに関するAPI

注意

  • 本API群では、display_id を指定することはできません。内部ID(p_id, d_idなど) を指定してください

データストア関連API

NoAPI NameAPI名MethodURI目的version画面ID(display_id)への対応
1GetDatastoresデータストア一覧の取得GET/api/v0/applications/:project-id/datastores指定したアプリケーション内のデータストアを取得しますv0-
2GetStatusesステータス一覧の取得GET/api/v0/datastores/:datastore-id/statusesデータストア内のステータス一覧を取得しますv0-

アクション関連API

Hexabaseでは、「アイテム」のカラムを「フィールド」または「画面項目」と呼びます。

NoAPI NameAPI名MethodURI目的version画面ID(display_id)への対応
3GetActionsアクション一覧の取得GET/api/v0/datastores/:datastore-id/actionsデータストアで利用できるアクションボタン一覧を取得しますv0-
4GetNewActions新規作成アクション一覧の取得GET/api/v0/datastores/:datastore-id/new-actionsデータストアで利用できる新規登録アクション一覧を取得しますv0-
5GetUpdateActions更新アクション一覧の取得GET/api/v0/datastores/:datastore-id/update-actionsデータストアで利用できる更新アクション一覧を取得しますv0-

フィールド関連API

Hexabaseでは、「アイテム」のカラムを「フィールド」または「画面項目」と呼びます。

NoAPI NameAPI名MethodURI目的version画面ID(display_id)への対応
6GetDatastoreFieldsフィールド一覧GET/api/v0/applications/:app-id/datastores/:datastore-id/fieldsデータストア内に定義されたフィールド一覧を取得しますv0