ver.2サポートサイト

HOME機能アプリ管理DBフィールドタイプリファレンス

フィールドタイプリファレンス

概要

データを扱いやすいように、特徴に応じたフィールドタイプを用意しています。

各フィールドを構成して、DBを作成します。

フィールドタイプの種類

フィールドタイプ名

フィールドタイプ

(API上での名称)

ストレージ計算容量

(bytes)

テキスト text 128
テキストエリア textarea

1024

メールアドレス email 256
電話番号 phone 19
整数 integer 8
数値 double 8
日付 date 4
月日 monthDay 4
時刻 time 8
日時 dateTime 8
セレクト select 8
マルチセレクト multiSelect 125
参照フィールド reference 8
ファイル file

0

※別途ファイルストレージ容量にて計算されます。

パスワード password

128

※ レコードストレージ容量はフィールドに登録されている実データ容量ではなく、フィールドタイプ毎に定められたストレージ計算容量の合計値で計算されます。

※ 具体的な計算イメージについては「レコードストレージ容量はどのように計算されますか?」をご覧ください。

フィールドタイプの詳細仕様

テキスト型フィールド

名前、住所など改行が必要ではないテキストデータで使用します。

タイプ 説明
テキスト(text) 改行を含まない最大128字の文字列を格納します。
API入出力 / 一括登録・出力ファイル上のフォーマット
  備考
入力 おはようございます。こんにちは。質問があります。 改行が含まれている場合はエラーになります。
出力 おはようございます。こんにちは。質問があります。 -
入力制限 (※空白(null)で設定すると制限なしになります。)
改行 改行不可
最小/最大文字数制限 0~128の範囲で指定できます。
正規表現 正規表現による入力制限をします。指定の正規表現にマッチした文字列のみが入力可能となります。

 

テキストエリア型フィールド

コメント欄など改行を含むテキストデータで使用します。

タイプ 説明
テキストエリア(textarea) 改行を含む最大20,000字の文字列を格納します。
API入出力 / 一括登録・出力ファイル上のフォーマット
  備考
入力 おはようございます。\nこんにちは。\n質問があります。 改行箇所は改行コード(\n)に変更して入力してください。
出力 おはようございます。\nこんにちは。\n質問があります。 -
入力制限 (※空白(null)で設定すると制限なしになります。)
最小/最大文字数制限 0~20,000の範囲で指定できます。
正規表現 正規表現による入力制限をします。指定の正規表現にマッチした文字列のみが入力可能となります。

 

メールアドレス型フィールド

メールアドレスに使用します。入力値に大文字が含まれる場合、小文字へ自動変換されます。

タイプ 説明
メールアドレス(email) メールアドレスを格納します。
API入出力 / 一括登録・出力ファイル上のフォーマット
  備考
入力 email@example.com 以下のフォーマットに従った文字列を格納します。
・ ASCII文字のみ
・ 先頭に.(ドット)は許可しない
・ 文字列の中間に@が含まれる
・ @は先頭、あるいは末尾ではない
・ ドメイン部分には必ず.(ドット)が含まれる
出力 email@example.com -
入力制限(※空白(null)で設定すると制限なしになります。)
ドメイン 

許可リスト:許可リストにあるドメインのみ入力を許可します

拒否リスト:拒否リストにあるドメインは入力できなくなります

正規表現 正規表現による入力制限をします。指定の正規表現にマッチした文字列のみが入力可能となります。

 

電話番号型フィールド

電話番号に使用します。以下のルールで自動変換されます。

タイプ 説明
電話番号(phone) 国コードを含む電話番号(international format)を格納します。
実在するフォーマットの電話番号でないとエラーになります。
API入出力 / 一括登録・出力ファイル上のフォーマット
  備考
入力

+81 80-1111-2222

080-1111-2222

DBの入力制限で許可国コード未指定の場合は、デフォルト値の「+81(日本)」が付与されます。

指定している場合は国コード入力を省略でき、レコード格納時に国コードは自動付与されます。

出力 +81 80-1111-2222

-

入力制限
許可国コード

指定の国コードで入力制限し、それ以外の国コードの場合はエラーとします。
「全て」を選択すると国コード入力が必須になります。

 

整数型フィールド

整数を格納するフィールドです。

タイプ 説明
整数(integer) -9,223,372,036,854,775,808~9,223,372,036,854,775,807の範囲の
整数を格納します。
API入出力 / 一括登録・出力ファイル上のフォーマット
  備考
入力 100 -
出力 100 -
入力制限 (※空白(null)で設定すると制限なしになります。)
最小/最大値制限 -9,223,372,036,854,775,808~9,223,372,036,854,775,807の範囲で指定できます。

 

数値型フィールド

実数を格納するフィールドです。

タイプ 説明
数値(double) 15桁までの実数を格納します。
API入出力 / 一括登録・出力ファイル上のフォーマット
  備考
入力

123456.789012345

-0.12345678901234

-
出力

123456.789012345

-0.12345678901234

-
入力制限 (※空白(null)で設定すると制限なしになります。)
最小/最大値制限 -999,999,999,999,999〜999,999,999,999,999の範囲で指定できます。
小数桁数固定設定 0~15桁の範囲で小数点の位置を固定できます。
小数部桁数超過時の扱い 切り捨て: 指定桁数を超えた場合の小数桁を削除します。
エラー : 指定桁数を超えた場合エラーを返します。

 

日付型フィールド

年月日の日付を格納するフィールドです。

タイプ 説明
日付(date) 日付(〇年〇月〇日)を格納します。
API入出力 / 一括登録・出力ファイル上のフォーマット
  備考
入力

2016-01-20

2016-01

2016

年月日・年月・年のいずれかが指定できます。

省略部分は1固定で格納されます。

出力

2016-01-20

2016-01-01

-
入力制限 (※空白(null)で設定すると制限なしになります。)
最小/最大値制限 1600年01月01日〜9999年12月31日の範囲で指定できます。

 

月日型フィールド

年月日の日付を格納するフィールドです。

タイプ 説明
月日(monthDay) 月日(〇月〇日)を格納します。
API入出力 / 一括登録・出力ファイル上のフォーマット
  備考
入力

01-20

01

年月・年のいずれかが指定できます。

省略部分は1固定で格納されます。

出力

01-20

01-01

-
入力制限 (※空白(null)で設定すると制限なしになります。)
最小/最大値制限 01月01日〜12月31日の範囲で指定できます。

 

時刻型フィールド

時刻を格納するフィールドです。

タイプ 説明
時刻(time) 時刻(〇時〇分〇秒)を格納します。
API入出力 / 一括登録・出力ファイル上のフォーマット
  備考
入力

12:34:56

12:00

12

時分秒、時分、時のいずれかが指定できます。

省略部分は0固定で格納されます。

出力

12:34:56

12:00:00

-
入力制限 (※空白(null)で設定すると制限なしになります。)
最小/最大値制限 00時00分00秒〜23時59分59秒の範囲で指定できます。

 

日時型フィールド

日付+時刻を格納するフィールドです。

タイプ 説明
日時(dateTime) 日時(〇年〇月〇日〇時〇分〇秒+timezone)を格納します。
API入出力 / 一括登録・出力ファイル上のフォーマット
  備考
入力

2016-01-01T12:00:00+09:00

2016-01-01T11:00:00+10:00

2016-01-01T11:00+10:00

2016-01-01T11+10:00

・年月日時分秒・年月日時分・年月日時のいずれかが指定できます。

 省略部分は0固定で格納されます。

・DB格納時にUTCにて扱います。

出力 2016-01-01T03:00:00Z

UTCにて出力します。

※ タイムゾーンを指定して入力した場合でも、DB格納値はUTC(協定世界時)となります。

入力制限 (※空白(null)で設定すると制限なしになります。)
最小/最大値制限 1600年01月01日00時00分00秒+timezone〜9999年12月31日23時59分59秒+timezoneの範囲で指定できます。

 

セレクト型フィールド

選択肢から選んだ1つの項目を格納するフィールドです。

タイプ 説明
セレクト(select)

択一の選択肢を格納します。

 

選択肢は300個まで設定可能。
ラベルIDは0~999まで指定できます。

API入出力フォーマット
  備考
入力

"2"

入力はラベルIDのみ。

出力

"2"

出力はラベルIDのみ。
一括登録・出力ファイル上のフォーマット
  備考
入力

2

ラベル2

ラベルID

ラベル名

出力

2

出力はラベルIDのみ。ラベル名はqueryで optionsFormat=label を指定すると出力可能です
入力制限
項目テンプレート

以下のテンプレートを指定して適用できます。
・ 都道府県(日本の都道府県)
・ 性別(男性、女性)

・ブーリアン(true,false)
※適用後に変更することも可能です

 

マルチセレクト型フィールド

選択肢から選んだ複数の項目を格納するフィールドです。

タイプ 説明
マルチセレクト(multiselect)

複数の選択肢を格納します。

 

選択肢は300個まで設定可能。
ラベルIDは0~999まで指定できます。

API入出力フォーマット
  備考
入力

["1","2"]

ラベルIDの配列

出力

["1","2"]

ラベルIDの配列
一括登録・出力ファイル上のフォーマット
  備考
入力

2|3

ラベル2|ラベル3

ラベルID

ラベル名

出力

2|3

出力はラベルIDのみ。ラベル名はqueryで optionsFormat=label を指定すると出力可能です
入力制限
項目テンプレート

以下のテンプレートを指定して適用できます。
・ 都道府県(日本の都道府県)
・ 性別(男性、女性)

・ブーリアン(true,false)
※適用後に変更することも可能です

最小/最大選択数制限 1〜300個の範囲で指定できます。
※空白(null)で設定すると制限なしになります。

 

参照フィールド

同一アプリ内にある別DBのレコードを参照して、レコード同士をデータ連携させることができるフィールドタイプです。

 

タイプ 説明
参照フィールド(reference)

・参照先に指定できるDBは同一アプリ内の別DBのみとなります。

・参照先に指定したDBのレコードをラベルとして表示することができます。

・選択できるフィールドは、入力必須かつユニークのテキストフィールド・メールアドレスフィールド、またはレコードIDのみとなります。

API入出力フォーマット
備考
入力 1レコード参照 "14"

入力は参照先DBのレコードIDのみです。

複数レコード参照
出力 1レコード参照

{
"info": {
"url": "https://api.spiral-platform.com/v1/dbs/123/records?referrer=123.4:56"
},
"value": {
"_id": "1",
"_revision": "10",
"_createdBy": {
"type": "user",
"userId": "100"
},
"_createdAt": "2020-04-30T17:06:29Z",
"_createOperationSourceId": "100",
"_updatedBy": {
"type": "user",
"userId": "100"
},
"_updatedAt": "2020-04-30T17:06:29Z",
"_updateOperationSourceId": "100",
"_unauthorized": "false",
"email": "yamada@example.com"
}
}

参照先レコードを取得するための情報、参照先レコード値(メタ情報やラベルフィールド)を出力します。

 

・infoで取得するURLは、参照先レコードを取得するためのリクエストURLです。

referrer=123.4:56で参照元から参照されているレコードを絞り込みます。

※[参照元DB ID].[参照フィールドID]:[参照元レコードID]のフォーマット形式になります。

 

 

・1レコード参照の参照先レコード値の場合、1件のオブジェクト、複数レコード参照の参照先レコード値の場合、オブジェクトのリストを返します。

 

レコードID|リビジョン番号|登録者|登録日時|登録操作元ID|更新者|更新日時|更新操作元ID|閲覧権限可否|フィールド値

複数レコード参照

{
"info": {
"url": "https://api.spiral-platform.com/v1/dbs/123/records?referrer=123.4:56"
},
"value": [
{
"_id": "1",
"_revision": "10",
"_createdBy": {
"type": "user",
"userId": "100"
},
"_createdAt": "2020-04-30T17:06:29Z",
"_createOperationSourceId": "100",
"_updatedBy": {
"type": "user",
"userId": "100"
},
"_updatedAt": "2020-04-30T17:06:29Z",
"_updateOperationSourceId": "100",
"_unauthorized": "false",
"shopName": "赤坂店"
},
{
"_id": "3",
"_revision": "10",
"_createdBy": {
"type": "user",
"userId": "100"
},
"_createdAt": "2020-04-30T17:06:29Z",
"_createOperationSourceId": "100",
"_updatedBy": {
"type": "user",
"userId": "100"
},
"_updatedAt": "2020-04-30T17:06:29Z",
"_updateOperationSourceId": "100",
"shopName": "青山店"
}
]
}

一括登録・出力ファイル上のフォーマット
  備考
入力

1レコード参照

赤坂店

10

入力形式は、参照先DBの入力必須かつユニークのテキスト、メールアドレスフィールドのラベルフィールド値、参照先レコードID

複数レコード参照

赤坂店|青山店|丸の内店|下北沢店

10|12|15|19

入力形式は、参照先DBの入力必須かつユニークのテキスト、メールアドレスフィールドのラベルフィールド値、参照先レコードID

※参照先のレコード値に|が含まれている場合、レコード値全体を""でくくります。

出力

1レコード参照

赤坂店

10

ラベルフィールド値で出力した場合で、参照先レコードの閲覧権限がない場合は(_unauthorized:XX)で出力します。

複数レコード参照

赤坂店|青山店|丸の内店|下北沢店

10|12|15|19

ラベルフィールド値で出力した場合で、参照先レコードの閲覧権限がない場合は(_unauthorized:XX)で出力します。

 

その他仕様
参照先DB 同一アプリ内の別DBのみ指定できます。フィールド作成後は、参照先DBを変更することはできません。
参照レコード数

参照先DBのレコードを1件のみ関連付けするか、複数レコードを関連付けするかを選択します。

複数レコードを参照する場合、1~20件の範囲で指定できます。

なお、設定済みの参照レコード数を1レコード参照から複数レコード参照へ変更することはできません。

ラベルフィールド

参照先DBのレコードをラベルとして表示するフィールドを選択します。

ラベルにできるフィールドは、入力必須かつユニークのテキストフィールド・メールアドレスフィールド、またはレコードIDのみとなります。

参照ユニーク制約 参照先DBの同一レコードを複数の参照元レコードから参照されないように制限を設けます。
参照先レコード削除時

参照先DBのレコードが削除された場合の参照フィールド上の値の取り扱いを指定します。

参照先DBのレコードを削除禁止、または、参照先レコードが削除した場合、参照元レコードの値はnullにするかを選択します。

 

入力制限 (※空白(null)で設定すると制限なしになります。)
最小/最大参照数制限 複数レコード参照 1~20の範囲で指定できます。

 

ファイル型フィールド

アップロードしたファイルを格納するフィールドです。

タイプ 説明
ファイル(file)

ファイルを格納します。

対象フィールドに対し、ファイルをアップロードし、その上でレコード登録します。

API入出力フォーマット
  備考
トークン発行
"fileUploadToken": "a0eebc999c0b4ef8bb6d6bb9bd380a11",
"expireAt": "2019-07-17T01:51:04Z"
レコードのファイル型フィールドにファイルを登録する際に、事前にファイルをアップロードするのに必要なトークンを発行します
入力

----WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="file"; filename="sample.png"
Content-Type: image/png

[file content goes there]
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="fileUploadToken"

a0eebc999c0b4ef8bb6d6bb9bd380a11
------WebKitFormBoundary7MA4YWxkTrZu0gW--

レコードのファイル型フィールドにファイルを登録する際に、事前に取得したトークンを用いてファイルをアップロードします
出力

ファイル型フィールドに格納しているファイル

pathパラメータにファイルキーを含めてリクエストします
一括登録・出力ファイル上のフォーマット

ファイル型フィールドにおけるファイル実体の一括登録/出力は、非対応となります。

入力制限
許可拡張子

アップロード可能な拡張子を登録します。

※最低1つの拡張子指定が必要です。

ファイル数

1フィールドにアップロードできるファイル数の上限を指定します。

1〜10ファイルの範囲で指定できます。

1ファイルあたりのファイルサイズ上限

1byte〜100MiBの範囲で指定できます。

※下限はAPIでは1byte、操作画面では1KiB

ファイル名

「\」「/」「:」「*」「?」「"」「<」「>」「|」が含まれていた場合はエラーとなります。

 

利用可能な拡張子一覧
ドキュメント

pdf、docx、doc、xlsx、xls、pptx、ppt、odt、ods、odp、pages、numbers、key

テキスト

txt、csv、tsv

画像

jpg、jpeg、png、gif、svg

音声

mp3、aac、m4a、wma、wav

動画

mp4、wmv、mpg、mpeg、mov、avi、flv

その他

zip、eml

※zip等の圧縮ファイルにウイルスファイルが含まれる場合、ウイルススキャンされず、ウイルスファイルがアップロードされる可能性があります。
 圧縮形式の拡張子を許可する場合には十分にご注意ください。

※ver.2.18(2021/11/30)以降に追加したファイルフィールドについては、「その他」の許可拡張子のデフォルトは「許可しない」に設定されています。

パスワード型フィールド

パスワードを格納するフィールドです。実体としてはハッシュ化したパスワードを格納します。

タイプ 説明
テキスト(password)

入力値はソルト付きハッシュ値にて格納されます。

出力は、値の有無のみの表示となります。

API入出力フォーマット
  備考
入力 pK-4Pqec -
出力 hasValue true パスワード値の有無によりhasValueの値にtrue/falseが入ります
一括登録・出力ファイル上のフォーマット

パスワード型フィールドは、一括登録/一括出力が非対応となります。

 

入力制限 (※空白(null)で設定すると制限なしになります。)
改行 改行不可
最小/最大文字数制限 6~128の範囲で指定できます。デフォルトの最小文字数は「8文字」、最大文字数は「64文字」です。
許可文字種 大文字アルファベット、小文字アルファベット、数字、記号(半角スペース,.:;?!`_/~|'"()[]{}+-=<>$%#&*@\^)
文字種数制限 2種~4種の範囲で文字種数を制限できます。デフォルトは「制限する(4種)」です。
その他 ユニーク制約とインデックスは設定できません。