ver.2サポートサイト

APIによるDB作成/レコード操作

APIを使用して、アプリ作成＞DB作成＞レコード登録までの手順を説明します。

詳しい作成方法については、「サンプルプログラム一覧」もしくは「SPIRAL ver.2 APIリファレンス」を参照してください。

設定手順（アプリ作成＞DB作成＞レコード登録）

1. アプリ作成

DBはアプリがないと作成出来ないので、アプリを作成していない方はまず /apps のAPIを使用し、アプリを作成してください。
アプリを作成するには、「アプリの識別名」「アプリの表示名」をJSON形式のフォーマットにして送信してください。

■name(識別名)

APIで使用するアプリを識別する時の名称です。

■displayName(表示名)

SPIRAL ver.2の操作画面に表示される名称です。

2. DB作成

/apps/{app}/dbs のAPIを使用し、DBを作成します。
DBを作成するには、「DBの識別名」「DBの表示名」「フィールド」をJSON形式のフォーマットにして送信してください。

■name(識別名)
APIで使用する他のDBと識別する時の名称です。
DBの検索、変更、削除やレコードのAPIなどで使用します。

■displayName(表示名)
SPIRAL ver.2の操作画面に表示される名称です。

■fields(フィールド)
データベースに格納する項目です。例えば、顧客情報の場合だと氏名、住所、メールアドレスなどがフィールドになります。
作成したいDBに合わせて必要なフィールドを組み合わせて設定してください。作成可能なフィールド数の最大値はこちらをご参照ください。
また、フィールドを設定するときは、以下の属性を設定します。

• • • • name(識別名)
        APIで使用する他のDBと識別する時の名称です。
        フィールドの変更や削除、レコードの検索でフィールドを条件に検索する時に使用します。
        
        
      • displayname(表示名)
        SPIRAL ver.2の操作画面に表示される名称です。
        
        
      • type(フィールドタイプ)
        フィールドの形式を設定します。
        フィールドタイプについては「SPIRAL ver2 フィールドタイプリファレンス」を参照してください。
        ※作成後はタイプを変更することが出来ません。
  • defaultValue(デフォルト値)
    未入力フィールド登録時のデフォルト値を指定できる設定です。
    ※重複不可の設定がtrueの場合や、入力制限に競合する値の指定は設定できません。

• required(入力必須)
  フィールドに値を必ず入力しなければならない設定です。
  
  
• unique(重複不可)
  フィールドに入力する値は他のレコードと重複してはならない設定です。
  
  
• index(インデックス)
  インデックスを作成することでレコードの検索性能が良くすることができます。
  しかし、多くのフィールドに付与すると書き込み性能が悪化する恐れがあります。
  
  
• フィールドタイプの固有設定
  それぞれのフィールドタイプの固有設定については、「SPIRAL ver2 フィールドタイプリファレンス」を参照してください。
  また、DBを作成した時にレスポンスで返ってきてたIDはdbIdといい、DBの検索、変更、削除やレコードのAPIで使用します。

3. レコード登録

レコードは、データの1件分のことで、顧客情報の場合だと1人分の顧客情報がレコードになります。

ヘッダでアプリロールまたは、利用権限/管理権限の指定が必要です。

/apps/{app}/dbs/{db}/records のAPIを使用し、作成したDBにレコードを登録できます。

レコードを登録するには、フィールドに入力する値をJSON形式のフォーマットにして送信してください。
レコードを作成した時にレスポンスで返ってきてたIDはレコードIdといい、レコードの検索、変更、削除で使用します。

/apps/{app}/dbs/{db}/records/bulk のAPIを使用すると、レコードを1000件単位で一括登録できます。
また、/apps/{app}/dbs/{db}/records/batchInserts のAPIを使用すると、大量レコードを非同期で一括登録できます。

DB操作

検索

GET メソッドを使用することで、/apps/{app}/dbs/{db} で、DB設定を取得できます。

これまで作成したDBの一覧は、/apps/{app}/dbs と指定することにより、アプリごとのDBの一覧を取得できます。

変更

PATCH メソッドを使用することで、/apps/{app}/dbs/{db} で、DB設定を変更できます。

変更可能な内容は、「DBの識別名」と「DBの表示名」、「フィールド」です。
フィールドは変更以外にも新しいフィールドの追加や削除、フィールドの並び替えも可能です。

削除

DELETE メソッドを使用することで、/apps/{app}/dbs/{db} で、DBを削除できます。

※DBを削除すると登録レコードも同時に削除されます。

レコード操作

検索

GET メソッドを使用することで、/apps/{app}/dbs/{db}/records/{recordId} で、登録したレコードを検索できます。

これまで登録したレコードの一覧は、 /apps/{app}/dbs/{db}/records で取得できます。

また、一覧取得時に /apps/{app}/dbs/{dbId}/records?where=@email='hoge@example.com' や /apps/{app}/dbs/{dbId}/records?where=@ineteger<=100 のように指定すると、
抽出条件に一致したレコードだけの一覧を取得できます。

where句を使用した検索条件については「レコード検索条件」を参照してください。

変更

PATCH メソッドを使用することで、/apps/{app}/dbs/{db}/records/{recordId} で、1レコードの情報を変更できます。

変更したい箇所を入力することで、作成されたレコードを変更できます。

/apps/{app}/dbs/{db}/records/bulk で、指定レコードを1000件単位で一括変更できます。
また、/apps/{app}/dbs/{db}/records/batchUpdates のAPIを使用すると、大量レコードを非同期で一括変更できます。
詳しい変更方法については、「SPIRAL ver.2 APIリファレンス」を参照してください。

削除

DELETE メソッドを使用することで、/apps/{app}/dbs/{db}/records/{recordId}で、作成されたDBやレコードを1件削除できます。

/apps/{app}/dbs/{db}/records/bulk で、指定レコードを1000件単位で一括削除できます。
また、/apps/{app}/dbs/{db}/records/batchDeletes のAPIを使用すると、大量レコードを非同期で一括削除できます。
詳しい削除方法については、「SPIRAL ver.2 APIリファレンス」を参照してください。