CreateField
フィールドを作成
Description
data_typeを指定してフィールドを作成します。
下記表のdata_typeが指定可能です。
※作成するフィールドのdata_type（型）に応じて設定可能な各項目が異なります
| data_type | 項目の種類 | 一意キー | タイトルに利用 | 検索条件に利用 | 検索インデックスの有無 | 全文検索の対象とする | 一覧に表示する | アクション実行時に表示しない | APIの結果に表示しない |
|---|---|---|---|---|---|---|---|---|---|
| text | テキスト | 〇 | 〇 | 〇 | 〇 | 〇 | |||
| textarea | 複数行テキスト | 〇 | 〇 | 〇 | |||||
| select | 選択肢 | 〇 | 〇 | ||||||
| radio | ラジオ | 〇 | 〇 | ||||||
| checkbox | チェックボックス | 〇 | 〇 | ||||||
| autonum | 自動採番 | 〇 | 〇 | 〇 | 〇 | ||||
| number | 数値 | 〇 | 〇 | ||||||
| calc | 計算式 | 〇 | 〇 | ||||||
| datetime | 日付・時刻 | 〇 | 〇 | ||||||
| file | 添付ファイル | 〇 | 〇 | 〇 | |||||
| users | ユーザー | 〇 | 〇 | ||||||
| dslookup | データベース参照 | 〇 | 〇 | ||||||
| label | ラベル | ||||||||
| separator | セパレーター |
Method
POST
Request URL Format
/api/v0/applications/:app-id/datastores/:datastore-id/fields
URL Params
app-id : アプリケーションID（Hexabase画面から入力したID）
datastore-id : データストアID（Hexabase画面から入力したID）
Request URL Sample
POST https://api.xxx.com/api/v0/applications/624bea3a879f4e8d8b5dcc6f/datastores/639912c0b1ea5632b8bc0545/fields
Payload
各data_typeの詳細設定は、UpdateFieldから行います
{
"dataType": "text",
"name": "フィールド名", // (必須)画面項目名
"display_id": "Fld-MzZNUHau", // 画面項目ID
"search": true, // 「検索条件に利用する」を設定
"show_list": true, // 「一覧に表示する」を設定
"as_title": false, // 「タイトルに利用する」を設定
"full_text": false, // 「全文検索の対象とする」を設定
"unique": false, // 「一意なデータ」を設定
"hideOnInput": false, // 「アクション実行時に表示しない」を設定
"hide_from_api": false, // 「APIの結果に表示しない」を設定
"has_index": false, // 「検索インデックスの有無」を設定
"roles": [ // 権限の設定（アプリケーションAdminロールは自動的に付与されます）
"MEMBER", // ロールIDを指定する
"624bea3a879f4e8d8b5dcc72"
]
}
Response Sample
{
"display_id": "Fld-MzZNUHau",
"field_id": "63c8dd1bc381e7e523178b97"
}